Gtk.Tree_Model

Entities

Simple Types

Tagged Types

Access Types

Subtypes

Constants

Subprograms

Generic Instantiations

Description

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-struct and the Gtk.Tree_Model.Gtk_Tree_Iter-struct ("iter" is short for iterator). Most of the interface consists of operations on a Gtk.Tree_Model.Gtk_Tree_Iter-struct.

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 0 refers to the root node and the path 2:4 refers to the fifth child of the third node.

By contrast, a Gtk.Tree_Model.Gtk_Tree_Iter-struct 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 3:2:5. While the first method shown is easier, the second is much more common, as you often get paths from callbacks.

## Acquiring a Gtk.Tree_Model.Gtk_Tree_Iter-struct

// 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,
                                     &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, &iter, path);
gtk_tree_path_free (path);

// walk the tree to find the iterator
gtk_tree_model_iter_nth_child (model, &iter,
                               NULL, 3);
parent_iter = iter;
gtk_tree_model_iter_nth_child (model, &iter,
                               &parent_iter, 2);
parent_iter = iter;
gtk_tree_model_iter_nth_child (model, &iter,
                               &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 populate_model 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 Gtk.Tree_Model.Gtk_Tree_Model

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.

valid = gtk_tree_model_get_iter_first (list_store,
                                       &iter);
while (valid)
 {
   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, &iter,
                       STRING_COLUMN, &str_data,
                       INT_COLUMN, &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);

   valid = gtk_tree_model_iter_next (list_store,
                                     &iter);
   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:

parent. This means that all parent nodes of a referenced node must be referenced as well.

possible because the node has already been deleted by the time the row-deleted signal is received.

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

"+"

function "+" (W : Gtk_Tree_Model) return Gtk_Tree_Model
Parameters
W
Return Value

"-"

function "-"
  (Interf : Gtk_Tree_Model) return Gtk_Root_Tree_Model

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.

Parameters
Interf
Return Value

"="

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

Append_Index

procedure Append_Index (Path : Gtk_Tree_Path; Index : Glib.Gint)

Appends a new index to a path. As a result, the depth of the path is increased.

Parameters
Path
Index

the index

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);
Parameters
Self
Path
Iter
New_Order

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);
Parameters
Self
Path
Iter

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);
Parameters
Self
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);
Parameters
Self
Path
Iter
New_Order

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);
Parameters
Self
Path
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);
Parameters
Self
Path

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);

Parameters
Tree_Model
Parent

the Gtk.Tree_Model.Gtk_Tree_Iter-struct, or null

Return Value

Compare

function Compare
   (Path : Gtk_Tree_Path;
    B    : Gtk_Tree_Path) return Glib.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.

Parameters
Path
B

a Gtk.Tree_Model.Gtk_Tree_Path-struct to compare with

Return Value

the relative positions of A and B

Convert

function Convert (R : Gtk.Tree_Model.Gtk_Tree_Path) return System.Address
Parameters
R
Return Value

Convert

function Convert (R : System.Address) return Gtk.Tree_Model.Gtk_Tree_Path
Parameters
R
Return Value

Copy

function Copy (Path : Gtk_Tree_Path) return Gtk_Tree_Path

Creates a new Gtk.Tree_Model.Gtk_Tree_Path-struct as a copy of Path.

Parameters
Path
Return Value

a new Gtk.Tree_Model.Gtk_Tree_Path-struct

Down

procedure Down (Path : Gtk_Tree_Path)

Moves Path to point to the first child of the current path.

Parameters
Path

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.

Parameters
Tree_Model
Func

a function to be called on each row

Free

procedure Free (Self : Gtk_Tree_Iter)

Frees an iterator that has been allocated by Gtk.Tree_Model.Iter_Copy. This function is mainly used for language bindings.

Parameters
Self

From_Object

function From_Object (Object : System.Address) return Gtk_Tree_Path
Parameters
Object
Return Value

From_Object_Free

function From_Object_Free (B : access Gtk_Tree_Iter) return Gtk_Tree_Iter

The Gtk.Tree_Model.Gtk_Tree_Iter is the primary structure for accessing a Gtk.Tree_Model.Gtk_Tree_Model. Models are expected to put a unique integer in the Stamp member, and put model-specific data in the three User_Data members.

