Struct gtk4::ListView

#[repr(transparent)]
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 property::ListView::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 property::ListView::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);

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 property::ListView::show-separators property is set. Each child widget uses a single CSS node named row. If the property::ListItem::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.

Implements

ListBaseExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, OrientableExt, ScrollableExt, WidgetExtManual, AccessibleExtManual

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 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 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_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 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 ListItem::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_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

Trait Implementations

impl Clone for ListView

fn clone(&self) -> Self

Returns a copy of the value.

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 Display for ListView

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

Formats the value using the given formatter.

impl Hash for ListView

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

Feeds this value into the given Hasher.

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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