Struct ListView

pub struct ListView { /* private fields */ }

ListView presents a large dynamic list of items.

ListView uses its factory to generate one row widget for each visible item and shows them in a linear display, either vertically or horizontally.

The show-separators property offers a simple way to display separators between the rows.

ListView allows the user to select items according to the selection characteristics of the model. For models that allow multiple selected items, it is possible to turn on rubberband selection, using enable-rubberband.

If you need multiple columns with headers, see ColumnView.

To learn more about the list widget framework, see the overview.

An example of using ListView: ⚠️ The following code is in c ⚠️

static void
setup_listitem_cb (GtkListItemFactory *factory,
                   GtkListItem        *list_item)
{
  GtkWidget *image;

  image = gtk_image_new ();
  gtk_image_set_icon_size (GTK_IMAGE (image), GTK_ICON_SIZE_LARGE);
  gtk_list_item_set_child (list_item, image);
}

static void
bind_listitem_cb (GtkListItemFactory *factory,
                  GtkListItem        *list_item)
{
  GtkWidget *image;
  GAppInfo *app_info;

  image = gtk_list_item_get_child (list_item);
  app_info = gtk_list_item_get_item (list_item);
  gtk_image_set_from_gicon (GTK_IMAGE (image), g_app_info_get_icon (app_info));
}

static void
activate_cb (GtkListView  *list,
             guint         position,
             gpointer      unused)
{
  GAppInfo *app_info;

  app_info = g_list_model_get_item (G_LIST_MODEL (gtk_list_view_get_model (list)), position);
  g_app_info_launch (app_info, NULL, NULL, NULL);
  g_object_unref (app_info);
}

...

  model = create_application_list ();

  factory = gtk_signal_list_item_factory_new ();
  g_signal_connect (factory, "setup", G_CALLBACK (setup_listitem_cb), NULL);
  g_signal_connect (factory, "bind", G_CALLBACK (bind_listitem_cb), NULL);

  list = gtk_list_view_new (GTK_SELECTION_MODEL (gtk_single_selection_new (model)), factory);

  g_signal_connect (list, "activate", G_CALLBACK (activate_cb), NULL);

  gtk_scrolled_window_set_child (GTK_SCROLLED_WINDOW (sw), list);

Actions

ListView defines a set of built-in actions:

• list.activate-item activates the item at given position by emitting the activate signal.

CSS nodes

listview[.separators][.rich-list][.navigation-sidebar][.data-table]
├── row[.activatable]
│
├── row[.activatable]
│
┊
╰── [rubberband]

ListView uses a single CSS node named listview. It may carry the .separators style class, when show-separators property is set. Each child widget uses a single CSS node named row. If the activatable property is set, the corresponding row will have the .activatable style class. For rubberband selection, a node with name rubberband is used.

The main listview node may also carry style classes to select the style of list presentation: .rich-list, .navigation-sidebar or .data-table.

Accessibility

ListView uses the AccessibleRole::List role, and the list items use the AccessibleRole::ListItem role.

Properties

enable-rubberband

Allow rubberband selection.

Readable | Writeable

factory

Factory for populating list items.

The factory must be for configuring ListItem objects.

Readable | Writeable

header-factory

Factory for creating header widgets.

The factory must be for configuring ListHeader objects.

Readable | Writeable

model

Model for the items displayed.

Readable | Writeable

show-separators

Show separators between rows.

Readable | Writeable

single-click-activate

Activate rows on single click and select them on hover.

Readable | Writeable

tab-behavior

Behavior of the Tab key

Readable | Writeable

ListBase

orientation

The orientation of the list. See GtkOrientable:orientation for details.

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 value of true 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

Override 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 None 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 None: 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 None: 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

Override 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

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Scrollable

hadjustment

Horizontal Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

Readable | Writeable | Construct

hscroll-policy

Determines when horizontal scrolling should start.

Readable | Writeable

vadjustment

Vertical Adjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

Readable | Writeable | Construct

vscroll-policy

Determines when vertical scrolling should start.

Readable | Writeable

Signals

activate

Emitted when a row has been activated by the user, usually via activating the GtkListView|list.activate-item action.

This allows for a convenient way to handle activation in a listview. See ListItemExt::set_activatable() for details on how to use this signal.

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