Parameters
B
Return Value

From_Object_Free

function From_Object_Free (B : access Gtk_Tree_Path'Class) return Gtk_Tree_Path
Parameters
B
Return Value

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

Parameters
Tree_Model
Iter
Column
Return Value

Get_Address

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

Get_Boolean

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

Get the value of one cell of the model

Parameters
Tree_Model
Iter
Column
Return Value

Get_Boolean

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

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 the value of one cell of the model

Parameters
Tree_Model
Iter
Column
Return Value

Get_C_Proxy

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

Get_Column_Type

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

Returns the type of the column.

Parameters
Tree_Model
Index

the column index

Return Value

the type of the column

Get_Depth

function Get_Depth (Path : Gtk_Tree_Path) return Glib.Gint

Returns the current depth of Path.

Parameters
Path
Return Value

The depth of Path

Get_Flags

function Get_Flags (Tree_Model : Gtk_Tree_Model) return Tree_Model_Flags

Returns a set of flags supported by this interface. The flags are a bitwise combination of Gtk.Tree_Model.Tree_Model_Flags. The flags supported should not change during the lifetime of the Tree_Model.

Parameters
Tree_Model
Return Value

the flags supported by this interface

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.

Parameters
Path
Return Value

Get_Int

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

Get the value of one cell of the model

Parameters
Tree_Model
Iter
Column
Return Value

Get_Int

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

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.

Parameters
Tree_Model
Path

the Gtk.Tree_Model.Gtk_Tree_Path-struct

Return Value

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.

Parameters
Tree_Model
Return Value

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.

Parameters
Tree_Model
Path_String

a string representation of a Gtk.Tree_Model.Gtk_Tree_Path-struct

Return Value

Get_N_Columns

function Get_N_Columns (Tree_Model : Gtk_Tree_Model) return Glib.Gint

Returns the number of columns supported by Tree_Model.

Parameters
Tree_Model
Return Value

the number of columns

Get_Object

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

Get the value of one cell of the model

Parameters
Tree_Model
Iter
Column
Return Value

Get_Object

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

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-struct referenced by Iter. This path should be freed with Gtk.Tree_Model.Path_Free.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Return Value

a newly-created Gtk.Tree_Model.Gtk_Tree_Path-struct

Get_String

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

Get the value of one cell of the model

Parameters
Tree_Model
Iter
Column
Return Value

Get_String

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

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

Parameters
Tree_Model
Iter

a Gtk.Tree_Model.Gtk_Tree_Iter-struct

Return Value

a newly-allocated string. Must be freed with g_free.

Get_Tree_Iter

function Get_Tree_Iter (Val : Glib.Values.GValue) return Gtk_Tree_Iter

Extract the iterator from the given GValue.

Parameters
Val
Return Value

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.

Parameters
Val
Iter

Get_Tree_Path

function Get_Tree_Path (Val : Glib.Values.GValue) return Gtk_Tree_Path

Extract the path from the given GValue.

Parameters
Val
Return Value

Get_Type

function Get_Type return Glib.GType
Return Value

Get_Ulong

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

Get the value of one cell of the model

Parameters
Tree_Model
Iter
Column
Return Value

Get_Ulong

function Get_Ulong
  (Tree_Model : Gtk_Tree_Model;
   Iter       : Gtk_Tree_Iter;
   Column     : Gint) return Gulong
Parameters
Tree_Model
Iter
Column
Return Value

Get_Value

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

Initializes and sets Value to that at Column. When done with Value, g_value_unset needs to be called to free any allocated memory.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Column

the column to lookup the value at

Value

an empty Glib.Values.GValue to set

Gtk_Filter_New

procedure Gtk_Filter_New
   (Tree_Model : out Gtk_Tree_Model;
    Root       : Gtk_Tree_Path)

Creates a new Gtk.Tree_Model.Gtk_Tree_Model, with Child_Model as the child_model and Root as the virtual root. Since: gtk+ 2.4

Parameters
Tree_Model
Root

A Gtk.Tree_Model.Gtk_Tree_Path or null.

Gtk_New

procedure Gtk_New (Path : out Gtk_Tree_Path)

Creates a new Gtk.Tree_Model.Gtk_Tree_Path-struct. This refers to a row.

Parameters
Path

Gtk_New

procedure Gtk_New (Self : out Gtk_Tree_Path; Path : UTF8_String)

Creates a new Gtk.Tree_Model.Gtk_Tree_Path-struct 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.

Parameters
Self
Path

The string representation of a path

Gtk_New_First

procedure Gtk_New_First (Path : out Gtk_Tree_Path)

Creates a new Gtk.Tree_Model.Gtk_Tree_Path-struct. The string representation of this path is "0".

Parameters
Path

Gtk_New_From_Indicesv

procedure Gtk_New_From_Indicesv
   (Path    : out Gtk_Tree_Path;
    Indices : Gint_Array;
    Length  : Gsize)

Creates a new path with the given Indices array of Length. Since: gtk+ 3.12

Parameters
Path
Indices

array of indices

Length

length of Indices array

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.

Gtk_Root_Tree_Model_Record

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

A common base type for all objects that implement GtkTreeModel. This is used to conveniently provide a number of primitive operations.

Gtk_Tree_Iter

type Gtk_Tree_Iter is private;

The Gtk.Tree_Model.Gtk_Tree_Iter is the primary structure for accessing a Gtk.Tree_Model.Gtk_Tree_Model. Models are expected to put a unique integer in the Stamp member, and put model-specific data in the three User_Data members.

Gtk_Tree_Model

type Gtk_Tree_Model is new Glib.Types.GType_Interface;

Gtk_Tree_Model_Filter_New

function Gtk_Tree_Model_Filter_New
   (Root : Gtk_Tree_Path) return Gtk_Tree_Model

Creates a new Gtk.Tree_Model.Gtk_Tree_Model, with Child_Model as the child_model and Root as the virtual root. Since: gtk+ 2.4

Parameters
Root

A Gtk.Tree_Model.Gtk_Tree_Path or null.

Return Value

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.

Parameters
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

Return Value

True to stop iterating, False to continue

Gtk_Tree_Path

type Gtk_Tree_Path is new Glib.C_Boxed with null record;

Gtk_Tree_Path_List

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

Gtk_Tree_Path_New

function Gtk_Tree_Path_New return Gtk_Tree_Path

Creates a new Gtk.Tree_Model.Gtk_Tree_Path-struct. This refers to a row.

Return Value

Gtk_Tree_Path_New_First

function Gtk_Tree_Path_New_First return Gtk_Tree_Path

Creates a new Gtk.Tree_Model.Gtk_Tree_Path-struct. The string representation of this path is "0".

Return Value

Gtk_Tree_Path_New_From_Indicesv

function Gtk_Tree_Path_New_From_Indicesv
   (Indices : Gint_Array;
    Length  : Gsize) return Gtk_Tree_Path

Creates a new path with the given Indices array of Length. Since: gtk+ 3.12

Parameters
Indices

array of indices

Length

length of Indices array

Return Value

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

Parameters
Path

The string representation of a path

Return Value

Has_Child

function Has_Child
   (Tree_Model : Gtk_Tree_Model;
    Iter       : Gtk_Tree_Iter) return Boolean

Returns True if Iter has children, False otherwise.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct to test for children

Return Value

True if Iter has children

Implements_Gtk_Tree_Model

package Implements_Gtk_Tree_Model is new Glib.Types.Implements
  (Gtk_Tree_Model, Gtk_Root_Tree_Model_Record, Gtk_Root_Tree_Model);

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.

Is_Ancestor

function Is_Ancestor
   (Path       : Gtk_Tree_Path;
    Descendant : Gtk_Tree_Path) return Boolean

Returns True if Descendant is a descendant of Path.

Parameters
Path
Descendant

another Gtk.Tree_Model.Gtk_Tree_Path-struct

Return Value

True if Descendant is contained inside 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.

Parameters
Path
Ancestor

another Gtk.Tree_Model.Gtk_Tree_Path-struct

Return Value

True if Ancestor contains Path somewhere below it

Iter_Copy

function Iter_Copy (Self : Gtk_Tree_Iter) return Gtk_Tree_Iter

Creates a dynamically allocated tree iterator as a copy of Iter. This function is not intended for use in applications, because you can just copy the structs by value (GtkTreeIter new_iter = iter;). You must free this iter with Gtk.Tree_Model.Free.

Parameters
Self
Return Value

a newly-allocated copy of Iter

Iter_Get_Type

function Iter_Get_Type return Glib.GType
Return Value

Iter_Or_Null

function Iter_Or_Null (Iter : System.Address) return System.Address

Internal function for GtkAda

Parameters
Iter
Return Value

N_Children

function N_Children
   (Tree_Model : Gtk_Tree_Model;
    Iter       : Gtk_Tree_Iter := Gtk.Tree_Model.Null_Iter)
    return Glib.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.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct, or null

Return Value

the number of children of Iter

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.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Next

procedure Next (Path : Gtk_Tree_Path)

Moves the Path to point to the next node at the current depth.

Parameters
Path

Nth_Child

function Nth_Child
   (Tree_Model : Gtk_Tree_Model;
    Parent     : Gtk_Tree_Iter;
    N          : Glib.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.

Parameters
Tree_Model
Parent

the Gtk.Tree_Model.Gtk_Tree_Iter-struct to get the child from, or null.

N

the index of the desired child

Return Value

Null_Gtk_Tree_Model

Null_Gtk_Tree_Model : constant Gtk_Tree_Model;

Null_Gtk_Tree_Path

Null_Gtk_Tree_Path : constant Gtk_Tree_Path;

Null_Iter

Null_Iter : constant Gtk_Tree_Iter;

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: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the -- changed row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- changed row

Parameters
Self
Call
Slot
After

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)

This signal is emitted when a row in the model has changed.

Callback parameters: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the -- changed row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- changed row

Parameters
Self
Call
After

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.

Parameters
Self
Call
Slot
After

On_Row_Deleted

procedure On_Row_Deleted
   (Self  : Gtk_Tree_Model;
    Call  : Cb_Gtk_Tree_Model_Gtk_Tree_Path_Void;
    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.

Parameters
Self
Call
After

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: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- row

Parameters
Self
Call
Slot
After

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)

This signal is emitted when a row has gotten the first child row or lost its last child row.

Callback parameters: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- row

Parameters
Self
Call
After

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: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the new -- row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- new row

Parameters
Self
Call
Slot
After

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)

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: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the new -- row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- new row

