Index

Package: Tree_Model

Description

package Gtk.Tree_Model is

The Gtk.Tree_Model.Gtk_Tree_Model interface defines a generic tree interface for use by the Gtk.Tree_View.Gtk_Tree_View widget. It is an abstract interface, and is designed to be usable with any appropriate data structure. The programmer just has to implement this interface on their own data type for it to be viewable by a Gtk.Tree_View.Gtk_Tree_View widget.

The model is represented as a hierarchical tree of strongly-typed, columned data. In other words, the model can be seen as a tree where every node has different values depending on which column is being queried. The type of data found in a column is determined by using the GType system (ie.

G_TYPE_INT, GTK_TYPE_BUTTON, G_TYPE_POINTER, etc). The types are homogeneous per column across all nodes. It is important to note that this interface only provides a way of examining a model and observing changes.

The implementation of each individual model decides how and if changes are made.

In order to make life simpler for programmers who do not need to write their own specialized model, two generic models are provided — the Gtk.Tree_Store.Gtk_Tree_Store and the Gtk.List_Store.Gtk_List_Store. To use these, the developer simply pushes data into these models as necessary.

These models provide the data structure as well as all appropriate tree interfaces. As a result, implementing drag and drop, sorting, and storing data is trivial. For the vast majority of trees and lists, these two models are sufficient.

Models are accessed on a node/column level of granularity. One can query for the value of a model at a certain node and a certain column on that node. There are two structures used to reference a particular node in a model. They are the Gtk.Tree_Model.Gtk_Tree_Path and the Gtk.Tree_Model.Gtk_Tree_Iter[ Here, <abbrev>iter</abbrev> is short for <quote>iterator</quote>]. Most of the interface consists of operations on a Gtk.Tree_Model.Gtk_Tree_Iter.

A path is essentially a potential node. It is a location on a model that may or may not actually correspond to a node on a specific model. The Gtk.Tree_Model.Gtk_Tree_Path struct can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path <quote>0</quote> refers to the root node and the path <quote>2:4</quote> refers to the fifth child of the third node.

By contrast, a Gtk.Tree_Model.Gtk_Tree_Iter is a reference to a specific node on a specific model. It is a generic struct with an integer and three generic pointers. These are filled in by the model in a model-specific way.

One can convert a path to an iterator by calling Gtk.Tree_Model.Get_Iter.

These iterators are the primary way of accessing a model and are similar to the iterators used by Gtk.Text_Buffer.Gtk_Text_Buffer. They are generally statically allocated on the stack and only used for a short time. The model interface defines a set of operations using them for navigating the model.

It is expected that models fill in the iterator with private data. For example, the Gtk.List_Store.Gtk_List_Store model, which is internally a simple linked list, stores a list node in one of the pointers. The Gtk.Tree_Model_Sort.Gtk_Tree_Model_Sort stores an array and an offset in two of the pointers. Additionally, there is an integer field. This field is generally filled with a unique stamp per model. This stamp is for catching errors resulting from using invalid iterators with a model.

