ListBox
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 method@Gtk.ListBox.prepend, method@Gtk.ListBox.append and method@Gtk.ListBox.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, signal@Gtk.ListBox::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 <child> element. See method@Gtk.ListBox.set_placeholder for info.
Shortcuts and Gestures
The following signals have default keybindings:
signal@Gtk.ListBox::move-cursor
signal@Gtk.ListBox::select-all
signal@Gtk.ListBox::toggle-cursor-row
signal@Gtk.ListBox::unselect-all
CSS nodes
|[ list.rich-list.boxed-list ╰── row.activatable ]|
GtkListBox uses a single CSS node named list. It may carry the .separators style class, when the property@Gtk.ListBox: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.
It may also carry the .boxed-list style class. In this case, the list will be automatically surrounded by a frame and have separators.
The main list node may also carry style classes to select the style of section-list-widget.html#list-styles: .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.
Skipped during bindings generation
method
accept-unpaired-release: Property has no getter nor setter
Constructors
Properties
The accessible role of the given GtkAccessible implementation.
Determines whether children can be activated with a single click, or require a double-click.
A list of css classes applied to this widget.
Whether the widget should grab focus when it is clicked with the mouse.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand property.
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
Whether the widget will receive the default action when it is focused.
The scale factor of the widget.
The selection mode used by the list box.
Whether to show separators between rows.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
Whether to use the vexpand property.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate action from @widget.
For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.
Requests the user's screen reader to announce the given message.
Binds @model to @box.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
Emitted when the cursor row is activated.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
Emitted when @widget is hidden.
Emitted if keyboard navigation fails.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the user initiates a cursor movement.
Emitted when the focus is moved.
Emitted when the widget’s tooltip is about to be shown.
Emitted when @widget is associated with a GdkSurface.
Emitted when a row has been activated by the user.
Emitted when a new row is selected, or (with a null @row) when the selection is cleared.
Emitted to select all children of the box, if the selection mode permits it.
Emitted when the set of selected rows changes.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted when the cursor row is toggled.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
Emitted to unselect all children of the box, if the selection mode permits it.
Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Clears the template children for the given widget.
Checks to see if a drag movement has passed the GTK drag threshold.
Add a drag highlight to a row.
If a row has previously been highlighted via gtk_list_box_drag_highlight_row(), it will have the highlight removed.
Retrieves the accessible parent for an accessible object.
Retrieves the accessible role of an accessible object.
Gets the adjustment (if any) that the widget uses to for vertical scrolling.
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Gets the first ancestor of @widget with type @widget_type.
Retrieves the accessible implementation for the given GtkAccessible.
Returns the baseline that has currently been allocated to @widget.
Gets the ID of the @buildable object.
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Gets the reading direction for a particular widget.
Get the GdkDisplay for the toplevel window associated with this widget.
Retrieves the first accessible child of an accessible object.
Returns the widget’s first child.
Returns the current focus child of @widget.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Returns the widget’s last child.
Retrieves the next accessible sibling of an accessible object
Returns the widget’s next sibling.
Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.
Query a platform state, such as focus.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of @widget.
Determines whether @widget is realized.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Gets the n-th child in the list (not counting headers).
Gets the row at the @y position.
Gets the selected row, or null if no rows are selected.
Creates a list of all selected children.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns the content width or height of the widget.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Determines whether the widget is visible.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Update the filtering for all rows.
Update the separators for all rows.
Update the sorting for all rows.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Returns the widget’s effective sensitivity.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the class@Gtk.EventControllers of @widget.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Calls a function for each selected child.
Make @row the currently selected row.
Sets the parent and sibling of an accessible object.
Sets the adjustment (if any) that the widget uses to for vertical scrolling.
Sets whether @widget should be mapped along with its parent.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
By setting a filter function on the @box one can decide dynamically which of the rows to show.
Set @child as the current focus child of @widget.
Sets the font map to use for Pango rendering.
Sets a header function.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
Sets the placeholder widget that is shown in the list when it doesn't display any visible children.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Sets a sort function.
Turns on flag values in the current widget state.
Sets the visibility state of @widget.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Unselect all children of @box, if the selection mode allows it.
Unselects a single row of @box, if the selection mode allows it.
Turns off flag values for the current widget state.
Updates the next accessible sibling of @self.