Parameters
Self
Call
After

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: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the tree -- node whose children have been reordered -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- node whose children have been reordered, or null if the depth of Path is -- 0 -- @param 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

Parameters
Self
Call
Slot
After

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)

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: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the tree -- node whose children have been reordered -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- node whose children have been reordered, or null if the depth of Path is -- 0 -- @param 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

Parameters
Self
Call
After

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. Iter will be initialized before the lookup is performed, so Child and Iter cannot point to the same memory location.

Parameters
Tree_Model
Child

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Return Value

Path_Free

procedure Path_Free (Path : Gtk_Tree_Path)

Frees Path. If Path is null, it simply returns.

Parameters
Path

Path_Get_Type

function Path_Get_Type return Glib.GType
Return Value

Prepend_Index

procedure Prepend_Index (Path : Gtk_Tree_Path; Index : Glib.Gint)

Prepends a new index to a path. As a result, the depth of the path is increased.

Parameters
Path
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.

Parameters
Path
Return Value

True if Path has a previous node, and the move was made

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

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Property_Tree_Model_Flags

type Property_Tree_Model_Flags is new Tree_Model_Flags_Properties.Property;

Ref_Node

procedure Ref_Node (Tree_Model : Gtk_Tree_Model; Iter : Gtk_Tree_Iter)

Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. This function is primarily meant as a way for views to let caching models know when nodes are being displayed (and hence, whether or not to cache that node). Being displayed means a node is in an expanded branch, regardless of whether the node is currently visible in the viewport. For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view. A model should be expected to be able to get an iter independent of its reffed state.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

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.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the changed row

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct 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.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct 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.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the changed row

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct 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.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the inserted row

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct 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.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the tree node whose children have been reordered

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct 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

