gi-gtk-3.0.14: Gtk bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Callbacks

Contents

Description

 

Synopsis

Signals

AccelGroupActivate

AccelGroupFindFunc

AccelMapForeach

type AccelMapForeach = Ptr () -> Text -> Word32 -> [ModifierType] -> Bool -> IO () Source #

type C_AccelMapForeach = Ptr () -> CString -> Word32 -> CUInt -> CInt -> IO () Source #

dynamic_AccelMapForeach Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_AccelMapForeach 
-> Ptr ()

data: User data passed to accelMapForeach or accelMapForeachUnfiltered

-> Text

accelPath: Accel path of the current accelerator

-> Word32

accelKey: Key of the current accelerator

-> [ModifierType]

accelMods: Modifiers of the current accelerator

-> Bool

changed: Changed flag of the accelerator (if True, accelerator has changed during runtime and would need to be saved during an accelerator dump)

-> m () 

AssistantPageFunc

dynamic_AssistantPageFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_AssistantPageFunc 
-> Int32

currentPage: The page number used to calculate the next page.

-> Ptr ()

data: user data.

-> m Int32

Returns: The next page number.

BuilderConnectFunc

dynamic_BuilderConnectFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuilder a, IsObject b, IsObject c) 
=> FunPtr C_BuilderConnectFunc 
-> a

builder: a Builder

-> b

object: object to connect a signal to

-> Text

signalName: name of the signal

-> Text

handlerName: name of the handler

-> Maybe c

connectObject: a Object, if non-Nothing, use g_signal_connect_object()

-> [ConnectFlags]

flags: ConnectFlags to use

-> Ptr ()

userData: user data

-> m () 

CalendarDetailFunc

dynamic_CalendarDetailFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsCalendar a) 
=> FunPtr C_CalendarDetailFunc 
-> a

calendar: a Calendar.

-> Word32

year: the year for which details are needed.

-> Word32

month: the month for which details are needed.

-> Word32

day: the day of month for which details are needed.

-> Ptr ()

userData: the data passed with calendarSetDetailFunc.

-> m (Maybe Text)

Returns: Newly allocated string with Pango markup with details for the specified day or Nothing.

Callback

type C_Callback = Ptr Widget -> Ptr () -> IO () Source #

type Callback = Widget -> IO () Source #

dynamic_Callback Source #

Arguments

:: (HasCallStack, MonadIO m, IsWidget a) 
=> FunPtr C_Callback 
-> a

widget: the widget to operate on

-> Ptr ()

data: user-supplied data

-> m () 

CellAllocCallback

dynamic_CellAllocCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a) 
=> FunPtr C_CellAllocCallback 
-> a

renderer: the cell renderer to operate on

-> Rectangle

cellArea: the area allocated to renderer inside the rectangle provided to cellAreaForeachAlloc.

-> Rectangle

cellBackground: the background area for renderer inside the background area provided to cellAreaForeachAlloc.

-> Ptr ()

data: user-supplied data

-> m Bool

Returns: True to stop iterating over cells.

CellCallback

dynamic_CellCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a) 
=> FunPtr C_CellCallback 
-> a

renderer: the cell renderer to operate on

-> Ptr ()

data: user-supplied data

-> m Bool

Returns: True to stop iterating over cells.

CellLayoutDataFunc

dynamic_CellLayoutDataFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellLayout a, IsCellRenderer b, IsTreeModel c) 
=> FunPtr C_CellLayoutDataFunc 
-> a

cellLayout: a CellLayout

-> b

cell: the cell renderer whose value is to be set

-> c

treeModel: the model

-> TreeIter

iter: a TreeIter indicating the row to set the value for

-> Ptr ()

data: user data passed to cellLayoutSetCellDataFunc

-> m () 

ClipboardClearFunc

dynamic_ClipboardClearFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsClipboard a) 
=> FunPtr C_ClipboardClearFunc 
-> a

clipboard: the Clipboard

-> Ptr ()

userDataOrOwner: the userData argument passed to gtk_clipboard_set_with_data(), or the owner argument passed to gtk_clipboard_set_with_owner()

-> m () 

