Struct gtk4::GridView

#[repr(transparent)]
pub struct GridView { /* private fields */ }

GridView presents a large dynamic grid of items.

GridView uses its factory to generate one child widget for each visible item and shows them in a grid. The orientation of the grid view determines if the grid reflows vertically or horizontally.

GridView 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::GridView::enable-rubberband.

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

CSS nodes

gridview
├── child[.activatable]
│
├── child[.activatable]
│
┊
╰── [rubberband]

GridView uses a single CSS node with name gridview. Each child uses a single CSS node with name child. If the property::ListItem::activatable property is set, the corresponding row will have the .activatable style class. For rubberband selection, a subnode with name rubberband is used.

Accessibility

GridView uses the AccessibleRole::Grid role, and the items use the AccessibleRole::GridCell role.

Implements

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

Implementations

impl GridView

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

Creates a new GridView 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 ⚠️

grid_view = gtk_grid_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 GridView using the given @model and @factory

pub fn builder() -> GridViewBuilder

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

This method returns an instance of GridViewBuilder which can be used to create GridView 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 max_columns(&self) -> u32

Gets the maximum number of columns that the grid will use.

Returns

The maximum number of columns

pub fn min_columns(&self) -> u32

Gets the minimum number of columns that the grid will use.

Returns

The minimum number of columns

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

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

Returns

true if items 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_max_columns(&self, max_columns: u32)

Sets the maximum number of columns to use.

This number must be at least 1.

If @max_columns is smaller than the minimum set via set_min_columns(), that value is used instead.

max_columns

The maximum number of columns

pub fn set_min_columns(&self, min_columns: u32)

Sets the minimum number of columns to use.

This number must be at least 1.

If @min_columns is smaller than the minimum set via set_max_columns(), that value is ignored.

min_columns

The minimum number of columns

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

Sets the imodel to use.

This must be a SelectionModel.

model

the model to use

pub fn set_single_click_activate(&self, single_click_activate: bool)

Sets whether items 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 cell has been activated by the user, usually via activating the GtkGridView|list.activate-item action.

This allows for a convenient way to handle activation in a gridview. See property::ListItem::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_max_columns_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_min_columns_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_single_click_activate_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for GridView

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 GridView

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

Formats the value using the given formatter.

impl Default for GridView

fn default() -> Self

Returns the “default value” for a type.

impl Display for GridView

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

Formats the value using the given formatter.

impl Hash for GridView

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 GridView

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 GridView

type Parent = ListBase

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

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 GridView

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 GridView

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GridView

impl IsA<Accessible> for GridView

impl IsA<Buildable> for GridView

impl IsA<ConstraintTarget> for GridView

impl IsA<ListBase> for GridView

impl IsA<Orientable> for GridView

impl IsA<Scrollable> for GridView

impl IsA<Widget> for GridView