Rows_Reordered_With_Length

procedure Rows_Reordered_With_Length
   (Tree_Model : Gtk_Tree_Model;
    Path       : Gtk_Tree_Path;
    Iter       : Gtk_Tree_Iter;
    New_Order  : Gint_Array;
    Length     : Glib.Gint)

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. Since: gtk+ 3.10

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the tree node whose children have been reordered

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct 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

Length

length of New_Order array

Set_Get_Column_Type

procedure Set_Get_Column_Type
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Get_Column_Type)
Parameters
Self
Handler

Set_Get_Flags

procedure Set_Get_Flags
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Get_Flags)
Parameters
Self
Handler

Set_Get_Iter

procedure Set_Get_Iter
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Get_Iter)
Parameters
Self
Handler

Set_Get_N_Columns

procedure Set_Get_N_Columns
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Get_N_Columns)
Parameters
Self
Handler

Set_Get_Path

procedure Set_Get_Path
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Get_Path)
Parameters
Self
Handler

Set_Get_Value

procedure Set_Get_Value
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Get_Value)
Parameters
Self
Handler

Set_Iter_Children

procedure Set_Iter_Children
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Iter_Children)
Parameters
Self
Handler

Set_Iter_Has_Child

procedure Set_Iter_Has_Child
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Iter_Has_Child)
Parameters
Self
Handler

