Struct gtk4::TreeListRow

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

TreeListRow is used by TreeListModel to represent items.

It allows navigating the model as a tree and modify the state of rows.

TreeListRow instances are created by a TreeListModel only when the passthrough property is not set.

There are various support objects that can make use of TreeListRow objects, such as the TreeExpander widget that allows displaying an icon to expand or collapse a row or TreeListRowSorter that makes it possible to sort trees properly.

Properties

children

The model holding the row’s children.

Readable

depth

The depth in the tree of this row.

Readable

expandable

If this row can ever be expanded.

Readable

expanded

If this row is currently expanded.

Readable | Writeable

item

The item held in this row.

Readable

Implements

glib::ObjectExt

Implementations

impl TreeListRow

pub fn child_row(&self, position: u32) -> Option<TreeListRow>

If @self is not expanded or @position is greater than the number of children, None is returned.

position

position of the child to get

Returns

the child in @position

pub fn children(&self) -> Option<ListModel>

If the row is expanded, gets the model holding the children of @self.

This model is the model created by the callback::Gtk::TreeListModelCreateModelFunc and contains the original items, no matter what value [passthrough`]crate::TreeListModel is set to.

Returns

The model containing the children

pub fn depth(&self) -> u32

Gets the depth of this row.

Rows that correspond to items in the root model have a depth of zero, rows corresponding to items of models of direct children of the root model have a depth of 1 and so on.

The depth of a row never changes until the row is removed from its model at which point it will forever return 0.

Returns

The depth of this row

pub fn is_expanded(&self) -> bool

Gets if a row is currently expanded.

Returns

true if the row is expanded

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

Gets the item corresponding to this row,

Returns

The item of this row. This function is only marked as nullable for backwards compatibility reasons.

pub fn parent(&self) -> Option<TreeListRow>

Gets the row representing the parent for @self.

That is the row that would need to be collapsed to make this row disappear.

If @self is a row corresponding to the root model, None is returned.

The value returned by this function never changes until the row is removed from its model at which point it will forever return None.

Returns

The parent of @self

pub fn position(&self) -> u32

Returns the position in the TreeListModel that @self occupies at the moment.

Returns

The position in the model

pub fn is_expandable(&self) -> bool

Checks if a row can be expanded.

This does not mean that the row is actually expanded, this can be checked with is_expanded().

If a row is expandable never changes until the row is removed from its model at which point it will forever return false.

Returns

true if the row is expandable

pub fn set_expanded(&self, expanded: bool)

Expands or collapses a row.

If a row is expanded, the model of calling the `callback::Gtk::TreeListModelCreateModelFunc for the row’s item will be inserted after this row. If a row is collapsed, those items will be removed from the model.

If the row is not expandable, this function does nothing.

expanded

true if the row should be expanded

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

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

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

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

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

Trait Implementations

impl Clone for TreeListRow

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 TreeListRow

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

Formats the value using the given formatter.

impl Display for TreeListRow

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

Formats the value using the given formatter.

impl HasParamSpec for TreeListRow

type ParamSpec = ParamSpecObject

type SetValue = TreeListRow

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TreeListRow

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 TreeListRow

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 TreeListRow

type Parent = Object

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

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 TreeListRow

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 TreeListRow

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TreeListRow