The lifecycle of an iterator can be a little confusing at first. Iterators are expected to always be valid for as long as the model is unchanged (and doesn't emit a signal). The model is considered to own all outstanding iterators and nothing needs to be done to free them from the user's point of view. Additionally, some models guarantee that an iterator is valid for as long as the node it refers to is valid (most notably the Gtk.Tree_Store.Gtk_Tree_Store and Gtk.List_Store.Gtk_List_Store). Although generally uninteresting, as one always has to allow for the case where iterators do not persist beyond a signal, some very important performance enhancements were made in the sort model. As a result, the GTK_TREE_MODEL_ITERS_PERSIST flag was added to indicate this behavior.

To help show some common operation of a model, some examples are provided.

The first example shows three ways of getting the iter at the location <quote>3:2:5</quote>. While the first method shown is easier, the second is much more common, as you often get paths from callbacks. == Acquiring a <structname>GtkTreeIter</structname> == /* Three ways of getting the iter pointing to the location */ GtkTreePath *path; GtkTreeIter iter; GtkTreeIter parent_iter; /* get the iterator from a string */ gtk_tree_model_get_iter_from_string (model, &amp;iter, "3:2:5"); /* get the iterator from a path */ path = gtk_tree_path_new_from_string ("3:2:5"); gtk_tree_model_get_iter (model, &amp;iter, path); gtk_tree_path_free (path); /* walk the tree to find the iterator */ gtk_tree_model_iter_nth_child (model, &amp;iter, NULL, 3); parent_iter = iter; gtk_tree_model_iter_nth_child (model, &amp;iter, &amp;parent_iter, 2); parent_iter = iter; gtk_tree_model_iter_nth_child (model, &amp;iter, &amp;parent_iter, 5); This second example shows a quick way of iterating through a list and getting a string and an integer from each row. The <function>populate_model</function> function used below is not shown, as it is specific to the Gtk.List_Store.Gtk_List_Store. For information on how to write such a function, see the Gtk.List_Store.Gtk_List_Store documentation. == Reading data from a <structname>GtkTreeModel</structname> == enum { STRING_COLUMN, INT_COLUMN, N_COLUMNS }; ... GtkTreeModel *list_store; GtkTreeIter iter; gboolean valid; gint row_count = 0; /* make a new list_store */ list_store = gtk_list_store_new (N_COLUMNS, G_TYPE_STRING, G_TYPE_INT); /* Fill the list store with data */ populate_model (list_store); /* Get the first iter in the list, check it is valid and walk * through the list, reading each row. */ for (valid = gtk_tree_model_get_iter_first (list_store, &amp;iter); valid; valid = gtk_tree_model_iter_next (list_store, &amp;iter)) { gchar *str_data; gint int_data; /* Make sure you terminate calls to gtk_tree_model_get * with a '-1' value */ gtk_tree_model_get (list_store, &amp;iter, STRING_COLUMN, &amp;str_data, INT_COLUMN, &amp;int_data, -1); /* Do something with the data */ g_print ("Row %d: (%s,%d)\n", row_count, str_data, int_data); g_free (str_data); row_count++; } The Gtk.Tree_Model.Gtk_Tree_Model interface contains two methods for reference counting: Gtk.Tree_Model.Ref_Node and Gtk.Tree_Model.Unref_Node.

These two methods are optional to implement. The reference counting is meant as a way for views to let models know when nodes are being displayed.

Gtk.Tree_View.Gtk_Tree_View will take a reference on a node when it is visible, which means the node is either in the toplevel or expanded. Being displayed does not mean that the node is currently directly visible to the user in the viewport. Based on this reference counting scheme a caching model, for example, can decide whether or not to cache a node based on the reference count. A file-system based model would not want to keep the entire file hierarchy in memory, but just the folders that are currently expanded in every current view.

When working with reference counting, the following rules must be taken into account: * Never take a reference on a node without owning a reference on its parent. This means that all parent nodes of a referenced node must be referenced as well. * Outstanding references on a deleted node are not released. This is not possible because the node has already been deleted by the time the row-deleted signal is received. * Models are not obligated to emit a signal on rows of which none of its siblings are referenced. To phrase this differently, signals are only required for levels in which nodes are referenced. For the root level however, signals must be emitted at all times (however the root level is always referenced when any view is attached).

Packages

Tree_Model_Flags_Properties (new Glib.Generic_Properties.Generic_Internal_Discrete_Property)

package Tree_Model_Flags_Properties is
      new Generic_Internal_Discrete_Property (Tree_Model_Flags);

Foreach_User_Data (generic)

Implements_Gtk_Tree_Model (new Glib.Types.Implements)

Gtk_Tree_Path_List (new Glib.Glist.Generic_List)

package Gtk_Tree_Path_List is new Generic_List (Gtk.Tree_Model.Gtk_Tree_Path);

Classes

Gtk_Tree_Path

type Gtk_Tree_Path is new Glib.C_Boxed with null record;

Ancestors:

Primitive operations:

Append_Index
From_Object_Free
Get_Tree_Path
Gtk_New_First
Gtk_Tree_Path_New
Gtk_Tree_Path_New_First
Gtk_Tree_Path_New_From_String
Is_Descendant
Prepend_Index
Row_Has_Child_Toggled
Row_Inserted
Rows_Reordered

Gtk_Root_Tree_Model_Record

type Gtk_Root_Tree_Model_Record is new Glib.Object.GObject_Record
   with null record;

Ancestors:

Immediate Children:

Primitive operations:

Glib.Object.Deallocate (Inherited)
Glib.Object.Get_Type (Inherited)
Glib.Object.Notify (Inherited)
Glib.Object.Ref (Inherited)
Glib.Object.Ref_Sink (Inherited)
Glib.Object.Unref (Inherited)

Types

Gtk_Tree_Model

type Gtk_Tree_Model is new Glib.Types.GType_Interface;

Tree_Model_Flags

type Tree_Model_Flags is mod 2 ** Integer'Size;

Gtk_Tree_Iter

type Gtk_Tree_Iter is private;

Gtk_Tree_Model_Foreach_Func

type Gtk_Tree_Model_Foreach_Func is access function
     (Model : Gtk_Tree_Model;
      Path  : Gtk_Tree_Path;
      Iter  : Gtk_Tree_Iter) return Boolean;
Type of the callback passed to Gtk.Tree_Model.Foreach to iterate over the rows in a tree model. "model": the Gtk.Tree_Model.Gtk_Tree_Model being iterated "path": the current Gtk.Tree_Model.Gtk_Tree_Path "iter": the current Gtk.Tree_Model.Gtk_Tree_Iter

Property_Tree_Model_Flags

type Property_Tree_Model_Flags is new Tree_Model_Flags_Properties.Property;

Gtk_Root_Tree_Model

type Gtk_Root_Tree_Model is
      access all Gtk_Root_Tree_Model_Record'Class;
A common base type for all objects that implement GtkTreeModel. This is used to conveniently provide a number of primitive operations.

Cb_Gtk_Tree_Model_Gtk_Tree_Path_Gtk_Tree_Iter_Void

type Cb_Gtk_Tree_Model_Gtk_Tree_Path_Gtk_Tree_Iter_Void is not null access procedure
     (Self : Gtk_Tree_Model;
      Path : Gtk_Tree_Path;
      Iter : Gtk_Tree_Iter);

Cb_GObject_Gtk_Tree_Path_Gtk_Tree_Iter_Void

type Cb_GObject_Gtk_Tree_Path_Gtk_Tree_Iter_Void is not null access procedure
     (Self : access Glib.Object.GObject_Record'Class;
      Path : Gtk_Tree_Path;
      Iter : Gtk_Tree_Iter);

Cb_Gtk_Tree_Model_Gtk_Tree_Path_Void

type Cb_Gtk_Tree_Model_Gtk_Tree_Path_Void is not null access procedure
     (Self : Gtk_Tree_Model;
      Path : Gtk_Tree_Path);

Cb_GObject_Gtk_Tree_Path_Void

type Cb_GObject_Gtk_Tree_Path_Void is not null access procedure
     (Self : access Glib.Object.GObject_Record'Class;
      Path : Gtk_Tree_Path);

Cb_Gtk_Tree_Model_Gtk_Tree_Path_Gtk_Tree_Iter_Address_Void

type Cb_Gtk_Tree_Model_Gtk_Tree_Path_Gtk_Tree_Iter_Address_Void is not null access procedure
     (Self      : Gtk_Tree_Model;
      Path      : Gtk_Tree_Path;
      Iter      : Gtk_Tree_Iter;
      New_Order : System.Address);

Cb_GObject_Gtk_Tree_Path_Gtk_Tree_Iter_Address_Void

type Cb_GObject_Gtk_Tree_Path_Gtk_Tree_Iter_Address_Void is not null access procedure
     (Self      : access Glib.Object.GObject_Record'Class;
      Path      : Gtk_Tree_Path;
      Iter      : Gtk_Tree_Iter;
      New_Order : System.Address);

Constants & Global variables

Null_Gtk_Tree_Model (Gtk_Tree_Model)

Null_Gtk_Tree_Model : constant Gtk_Tree_Model;

Tree_Model_Iters_Persist (Tree_Model_Flags)

Tree_Model_Iters_Persist : constant Tree_Model_Flags := 1;

Tree_Model_List_Only (Tree_Model_Flags)

Tree_Model_List_Only : constant Tree_Model_Flags := 2;

Null_Gtk_Tree_Path (Gtk_Tree_Path)

Null_Gtk_Tree_Path : constant Gtk_Tree_Path;

Signal_Row_Changed (Glib.Signal_Name)

Signal_Row_Changed : constant Glib.Signal_Name := "row-changed";

Signal_Row_Deleted (Glib.Signal_Name)

Signal_Row_Deleted : constant Glib.Signal_Name := "row-deleted";

Signal_Row_Has_Child_Toggled (Glib.Signal_Name)

Signal_Row_Has_Child_Toggled : constant Glib.Signal_Name := "row-has-child-toggled";

Signal_Row_Inserted (Glib.Signal_Name)

Signal_Row_Inserted : constant Glib.Signal_Name := "row-inserted";

Signal_Rows_Reordered (Glib.Signal_Name)

Signal_Rows_Reordered : constant Glib.Signal_Name := "rows-reordered";

Subprograms & Entries

From_Object_Free

function From_Object_Free 
(B: access Gtk_Tree_Iter) return Gtk_Tree_Iter;

From_Object

function From_Object 
(Object: System.Address) return Gtk_Tree_Path;

From_Object_Free

function From_Object_Free 
(B: access Gtk_Tree_Path'Class) return Gtk_Tree_Path;

Get_Type

function Get_Type return Glib.GType;

Iter_Get_Type

function Iter_Get_Type return Glib.GType;

Gtk_New

procedure Gtk_New 
(Path: out Gtk_Tree_Path);
Creates a new Gtk.Tree_Model.Gtk_Tree_Path. This structure refers to a row.

Gtk_Tree_Path_New

function Gtk_Tree_Path_New return Gtk_Tree_Path;
Creates a new Gtk.Tree_Model.Gtk_Tree_Path. This structure refers to a row.

Gtk_New_First

procedure Gtk_New_First 
(Path: out Gtk_Tree_Path);
Creates a new Gtk.Tree_Model.Gtk_Tree_Path. The string representation of this path is "0".

Gtk_Tree_Path_New_First

function Gtk_Tree_Path_New_First return Gtk_Tree_Path;
Creates a new Gtk.Tree_Model.Gtk_Tree_Path. The string representation of this path is "0".

Gtk_New

procedure Gtk_New 
(Self: out Gtk_Tree_Path;
Path: UTF8_String);
Creates a new Gtk.Tree_Model.Gtk_Tree_Path initialized to Path. Path is expected to be a colon separated list of numbers. For example, the string "10:4:0" would create a path of depth 3 pointing to the 11th child of the root node, the 5th child of that 11th child, and the 1st child of that 5th child. If an invalid path string is passed in, null is returned. "path": The string representation of a path

Gtk_Tree_Path_New_From_String

function Gtk_Tree_Path_New_From_String 
(Path: UTF8_String) return Gtk_Tree_Path;
Creates a new Gtk.Tree_Model.Gtk_Tree_Path initialized to Path. Path is expected to be a colon separated list of numbers. For example, the string "10:4:0" would create a path of depth 3 pointing to the 11th child of the root node, the 5th child of that 11th child, and the 1st child of that 5th child. If an invalid path string is passed in, null is returned. "path": The string representation of a path

Path_Get_Type

function Path_Get_Type return Glib.GType;

Foreach

procedure Foreach 
(Tree_Model: Gtk_Tree_Model;
Func: Gtk_Tree_Model_Foreach_Func);
Calls func on each node in model in a depth-first fashion. If Func returns True, then the tree ceases to be walked, and Gtk.Tree_Model.Foreach returns. "func": a function to be called on each row

Get_Column_Type

function Get_Column_Type 
(Tree_Model: Gtk_Tree_Model;
Index: Gint) return GType;

Get_Flags

function Get_Flags 
(Tree_Model: Gtk_Tree_Model) return Tree_Model_Flags;

Get_Iter

function Get_Iter 
(Tree_Model: Gtk_Tree_Model;
Path: Gtk_Tree_Path) return Gtk_Tree_Iter;
Sets Iter to a valid iterator pointing to Path. If Path does not exist, Iter is set to an invalid iterator and False is returned. "path": the Gtk.Tree_Model.Gtk_Tree_Path

Get_Iter_First

function Get_Iter_First 
(Tree_Model: Gtk_Tree_Model) return Gtk_Tree_Iter;
Initializes Iter with the first iterator in the tree (the one at the path "0") and returns True. Returns False if the tree is empty.

Get_Iter_From_String

function Get_Iter_From_String 
(Tree_Model: Gtk_Tree_Model;
Path_String: UTF8_String) return Gtk_Tree_Iter;
Sets Iter to a valid iterator pointing to Path_String, if it exists. Otherwise, Iter is left invalid and False is returned. "path_string": a string representation of a Gtk.Tree_Model.Gtk_Tree_Path

Get_N_Columns

function Get_N_Columns 
(Tree_Model: Gtk_Tree_Model) return Gint;

Get_Path

function Get_Path 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter) return Gtk_Tree_Path;
Returns a newly-created Gtk.Tree_Model.Gtk_Tree_Path referenced by Iter. This path should be freed with Gtk.Tree_Model.Path_Free. "iter": the Gtk.Tree_Model.Gtk_Tree_Iter

Get_String_From_Iter

function Get_String_From_Iter 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter) return UTF8_String;
Generates a string representation of the iter. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string. Since: gtk+ 2.2 "iter": a Gtk.Tree_Model.Gtk_Tree_Iter