ClipboardGetFunc

dynamic_ClipboardGetFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsClipboard a) 
=> FunPtr C_ClipboardGetFunc 
-> a

clipboard: the Clipboard

-> SelectionData

selectionData: a SelectionData argument in which the requested data should be stored.

-> Word32

info: the info field corresponding to the requested target from the TargetEntry array passed to gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().

-> Ptr ()

userDataOrOwner: the userData argument passed to gtk_clipboard_set_with_data(), or the owner argument passed to gtk_clipboard_set_with_owner()

-> m () 

ClipboardImageReceivedFunc

dynamic_ClipboardImageReceivedFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsClipboard a, IsPixbuf b) 
=> FunPtr C_ClipboardImageReceivedFunc 
-> a

clipboard: the Clipboard

-> b

pixbuf: the received image

-> Ptr ()

data: the userData supplied to clipboardRequestImage.

-> m () 

ClipboardReceivedFunc

dynamic_ClipboardReceivedFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsClipboard a) 
=> FunPtr C_ClipboardReceivedFunc 
-> a

clipboard: the Clipboard

-> SelectionData

selectionData: a SelectionData containing the data was received. If retrieving the data failed, then then length field of selectionData will be negative.

-> Ptr ()

data: the userData supplied to clipboardRequestContents.

-> m () 

ClipboardRichTextReceivedFunc

dynamic_ClipboardRichTextReceivedFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsClipboard a) 
=> FunPtr C_ClipboardRichTextReceivedFunc 
-> a

clipboard: the Clipboard

-> Atom

format: The format of the rich text

-> Maybe Text

text: the rich text received, as a UTF-8 encoded string, or Nothing if retrieving the data failed.

-> Word64

length: Length of the text.

-> Ptr ()

data: the userData supplied to clipboardRequestRichText.

-> m () 

ClipboardTargetsReceivedFunc

dynamic_ClipboardTargetsReceivedFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsClipboard a) 
=> FunPtr C_ClipboardTargetsReceivedFunc 
-> a

clipboard: the Clipboard

-> Maybe [Atom]

atoms: the supported targets, as array of Atom, or Nothing if retrieving the data failed.

-> Ptr ()

data: the userData supplied to clipboardRequestTargets.

-> m () 

ClipboardTextReceivedFunc

dynamic_ClipboardTextReceivedFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsClipboard a) 
=> FunPtr C_ClipboardTextReceivedFunc 
-> a

clipboard: the Clipboard

-> Maybe Text

text: the text received, as a UTF-8 encoded string, or Nothing if retrieving the data failed.

-> Ptr ()

data: the userData supplied to clipboardRequestText.

-> m () 

ClipboardURIReceivedFunc

dynamic_ClipboardURIReceivedFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsClipboard a) 
=> FunPtr C_ClipboardURIReceivedFunc 
-> a

clipboard: the Clipboard

-> [Text]

uris: the received URIs

-> Ptr ()

data: the userData supplied to clipboardRequestUris.

-> m () 

ColorSelectionChangePaletteFunc

type ColorSelectionChangePaletteFunc = [Color] -> IO () Source #

Deprecated: (Since version 3.4)

ColorSelectionChangePaletteWithScreenFunc

type ColorSelectionChangePaletteWithScreenFunc = Screen -> [Color] -> IO () Source #

Deprecated: (Since version 3.4)

EntryCompletionMatchFunc

dynamic_EntryCompletionMatchFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntryCompletion a) 
=> FunPtr C_EntryCompletionMatchFunc 
-> a

completion: the EntryCompletion

-> Text

key: the string to match, normalized and case-folded

-> TreeIter

iter: a TreeIter indicating the row to match

-> Ptr ()

userData: user data given to entryCompletionSetMatchFunc

-> m Bool

Returns: True if iter should be displayed as a possible completion for key

FileFilterFunc

dynamic_FileFilterFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_FileFilterFunc 
-> FileFilterInfo

filterInfo: a FileFilterInfo that is filled according to the needed flags passed to fileFilterAddCustom

-> Ptr ()

data: user data passed to fileFilterAddCustom

-> m Bool

