Memory-managed wrapper type.

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

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

A convenience alias for Nothing :: Maybe ListBox.

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

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

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

Since: 3.10

Returns whether rows activate on single clicks.

Since: 3.10

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

Since: 3.10

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

Gets the row at the y position.

Since: 3.10

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

Creates a list of all selected children.

Since: 3.14

Gets the selection mode of the listbox.

Since: 3.10

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

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

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

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

Creates a new ListBox container.

Since: 3.10

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

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

Since: 3.14

Make row the currently selected row.

Since: 3.10

Calls a function for each selected child.

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

Since: 3.14

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

Since: 3.10

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

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

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

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

Since: 3.10

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

Since: 3.10

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

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

Since: 3.14

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

Since: 3.14

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

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

get listBox #activateOnSingleClick

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

set listBox [ #activateOnSingleClick := value ]

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

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

get listBox #selectionMode

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

set listBox [ #selectionMode := value ]

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

No description available in the introspection data.

Connect a signal handler for the “activate-cursor-row” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #activateCursorRow callback

Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxActivateCursorRowCallback.

Connect a signal handler for the “activate-cursor-row” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #activateCursorRow callback

Wrap a ListBoxActivateCursorRowCallback into a C_ListBoxActivateCursorRowCallback.

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

No description available in the introspection data.

Connect a signal handler for the “move-cursor” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #moveCursor callback

Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxMoveCursorCallback.

Connect a signal handler for the “move-cursor” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #moveCursor callback

Wrap a ListBoxMoveCursorCallback into a C_ListBoxMoveCursorCallback.

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

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

Since: 3.10

Connect a signal handler for the “row-activated” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #rowActivated callback

Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxRowActivatedCallback.

Connect a signal handler for the “row-activated” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #rowActivated callback

Wrap a ListBoxRowActivatedCallback into a C_ListBoxRowActivatedCallback.

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

The ::row-selected 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 ListBox::selected-rows-changed signal instead.

Since: 3.10

Connect a signal handler for the “row-selected” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #rowSelected callback

Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxRowSelectedCallback.

Connect a signal handler for the “row-selected” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #rowSelected callback

Wrap a ListBoxRowSelectedCallback into a C_ListBoxRowSelectedCallback.

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

The ::select-all 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

Connect a signal handler for the “select-all” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #selectAll callback

Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxSelectAllCallback.

Connect a signal handler for the “select-all” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #selectAll callback

Wrap a ListBoxSelectAllCallback into a C_ListBoxSelectAllCallback.

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

The ::selected-rows-changed signal is emitted when the set of selected rows changes.

Since: 3.14

Connect a signal handler for the “selected-rows-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #selectedRowsChanged callback

Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxSelectedRowsChangedCallback.

Connect a signal handler for the “selected-rows-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #selectedRowsChanged callback

Wrap a ListBoxSelectedRowsChangedCallback into a C_ListBoxSelectedRowsChangedCallback.

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

No description available in the introspection data.

Connect a signal handler for the “toggle-cursor-row” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #toggleCursorRow callback

Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxToggleCursorRowCallback.

Connect a signal handler for the “toggle-cursor-row” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #toggleCursorRow callback

Wrap a ListBoxToggleCursorRowCallback into a C_ListBoxToggleCursorRowCallback.

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

The ::unselect-all 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

Connect a signal handler for the “unselect-all” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after listBox #unselectAll callback

Wrap the callback into a GClosure.

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

A convenience synonym for Nothing :: Maybe ListBoxUnselectAllCallback.

Connect a signal handler for the “unselect-all” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on listBox #unselectAll callback

Wrap a ListBoxUnselectAllCallback into a C_ListBoxUnselectAllCallback.