GI.Gtk.Objects.ListBox

A GtkListBox is a vertical container that contains GtkListBoxRow children. These rows can by dynamically sorted and filtered, and headers can be added dynamically depending on the row content. It also allows keyboard and mouse navigation and selection like a typical list.

Using GtkListBox is often an alternative to TreeView, especially when the list contents has a more complicated layout than what is allowed by a CellRenderer, or when the contents is interactive (i.e. has a button in it).

Although a ListBox must have only ListBoxRow children you can add any kind of widget to it via containerAdd, and a ListBoxRow widget will automatically be inserted between the list and the widget.

GtkListBoxRows can be marked as activatable or selectable. If a row is activatable, rowActivated will be emitted for it when the user tries to activate it. If it is selectable, the row will be marked as selected when the user tries to select it.

The GtkListBox widget was added in GTK+ 3.10.

GtkListBox as GtkBuildable

The GtkListBox implementation of the Buildable interface supports setting a child as the placeholder by specifying “placeholder” as the “type” attribute of a <child> element. See listBoxSetPlaceholder for info.

CSS nodes

plain code

list
╰── row[.activatable]

GtkListBox uses a single CSS node named list. Each GtkListBoxRow uses a single CSS node named row. The row nodes get the .activatable style class added when appropriate.

Exported types

newtype ListBox

Memory-managed wrapper type.

Constructors

ListBox (ManagedPtr ListBox)

Instances

Eq ListBox

Defined in GI.Gtk.Objects.ListBox

Methods

(==) :: ListBox -> ListBox -> Bool

(/=) :: ListBox -> ListBox -> Bool

GObject ListBox

Defined in GI.Gtk.Objects.ListBox

ManagedPtrNewtype ListBox

Defined in GI.Gtk.Objects.ListBox

Methods

toManagedPtr :: ListBox -> ManagedPtr ListBox

TypedObject ListBox

Defined in GI.Gtk.Objects.ListBox

Methods

glibType :: IO GType

HasParentTypes ListBox

Defined in GI.Gtk.Objects.ListBox

IsGValue (Maybe ListBox)

Convert ListBox to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.ListBox

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ListBox -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ListBox)

type ParentTypes ListBox

Defined in GI.Gtk.Objects.ListBox

type ParentTypes ListBox = '[Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf ListBox o) => IsListBox o

Type class for types which can be safely cast to ListBox, for instance with toListBox.

Instances

(GObject o, IsDescendantOf ListBox o) => IsListBox o

Defined in GI.Gtk.Objects.ListBox

toListBox :: (MonadIO m, IsListBox o) => o -> m ListBox

Cast to ListBox, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindModel, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragHighlightRow, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, dragUnhighlightRow, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insert, insertActionGroup, intersect, invalidateFilter, invalidateHeaders, invalidateSort, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, prepend, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, selectAll, selectRow, selectedForeach, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unselectAll, unselectRow, unsetFocusChain, unsetStateFlags, watchClosure.

Getters

getAccessible, getActionGroup, getActivateOnSingleClick, getAdjustment, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getRowAtIndex, getRowAtY, getScaleFactor, getScreen, getSelectedRow, getSelectedRows, getSelectionMode, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

Setters

setAccelPath, setActivateOnSingleClick, setAdjustment, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFilterFunc, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHeaderFunc, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setPlaceholder, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSelectionMode, setSensitive, setSizeRequest, setSortFunc, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

bindModel

listBoxBindModel

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsListModel b)

=> a

box: a ListBox

-> Maybe b

model: the ListModel to be bound to box

-> Maybe ListBoxCreateWidgetFunc

createWidgetFunc: a function that creates widgets for items or Nothing in case you also passed Nothing as model

-> m ()

Binds model to box.

If box was already bound to a model, that previous binding is destroyed.

The contents of box are cleared and then filled with widgets that represent items from model. box is updated whenever model changes. If model is Nothing, box is left empty.

It is undefined to add or remove widgets directly (for example, with listBoxInsert or containerAdd) while box is bound to a model.

Note that using a model is incompatible with the filtering and sorting functionality in GtkListBox. When using a model, filtering and sorting should be implemented by the model.

Since: 3.16

dragHighlightRow

listBoxDragHighlightRow

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsListBoxRow b)

=> a

box: a ListBox

-> b