Returns: True if the file should be displayed

FlowBoxCreateWidgetFunc

dynamic_FlowBoxCreateWidgetFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_FlowBoxCreateWidgetFunc 
-> Ptr ()

item: the item from the model for which to create a widget for

-> Ptr ()

userData: user data from flowBoxBindModel

-> m Widget

Returns: a Widget that represents item

FlowBoxFilterFunc

dynamic_FlowBoxFilterFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsFlowBoxChild a) 
=> FunPtr C_FlowBoxFilterFunc 
-> a

child: a FlowBoxChild that may be filtered

-> Ptr ()

userData: user data

-> m Bool

Returns: True if the row should be visible, False otherwise

FlowBoxForeachFunc

dynamic_FlowBoxForeachFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a, IsFlowBoxChild b) 
=> FunPtr C_FlowBoxForeachFunc 
-> a

box: a FlowBox

-> b

child: a FlowBoxChild

-> Ptr ()

userData: user data

-> m () 

FlowBoxSortFunc

dynamic_FlowBoxSortFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsFlowBoxChild a, IsFlowBoxChild b) 
=> FunPtr C_FlowBoxSortFunc 
-> a

child1: the first child

-> b

child2: the second child

-> Ptr ()

userData: user data

-> m Int32

Returns: < 0 if child1 should be before child2, 0 if the are equal, and > 0 otherwise

FontFilterFunc

dynamic_FontFilterFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsFontFamily a, IsFontFace b) 
=> FunPtr C_FontFilterFunc 
-> a

family: a FontFamily

-> b

face: a FontFace belonging to family

-> Ptr ()

data: user data passed to fontChooserSetFilterFunc

-> m Bool

Returns: True if the font should be displayed

IconViewForeachFunc

dynamic_IconViewForeachFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> FunPtr C_IconViewForeachFunc 
-> a

iconView: a IconView

-> TreePath

path: The TreePath of a selected row

-> Ptr ()

data: user data

-> m () 

KeySnoopFunc

dynamic_KeySnoopFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsWidget a) 
=> FunPtr C_KeySnoopFunc 
-> a

grabWidget: the widget to which the event will be delivered

-> EventKey

event: the key event

-> Ptr ()

funcData: data supplied to gtk_key_snooper_install()

-> m Int32

Returns: True to stop further processing of event, False to continue.

ListBoxCreateWidgetFunc

dynamic_ListBoxCreateWidgetFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> FunPtr C_ListBoxCreateWidgetFunc 
-> a

item: the item from the model for which to create a widget for

-> Ptr ()

userData: user data

-> m Widget

Returns: a Widget that represents item

ListBoxFilterFunc

dynamic_ListBoxFilterFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsListBoxRow a) 
=> FunPtr C_ListBoxFilterFunc 
-> a

row: the row that may be filtered

-> Ptr ()

userData: user data

-> m Bool

Returns: True if the row should be visible, False otherwise

ListBoxForeachFunc

dynamic_ListBoxForeachFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsListBoxRow b) 
=> FunPtr C_ListBoxForeachFunc 
-> a

box: a ListBox

-> b

row: a ListBoxRow

-> Ptr ()

userData: user data

-> m () 

ListBoxSortFunc

dynamic_ListBoxSortFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsListBoxRow a, IsListBoxRow b) 
=> FunPtr C_ListBoxSortFunc 
-> a

row1: the first row

-> b

row2: the second row

-> Ptr ()

userData: user data

-> m Int32

Returns: < 0 if row1 should be before row2, 0 if they are equal and > 0 otherwise

ListBoxUpdateHeaderFunc

dynamic_ListBoxUpdateHeaderFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsListBoxRow a, IsListBoxRow b) 
=> FunPtr C_ListBoxUpdateHeaderFunc 
-> a

row: the row to update

-> Maybe b

before: the row before row, or Nothing if it is first

-> Ptr ()

userData: user data

-> m () 

MenuDetachFunc

dynamic_MenuDetachFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsMenu b) 
=> FunPtr C_MenuDetachFunc 
-> a

attachWidget: the Widget that the menu is being detached from.

-> b

menu: the Menu being detached.

