Class
GtkListBox
Description [src]
final class Gtk.ListBox : Gtk.Widget {
/* No available fields */
}GtkListBox is a vertical list.
A GtkListBox only 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_list_box_prepend(),
gtk_list_box_append() and gtk_list_box_insert() 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.
GtkListBox as GtkBuildable
The GtkListBox implementation of the GtkBuildable interface supports
setting a child as the placeholder by specifying “placeholder” as the “type”
attribute of a gtk_list_box_set_placeholder()
for info.
CSS nodes
list[.separators][.rich-list][.navigation-sidebar]
╰── row[.activatable]
GtkListBox uses a single CSS node named list. It may carry the .separators
style class, when the GtkListBox:show-separators property is set.
Each GtkListBoxRow uses a single CSS node named row. The row nodes get the
.activatable style class added when appropriate.
The main list node may also carry style classes to select the style of list presentation: .rich-list, .navigation-sidebar or .data-table.
Accessibility
GtkListBox uses the GTK_ACCESSIBLE_ROLE_LIST role and GtkListBoxRow uses
the GTK_ACCESSIBLE_ROLE_LIST_ITEM role.
Constructors
gtk_list_box_new
Creates a new GtkListBox container.
Instance methods
gtk_list_box_append
Append a widget to the list.
gtk_list_box_bind_model
Binds model to box.
gtk_list_box_drag_highlight_row
Add a drag highlight to a row.
gtk_list_box_drag_unhighlight_row
If a row has previously been highlighted via gtk_list_box_drag_highlight_row(), it will have the highlight removed.
gtk_list_box_get_activate_on_single_click
Returns whether rows activate on single clicks.
gtk_list_box_get_adjustment
Gets the adjustment (if any) that the widget uses to for vertical scrolling.
gtk_list_box_get_row_at_index
Gets the n-th child in the list (not counting headers).
gtk_list_box_get_row_at_y
Gets the row at the y position.
gtk_list_box_get_selected_row
Gets the selected row, or NULL if no rows are selected.
gtk_list_box_get_selected_rows
Creates a list of all selected children.
gtk_list_box_get_selection_mode
Gets the selection mode of the listbox.
gtk_list_box_get_show_separators
Returns whether the list box should show separators between rows.
gtk_list_box_insert
Insert the child into the box at position.
gtk_list_box_invalidate_filter
Update the filtering for all rows.
gtk_list_box_invalidate_headers
Update the separators for all rows.
gtk_list_box_invalidate_sort
Update the sorting for all rows.
gtk_list_box_prepend
Prepend a widget to the list.
gtk_list_box_remove
Removes a child from box.
gtk_list_box_select_all
Select all children of box, if the selection mode allows it.
gtk_list_box_select_row
Make row the currently selected row.
gtk_list_box_selected_foreach
Calls a function for each selected child.
gtk_list_box_set_activate_on_single_click
If single is TRUE, rows will be activated when you click on them,
otherwise you need to double-click.
gtk_list_box_set_adjustment
Sets the adjustment (if any) that the widget uses to for vertical scrolling.
gtk_list_box_set_filter_func
By setting a filter function on the box one can decide dynamically which
of the rows to show.
gtk_list_box_set_header_func
Sets a header function.
gtk_list_box_set_placeholder
Sets the placeholder widget that is shown in the list when it doesn’t display any visible children.
gtk_list_box_set_selection_mode
Sets how selection works in the listbox.
gtk_list_box_set_show_separators
Sets whether the list box should show separators between rows.
gtk_list_box_set_sort_func
Sets a sort function.
gtk_list_box_unselect_all
Unselect all children of box, if the selection mode allows it.
gtk_list_box_unselect_row
Unselects a single row of box, if the selection mode allows it.
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role
Retrieves the GtkAccessibleRole for the given GtkAccessible.
gtk_accessible_reset_property
Resets the accessible property to its default value.
gtk_accessible_reset_relation
Resets the accessible relation to its default value.
gtk_accessible_reset_state
Resets the accessible state to its default value.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable object.
Properties
Gtk.ListBox:accept-unpaired-release
Whether to accept unpaired release events.
Gtk.ListBox:activate-on-single-click
Determines whether children can be activated with a single click, or require a double-click.
Gtk.ListBox:selection-mode
The selection mode used by the list box.
Gtk.ListBox:show-separators
Whether to show separators between rows.
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand property.
Gtk.Widget:layout-manager
The GtkLayoutManager instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible implementation.
Signals
Gtk.ListBox::activate-cursor-row
Gtk.ListBox::move-cursor
Gtk.ListBox::row-activated
Emitted when a row has been activated by the user.
Gtk.ListBox::row-selected
Emitted when a new row is selected, or (with a NULL row)
when the selection is cleared.
Gtk.ListBox::select-all
Emitted to select all children of the box, if the selection mode permits it.
Gtk.ListBox::selected-rows-changed
Emitted when the set of selected rows changes.
Gtk.ListBox::toggle-cursor-row
Gtk.ListBox::unselect-all
Emitted to unselect all children of the box, if the selection mode permits it.
Signals inherited from GtkWidget (13)
Gtk.Widget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
Gtk.Widget::direction-changed
Emitted when the text direction of a widget changes.
Gtk.Widget::hide
Emitted when widget is hidden.
Gtk.Widget::keynav-failed
Emitted if keyboard navigation fails.
Gtk.Widget::map
Emitted when widget is going to be mapped.
Gtk.Widget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
Gtk.Widget::move-focus
Emitted when the focus is moved.
Gtk.Widget::query-tooltip
Emitted when the widgets tooltip is about to be shown.
Gtk.Widget::realize
Emitted when widget is associated with a GdkSurface.
Gtk.Widget::show
Emitted when widget is shown.
Gtk.Widget::state-flags-changed
Emitted when the widget state changes.
Gtk.Widget::unmap
Emitted when widget is going to be unmapped.
Gtk.Widget::unrealize
Emitted when the GdkSurface associated with widget is destroyed.
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.