row: a ListBoxRow

-> m ()

This is a helper function for implementing DnD onto a ListBox. The passed in row will be highlighted via widgetDragHighlight, and any previously highlighted row will be unhighlighted.

The row will also be unhighlighted when the widget gets a drag leave event.

Since: 3.10

dragUnhighlightRow

listBoxDragUnhighlightRow

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m ()

If a row has previously been highlighted via listBoxDragHighlightRow it will have the highlight removed.

Since: 3.10

getActivateOnSingleClick

listBoxGetActivateOnSingleClick

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m Bool

Returns: True if rows are activated on single click, False otherwise

Returns whether rows activate on single clicks.

Since: 3.10

getAdjustment

listBoxGetAdjustment

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m Adjustment

Returns: the adjustment

Gets the adjustment (if any) that the widget uses to for vertical scrolling.

Since: 3.10

getRowAtIndex

listBoxGetRowAtIndex

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> Int32

index_: the index of the row

-> m (Maybe ListBoxRow)

Returns: the child Widget or Nothing

Gets the n-th child in the list (not counting headers). If index_ is negative or larger than the number of items in the list, Nothing is returned.

Since: 3.10

getRowAtY

listBoxGetRowAtY

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> Int32

y: position

-> m (Maybe ListBoxRow)

Returns: the row or Nothing in case no row exists for the given y coordinate.

Gets the row at the y position.

Since: 3.10

getSelectedRow

listBoxGetSelectedRow

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m ListBoxRow

Returns: the selected row

Gets the selected row.

Note that the box may allow multiple selection, in which case you should use listBoxSelectedForeach to find all selected rows.

Since: 3.10

getSelectedRows

listBoxGetSelectedRows

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m [ListBoxRow]

Returns: A List containing the Widget for each selected child. Free with g_list_free() when done.

Creates a list of all selected children.

Since: 3.14

getSelectionMode

listBoxGetSelectionMode

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m SelectionMode

Returns: a SelectionMode

Gets the selection mode of the listbox.

Since: 3.10

insert

listBoxInsert

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsWidget b)

=> a

box: a ListBox

-> b

child: the Widget to add

-> Int32

position: the position to insert child in

-> m ()

Insert the child into the box at position. If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of containerAdd.

If position is -1, or larger than the total number of items in the box, then the child will be appended to the end.

Since: 3.10

invalidateFilter

listBoxInvalidateFilter

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m ()

Update the filtering for all rows. Call this when result of the filter function on the box is changed due to an external factor. For instance, this would be used if the filter function just looked for a specific search string and the entry with the search string has changed.

Since: 3.10

invalidateHeaders

listBoxInvalidateHeaders

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m ()

Update the separators for all rows. Call this when result of the header function on the box is changed due to an external factor.

Since: 3.10

invalidateSort

listBoxInvalidateSort

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m ()

Update the sorting for all rows. Call this when result of the sort function on the box is changed due to an external factor.

Since: 3.10

new

listBoxNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ListBox

Returns: a new ListBox

Creates a new ListBox container.

Since: 3.10

prepend

listBoxPrepend

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsWidget b)

=> a

box: a ListBox

-> b

child: the Widget to add

-> m ()

Prepend a widget to the list. If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of containerAdd.

Since: 3.10

selectAll

listBoxSelectAll

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m ()

Select all children of box, if the selection mode allows it.

Since: 3.14

selectRow

listBoxSelectRow

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsListBoxRow b)

=> a

box: a ListBox

-> Maybe b

row: The row to select or Nothing

-> m ()

Make row the currently selected row.

Since: 3.10

selectedForeach

listBoxSelectedForeach

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> ListBoxForeachFunc

func: the function to call for each selected child

-> m ()

Calls a function for each selected child.

Note that the selection cannot be modified from within this function.

Since: 3.14

setActivateOnSingleClick

listBoxSetActivateOnSingleClick

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> Bool

single: a boolean

-> m ()

If single is True, rows will be activated when you click on them, otherwise you need to double-click.

Since: 3.10

setAdjustment

listBoxSetAdjustment

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsAdjustment b)

=> a

box: a ListBox

-> Maybe b

adjustment: the adjustment, or Nothing

-> m ()

Sets the adjustment (if any) that the widget uses to for vertical scrolling. For instance, this is used to get the page size for PageUp/Down key handling.