Get_Value

procedure Get_Value 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter;
Column: Gint;
Value: out Glib.Values.GValue);

Children

function Children 
(Tree_Model: Gtk_Tree_Model;
Parent: Gtk_Tree_Iter) return Gtk_Tree_Iter;
Sets Iter to point to the first child of Parent. If Parent has no children, False is returned and Iter is set to be invalid. Parent will remain a valid node after this function has been called. If Parent is null returns the first node, equivalent to 'gtk_tree_model_get_iter_first (tree_model, iter);' "parent": the Gtk.Tree_Model.Gtk_Tree_Iter, or null

Has_Child

function Has_Child 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter) return Boolean;
Returns True if Iter has children, False otherwise. "iter": the Gtk.Tree_Model.Gtk_Tree_Iter to test for children

N_Children

function N_Children 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter := Gtk.Tree_Model.Null_Iter) return Gint;
Returns the number of children that Iter has. As a special case, if Iter is null, then the number of toplevel nodes is returned. "iter": the Gtk.Tree_Model.Gtk_Tree_Iter, or null

Next

procedure Next 
(Tree_Model: Gtk_Tree_Model;
Iter: in out Gtk_Tree_Iter);
Sets Iter to point to the node following it at the current level. If there is no next Iter, False is returned and Iter is set to be invalid. "iter": the Gtk.Tree_Model.Gtk_Tree_Iter

