Struct gtk4::TreeListModel

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

TreeListModel is a list model that can create child models on demand.

Properties

autoexpand

If all rows should be expanded by default.

Readable | Writeable

item-type

The type of items. See [ListModelExtManual::item_type()][crate::gio::prelude::ListModelExtManual::item_type()].

Readable

model

The root model displayed.

Readable

n-items

The number of items. See [ListModelExtManual::n_items()][crate::gio::prelude::ListModelExtManual::n_items()].

Readable

passthrough

Gets whether the model is in passthrough mode.

If false, the GListModel functions for this object return custom TreeListRow objects. If true, the values of the child models are pass through unmodified.

Readable | Writeable | Construct Only

Implements

glib::ObjectExt, gio::prelude::ListModelExt

Implementations

impl TreeListModel

pub fn new<P: Fn(&Object) -> Option<ListModel> + 'static>( root: impl IsA<ListModel>, passthrough: bool, autoexpand: bool, create_func: P ) -> TreeListModel

Creates a new empty TreeListModel displaying @root with all rows collapsed.

root

The GListModel to use as root

passthrough

true to pass through items from the models

autoexpand

true to set the autoexpand property and expand the @root model

create_func

Function to call to create the GListModel for the children of an item

Returns

a newly created TreeListModel.

pub fn is_autoexpand(&self) -> bool

Gets whether the model is set to automatically expand new rows that get added.

This can be either rows added by changes to the underlying models or via TreeListRow::set_expanded().

Returns

true if the model is set to autoexpand

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

Gets the row item corresponding to the child at index @position for @self’s root model.

If @position is greater than the number of children in the root model, None is returned.

Do not confuse this function with row().

position

position of the child to get

Returns

the child in @position

pub fn model(&self) -> ListModel

Gets the root model that @self was created with.

Returns

the root model

pub fn is_passthrough(&self) -> bool

Gets whether the model is passing through original row items.

If this function returns false, the GListModel functions for @self return custom TreeListRow objects. You need to call TreeListRow::item() on these objects to get the original item.

If true, the values of the child models are passed through in their original state. You then need to call row() to get the custom TreeListRows.

Returns

true if the model is passing through original row items

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

Gets the row object for the given row.

If @position is greater than the number of items in @self, None is returned.

The row object can be used to expand and collapse rows as well as to inspect its position in the tree. See its documentation for details.

This row object is persistent and will refer to the current item as long as the row is present in @self, independent of other rows being added or removed.

If @self is set to not be passthrough, this function is equivalent to calling g_list_model_get_item().

Do not confuse this function with child_row().

position

the position of the row to fetch

Returns

The row item

pub fn set_autoexpand(&self, autoexpand: bool)

Sets whether the model should autoexpand.

If set to true, the model will recursively expand all rows that get added to the model. This can be either rows added by changes to the underlying models or via TreeListRow::set_expanded().

autoexpand

true to make the model autoexpand its rows

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

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

Trait Implementations

impl Clone for TreeListModel

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 TreeListModel

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

Formats the value using the given formatter.

impl Display for TreeListModel

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

Formats the value using the given formatter.

impl HasParamSpec for TreeListModel

type ParamSpec = ParamSpecObject

type SetValue = TreeListModel

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TreeListModel

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 TreeListModel

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 TreeListModel

type Parent = Object

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

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 TreeListModel

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 TreeListModel

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TreeListModel

impl IsA<ListModel> for TreeListModel