Struct gtk4::TreeExpander

source ·
#[repr(transparent)]
pub struct TreeExpander { /* private fields */ }
Expand description

TreeExpander is a widget that provides an expander for a list.

It is typically placed as a bottommost child into a ListView to allow users to expand and collapse children in a list with a TreeListModel. TreeExpander provides the common UI elements, gestures and keybindings for this purpose.

On top of this, the “listitem.expand”, “listitem.collapse” and “listitem.toggle-expand” actions are provided to allow adding custom UI for managing expanded state.

The TreeListModel must be set to not be passthrough. Then it will provide TreeListRow items which can be set via set_list_row() on the expander. The expander will then watch that row item automatically. set_child() sets the widget that displays the actual row contents.

TreeExpander can be modified with properties such as property::TreeExpander::indent-for-icon, property::TreeExpander::indent-for-depth, and property::TreeExpander::hide-expander to achieve a different appearance. This can even be done to influence individual rows, for example by binding the property::TreeExpander::hide-expander property to the item count of the model of the treelistrow, to hide the expander for rows without children, even if the row is expandable.

CSS nodes

treeexpander
├── [indent]*
├── [expander]
╰── <child>

TreeExpander has zero or one CSS nodes with the name “expander” that should display the expander icon. The node will be :checked when it is expanded. If the node is not expandable, an “indent” node will be displayed instead.

For every level of depth, another “indent” node is prepended.

Accessibility

TreeExpander uses the AccessibleRole::Group role. The expander icon is represented as a AccessibleRole::Button, labelled by the expander’s child, and toggling it will change the AccessibleState::Expanded state.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations§

Creates a new TreeExpander

Returns

a new TreeExpander

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

This method returns an instance of TreeExpanderBuilder which can be used to create TreeExpander objects.

Gets the child widget displayed by @self.

Returns

The child displayed by @self

Available on crate feature v4_10 only.

Gets whether the TreeExpander should be hidden in a GtkTreeListRow.

Returns

TRUE if the expander icon should be hidden. Otherwise FALSE.

Available on crate feature v4_10 only.

TreeExpander indents each level of depth with an additional indent.

Returns

TRUE if the child should be indented . Otherwise FALSE.

Available on crate feature v4_6 only.

TreeExpander indents the child by the width of an expander-icon if it is not expandable.

Returns

TRUE if the child should be indented when not expandable. Otherwise FALSE.

Forwards the item set on the TreeListRow that @self is managing.

This call is essentially equivalent to calling:

⚠️ The following code is in c ⚠️

gtk_tree_list_row_get_item (gtk_tree_expander_get_list_row (@self));
Returns

The item of the row

Gets the list row managed by @self.

Returns

The list row displayed by @self

Sets the content widget to display.

child

a Widget

Available on crate feature v4_10 only.

Sets whether the expander icon should be visible in a GtkTreeListRow.

hide_expander

TRUE if the expander should be hidden. Otherwise FALSE.

Available on crate feature v4_10 only.

Sets if the TreeExpander should indent the child according to its depth.

indent_for_depth

TRUE if the child should be indented. Otherwise FALSE.

Available on crate feature v4_6 only.

Sets if the TreeExpander should indent the child by the width of an expander-icon when it is not expandable.

indent_for_icon

TRUE if the child should be indented without expander. Otherwise FALSE.

Sets the tree list row that this expander should manage.

list_row

a TreeListRow

Available on crate feature v4_10 only.
Available on crate feature v4_10 only.
Available on crate feature v4_6 only.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Formats the value using the given formatter. Read more
Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Returns the type identifier of Self.

Auto Trait Implementations§

Blanket Implementations§

Updates an array of accessible properties. Read more
Updates an array of accessible relations. Read more
Updates an array of accessible states. Read more
Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T. Read more
Upcasts an object to a reference of its superclass or interface T. Read more
Tries to downcast to a subclass or interface implementor T. Read more
Tries to downcast to a reference of its subclass or interface implementor T. Read more
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 downcast and upcast will do many checks at compile-time already. Read more
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
Casts to T unconditionally. Read more
Casts to &T unconditionally. Read more

Returns the argument unchanged.

Calls U::from(self).

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

Returns true if the object is an instance of (can be cast to) T.
Returns the type of the object.
Returns the ObjectClass of the object. Read more
Returns the class of the object.
Returns the class of the object in the given type T. Read more
Returns the interface T of the object. Read more
Sets the property property_name of the object to value value. Read more
Sets the property property_name of the object to value value. Read more
Sets multiple properties of the object at once. Read more
Sets multiple properties of the object at once. Read more
Gets the property property_name of the object and cast it to the type V. Read more
Gets the property property_name of the object. Read more
Check if the object has a property property_name of the given type_. Read more
Get the type of the property property_name of this object. Read more
Get the ParamSpec of the property property_name of this object.
Return all ParamSpec of the properties of this object.
Freeze all property notifications until the return guard object is dropped. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Block a given signal handler. Read more
Unblock a given signal handler.
Stop emission of the currently emitted signal.
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect a closure to the signal signal_name on this object. Read more
Connect a closure to the signal signal_id on this object. Read more
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. Read more
Emit signal by signal id. Read more
Same as Self::emit but takes Value for the arguments.
Emit signal by its name. Read more
Emit signal by its name. Read more
Emit signal by its name with details. Read more
Emit signal by its name with details. Read more
Emit signal by signal id with details. Read more
Emit signal by signal id with details. Read more
Disconnect a previously connected signal handler.
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Notify that the given property has changed its value. Read more
Notify that the given property has changed its value. Read more
Downgrade this object to a weak reference.
Add a callback to be notified when the Object is disposed.
Add a callback to be notified when the Object is disposed. Read more
Bind property source_property on this object to the target_property on the target object. Read more
Returns the strong reference count of this object.
Runs the dispose mechanism of the object. Read more
Ensures that the type has been registered with the type system.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.