Next

procedure Next 
(Path: Gtk_Tree_Path);
Moves the Path to point to the next node at the current depth.

Nth_Child

function Nth_Child 
(Tree_Model: Gtk_Tree_Model;
Parent: Gtk_Tree_Iter;
N: Gint) return Gtk_Tree_Iter;
Sets Iter to be the child of Parent, using the given index. The first index is 0. If N is too big, or Parent has no children, Iter is set to an invalid iterator and False is returned. Parent will remain a valid node after this function has been called. As a special case, if Parent is null, then the N<!-- -->th root node is set. "parent": the Gtk.Tree_Model.Gtk_Tree_Iter to get the child from, or null. "n": the index of the desired child

Parent

function Parent 
(Tree_Model: Gtk_Tree_Model;
Child: Gtk_Tree_Iter) return Gtk_Tree_Iter;
Sets Iter to be the parent of Child. If Child is at the toplevel, and doesn't have a parent, then Iter is set to an invalid iterator and False is returned. Child will remain a valid node after this function has been called. "child": the Gtk.Tree_Model.Gtk_Tree_Iter

Previous

procedure Previous 
(Tree_Model: Gtk_Tree_Model;
Iter: in out Gtk_Tree_Iter);
Sets Iter to point to the previous node at the current level. If there is no previous Iter, False is returned and Iter is set to be invalid. Since: gtk+ 3.0 "iter": the Gtk.Tree_Model.Gtk_Tree_Iter