Set_Iter_N_Children

procedure Set_Iter_N_Children
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Iter_N_Children)
Parameters
Self
Handler

Set_Iter_Next

procedure Set_Iter_Next
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Iter_Next)
Parameters
Self
Handler

Set_Iter_Nth_Child

procedure Set_Iter_Nth_Child
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Iter_Nth_Child)
Parameters
Self
Handler

Set_Iter_Parent

procedure Set_Iter_Parent
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Iter_Parent)
Parameters
Self
Handler

Set_Iter_Previous

procedure Set_Iter_Previous
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Iter_Previous)
Parameters
Self
Handler

Set_Ref_Node

procedure Set_Ref_Node
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Ref_Node)
Parameters
Self
Handler

Set_Row_Changed

procedure Set_Row_Changed
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Row_Changed)
Parameters
Self
Handler

Set_Row_Deleted

procedure Set_Row_Deleted
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Row_Deleted)
Parameters
Self
Handler

Set_Row_Has_Child_Toggled

procedure Set_Row_Has_Child_Toggled
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Row_Has_Child_Toggled)
Parameters
Self
Handler

Set_Row_Inserted

procedure Set_Row_Inserted
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Row_Inserted)
Parameters
Self
Handler

Set_Rows_Reordered

procedure Set_Rows_Reordered
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Rows_Reordered)
Parameters
Self
Handler

Set_Tree_Iter

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

Set the value of the given GValue to Iter. Note that Iter is stored by reference, which means no copy of Iter is made. Iter should remain allocated as long as Val is being used.

Parameters
Val
Iter

Set_Unref_Node

procedure Set_Unref_Node
  (Self    : Tree_Model_Interface_Descr;
   Handler : Virtual_Unref_Node)

See Glib.Object.Add_Interface

Parameters
Self
Handler

Signal_Row_Changed

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

This signal is emitted when a row in the model has changed.

Callback parameters: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the -- changed row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- changed row

Signal_Row_Deleted

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

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.

Signal_Row_Has_Child_Toggled

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

This signal is emitted when a row has gotten the first child row or lost its last child row.

Callback parameters: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- row

Signal_Row_Inserted

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

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: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the new -- row -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- new row

Signal_Rows_Reordered

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

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: -- @param Path a Gtk.Tree_Model.Gtk_Tree_Path-struct identifying the tree -- node whose children have been reordered -- @param Iter a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the -- node whose children have been reordered, or null if the depth of Path is -- 0 -- @param 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

To_Address

function To_Address (Iter : Gtk_Tree_Iter) return System.Address

Return address of the specified iterator. Note: To_Address needs a pass-by-reference semantic to work properly On some ABIs (e.g. IA64), Gtk_Tree_Iter is passed by copy, since it's a "small enough" record.

Parameters
Iter
Return Value

To_Interface

