Struct gtk4::TreeStore

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

Use TreeListModel instead A tree-like data structure that can be used with the TreeView.

The TreeStore object is a list model for use with a TreeView widget. It implements the TreeModel interface, and consequently, can use all of the methods available there. It also implements the TreeSortable interface so it can be sorted by the view. Finally, it also implements the tree dragcrate::TreeDragSource and dropcrate::TreeDragDest interfaces.

TreeStore is deprecated since GTK 4.10, and should not be used in newly written code. You should use TreeListModel for a tree-like model object.

GtkTreeStore as GtkBuildable

The GtkTreeStore implementation of the Buildable interface allows to specify the model columns with a element that may contain multiple elements, each specifying one model column. The “type” attribute specifies the data type for the column.

An example of a UI Definition fragment for a tree store:

<object class="GtkTreeStore">
  <columns>
    <column type="gchararray"/>
    <column type="gchararray"/>
    <column type="gint"/>
  </columns>
</object>

Implements

glib::ObjectExt, BuildableExt, TreeDragDestExt, TreeDragSourceExt, TreeModelExt, TreeSortableExt, TreeModelExtManual, TreeSortableExtManual

Implementations§

Appends a new row to @self.

If @parent is non-None, then it will append the new row after the last child of @parent, otherwise it will append a row to the top level.

The @iter parameter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value().

Deprecated since 4.10

Use TreeListModel instead

parent

A valid TreeIter

Returns
iter

An unset TreeIter to set to the appended row

Removes all rows from @self

Deprecated since 4.10

Use TreeListModel instead

Creates a new row at @position.

If parent is non-None, then the row will be made a child of @parent. Otherwise, the row will be created at the toplevel.

If @position is -1 or is larger than the number of rows at that level, then the new row will be inserted to the end of the list.

The @iter parameter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value().

Deprecated since 4.10

Use TreeListModel instead

parent

A valid TreeIter

position

position to insert the new row, or -1 for last

Returns
iter

An unset TreeIter to set to the new row

Inserts a new row after @sibling.

If @sibling is None, then the row will be prepended to @parent’s children.

If @parent and @sibling are None, then the row will be prepended to the toplevel.

If both @sibling and @parent are set, then @parent must be the parent of @sibling. When @sibling is set, @parent is optional.

The @iter parameter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value().

Deprecated since 4.10

Use TreeListModel instead

parent

A valid TreeIter

sibling

A valid TreeIter

Returns
iter

An unset TreeIter to set to the new row

Inserts a new row before @sibling.

If @sibling is None, then the row will be appended to @parent’s children.

If @parent and @sibling are None, then the row will be appended to the toplevel.

If both @sibling and @parent are set, then @parent must be the parent of @sibling. When @sibling is set, @parent is optional.

The @iter parameter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value().

Deprecated since 4.10

Use TreeListModel instead

parent

A valid TreeIter

sibling

A valid TreeIter

Returns
iter

An unset TreeIter to set to the new row

Checks if @iter is an ancestor of @descendant.

Deprecated since 4.10

Use TreeListModel instead

iter

A valid TreeIter

descendant

A valid TreeIter

Returns

true if @iter is an ancestor of @descendant, and false otherwise

Returns the depth of the position pointed by the iterator

The depth will be 0 for anything on the root level, 1 for anything down a level, etc.

Deprecated since 4.10

Use TreeListModel instead

iter

A valid TreeIter

Returns

The depth of the position pointed by the iterator

Checks if the given iter is a valid iter for this TreeStore.

This function is slow. Only use it for debugging and/or testing purposes.

Deprecated since 4.10

Use TreeListModel instead

iter

the iterator to check

Returns

true if the iter is valid, and false otherwise

Moves @iter in @self to the position after @position.

@iter and @position should be in the same level.

Note that this function only works with unsorted stores.

If @position is None, @iter will be moved to the start of the level.

Deprecated since 4.10

Use TreeListModel instead

iter

A TreeIter.

position

A TreeIter.

Moves @iter in @self to the position before @position.

@iter and @position should be in the same level.

Note that this function only works with unsorted stores.

If @position is None, @iter will be moved to the end of the level.

Deprecated since 4.10

Use TreeListModel instead

iter

A TreeIter

position

A TreeIter

Prepends a new row to @self.

If @parent is non-None, then it will prepend the new row before the first child of @parent, otherwise it will prepend a row to the top level. The iter parameter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value().

Deprecated since 4.10

Use TreeListModel instead

parent

A valid TreeIter

Returns
iter

An unset TreeIter to set to the prepended row

Removes @iter from @self.

After being removed, @iter is set to the next valid row at that level, or invalidated if it previously pointed to the last one.

Deprecated since 4.10

Use TreeListModel instead

iter

A valid TreeIter

Returns

true if @iter is still valid, and false otherwise

Swaps @a and @b in the same level of @self.

Note that this function only works with unsorted stores.

Deprecated since 4.10

Use TreeListModel instead

a

A TreeIter.

b

Another TreeIter.

Creates a new tree store.

The tree store will have @n_columns, with each column using the corresponding type passed to this function.

Note that only types derived from standard GObject fundamental types are supported.

As an example:

⚠️ The following code is in c ⚠️

gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING, GDK_TYPE_TEXTURE);

will create a new TreeStore with three columns of type int, gchararray, and gdk::Texture respectively.

Deprecated since 4.10

Use TreeListModel instead

Returns

a new TreeStore

A variant of gtk_tree_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs.

This function is mainly intended for language bindings.

Deprecated since 4.10

Use TreeListModel instead

parent

A valid TreeIter

position

position to insert the new row, or -1 for last

columns

an array of column numbers

values

an array of GValues

Returns
iter

An unset TreeIter to set the new row

Reorders the children of @parent in @self to follow the order indicated by @new_order.

Note that this function only works with unsorted stores.

Deprecated since 4.10

Use TreeListModel instead

parent

the parent of the children to re-order

new_order

an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. new_order[newpos] = oldpos

Sets the value of one or more cells in the row referenced by @iter.

The variable argument list should contain integer column numbers, each column number followed by the value to be set.

The list is terminated by a value of -1.

For example, to set column 0 with type G_TYPE_STRING to “Foo”, you would write

⚠️ The following code is in c ⚠️

gtk_tree_store_set (store, iter, 0, "Foo", -1);

The value will be referenced by the store if it is a G_TYPE_OBJECT, and it will be copied if it is a G_TYPE_STRING or G_TYPE_BOXED.

Deprecated since 4.10

Use TreeListModel instead

iter

A valid TreeIter for the row being modified

Sets the type of the columns in a tree store.

This function is meant primarily for types that inherit from TreeStore, and should only be used when constructing a new TreeStore.

This functions cannot be called after a row has been added, or a method on the TreeModel interface is called on the tree store.

Deprecated since 4.10

Use TreeListModel instead

types

An array of GType types, one for each column

Sets the data in the cell specified by @iter and @column.

The type of @value must be convertible to the type of the column.

Deprecated since 4.10

Use TreeListModel instead

iter

A valid TreeIter for the row being modified

column

column number to modify

value

new value for the cell

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
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§

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.