Ref_Node

procedure Ref_Node 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter);

Row_Changed

procedure Row_Changed 
(Tree_Model: Gtk_Tree_Model;
Path: Gtk_Tree_Path;
Iter: Gtk_Tree_Iter);
Emits the Gtk.Tree_Model.Gtk_Tree_Model::row-changed signal on Tree_Model. "path": a Gtk.Tree_Model.Gtk_Tree_Path pointing to the changed row "iter": a valid Gtk.Tree_Model.Gtk_Tree_Iter pointing to the changed row

Row_Deleted

procedure Row_Deleted 
(Tree_Model: Gtk_Tree_Model;
Path: Gtk_Tree_Path);
Emits the Gtk.Tree_Model.Gtk_Tree_Model::row-deleted signal on Tree_Model. This should be called by models after a row has been removed. The location pointed to by Path should be the location that the row previously was at. It may not be a valid location anymore. Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released. "path": a Gtk.Tree_Model.Gtk_Tree_Path pointing to the previous location of the deleted row

Row_Has_Child_Toggled

procedure Row_Has_Child_Toggled 
(Tree_Model: Gtk_Tree_Model;
Path: Gtk_Tree_Path;
Iter: Gtk_Tree_Iter);
Emits the Gtk.Tree_Model.Gtk_Tree_Model::row-has-child-toggled signal on Tree_Model. This should be called by models after the child state of a node changes. "path": a Gtk.Tree_Model.Gtk_Tree_Path pointing to the changed row "iter": a valid Gtk.Tree_Model.Gtk_Tree_Iter pointing to the changed row

