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 #GtkTreeView, especially when the list contents has a more complicated layout than what is allowed by a #GtkCellRenderer, or when the contents is interactive (i.e. has a button in it).

Although a #GtkListBox must have only #GtkListBoxRow children you can add any kind of widget to it via gtk_container_add(), and a #GtkListBoxRow widget will automatically be inserted between the list and the widget.

#GtkListBoxRows can be marked as activatable or selectable. If a row is activatable, #GtkListBox::row-activated 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.

CSS nodes

|[<!-- language="plain" --> 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.

class ListBox : Container {}

Constructors

this
this(GtkListBox* gtkListBox, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new #GtkListBox container.

Members

Functions

addOnActivateCursorRow
gulong addOnActivateCursorRow(void delegate(ListBox) dlg, ConnectFlags connectFlags)
addOnMoveCursor
gulong addOnMoveCursor(void delegate(GtkMovementStep, int, ListBox) dlg, ConnectFlags connectFlags)
addOnRowActivated
gulong addOnRowActivated(void delegate(ListBoxRow, ListBox) dlg, ConnectFlags connectFlags)

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

addOnRowSelected
gulong addOnRowSelected(void delegate(ListBoxRow, ListBox) dlg, ConnectFlags connectFlags)

The ::row-selected signal is emitted when a new row is selected, or (with a %NULL @row) when the selection is cleared.

addOnSelectAll
gulong addOnSelectAll(void delegate(ListBox) dlg, ConnectFlags connectFlags)

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.

addOnSelectedRowsChanged
gulong addOnSelectedRowsChanged(void delegate(ListBox) dlg, ConnectFlags connectFlags)

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

addOnToggleCursorRow
gulong addOnToggleCursorRow(void delegate(ListBox) dlg, ConnectFlags connectFlags)
addOnUnselectAll
gulong addOnUnselectAll(void delegate(ListBox) dlg, ConnectFlags connectFlags)

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.

bindModel
void bindModel(ListModelIF model, GtkListBoxCreateWidgetFunc createWidgetFunc, void* userData, GDestroyNotify userDataFreeFunc)

Binds @model to @box.

dragHighlightRow
void dragHighlightRow(ListBoxRow row)

This is a helper function for implementing DnD onto a #GtkListBox. The passed in @row will be highlighted via gtk_drag_highlight(), and any previously highlighted row will be unhighlighted.

dragUnhighlightRow
void dragUnhighlightRow()

If a row has previously been highlighted via gtk_list_box_drag_highlight_row() it will have the highlight removed.

getActivateOnSingleClick
bool getActivateOnSingleClick()

Returns whether rows activate on single clicks.

getAdjustment
Adjustment getAdjustment()

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

getListBoxStruct
GtkListBox* getListBoxStruct(bool transferOwnership)

Get the main Gtk struct

getRowAtIndex
ListBoxRow getRowAtIndex(int index)

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, %NULL is returned.

getRowAtY
ListBoxRow getRowAtY(int y)

Gets the row at the @y position.

getSelectedRow
ListBoxRow getSelectedRow()

Gets the selected row.

getSelectedRows
ListG getSelectedRows()

Creates a list of all selected children.

getSelectionMode
GtkSelectionMode getSelectionMode()

Gets the selection mode of the listbox.

getStruct
void* getStruct()

the main Gtk struct as a void*

insert
void insert(Widget child, int position)

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 gtk_container_add().

invalidateFilter
void invalidateFilter()

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.

invalidateHeaders
void invalidateHeaders()

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

invalidateSort
void invalidateSort()

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

prepend
void prepend(Widget child)

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 gtk_container_add().

selectAll
void selectAll()

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

selectRow
void selectRow(ListBoxRow row)

Make @row the currently selected row.

selectedForeach
void selectedForeach(GtkListBoxForeachFunc func, void* data)

Calls a function for each selected child.

setActivateOnSingleClick
void setActivateOnSingleClick(bool single)

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

setAdjustment
void setAdjustment(Adjustment adjustment)

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.

setFilterFunc
void setFilterFunc(GtkListBoxFilterFunc filterFunc, void* userData, GDestroyNotify destroy)

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.

setHeaderFunc
void setHeaderFunc(GtkListBoxUpdateHeaderFunc updateHeader, void* userData, GDestroyNotify destroy)

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.

setPlaceholder
void setPlaceholder(Widget placeholder)

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

setSelectionMode
void setSelectionMode(GtkSelectionMode mode)

Sets how selection works in the listbox. See #GtkSelectionMode for details.

setSortFunc
void setSortFunc(GtkListBoxSortFunc sortFunc, void* userData, GDestroyNotify destroy)

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

unselectAll
void unselectAll()

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

unselectRow
void unselectRow(ListBoxRow row)

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

Static functions

getType
GType getType()

Variables

gtkListBox
GtkListBox* gtkListBox;

the main Gtk struct

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

removeAll
void removeAll()

Removes all widgets from the container

getType
GType getType()
add
void add(Widget widget)

Adds @widget to @container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_grid_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.

checkResize
void checkResize()
childGetProperty
void childGetProperty(Widget child, string propertyName, Value value)

Gets the value of a child property for @child and @container.

childGetValist
void childGetValist(Widget child, string firstPropertyName, void* varArgs)

Gets the values of one or more child properties for @child and @container.

childNotify
void childNotify(Widget child, string childProperty)

Emits a #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on the child.

childNotifyByPspec
void childNotifyByPspec(Widget child, ParamSpec pspec)

Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by @pspec on the child.

childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)

Sets a child property for @child and @container.

childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)

Sets one or more child properties for @child and @container.

childType
GType childType()

Returns the type of the children supported by the container.

forall
void forall(GtkCallback callback, void* callbackData)

Invokes @callback on each direct child of @container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.

foreac
void foreac(GtkCallback callback, void* callbackData)

Invokes @callback on each non-internal child of @container. See gtk_container_forall() for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk_container_set_border_width().

getChildren
ListG getChildren()

Returns the container’s non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.

getFocusChain
bool getFocusChain(ListG focusableWidgets)

Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores %NULL in @focusable_widgets and returns %FALSE.

getFocusChild
Widget getFocusChild()

Returns the current focus child widget inside @container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus().

getFocusHadjustment
Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().

getPathForChild
WidgetPath getPathForChild(Widget child)

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including @child.

getResizeMode
GtkResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode ().

propagateDraw
void propagateDraw(Widget child, Context cr)

When a container receives a call to the draw function, it must send synthetic #GtkWidget::draw calls to all children that don’t have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its #GtkWidget::draw function, calls gtk_container_propagate_draw() once for each child, passing in the @cr the container received.

remove
void remove(Widget widget)

Removes @widget from @container. @widget must be inside @container. Note that @container will own a reference to @widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use @widget again, you need to add a reference to it before removing it from a container, using g_object_ref(). If you don’t want to use @widget again it’s usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

resizeChildren
void resizeChildren()
setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container.

setFocusChain
void setFocusChain(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+.

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if @child is %NULL, the focused child of @container.

setFocusHadjustment
void setFocusHadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment.

setFocusVadjustment
void setFocusVadjustment(Adjustment adjustment)

Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk_scrolled_window_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment.

setReallocateRedraws
void setReallocateRedraws(bool needsRedraws)

Sets the @reallocate_redraws flag of the container to the given value.

setResizeMode
void setResizeMode(GtkResizeMode resizeMode)

Sets the resize mode for the container.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk_container_set_focus_chain().

addOnAdd
gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnCheckResize
gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
addOnRemove
gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
addOnSetFocusChild
gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)

Meta