In the normal case when the box is packed inside a ScrolledWindow the adjustment from that will be picked up automatically, so there is no need to manually do that.

Since: 3.10

setFilterFunc

listBoxSetFilterFunc

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> Maybe ListBoxFilterFunc

filterFunc: callback that lets you filter which rows to show

-> m ()

By setting a filter function on the box one can decide dynamically which of the rows to show. For instance, to implement a search function on a list that filters the original list to only show the matching rows.

The filterFunc will be called for each row after the call, and it will continue to be called each time a row changes (via listBoxRowChanged) or when listBoxInvalidateFilter is called.

Note that using a filter function is incompatible with using a model (see listBoxBindModel).

Since: 3.10

setHeaderFunc

listBoxSetHeaderFunc

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> Maybe ListBoxUpdateHeaderFunc

updateHeader: callback that lets you add row headers

-> m ()

By setting a header function on the box one can dynamically add headers in front of rows, depending on the contents of the row and its position in the list. For instance, one could use it to add headers in front of the first item of a new kind, in a list sorted by the kind.

The updateHeader can look at the current header widget using listBoxRowGetHeader and either update the state of the widget as needed, or set a new one using listBoxRowSetHeader. If no header is needed, set the header to Nothing.

Note that you may get many calls updateHeader to this for a particular row when e.g. changing things that don’t affect the header. In this case it is important for performance to not blindly replace an existing header with an identical one.

The updateHeader function will be called for each row after the call, and it will continue to be called each time a row changes (via listBoxRowChanged) and when the row before changes (either by listBoxRowChanged on the previous row, or when the previous row becomes a different row). It is also called for all rows when listBoxInvalidateHeaders is called.

Since: 3.10

setPlaceholder

listBoxSetPlaceholder

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsWidget b)

=> a

box: a ListBox

-> Maybe b

placeholder: a Widget or Nothing

-> m ()

Sets the placeholder widget that is shown in the list when it doesn't display any visible children.

Since: 3.10

setSelectionMode

listBoxSetSelectionMode

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> SelectionMode

mode: The SelectionMode

-> m ()

Sets how selection works in the listbox. See SelectionMode for details.

Since: 3.10

setSortFunc

listBoxSetSortFunc

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> Maybe ListBoxSortFunc

sortFunc: the sort function

-> m ()

By setting a sort function on the box one can dynamically reorder the rows of the list, based on the contents of the rows.

The sortFunc will be called for each row after the call, and will continue to be called each time a row changes (via listBoxRowChanged) and when listBoxInvalidateSort is called.

Note that using a sort function is incompatible with using a model (see listBoxBindModel).

Since: 3.10

unselectAll

listBoxUnselectAll

Arguments

:: (HasCallStack, MonadIO m, IsListBox a)

=> a

box: a ListBox

-> m ()

Unselect all children of box, if the selection mode allows it.

Since: 3.14

unselectRow

listBoxUnselectRow

Arguments

:: (HasCallStack, MonadIO m, IsListBox a, IsListBoxRow b)

=> a

box: a ListBox

-> b

row: the row to unselected

-> m ()

Unselects a single row of box, if the selection mode allows it.

Since: 3.14

Properties

activateOnSingleClick

No description available in the introspection data.