Row_Inserted

procedure Row_Inserted 
(Tree_Model: Gtk_Tree_Model;
Path: Gtk_Tree_Path;
Iter: Gtk_Tree_Iter);
Emits the Gtk.Tree_Model.Gtk_Tree_Model::row-inserted signal on Tree_Model. "path": a Gtk.Tree_Model.Gtk_Tree_Path pointing to the inserted row "iter": a valid Gtk.Tree_Model.Gtk_Tree_Iter pointing to the inserted row

Rows_Reordered

procedure Rows_Reordered 
(Tree_Model: Gtk_Tree_Model;
Path: Gtk_Tree_Path;
Iter: Gtk_Tree_Iter;
New_Order: Gint_Array);
Emits the Gtk.Tree_Model.Gtk_Tree_Model::rows-reordered signal on Tree_Model. This should be called by models when their rows have been reordered. "path": a Gtk.Tree_Model.Gtk_Tree_Path pointing to the tree node whose children have been reordered "iter": a valid Gtk.Tree_Model.Gtk_Tree_Iter pointing to the node whose children have been reordered, or null if the depth of Path is 0 "new_order": an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. New_Order'[newpos] = oldpos'

Unref_Node

procedure Unref_Node 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter);

Iter_Copy

function Iter_Copy 
(Self: Gtk_Tree_Iter) return Gtk_Tree_Iter;

Append_Index

procedure Append_Index 
(Path: Gtk_Tree_Path;
Index: Gint);
Appends a new index to a path. As a result, the depth of the path is increased. "index_": the index

Compare

function Compare 
(Path: Gtk_Tree_Path;
B: Gtk_Tree_Path) return Gint;
Compares two paths. If A appears before B in a tree, then -1 is returned. If B appears before A, then 1 is returned. If the two nodes are equal, then 0 is returned. "b": a Gtk.Tree_Model.Gtk_Tree_Path to compare with

Copy

function Copy 
(Path: Gtk_Tree_Path) return Gtk_Tree_Path;
Creates a new Gtk.Tree_Model.Gtk_Tree_Path as a copy of Path.

Down

procedure Down 
(Path: Gtk_Tree_Path);
Moves Path to point to the first child of the current path.

Path_Free

procedure Path_Free 
(Path: Gtk_Tree_Path);
Frees Path. If Path is null, it simply returns.

Get_Depth

function Get_Depth 
(Path: Gtk_Tree_Path) return Gint;
Returns the current depth of Path.

Get_Indices

function Get_Indices 
(Path: Gtk_Tree_Path) return Glib.Gint_Array;
Returns the current indices of Path. This is an array of integers, each representing a node in a tree. This value should not be freed. The length of the array can be obtained with Gtk.Tree_Model.Get_Depth.

Is_Ancestor

function Is_Ancestor 
(Path: Gtk_Tree_Path;
Descendant: Gtk_Tree_Path) return Boolean;
Returns True if Descendant is a descendant of Path. "descendant": another Gtk.Tree_Model.Gtk_Tree_Path

Is_Descendant