function To_Interface
  (Widget : access Gtk_Root_Tree_Model_Record'Class)
return Gtk_Tree_Model

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.

Parameters
Widget
Return Value

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.

Parameters
Path
Return Value

A newly-allocated string. Must be freed with g_free.

Tree_Model_Flags

type Tree_Model_Flags is mod 2 ** Integer'Size;

These flags indicate various properties of a Gtk.Tree_Model.Gtk_Tree_Model.

They are returned by Gtk.Tree_Model.Get_Flags, and must be static for the lifetime of the object. A more complete description of GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of this section.

Tree_Model_Flags_Properties

package Tree_Model_Flags_Properties is
   new Generic_Internal_Discrete_Property (Tree_Model_Flags);

Tree_Model_Interface_Descr

subtype Tree_Model_Interface_Descr is Glib.Object.Interface_Description;

Tree_Model_Iters_Persist

Tree_Model_Iters_Persist : constant Tree_Model_Flags := 1;

Tree_Model_List_Only

Tree_Model_List_Only : constant Tree_Model_Flags := 2;

Unref_Node

procedure Unref_Node (Tree_Model : Gtk_Tree_Model; Iter : Gtk_Tree_Iter)

Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see Gtk.Tree_Model.Ref_Node. Please note that nodes that are deleted are not unreffed.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Up

function Up (Path : Gtk_Tree_Path) return Boolean

Moves the Path to point to its parent node, if it has a parent.

Parameters
Path
Return Value

True if Path has a parent, and the move was made

Virtual_Get_Column_Type

type Virtual_Get_Column_Type is access function
  (Tree_Model : Gtk_Tree_Model;
   Index      : Glib.Gint) return GType;

Returns the type of the column.

Parameters
Tree_Model
Index

the column index

Return Value

the type of the column

Virtual_Get_Flags

type Virtual_Get_Flags is access function (Tree_Model : Gtk_Tree_Model) return Tree_Model_Flags;

Returns a set of flags supported by this interface. The flags are a bitwise combination of Gtk.Tree_Model.Tree_Model_Flags. The flags supported should not change during the lifetime of the Tree_Model.

Parameters
Tree_Model
Return Value

the flags supported by this interface

Virtual_Get_Iter

type Virtual_Get_Iter is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : access Gtk_Tree_Iter;
   Path       : System.Address) return Glib.Gboolean;

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.

Parameters
Tree_Model
Iter

the uninitialized Gtk.Tree_Model.Gtk_Tree_Iter-struct

Path

the Gtk.Tree_Model.Gtk_Tree_Path-struct

Return Value

True, if Iter was set

Virtual_Get_N_Columns

type Virtual_Get_N_Columns is access function (Tree_Model : Gtk_Tree_Model) return Glib.Gint;

Returns the number of columns supported by Tree_Model.

Parameters
Tree_Model
Return Value

the number of columns

Virtual_Get_Path

type Virtual_Get_Path is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : Gtk_Tree_Iter) return System.Address;

Returns a newly-created Gtk.Tree_Model.Gtk_Tree_Path-struct referenced by Iter. This path should be freed with gtk_tree_path_free.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Return Value

a newly-created Gtk.Tree_Model.Gtk_Tree_Path-struct

Virtual_Get_Value

type Virtual_Get_Value is access procedure
  (Tree_Model : Gtk_Tree_Model;
   Iter       : Gtk_Tree_Iter;
   Column     : Glib.Gint;
   Value      : out Glib.Values.GValue);

Initializes and sets Value to that at Column. When done with Value, g_value_unset needs to be called to free any allocated memory.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Column

the column to lookup the value at

Value

an empty Glib.Values.GValue to set

Virtual_Iter_Children

type Virtual_Iter_Children is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : access Gtk_Tree_Iter;
   Parent     : access Gtk_Tree_Iter) return Glib.Gboolean;

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);

Parameters
Tree_Model
Iter

the new Gtk.Tree_Model.Gtk_Tree_Iter-struct to be set to the child

Parent

the Gtk.Tree_Model.Gtk_Tree_Iter-struct, or null

Return Value

True, if Iter has been set to the first child

Virtual_Iter_Has_Child

type Virtual_Iter_Has_Child is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : Gtk_Tree_Iter) return Glib.Gboolean;