constructListBoxActivateOnSingleClick :: (IsListBox o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “activate-on-single-click” property. This is rarely needed directly, but it is used by new.

getListBoxActivateOnSingleClick :: (MonadIO m, IsListBox o) => o -> m Bool

Get the value of the “activate-on-single-click” property. When overloading is enabled, this is equivalent to

get listBox #activateOnSingleClick

setListBoxActivateOnSingleClick :: (MonadIO m, IsListBox o) => o -> Bool -> m ()

Set the value of the “activate-on-single-click” property. When overloading is enabled, this is equivalent to

set listBox [ #activateOnSingleClick := value ]

selectionMode

No description available in the introspection data.

constructListBoxSelectionMode :: (IsListBox o, MonadIO m) => SelectionMode -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “selection-mode” property. This is rarely needed directly, but it is used by new.

getListBoxSelectionMode :: (MonadIO m, IsListBox o) => o -> m SelectionMode

Get the value of the “selection-mode” property. When overloading is enabled, this is equivalent to

get listBox #selectionMode

setListBoxSelectionMode :: (MonadIO m, IsListBox o) => o -> SelectionMode -> m ()

Set the value of the “selection-mode” property. When overloading is enabled, this is equivalent to

set listBox [ #selectionMode := value ]

Signals

activateCursorRow

type C_ListBoxActivateCursorRowCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ListBoxActivateCursorRowCallback = IO ()

No description available in the introspection data.

afterListBoxActivateCursorRow :: (IsListBox a, MonadIO m) => a -> ListBoxActivateCursorRowCallback -> m SignalHandlerId

Connect a signal handler for the activateCursorRow signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #activateCursorRow callback

genClosure_ListBoxActivateCursorRow :: MonadIO m => ListBoxActivateCursorRowCallback -> m (GClosure C_ListBoxActivateCursorRowCallback)

Wrap the callback into a GClosure.

mk_ListBoxActivateCursorRowCallback :: C_ListBoxActivateCursorRowCallback -> IO (FunPtr C_ListBoxActivateCursorRowCallback)

Generate a function pointer callable from C code, from a C_ListBoxActivateCursorRowCallback.

noListBoxActivateCursorRowCallback :: Maybe ListBoxActivateCursorRowCallback

A convenience synonym for Nothing :: Maybe ListBoxActivateCursorRowCallback.

onListBoxActivateCursorRow :: (IsListBox a, MonadIO m) => a -> ListBoxActivateCursorRowCallback -> m SignalHandlerId

Connect a signal handler for the activateCursorRow signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #activateCursorRow callback

wrap_ListBoxActivateCursorRowCallback :: ListBoxActivateCursorRowCallback -> C_ListBoxActivateCursorRowCallback

Wrap a ListBoxActivateCursorRowCallback into a C_ListBoxActivateCursorRowCallback.

moveCursor

type C_ListBoxMoveCursorCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ListBoxMoveCursorCallback = MovementStep -> Int32 -> IO ()

No description available in the introspection data.

afterListBoxMoveCursor :: (IsListBox a, MonadIO m) => a -> ListBoxMoveCursorCallback -> m SignalHandlerId

Connect a signal handler for the moveCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #moveCursor callback

genClosure_ListBoxMoveCursor :: MonadIO m => ListBoxMoveCursorCallback -> m (GClosure C_ListBoxMoveCursorCallback)

Wrap the callback into a GClosure.

mk_ListBoxMoveCursorCallback :: C_ListBoxMoveCursorCallback -> IO (FunPtr C_ListBoxMoveCursorCallback)

Generate a function pointer callable from C code, from a C_ListBoxMoveCursorCallback.

noListBoxMoveCursorCallback :: Maybe ListBoxMoveCursorCallback

A convenience synonym for Nothing :: Maybe ListBoxMoveCursorCallback.

onListBoxMoveCursor :: (IsListBox a, MonadIO m) => a -> ListBoxMoveCursorCallback -> m SignalHandlerId

Connect a signal handler for the moveCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #moveCursor callback

wrap_ListBoxMoveCursorCallback :: ListBoxMoveCursorCallback -> C_ListBoxMoveCursorCallback

Wrap a ListBoxMoveCursorCallback into a C_ListBoxMoveCursorCallback.

rowActivated

type C_ListBoxRowActivatedCallback = Ptr () -> Ptr ListBoxRow -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ListBoxRowActivatedCallback

Arguments

 = ListBoxRow

row: the activated row

-> IO ()

The rowActivated signal is emitted when a row has been activated by the user.

Since: 3.10

afterListBoxRowActivated :: (IsListBox a, MonadIO m) => a -> ListBoxRowActivatedCallback -> m SignalHandlerId

Connect a signal handler for the rowActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #rowActivated callback

genClosure_ListBoxRowActivated :: MonadIO m => ListBoxRowActivatedCallback -> m (GClosure C_ListBoxRowActivatedCallback)

Wrap the callback into a GClosure.

mk_ListBoxRowActivatedCallback :: C_ListBoxRowActivatedCallback -> IO (FunPtr C_ListBoxRowActivatedCallback)

Generate a function pointer callable from C code, from a C_ListBoxRowActivatedCallback.

noListBoxRowActivatedCallback :: Maybe ListBoxRowActivatedCallback

A convenience synonym for Nothing :: Maybe ListBoxRowActivatedCallback.

onListBoxRowActivated :: (IsListBox a, MonadIO m) => a -> ListBoxRowActivatedCallback -> m SignalHandlerId

Connect a signal handler for the rowActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #rowActivated callback

wrap_ListBoxRowActivatedCallback :: ListBoxRowActivatedCallback -> C_ListBoxRowActivatedCallback

Wrap a ListBoxRowActivatedCallback into a C_ListBoxRowActivatedCallback.

rowSelected

type C_ListBoxRowSelectedCallback = Ptr () -> Ptr ListBoxRow -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ListBoxRowSelectedCallback

Arguments

 = Maybe ListBoxRow

row: the selected row

-> IO ()

The rowSelected signal is emitted when a new row is selected, or (with a Nothing row) when the selection is cleared.

When the box is using GTK_SELECTION_MULTIPLE, this signal will not give you the full picture of selection changes, and you should use the selectedRowsChanged signal instead.

Since: 3.10

afterListBoxRowSelected :: (IsListBox a, MonadIO m) => a -> ListBoxRowSelectedCallback -> m SignalHandlerId

Connect a signal handler for the rowSelected signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #rowSelected callback

genClosure_ListBoxRowSelected :: MonadIO m => ListBoxRowSelectedCallback -> m (GClosure C_ListBoxRowSelectedCallback)

Wrap the callback into a GClosure.

mk_ListBoxRowSelectedCallback :: C_ListBoxRowSelectedCallback -> IO (FunPtr C_ListBoxRowSelectedCallback)

Generate a function pointer callable from C code, from a C_ListBoxRowSelectedCallback.

noListBoxRowSelectedCallback :: Maybe ListBoxRowSelectedCallback

A convenience synonym for Nothing :: Maybe ListBoxRowSelectedCallback.

onListBoxRowSelected :: (IsListBox a, MonadIO m) => a -> ListBoxRowSelectedCallback -> m SignalHandlerId

Connect a signal handler for the rowSelected signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #rowSelected callback

wrap_ListBoxRowSelectedCallback :: ListBoxRowSelectedCallback -> C_ListBoxRowSelectedCallback

Wrap a ListBoxRowSelectedCallback into a C_ListBoxRowSelectedCallback.

selectAll

type C_ListBoxSelectAllCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ListBoxSelectAllCallback = IO ()

The selectAll signal is a [keybinding signal][GtkBindingSignal] which gets emitted to select all children of the box, if the selection mode permits it.

The default bindings for this signal is Ctrl-a.

Since: 3.14

afterListBoxSelectAll :: (IsListBox a, MonadIO m) => a -> ListBoxSelectAllCallback -> m SignalHandlerId

Connect a signal handler for the selectAll signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #selectAll callback

genClosure_ListBoxSelectAll :: MonadIO m => ListBoxSelectAllCallback -> m (GClosure C_ListBoxSelectAllCallback)

Wrap the callback into a GClosure.

mk_ListBoxSelectAllCallback :: C_ListBoxSelectAllCallback -> IO (FunPtr C_ListBoxSelectAllCallback)

Generate a function pointer callable from C code, from a C_ListBoxSelectAllCallback.

noListBoxSelectAllCallback :: Maybe ListBoxSelectAllCallback

A convenience synonym for Nothing :: Maybe ListBoxSelectAllCallback.

onListBoxSelectAll :: (IsListBox a, MonadIO m) => a -> ListBoxSelectAllCallback -> m SignalHandlerId

Connect a signal handler for the selectAll signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #selectAll callback

wrap_ListBoxSelectAllCallback :: ListBoxSelectAllCallback -> C_ListBoxSelectAllCallback

Wrap a ListBoxSelectAllCallback into a C_ListBoxSelectAllCallback.

selectedRowsChanged

type C_ListBoxSelectedRowsChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ListBoxSelectedRowsChangedCallback = IO ()

The selectedRowsChanged signal is emitted when the set of selected rows changes.

Since: 3.14

afterListBoxSelectedRowsChanged :: (IsListBox a, MonadIO m) => a -> ListBoxSelectedRowsChangedCallback -> m SignalHandlerId

Connect a signal handler for the selectedRowsChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #selectedRowsChanged callback

genClosure_ListBoxSelectedRowsChanged :: MonadIO m => ListBoxSelectedRowsChangedCallback -> m (GClosure C_ListBoxSelectedRowsChangedCallback)

Wrap the callback into a GClosure.

mk_ListBoxSelectedRowsChangedCallback :: C_ListBoxSelectedRowsChangedCallback -> IO (FunPtr C_ListBoxSelectedRowsChangedCallback)

Generate a function pointer callable from C code, from a C_ListBoxSelectedRowsChangedCallback.

noListBoxSelectedRowsChangedCallback :: Maybe ListBoxSelectedRowsChangedCallback

A convenience synonym for Nothing :: Maybe ListBoxSelectedRowsChangedCallback.

onListBoxSelectedRowsChanged :: (IsListBox a, MonadIO m) => a -> ListBoxSelectedRowsChangedCallback -> m SignalHandlerId

Connect a signal handler for the selectedRowsChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #selectedRowsChanged callback

wrap_ListBoxSelectedRowsChangedCallback :: ListBoxSelectedRowsChangedCallback -> C_ListBoxSelectedRowsChangedCallback

Wrap a ListBoxSelectedRowsChangedCallback into a C_ListBoxSelectedRowsChangedCallback.

toggleCursorRow

type C_ListBoxToggleCursorRowCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ListBoxToggleCursorRowCallback = IO ()

No description available in the introspection data.

afterListBoxToggleCursorRow :: (IsListBox a, MonadIO m) => a -> ListBoxToggleCursorRowCallback -> m SignalHandlerId

Connect a signal handler for the toggleCursorRow signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #toggleCursorRow callback

genClosure_ListBoxToggleCursorRow :: MonadIO m => ListBoxToggleCursorRowCallback -> m (GClosure C_ListBoxToggleCursorRowCallback)

Wrap the callback into a GClosure.

mk_ListBoxToggleCursorRowCallback :: C_ListBoxToggleCursorRowCallback -> IO (FunPtr C_ListBoxToggleCursorRowCallback)

Generate a function pointer callable from C code, from a C_ListBoxToggleCursorRowCallback.

noListBoxToggleCursorRowCallback :: Maybe ListBoxToggleCursorRowCallback

A convenience synonym for Nothing :: Maybe ListBoxToggleCursorRowCallback.

onListBoxToggleCursorRow :: (IsListBox a, MonadIO m) => a -> ListBoxToggleCursorRowCallback -> m SignalHandlerId

Connect a signal handler for the toggleCursorRow signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #toggleCursorRow callback

wrap_ListBoxToggleCursorRowCallback :: ListBoxToggleCursorRowCallback -> C_ListBoxToggleCursorRowCallback

Wrap a ListBoxToggleCursorRowCallback into a C_ListBoxToggleCursorRowCallback.

unselectAll

type C_ListBoxUnselectAllCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ListBoxUnselectAllCallback = IO ()

The unselectAll signal is a [keybinding signal][GtkBindingSignal] which gets emitted to unselect all children of the box, if the selection mode permits it.

The default bindings for this signal is Ctrl-Shift-a.

Since: 3.14

afterListBoxUnselectAll :: (IsListBox a, MonadIO m) => a -> ListBoxUnselectAllCallback -> m SignalHandlerId

Connect a signal handler for the unselectAll signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #unselectAll callback

genClosure_ListBoxUnselectAll :: MonadIO m => ListBoxUnselectAllCallback -> m (GClosure C_ListBoxUnselectAllCallback)

Wrap the callback into a GClosure.

mk_ListBoxUnselectAllCallback :: C_ListBoxUnselectAllCallback -> IO (FunPtr C_ListBoxUnselectAllCallback)

Generate a function pointer callable from C code, from a C_ListBoxUnselectAllCallback.

noListBoxUnselectAllCallback :: Maybe ListBoxUnselectAllCallback

A convenience synonym for Nothing :: Maybe ListBoxUnselectAllCallback.

onListBoxUnselectAll :: (IsListBox a, MonadIO m) => a -> ListBoxUnselectAllCallback -> m SignalHandlerId

Connect a signal handler for the unselectAll signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #unselectAll callback

wrap_ListBoxUnselectAllCallback :: ListBoxUnselectAllCallback -> C_ListBoxUnselectAllCallback

Wrap a ListBoxUnselectAllCallback into a C_ListBoxUnselectAllCallback.