Struct gtk4::ListItem

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

ListItem is used by list widgets to represent items in a GListModel.

The ListItems are managed by the list widget (with its factory) and cannot be created by applications, but they need to be populated by application code. This is done by calling set_child().

ListItems exist in 2 stages:

1. The unbound stage where the listitem is not currently connected to an item in the list. In that case, the item property is set to None.

2. The bound stage where the listitem references an item from the list. The item property is not None.

Properties

activatable

If the item can be activated by the user.

Readable | Writeable

child

Widget used for display.

Readable | Writeable

item

Displayed item.

Readable

position

Position of the item.

Readable

selectable

If the item can be selected by the user.

Readable | Writeable

selected

If the item is currently selected.

Readable

Implements

glib::ObjectExt

Implementations

impl ListItem

pub fn is_activatable(&self) -> bool

Checks if a list item has been set to be activatable via gtk_list_item_set_activatable().

Returns

true if the item is activatable

pub fn child(&self) -> Option<Widget>

Gets the child previously set via gtk_list_item_set_child() or None if none was set.

Returns

The child

pub fn item(&self) -> Option<Object>

Gets the model item that associated with @self.

If @self is unbound, this function returns None.

Returns

The item displayed

pub fn position(&self) -> u32

Gets the position in the model that @self currently displays.

If @self is unbound, GTK_INVALID_LIST_POSITION is returned.

Returns

The position of this item

pub fn is_selectable(&self) -> bool

Checks if a list item has been set to be selectable via gtk_list_item_set_selectable().

Do not confuse this function with is_selected().

Returns

true if the item is selectable

pub fn is_selected(&self) -> bool

Checks if the item is displayed as selected.

The selected state is maintained by the liste widget and its model and cannot be set otherwise.

Returns

true if the item is selected.

pub fn set_activatable(&self, activatable: bool)

Sets @self to be activatable.

If an item is activatable, double-clicking on the item, using the Return key or calling gtk_widget_activate() will activate the item. Activating instructs the containing view to handle activation. ListView for example will be emitting the activate signal.

By default, list items are activatable.

activatable

if the item should be activatable

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

Sets the child to be used for this listitem.

This function is typically called by applications when setting up a listitem so that the widget can be reused when binding it multiple times.

child

The list item’s child or None to unset

pub fn set_selectable(&self, selectable: bool)

Sets @self to be selectable.

If an item is selectable, clicking on the item or using the keyboard will try to select or unselect the item. If this succeeds is up to the model to determine, as it is managing the selected state.

Note that this means that making an item non-selectable has no influence on the selected state at all. A non-selectable item may still be selected.

By default, list items are selectable. When rebinding them to a new item, they will also be reset to be selectable by GTK.

selectable

if the item should be selectable

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

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

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

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

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

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

Trait Implementations

impl Clone for ListItem

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 ListItem

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

Formats the value using the given formatter.

impl Display for ListItem

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

Formats the value using the given formatter.

impl HasParamSpec for ListItem

type ParamSpec = ParamSpecObject

type SetValue = ListItem

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ListItem

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 ListItem

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 ListItem

type Parent = Object

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

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 ListItem

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 ListItem

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ListItem