function Is_Descendant 
(Path: Gtk_Tree_Path;
Ancestor: Gtk_Tree_Path) return Boolean;
Returns True if Path is a descendant of Ancestor. "ancestor": another Gtk.Tree_Model.Gtk_Tree_Path

Prepend_Index

procedure Prepend_Index 
(Path: Gtk_Tree_Path;
Index: Gint);
Prepends a new index to a path. As a result, the depth of the path is increased. "index_": the index

Prev

function Prev 
(Path: Gtk_Tree_Path) return Boolean;
Moves the Path to point to the previous node at the current depth, if it exists.

To_String

function To_String 
(Path: Gtk_Tree_Path) return UTF8_String;
Generates a string representation of the path. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.

Up

function Up 
(Path: Gtk_Tree_Path) return Boolean;
Moves the Path to point to its parent node, if it has a parent.

Get_Int

function Get_Int 
(Tree_Model: access Gtk_Root_Tree_Model_Record;
Iter: Gtk_Tree_Iter;
Column: Gint) return Gint;

Get_Boolean

function Get_Boolean 
(Tree_Model: access Gtk_Root_Tree_Model_Record;
Iter: Gtk_Tree_Iter;
Column: Gint) return Boolean;

Get_Object

function Get_Object 
(Tree_Model: access Gtk_Root_Tree_Model_Record;
Iter: Gtk_Tree_Iter;
Column: Gint) return Glib.Object.GObject;

Get_C_Proxy

function Get_C_Proxy 
(Tree_Model: access Gtk_Root_Tree_Model_Record;
Iter: Gtk_Tree_Iter;
Column: Gint) return Glib.C_Proxy;

Get_String

function Get_String 
(Tree_Model: access Gtk_Root_Tree_Model_Record;
Iter: Gtk_Tree_Iter;
Column: Gint) return UTF8_String;

Get_Address

function Get_Address 
(Tree_Model: access Gtk_Root_Tree_Model_Record;
Iter: Gtk_Tree_Iter;
Column: Gint) return System.Address;
Get the value of one cell of the model

Get_Int

function Get_Int 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter;
Column: Gint) return Gint;

Get_Boolean

function Get_Boolean 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter;
Column: Gint) return Boolean;

Get_Object

function Get_Object 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter;
Column: Gint) return Glib.Object.GObject;

Get_C_Proxy

function Get_C_Proxy 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter;
Column: Gint) return Glib.C_Proxy;

Get_String

function Get_String 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter;
Column: Gint) return UTF8_String;

Get_Address

function Get_Address 
(Tree_Model: Gtk_Tree_Model;
Iter: Gtk_Tree_Iter;
Column: Gint) return System.Address;

To_Interface