[ListBaseExt][trait@crate::prelude::ListBaseExt], WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, OrientableExt, ScrollableExt, WidgetExtManual, AccessibleExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl ListView

pub fn new( model: Option<impl IsA<SelectionModel>>, factory: Option<impl IsA<ListItemFactory>>, ) -> ListView

Creates a new ListView that uses the given @factory for mapping items to widgets.

The function takes ownership of the arguments, so you can write code like ⚠️ The following code is in c ⚠️

list_view = gtk_list_view_new (create_model (),
  gtk_builder_list_item_factory_new_from_resource ("/resource.ui"));

model

the model to use

factory

The factory to populate items with

Returns

a new ListView using the given @model and @factory

pub fn builder() -> ListViewBuilder

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

This method returns an instance of ListViewBuilder which can be used to create ListView objects.

pub fn enables_rubberband(&self) -> bool

Returns whether rows can be selected by dragging with the mouse.

Returns

true if rubberband selection is enabled

pub fn factory(&self) -> Option<ListItemFactory>

Gets the factory that’s currently used to populate list items.

Returns

The factory in use

pub fn header_factory(&self) -> Option<ListItemFactory>

Available on crate feature v4_12 only.

Gets the factory that’s currently used to populate section headers.

Returns

The factory in use

pub fn model(&self) -> Option<SelectionModel>

Gets the model that’s currently used to read the items displayed.

Returns

The model in use

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 is_single_click_activate(&self) -> bool

Returns whether rows will be activated on single click and selected on hover.

Returns

true if rows are activated on single click

pub fn tab_behavior(&self) -> ListTabBehavior

Available on crate feature v4_12 only.

Gets the behavior set for the Tab key.

Returns

The behavior of the Tab key

pub fn scroll_to( &self, pos: u32, flags: ListScrollFlags, scroll: Option<ScrollInfo>, )

Available on crate feature v4_12 only.

Scrolls to the item at the given position and performs the actions specified in @flags.

This function works no matter if the listview is shown or focused. If it isn’t, then the changes will take effect once that happens.

pos

position of the item. Must be less than the number of items in the view.

flags

actions to perform

scroll

details of how to perform the scroll operation or None to scroll into view

pub fn set_enable_rubberband(&self, enable_rubberband: bool)

Sets whether selections can be changed by dragging with the mouse.

enable_rubberband

true to enable rubberband selection

pub fn set_factory(&self, factory: Option<&impl IsA<ListItemFactory>>)

Sets the ListItemFactory to use for populating list items.

factory

the factory to use

pub fn set_header_factory(&self, factory: Option<&impl IsA<ListItemFactory>>)

Available on crate feature v4_12 only.

Sets the ListItemFactory to use for populating the ListHeader objects used in section headers.

If this factory is set to None, the list will not show section headers.

factory

the factory to use

pub fn set_model(&self, model: Option<&impl IsA<SelectionModel>>)

Sets the model to use.

This must be a SelectionModel to use.

model

the model to use

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_single_click_activate(&self, single_click_activate: bool)

Sets whether rows should be activated on single click and selected on hover.

single_click_activate

true to activate items on single click

pub fn set_tab_behavior(&self, tab_behavior: ListTabBehavior)

Available on crate feature v4_12 only.

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

tab_behavior

The desired tab behavior

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

Emitted when a row has been activated by the user, usually via activating the GtkListView|list.activate-item action.

This allows for a convenient way to handle activation in a listview. See ListItemExt::set_activatable() for details on how to use this signal.

position

position of item to activate

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

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

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

Available on crate feature v4_12 only.

pub fn connect_model_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_single_click_activate_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_12 only.

Trait Implementations

impl Clone for ListView

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 ListView

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

Formats the value using the given formatter.

impl Default for ListView

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for ListView

type ParamSpec = ParamSpecObject

type SetValue = ListView

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ListView

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 ListView

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 ListView

type Parent = ListBase

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

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 ListView

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 ListView

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ListView

impl IsA<Accessible> for ListView

impl IsA<Buildable> for ListView

impl IsA<ConstraintTarget> for ListView

impl IsA<ListBase> for ListView

impl IsA<Orientable> for ListView

impl IsA<Scrollable> for ListView

impl IsA<Widget> for ListView