Struct gtk4 :: TreeListModel Copy item path

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. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for TreeListModel

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

Formats the value using the given formatter. Read more

impl HasParamSpec for TreeListModel

type ParamSpec = ParamSpecObject

type SetValue = TreeListModel

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

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

Feeds this value into the given Hasher. Read more

1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl Ord for TreeListModel

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

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

Restrict a value to a certain interval. Read more

impl ParentClassIs for TreeListModel

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 ==.

1.0.0 · source§

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. Read more

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl StaticType for TreeListModel

fn static_type() -> Type

Returns the type identifier of Self.

impl IsA<ListModel> for TreeListModel

Auto Trait Implementations§

impl RefUnwindSafe for TreeListModel

impl UnwindSafe for TreeListModel

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Cast for T
where T: ObjectType,

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a subclass or interface implementor T. Read more

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

Casts to T unconditionally. Read more

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

Casts to &T unconditionally. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize ) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize ) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property.

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property with a weak reference.

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

fn into_closure_return_value(self) -> Option<Value>

impl IsSubclassableExt for U
where U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class)
where T: ObjectSubclass, ::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>)
where T: ObjectSubclass, ::Parent: IsSubclassable<T>,

impl<O> ListModelExt for O
where O: IsA<ListModel>,

fn item_type(&self) -> Type

fn n_items(&self) -> u32

fn item(&self, position: u32) -> Option<Object>

fn items_changed(&self, position: u32, removed: u32, added: u32)

fn connect_items_changed<F>(&self, f: F) -> SignalHandlerId
where F: Fn(&Self, u32, u32, u32) + 'static,

impl<T> ListModelExtManual for T
where T: IsA<ListModel>,

fn snapshot(&self) -> Vec<Object>

Get an immutable snapshot of the container inside the ListModel. Any modification done to the returned container Vec will not be reflected on the ListModel.

fn iter<LT>(&self) -> ListModelIter<'_, LT>
where LT: IsA<Object>,

If T::static_type().is_a(self.item_type()) then it returns an iterator over the ListModel elements, else the types are not compatible and returns an Err(...). Read more

impl<T> ObjectExt for T
where T: ObjectType,

fn is(&self) -> bool
where U: StaticType,

Returns true if the object is an instance of (can be cast to) T.

fn type_(&self) -> Type

Returns the type of the object.

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.

fn class_of(&self) -> Option<&Class>
where U: IsClass,

Returns the class of the object in the given type T. Read more

fn interface(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more

unsafe fn set_data<QD>(&self, key: &str, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.

fn connect<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more

fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more

fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more

fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.