function To_Interface 
(Widget: access Gtk_Root_Tree_Model_Record'Class) return Gtk_Tree_Model renames Implements_Gtk_Tree_Model.To_Interface;

-

Convert from the gtk+ interface to an actual object. The return type depends on the exact model, and will likely be an instance of Gtk_Tree_Store'Class or Gtk_List_Store'Class depending on how you created it.

=

function "=" 
(Left: Gtk_Tree_Iter;
Right: Gtk_Tree_Iter) return Boolean;

Set_Tree_Iter

procedure Set_Tree_Iter 
(Val: in out Glib.Values.GValue;
Iter: Gtk_Tree_Iter);

Get_Tree_Iter

procedure Get_Tree_Iter 
(Val: Glib.Values.GValue;
Iter: out Gtk_Tree_Iter);
Extract the iterator from the given GValue. Note that the iterator returned is a copy of the iterator referenced by the give GValue. Modifying the iterator returned does not modify the iterator referenced by the GValue.

Get_Tree_Iter

function Get_Tree_Iter 
(Val: Glib.Values.GValue) return Gtk_Tree_Iter;
Extract the iterator from the given GValue.

To_Address

function To_Address 
(Iter: Gtk_Tree_Iter) return System.Address;

Iter_Or_Null

function Iter_Or_Null 
(Iter: System.Address) return System.Address;
Internal function for GtkAda

Get_Tree_Path

function Get_Tree_Path 
(Val: Glib.Values.GValue) return Gtk_Tree_Path;
Extract the path from the given GValue.

Convert

function Convert 
(R: Gtk.Tree_Model.Gtk_Tree_Path) return System.Address;

Convert

function Convert 
(R: System.Address) return Gtk.Tree_Model.Gtk_Tree_Path;

On_Row_Changed

procedure On_Row_Changed 
(Self: Gtk_Tree_Model;
Call: Cb_Gtk_Tree_Model_Gtk_Tree_Path_Gtk_Tree_Iter_Void;
After: Boolean := False);

On_Row_Changed

procedure On_Row_Changed 
(Self: Gtk_Tree_Model;
Call: Cb_GObject_Gtk_Tree_Path_Gtk_Tree_Iter_Void;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
This signal is emitted when a row in the model has changed. Callback parameters: -- "path": a Gtk.Tree_Model.Gtk_Tree_Path identifying the changed row -- "iter": a valid Gtk.Tree_Model.Gtk_Tree_Iter pointing to the changed -- row

On_Row_Deleted

procedure On_Row_Deleted 
(Self: Gtk_Tree_Model;
Call: Cb_Gtk_Tree_Model_Gtk_Tree_Path_Void;
After: Boolean := False);

On_Row_Deleted

procedure On_Row_Deleted 
(Self: Gtk_Tree_Model;
Call: Cb_GObject_Gtk_Tree_Path_Void;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
This signal is emitted when a row has been deleted. Note that no iterator is passed to the signal handler, since the row is already deleted. This should be called by models after a row has been removed. The location pointed to by Path should be the location that the row previously was at. It may not be a valid location anymore.

On_Row_Has_Child_Toggled

procedure On_Row_Has_Child_Toggled 
(Self: Gtk_Tree_Model;
Call: Cb_Gtk_Tree_Model_Gtk_Tree_Path_Gtk_Tree_Iter_Void;
After: Boolean := False);

On_Row_Has_Child_Toggled

procedure On_Row_Has_Child_Toggled 
(Self: Gtk_Tree_Model;
Call: Cb_GObject_Gtk_Tree_Path_Gtk_Tree_Iter_Void;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
This signal is emitted when a row has gotten the first child row or lost its last child row. Callback parameters: -- "path": a Gtk.Tree_Model.Gtk_Tree_Path identifying the row -- "iter": a valid Gtk.Tree_Model.Gtk_Tree_Iter pointing to the row

On_Row_Inserted

procedure On_Row_Inserted 
(Self: Gtk_Tree_Model;
Call: Cb_Gtk_Tree_Model_Gtk_Tree_Path_Gtk_Tree_Iter_Void;
After: Boolean := False);

On_Row_Inserted

procedure On_Row_Inserted 
(Self: Gtk_Tree_Model;
Call: Cb_GObject_Gtk_Tree_Path_Gtk_Tree_Iter_Void;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
This signal is emitted when a new row has been inserted in the model. Note that the row may still be empty at this point, since it is a common pattern to first insert an empty row, and then fill it with the desired values. Callback parameters: -- "path": a Gtk.Tree_Model.Gtk_Tree_Path identifying the new row -- "iter": a valid Gtk.Tree_Model.Gtk_Tree_Iter pointing to the new row

On_Rows_Reordered

procedure On_Rows_Reordered 
(Self: Gtk_Tree_Model;
Call: Cb_Gtk_Tree_Model_Gtk_Tree_Path_Gtk_Tree_Iter_Address_Void;
After: Boolean := False);

On_Rows_Reordered

procedure On_Rows_Reordered 
(Self: Gtk_Tree_Model;
Call: Cb_GObject_Gtk_Tree_Path_Gtk_Tree_Iter_Address_Void;
Slot: not null access Glib.Object.GObject_Record'Class;
After: Boolean := False);
This signal is emitted when the children of a node in the Gtk.Tree_Model.Gtk_Tree_Model have been reordered. Note that this signal is *not* emitted when rows are reordered by DND, since this is implemented by removing and then reinserting the row. Callback parameters: -- "path": a Gtk.Tree_Model.Gtk_Tree_Path identifying the tree node whose -- children have been reordered -- "iter": a valid Gtk.Tree_Model.Gtk_Tree_Iter pointing to the node whose -- "new_order": an array of integers mapping the current position of each -- child to its old position before the re-ordering, i.e. -- New_Order'[newpos] = oldpos'

+

function "+" 
(W: Gtk_Tree_Model) return Gtk_Tree_Model;