Struct gtk4::TreeStore

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

A tree-like data structure that can be used with the GtkTreeView

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 [drag and drop][gtk3-GtkTreeView-drag-and-drop] interfaces.

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

impl TreeStore

pub fn append(&self, parent: Option<&TreeIter>) -> TreeIter

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. @iter 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().

parent

A valid TreeIter

Returns

iter

An unset TreeIter to set to the appended row

pub fn clear(&self)

Removes all rows from @self

pub fn insert(&self, parent: Option<&TreeIter>, position: i32) -> TreeIter

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. @iter 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().

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

pub fn insert_after( &self, parent: Option<&TreeIter>, sibling: Option<&TreeIter> ) -> TreeIter

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.

@iter 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().

parent

A valid TreeIter

sibling

A valid TreeIter

Returns

iter

An unset TreeIter to set to the new row

pub fn insert_before( &self, parent: Option<&TreeIter>, sibling: Option<&TreeIter> ) -> TreeIter

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.

@iter 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().

parent

A valid TreeIter

sibling

A valid TreeIter

Returns

iter

An unset TreeIter to set to the new row

pub fn is_ancestor(&self, iter: &TreeIter, descendant: &TreeIter) -> bool

Returns true if @iter is an ancestor of @descendant. That is, @iter is the parent (or grandparent or great-grandparent) of @descendant.

iter

A valid TreeIter

descendant

A valid TreeIter

Returns

true, if @iter is an ancestor of @descendant

pub fn iter_depth(&self, iter: &TreeIter) -> i32

Returns the depth of @iter. This will be 0 for anything on the root level, 1 for anything down a level, etc.

iter

A valid TreeIter

Returns

The depth of @iter

pub fn iter_is_valid(&self, iter: &TreeIter) -> bool

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.

iter

the iterator to check

Returns

true if the iter is valid, false if the iter is invalid.

pub fn move_after(&self, iter: &TreeIter, position: Option<&TreeIter>)

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.

iter

A TreeIter.

position

A TreeIter.

pub fn move_before(&self, iter: &TreeIter, position: Option<&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.

iter

A TreeIter

position

A TreeIter

pub fn prepend(&self, parent: Option<&TreeIter>) -> 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. @iter 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().

parent

A valid TreeIter

Returns

iter

An unset TreeIter to set to the prepended row

pub fn remove(&self, iter: &TreeIter) -> bool

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.

iter

A valid TreeIter

Returns

true if @iter is still valid, false if not.

pub fn swap(&self, a: &TreeIter, b: &TreeIter)

Swaps @a and @b in the same level of @self. Note that this function only works with unsorted stores.

a

A TreeIter.

b

Another TreeIter.

impl TreeStore

pub fn new(column_types: &[Type]) -> Self

Creates a new tree store as with @n_columns columns each of the types passed in. Note that only types derived from standard GObject fundamental types are supported.

As an example,

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.

Returns

a new TreeStore

pub fn insert_with_values( &self, parent: Option<&TreeIter>, position: Option<u32>, columns_and_values: &[(u32, &dyn ToValue)] ) -> TreeIter

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.

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

pub fn reorder(&self, parent: &TreeIter, new_order: &[u32])

Reorders the children of @parent in @self to follow the order indicated by @new_order. Note that this function only works with unsorted stores.

parent

A TreeIter

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.

pub fn set(&self, iter: &TreeIter, columns_and_values: &[(u32, &dyn ToValue)])

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 -1. For example, to set column 0 with type G_TYPE_STRING to “Foo”, you would write 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.

iter

A valid TreeIter for the row being modified

pub fn set_column_types(&self, types: &[Type])

This function is meant primarily for GObjects that inherit from TreeStore, and should only be used when constructing a new TreeStore. It will not function after a row has been added, or a method on the TreeModel interface is called.

types

An array of GType types, one for each column

pub fn set_value(&self, iter: &TreeIter, column: u32, value: &Value)

Sets the data in the cell specified by @iter and @column. The type of @value must be convertible to the type of the column.

iter

A valid TreeIter for the row being modified

column

column number to modify

value

new value for the cell

Trait Implementations

impl Clone for TreeStore

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 TreeStore

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

Formats the value using the given formatter.

impl Display for TreeStore

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

Formats the value using the given formatter.

impl Hash for TreeStore

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 TreeStore

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 TreeStore

type Parent = Object

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

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 TreeStore

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 TreeStore

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TreeStore

impl IsA<Buildable> for TreeStore

impl IsA<TreeDragDest> for TreeStore

impl IsA<TreeDragSource> for TreeStore

impl IsA<TreeModel> for TreeStore

impl IsA<TreeSortable> for TreeStore