-> m () 

MenuPositionFunc

type C_MenuPositionFunc = Ptr Menu -> Ptr Int32 -> Ptr Int32 -> Ptr CInt -> Ptr () -> IO () Source #

dynamic_MenuPositionFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsMenu a) 
=> FunPtr C_MenuPositionFunc 
-> a

menu: a Menu.

-> Int32

x: address of the gint representing the horizontal position where the menu shall be drawn.

-> Int32

y: address of the gint representing the vertical position where the menu shall be drawn. This is an output parameter.

-> Ptr ()

userData: the data supplied by the user in the menuPopup data parameter.

-> m (Int32, Int32, Bool) 

ModuleDisplayInitFunc

ModuleInitFunc

dynamic_ModuleInitFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ModuleInitFunc 
-> Maybe [Text]

argv: GTK+ always passes Nothing for this argument

-> m () 

PageSetupDoneFunc

dynamic_PageSetupDoneFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsPageSetup a) 
=> FunPtr C_PageSetupDoneFunc 
-> a

pageSetup: the PageSetup that has been

-> Ptr ()

data: user data that has been passed to printRunPageSetupDialogAsync

-> m () 

PrintSettingsFunc

RcPropertyParser

RecentFilterFunc

dynamic_RecentFilterFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_RecentFilterFunc 
-> RecentFilterInfo

filterInfo: a RecentFilterInfo that is filled according to the needed flags passed to recentFilterAddCustom

-> Ptr ()

userData: user data passed to recentFilterAddCustom

-> m Bool

Returns: True if the file should be displayed

RecentSortFunc

StylePropertyParser

TextBufferDeserializeFunc

dynamic_TextBufferDeserializeFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a, IsTextBuffer b) 
=> FunPtr C_TextBufferDeserializeFunc 
-> a

registerBuffer: the TextBuffer the format is registered with

-> b

contentBuffer: the TextBuffer to deserialize into

-> TextIter

iter: insertion point for the deserialized text

-> ByteString

data: data to deserialize

-> Bool

createTags: True if deserializing may create tags

-> Ptr ()

userData: user data that was specified when registering the format

-> m ()

(Can throw GError)

TextBufferSerializeFunc

dynamic_TextBufferSerializeFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextBuffer a, IsTextBuffer b) 
=> FunPtr C_TextBufferSerializeFunc 
-> a

registerBuffer: the TextBuffer for which the format is registered

-> b

contentBuffer: the TextBuffer to serialize

-> TextIter

start: start of the block of text to serialize

-> TextIter

end: end of the block of text to serialize

-> Word64

length: Return location for the length of the serialized data

-> Ptr ()

userData: user data that was specified when registering the format

-> m Word8

Returns: a newly-allocated array of guint8 which contains the serialized data, or Nothing if an error occurred

TextCharPredicate

TextTagTableForeach

dynamic_TextTagTableForeach Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTag a) 
=> FunPtr C_TextTagTableForeach 
-> a

tag: the TextTag

-> Ptr ()

data: data passed to textTagTableForeach

-> m () 

TickCallback

dynamic_TickCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsFrameClock b) 
=> FunPtr C_TickCallback 
-> a

widget: the widget

-> b

frameClock: the frame clock for the widget (same as calling widgetGetFrameClock)

-> Ptr ()

userData: user data passed to widgetAddTickCallback.

-> m Bool

Returns: SOURCE_CONTINUE if the tick callback should continue to be called, SOURCE_REMOVE if the tick callback should be removed.

TranslateFunc

type TranslateFunc = Text -> IO Text Source #

Deprecated: (Since version 3.10)

dynamic_TranslateFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_TranslateFunc 
-> Text

path: The id of the message. In ActionGroup this will be a label or tooltip from a ActionEntry.

-> Ptr ()

funcData: user data passed in when registering the function

-> m Text

Returns: the translated message

TreeCellDataFunc

dynamic_TreeCellDataFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeViewColumn a, IsCellRenderer b, IsTreeModel c) 
=> FunPtr C_TreeCellDataFunc 
-> a

treeColumn: A TreeViewColumn

-> b

