Struct ListBox

pub struct ListBox { /* private fields */ }

ListBox is a vertical list.

A ListBox only contains ListBoxRow 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 ListBox 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 prepend(), append() and insert() 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, 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 ListBox implementation of the Buildable interface supports setting a child as the placeholder by specifying “placeholder” as the “type” attribute of a <child> element. See set_placeholder() for info.

Shortcuts and Gestures

The following signals have default keybindings:

• move-cursor
• select-all
• toggle-cursor-row
• unselect-all

CSS nodes

⚠️ The following code is in plain ⚠️

list[.separators][.rich-list][.navigation-sidebar][.boxed-list]
╰── row[.activatable]

ListBox uses a single CSS node named list. It may carry the .separators style class, when the show-separators property is set. Each ListBoxRow 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 list presentation: .rich-list, .navigation-sidebar or .data-table.

Accessibility

ListBox uses the AccessibleRole::List role and ListBoxRow uses the AccessibleRole::ListItem role.

Properties

accept-unpaired-release

Whether to accept unpaired release events.

Readable | Writeable

activate-on-single-click

Determines whether children can be activated with a single click, or require a double-click.

Readable | Writeable

selection-mode

The selection mode used by the list box.

Readable | Writeable

show-separators

Whether to show separators between rows.

Readable | Writeable

tab-behavior

Behavior of the Tab key

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the query-tooltip signal on @widget.

A true value indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Overrides for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be NULL if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Overrides for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Signals

activate-cursor-row

Emitted when the cursor row is activated.

Action

move-cursor

Emitted when the user initiates a cursor movement.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.

• ←, →, ↑, ↓ move by individual children
• Home, End move to the ends of the box
• PgUp, PgDn move vertically by pages

Action

row-activated

Emitted when a row has been activated by the user.

row-selected

Emitted when a new row is selected, or (with a None @row) when the selection is cleared.

When the @box_ is using SelectionMode::Multiple, this signal will not give you the full picture of selection changes, and you should use the selected-rows-changed signal instead.

select-all

Emitted to select all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default binding for this signal is Ctrl-a.

Action

selected-rows-changed

Emitted when the set of selected rows changes.

toggle-cursor-row

Emitted when the cursor row is toggled.

The default bindings for this signal is Ctrl+␣.

Action

unselect-all

Emitted to unselect all children of the box, if the selection mode permits it.

This is a keybinding signal.

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

Action

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering above @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl ListBox

pub fn new() -> ListBox

Creates a new ListBox container.

Returns

a new ListBox

pub fn builder() -> ListBoxBuilder

Creates a new builder-pattern struct instance to construct ListBox objects.

This method returns an instance of ListBoxBuilder which can be used to create ListBox objects.

pub fn append(&self, child: &impl IsA<Widget>)

Append a widget to the list.

If a sort function is set, the widget will actually be inserted at the calculated position.

child

the Widget to add

pub fn bind_model<P: Fn(&Object) -> Widget + 'static>( &self, model: Option<&impl IsA<ListModel>>, create_widget_func: P, )

Binds @model to @self.

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

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

It is undefined to add or remove widgets directly (for example, with insert()) while @self is bound to a model.

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

model

the GListModel to be bound to @self

create_widget_func

a function that creates widgets for items or None in case you also passed None as @model

pub fn drag_highlight_row(&self, row: &impl IsA<ListBoxRow>)

Add a drag highlight to a row.

This is a helper function for implementing DnD onto a ListBox. The passed in @row will be highlighted by setting the StateFlags::DROP_ACTIVE state and any previously highlighted row will be unhighlighted.

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

row

a ListBoxRow

pub fn drag_unhighlight_row(&self)

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

pub fn activates_on_single_click(&self) -> bool

Returns whether rows activate on single clicks.

Returns

true if rows are activated on single click, false otherwise

pub fn adjustment(&self) -> Option<Adjustment>

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

Returns

the adjustment

pub fn row_at_index(&self, index_: i32) -> Option<ListBoxRow>

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

index_

the index of the row

Returns

the child Widget

pub fn row_at_y(&self, y: i32) -> Option<ListBoxRow>

Gets the row at the @y position.

y

position

Returns

the row

pub fn selected_row(&self) -> Option<ListBoxRow>

Gets the selected row, or None if no rows are selected.

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

Returns

the selected row

pub fn selected_rows(&self) -> Vec<ListBoxRow>

Creates a list of all selected children.

Returns

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

pub fn selection_mode(&self) -> SelectionMode

Gets the selection mode of the listbox.

Returns

a SelectionMode

pub fn shows_separators(&self) -> bool

Returns whether the list box should show separators between rows.

Returns

true if the list box shows separators

pub fn tab_behavior(&self) -> ListTabBehavior

Available on crate feature v4_18 only.

Returns the behavior of the Tab and Shift+Tab keys.

Returns

the tab behavior

pub fn insert(&self, child: &impl IsA<Widget>, position: i32)

Insert the @child into the @self at @position.

If a sort function is set, the widget will actually be inserted at the calculated position.

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

child

the Widget to add

position

the position to insert @child in

pub fn invalidate_filter(&self)

Update the filtering for all rows.

Call this when result of the filter function on the @self 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.

pub fn invalidate_headers(&self)

Update the separators for all rows.

Call this when result of the header function on the @self is changed due to an external factor.

pub fn invalidate_sort(&self)

Update the sorting for all rows.

Call this when result of the sort function on the @self is changed due to an external factor.

pub fn prepend(&self, child: &impl IsA<Widget>)

Prepend a widget to the list.

If a sort function is set, the widget will actually be inserted at the calculated position.