Returns True if Iter has children, False otherwise.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct to test for children

Return Value

True if Iter has children

Virtual_Iter_N_Children

type Virtual_Iter_N_Children is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : access Gtk_Tree_Iter) return Glib.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.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct, or null

Return Value

the number of children of Iter

Virtual_Iter_Next

type Virtual_Iter_Next is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : access Gtk_Tree_Iter) return Glib.Gboolean;

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.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Return Value

True if Iter has been changed to the next node

Virtual_Iter_Nth_Child

type Virtual_Iter_Nth_Child is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : access Gtk_Tree_Iter;
   Parent     : access Gtk_Tree_Iter;
   N          : Glib.Gint) return Glib.Gboolean;

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.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct to set to the nth child

Parent

the Gtk.Tree_Model.Gtk_Tree_Iter-struct to get the child from, or null.

N

the index of the desired child

Return Value

True, if Parent has an N-th child

Virtual_Iter_Parent

type Virtual_Iter_Parent is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : access Gtk_Tree_Iter;
   Child      : Gtk_Tree_Iter) return Glib.Gboolean;

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. Iter will be initialized before the lookup is performed, so Child and Iter cannot point to the same memory location.

Parameters
Tree_Model
Iter

the new Gtk.Tree_Model.Gtk_Tree_Iter-struct to set to the parent

Child

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Return Value

True, if Iter is set to the parent of Child

Virtual_Iter_Previous

type Virtual_Iter_Previous is access function
  (Tree_Model : Gtk_Tree_Model;
   Iter       : Gtk_Tree_Iter) return Glib.Gboolean;

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

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Return Value

True if Iter has been changed to the previous node

Virtual_Ref_Node

type Virtual_Ref_Node is access procedure (Tree_Model : Gtk_Tree_Model; Iter : Gtk_Tree_Iter);

Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. This function is primarily meant as a way for views to let caching models know when nodes are being displayed (and hence, whether or not to cache that node). Being displayed means a node is in an expanded branch, regardless of whether the node is currently visible in the viewport. For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view. A model should be expected to be able to get an iter independent of its reffed state.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct

Virtual_Row_Changed

type Virtual_Row_Changed is access procedure
  (Tree_Model : Gtk_Tree_Model;
   Path       : System.Address;
   Iter       : Gtk_Tree_Iter);

Emits the Gtk.Tree_Model.Gtk_Tree_Model::row-changed signal on Tree_Model.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the changed row

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the changed row

Virtual_Row_Deleted

type Virtual_Row_Deleted is access procedure (Tree_Model : Gtk_Tree_Model; Path : System.Address);

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.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the previous location of the deleted row

Virtual_Row_Has_Child_Toggled

type Virtual_Row_Has_Child_Toggled is access procedure
  (Tree_Model : Gtk_Tree_Model;
   Path       : System.Address;
   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.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the changed row

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the changed row

Virtual_Row_Inserted

type Virtual_Row_Inserted is access procedure
  (Tree_Model : Gtk_Tree_Model;
   Path       : System.Address;
   Iter       : Gtk_Tree_Iter);

Emits the Gtk.Tree_Model.Gtk_Tree_Model::row-inserted signal on Tree_Model.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the inserted row

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct pointing to the inserted row

Virtual_Rows_Reordered

type Virtual_Rows_Reordered is access procedure
  (Tree_Model : Gtk_Tree_Model;
   Path       : System.Address;
   Iter       : Gtk_Tree_Iter;
   New_Order  : in out Glib.Gint);

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.

Parameters
Tree_Model
Path

a Gtk.Tree_Model.Gtk_Tree_Path-struct pointing to the tree node whose children have been reordered

Iter

a valid Gtk.Tree_Model.Gtk_Tree_Iter-struct 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

Virtual_Unref_Node

type Virtual_Unref_Node is access procedure (Tree_Model : Gtk_Tree_Model; Iter : Gtk_Tree_Iter);

Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see Gtk.Tree_Model.Ref_Node. Please note that nodes that are deleted are not unreffed.

Parameters
Tree_Model
Iter

the Gtk.Tree_Model.Gtk_Tree_Iter-struct