cell: The CellRenderer that is being rendered by treeColumn

-> c

treeModel: The TreeModel being rendered

-> TreeIter

iter: A TreeIter of the current row rendered

-> Ptr ()

data: user data

-> m () 

TreeDestroyCountFunc

TreeIterCompareFunc

dynamic_TreeIterCompareFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a) 
=> FunPtr C_TreeIterCompareFunc 
-> a

model: The TreeModel the comparison is within

-> TreeIter

a: A TreeIter in model

-> TreeIter

b: Another TreeIter in model

-> Ptr ()

userData: Data passed when the compare func is assigned e.g. by treeSortableSetSortFunc

-> m Int32

Returns: a negative integer, zero or a positive integer depending on whether a sorts before, with or after b

TreeModelFilterVisibleFunc

dynamic_TreeModelFilterVisibleFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a) 
=> FunPtr C_TreeModelFilterVisibleFunc 
-> a

model: the child model of the TreeModelFilter

-> TreeIter

iter: a TreeIter pointing to the row in model whose visibility is determined

-> Ptr ()

data: user data given to treeModelFilterSetVisibleFunc

-> m Bool

Returns: Whether the row indicated by iter is visible.

TreeModelForeachFunc

dynamic_TreeModelForeachFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a) 
=> FunPtr C_TreeModelForeachFunc 
-> a

model: the TreeModel being iterated

-> TreePath

path: the current TreePath

-> TreeIter

iter: the current TreeIter

-> Ptr ()

data: The user data passed to treeModelForeach

-> m Bool

Returns: True to stop iterating, False to continue

TreeSelectionForeachFunc

dynamic_TreeSelectionForeachFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a) 
=> FunPtr C_TreeSelectionForeachFunc 
-> a

model: The TreeModel being viewed

-> TreePath

path: The TreePath of a selected row

-> TreeIter

iter: A TreeIter pointing to a selected row

-> Ptr ()

data: user data

-> m () 

TreeSelectionFunc

dynamic_TreeSelectionFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeSelection a, IsTreeModel b) 
=> FunPtr C_TreeSelectionFunc 
-> a

selection: A TreeSelection

-> b

model: A TreeModel being viewed

-> TreePath

path: The TreePath of the row in question

-> Bool

pathCurrentlySelected: True, if the path is currently selected

-> Ptr ()

data: user data

-> m Bool

Returns: True, if the selection state of the row can be toggled

TreeViewColumnDropFunc

dynamic_TreeViewColumnDropFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a, IsTreeViewColumn b, IsTreeViewColumn c, IsTreeViewColumn d) 
=> FunPtr C_TreeViewColumnDropFunc 
-> a

treeView: A TreeView

-> b

column: The TreeViewColumn being dragged

-> c

prevColumn: A TreeViewColumn on one side of column

-> d

nextColumn: A TreeViewColumn on the other side of column

-> Ptr ()

data: user data

-> m Bool

Returns: True, if column can be dropped in this spot

TreeViewMappingFunc

dynamic_TreeViewMappingFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeView a) 
=> FunPtr C_TreeViewMappingFunc 
-> a

treeView: A TreeView

-> TreePath

path: The path that’s expanded

-> Ptr ()

userData: user data

-> m () 

TreeViewRowSeparatorFunc

dynamic_TreeViewRowSeparatorFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a) 
=> FunPtr C_TreeViewRowSeparatorFunc 
-> a

model: the TreeModel

-> TreeIter

iter: a TreeIter pointing at a row in model

-> Ptr ()

data: user data

-> m Bool

Returns: True if the row is a separator

TreeViewSearchEqualFunc

dynamic_TreeViewSearchEqualFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a) 
=> FunPtr C_TreeViewSearchEqualFunc 
-> a

model: the TreeModel being searched

-> Int32

column: the search column set by treeViewSetSearchColumn

-> Text

key: the key string to compare with

-> TreeIter

iter: a TreeIter pointing the row of model that should be compared with key.

-> Ptr ()

searchData: user data from treeViewSetSearchEqualFunc

-> m Bool

Returns: False if the row matches, True otherwise.

TreeViewSearchPositionFunc