child

the Widget to add

pub fn remove(&self, child: &impl IsA<Widget>)

Removes a child from @self.

child

the child to remove

pub fn remove_all(&self)

Available on crate feature v4_12 only.

Removes all rows from @self.

This function does nothing if @self is backed by a model.

pub fn select_all(&self)

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

pub fn select_row(&self, row: Option<&impl IsA<ListBoxRow>>)

Make @row the currently selected row.

row

The row to select

pub fn selected_foreach<P: FnMut(&ListBox, &ListBoxRow)>(&self, func: P)

Calls a function for each selected child.

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

func

the function to call for each selected child

pub fn set_activate_on_single_click(&self, single: bool)

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

single

a boolean

pub fn set_adjustment(&self, adjustment: Option<&impl IsA<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.

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

adjustment

the adjustment

pub fn set_filter_func<P: Fn(&ListBoxRow) -> bool + 'static>( &self, filter_func: P, )

By setting a filter function on the @self 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 @filter_func will be called for each row after the call, and it will continue to be called each time a row changes (via ListBoxRowExt::changed()) or when invalidate_filter() is called.

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

filter_func

callback that lets you filter which rows to show

pub fn set_header_func<P: Fn(&ListBoxRow, Option<&ListBoxRow>) + 'static>( &self, update_header: P, )

Sets a header function.

By setting a header function on the @self 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 @update_header can look at the current header widget using ListBoxRowExt::header() and either update the state of the widget as needed, or set a new one using ListBoxRowExt::set_header(). If no header is needed, set the header to None.

Note that you may get many calls @update_header 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 @update_header function will be called for each row after the call, and it will continue to be called each time a row changes (via ListBoxRowExt::changed()) and when the row before changes (either by ListBoxRowExt::changed() on the previous row, or when the previous row becomes a different row). It is also called for all rows when invalidate_headers() is called.

update_header

callback that lets you add row headers

pub fn set_placeholder(&self, placeholder: Option<&impl IsA<Widget>>)

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

placeholder

a Widget

pub fn set_selection_mode(&self, mode: SelectionMode)

Sets how selection works in the listbox.

mode

The SelectionMode

pub fn set_show_separators(&self, show_separators: bool)

Sets whether the list box should show separators between rows.

show_separators

true to show separators

pub fn set_tab_behavior(&self, behavior: ListTabBehavior)

Available on crate feature v4_18 only.

Sets the behavior of the Tab and Shift+Tab keys.

behavior

the tab behavior

pub fn unselect_all(&self)

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

pub fn unselect_row(&self, row: &impl IsA<ListBoxRow>)

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

row

the row to unselect

pub fn accepts_unpaired_release(&self) -> bool

Whether to accept unpaired release events.

pub fn set_accept_unpaired_release(&self, accept_unpaired_release: bool)

Whether to accept unpaired release events.

pub fn connect_activate_cursor_row<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when the cursor row is activated.

pub fn emit_activate_cursor_row(&self)

pub fn connect_move_cursor<F: Fn(&Self, MovementStep, i32, bool, bool) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when the user initiates a cursor movement.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.

• ←, →, ↑, ↓ move by individual children
• Home, End move to the ends of the box
• PgUp, PgDn move vertically by pages

step

the granularity of the move, as a MovementStep

count

the number of @step units to move

extend

whether to extend the selection

modify

whether to modify the selection

pub fn emit_move_cursor( &self, step: MovementStep, count: i32, extend: bool, modify: bool, )

pub fn connect_row_activated<F: Fn(&Self, &ListBoxRow) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when a row has been activated by the user.

row

the activated row

pub fn connect_row_selected<F: Fn(&Self, Option<&ListBoxRow>) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when a new row is selected, or (with a None @row) when the selection is cleared.

When the @box_ is using SelectionMode::Multiple, this signal will not give you the full picture of selection changes, and you should use the selected-rows-changed signal instead.

row

the selected row

pub fn connect_select_all<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted to select all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default binding for this signal is Ctrl-a.

pub fn emit_select_all(&self)

pub fn connect_selected_rows_changed<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when the set of selected rows changes.

pub fn connect_toggle_cursor_row<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when the cursor row is toggled.

The default bindings for this signal is Ctrl+␣.

pub fn emit_toggle_cursor_row(&self)

pub fn connect_unselect_all<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted to unselect all children of the box, if the selection mode permits it.

This is a keybinding signal.

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

pub fn emit_unselect_all(&self)

pub fn connect_accept_unpaired_release_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_activate_on_single_click_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_selection_mode_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_show_separators_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_tab_behavior_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v4_18 only.

impl ListBox

pub fn unbind_model(&self)

pub fn unset_filter_func(&self)

pub fn unset_header_func(&self)

pub fn set_sort_func<P: Fn(&ListBoxRow, &ListBoxRow) -> Ordering + 'static>( &self, sort_func: P, )

Sets a sort function.

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

The @sort_func will be called for each row after the call, and will continue to be called each time a row changes (via ListBoxRowExt::changed()) and when invalidate_sort() is called.

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

sort_func

the sort function

pub fn unset_sort_func(&self)

Trait Implementations

impl Clone for ListBox

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListBox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListBox

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for ListBox

type ParamSpec = ParamSpecObject

type SetValue = ListBox

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, ListBox>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ListBox

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ListBox

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for ListBox

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for ListBox

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ListBox

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ListBox

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ListBox

impl IsA<Accessible> for ListBox

impl IsA<Buildable> for ListBox

impl IsA<ConstraintTarget> for ListBox

impl IsA<Widget> for ListBox