Gtk.Tree_Store

Entities

Tagged Types

Access Types

Subprograms

Generic Instantiations

Description

The Gtk.Tree_Store.Gtk_Tree_Store object is a list model for use with a Gtk.Tree_View.Gtk_Tree_View widget. It implements the Gtk.Tree_Model.Gtk_Tree_Model interface, and consequentially, can use all of the methods available there. It also implements the Gtk.Tree_Sortable.Gtk_Tree_Sortable 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 Gtk.Buildable.Gtk_Buildable interface allows to specify the model columns with a <columns> element that may contain multiple <column> 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>

"+"

function "+"
  (Widget : access Gtk_Tree_Store_Record'Class)
return Gtk.Buildable.Gtk_Buildable
Parameters
Widget
Return Value

"+"

function "+"
  (Widget : access Gtk_Tree_Store_Record'Class)
return Gtk.Tree_Drag_Dest.Gtk_Tree_Drag_Dest
Parameters
Widget
Return Value

"+"

function "+"
  (Widget : access Gtk_Tree_Store_Record'Class)
return Gtk.Tree_Drag_Source.Gtk_Tree_Drag_Source
Parameters
Widget
Return Value

"+"

function "+"
  (Widget : access Gtk_Tree_Store_Record'Class)
return Gtk.Tree_Model.Gtk_Tree_Model
Parameters
Widget
Return Value

"+"

function "+"
  (Widget : access Gtk_Tree_Store_Record'Class)
return Gtk.Tree_Sortable.Gtk_Tree_Sortable
Parameters
Widget
Return Value

"-"

function "-"
  (Interf : Gtk.Buildable.Gtk_Buildable)
return Gtk_Tree_Store
Parameters
Interf
Return Value

"-"

function "-"
  (Interf : Gtk.Tree_Drag_Dest.Gtk_Tree_Drag_Dest)
return Gtk_Tree_Store
Parameters
Interf
Return Value

"-"

function "-"
  (Interf : Gtk.Tree_Drag_Source.Gtk_Tree_Drag_Source)
return Gtk_Tree_Store
Parameters
Interf
Return Value

"-"

function "-"
  (Interf : Gtk.Tree_Model.Gtk_Tree_Model)
return Gtk_Tree_Store
Parameters
Interf
Return Value

"-"

function "-"
  (Interf : Gtk.Tree_Sortable.Gtk_Tree_Sortable)
return Gtk_Tree_Store
Parameters
Interf
Return Value

Append

procedure Append
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : out Gtk.Tree_Model.Gtk_Tree_Iter;
    Parent     : Gtk.Tree_Model.Gtk_Tree_Iter)

Appends a new row to Tree_Store. If Parent is non-null, 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.

Parameters
Tree_Store
Iter

An unset Gtk.Tree_Model.Gtk_Tree_Iter to set to the appended row

Parent

A valid Gtk.Tree_Model.Gtk_Tree_Iter, or null

Children

function Children
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Parent     : Gtk.Tree_Model.Gtk_Tree_Iter)
    return Gtk.Tree_Model.Gtk_Tree_Iter
Parameters
Tree_Model
Parent
Return Value

Clear

procedure Clear (Tree_Store : not null access Gtk_Tree_Store_Record)

Removes all rows from Tree_Store

Parameters
Tree_Store

Drag_Data_Delete

function Drag_Data_Delete
   (Self : not null access Gtk_Tree_Store_Record;
    Path : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean
Parameters
Self
Path
Return Value

Drag_Data_Get

function Drag_Data_Get
   (Self           : not null access Gtk_Tree_Store_Record;
    Path           : Gtk.Tree_Model.Gtk_Tree_Path;
    Selection_Data : Gtk.Selection_Data.Gtk_Selection_Data)
    return Boolean
Parameters
Self
Path
Selection_Data
Return Value

Drag_Data_Received

function Drag_Data_Received
   (Self           : not null access Gtk_Tree_Store_Record;
    Dest           : Gtk.Tree_Model.Gtk_Tree_Path;
    Selection_Data : Gtk.Selection_Data.Gtk_Selection_Data)
    return Boolean
Parameters
Self
Dest
Selection_Data
Return Value

Foreach

procedure Foreach
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    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

Freeze_Sort

function Freeze_Sort
  (Tree : access Gtk.Tree_Store.Gtk_Tree_Store_Record'Class)
return Gint

Freeze the sorting in the tree view, and returns the current sort_column_id, which should be used when thawing. (See Thaw_Sort)

Parameters
Tree
Return Value

Get_Column_Type

function Get_Column_Type
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Index      : Glib.Gint) return GType
Parameters
Tree_Model
Index
Return Value

Get_Flags

function Get_Flags
   (Tree_Model : not null access Gtk_Tree_Store_Record)
    return Gtk.Tree_Model.Tree_Model_Flags
Parameters
Tree_Model
Return Value

Get_Iter

function Get_Iter
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Path       : Gtk.Tree_Model.Gtk_Tree_Path)
    return Gtk.Tree_Model.Gtk_Tree_Iter
Parameters
Tree_Model
Path
Return Value

Get_Iter_First

function Get_Iter_First
   (Tree_Model : not null access Gtk_Tree_Store_Record)
    return Gtk.Tree_Model.Gtk_Tree_Iter
Parameters
Tree_Model
Return Value

Get_Iter_From_String

function Get_Iter_From_String
   (Tree_Model  : not null access Gtk_Tree_Store_Record;
    Path_String : UTF8_String) return Gtk.Tree_Model.Gtk_Tree_Iter
Parameters
Tree_Model
Path_String
Return Value

Get_N_Columns

function Get_N_Columns
   (Tree_Model : not null access Gtk_Tree_Store_Record) return Glib.Gint
Parameters
Tree_Model
Return Value

Get_Path

function Get_Path
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter)
    return Gtk.Tree_Model.Gtk_Tree_Path
Parameters
Tree_Model
Iter
Return Value

Get_Sort_Column_Id

procedure Get_Sort_Column_Id
   (Sortable       : not null access Gtk_Tree_Store_Record;
    Sort_Column_Id : out Glib.Gint;
    Order          : out Gtk.Enums.Gtk_Sort_Type)
Parameters
Sortable
Sort_Column_Id
Order

Get_String_From_Iter

function Get_String_From_Iter
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter) return UTF8_String
Parameters
Tree_Model
Iter
Return Value

Get_Type

function Get_Type return Glib.GType
Return Value

Get_Value

procedure Get_Value
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
    Column     : Glib.Gint;
    Value      : out Glib.Values.GValue)
Parameters
Tree_Model
Iter
Column
Value

Gtk_New

procedure Gtk_New (Tree_Store : out Gtk_Tree_Store; Types : GType_Array)

Non vararg creation function. Used primarily by language bindings. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Tree_Store
Types

an array of GType types for the columns, from first to last

Gtk_Tree_Iter_Compare_Func

type Gtk_Tree_Iter_Compare_Func is access function
  (Model : Gtk.Tree_Model.Gtk_Tree_Model;
   A     : Gtk.Tree_Model.Gtk_Tree_Iter;
   B     : Gtk.Tree_Model.Gtk_Tree_Iter) return Glib.Gint;

A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive integer if A sorts before B, A sorts with B, or A sorts after B respectively. If two iters compare as equal, their order in the sorted model is undefined. In order to ensure that the Gtk.Tree_Sortable.Gtk_Tree_Sortable behaves as expected, the GtkTreeIterCompareFunc must define a partial order on the model, i.e. it must be reflexive, antisymmetric and transitive. For example, if Model is a product catalogue, then a compare function for the "price" column could be one which returns price_of(A) - price_of(B).

Parameters
Model

The Gtk.Tree_Model.Gtk_Tree_Model the comparison is within

A

A Gtk.Tree_Model.Gtk_Tree_Iter in Model

B

Another Gtk.Tree_Model.Gtk_Tree_Iter in Model

Return Value

a negative integer, zero or a positive integer depending on whether A sorts before, with or after B

Gtk_Tree_Model_Foreach_Func

type Gtk_Tree_Model_Foreach_Func is access function
  (Model : Gtk.Tree_Model.Gtk_Tree_Model;
   Path  : Gtk.Tree_Model.Gtk_Tree_Path;
   Iter  : Gtk.Tree_Model.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_Store

type Gtk_Tree_Store is access all Gtk_Tree_Store_Record'Class;

Gtk_Tree_Store_Newv

function Gtk_Tree_Store_Newv (Types : GType_Array) return Gtk_Tree_Store

Non vararg creation function. Used primarily by language bindings.

Parameters
Types

an array of GType types for the columns, from first to last

Return Value

Gtk_Tree_Store_Record

type Gtk_Tree_Store_Record is new Gtk_Root_Tree_Model_Record with null record;

Has_Child

function Has_Child
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean
Parameters
Tree_Model
Iter
Return Value

Has_Default_Sort_Func

function Has_Default_Sort_Func
   (Sortable : not null access Gtk_Tree_Store_Record) return Boolean
Parameters
Sortable
Return Value

Implements_Gtk_Buildable

package Implements_Gtk_Buildable is new Glib.Types.Implements
  (Gtk.Buildable.Gtk_Buildable, Gtk_Tree_Store_Record, Gtk_Tree_Store);

Implements_Gtk_Tree_Drag_Dest

package Implements_Gtk_Tree_Drag_Dest is new Glib.Types.Implements
  (Gtk.Tree_Drag_Dest.Gtk_Tree_Drag_Dest, Gtk_Tree_Store_Record, Gtk_Tree_Store);

Implements_Gtk_Tree_Drag_Source

package Implements_Gtk_Tree_Drag_Source is new Glib.Types.Implements
  (Gtk.Tree_Drag_Source.Gtk_Tree_Drag_Source, Gtk_Tree_Store_Record, Gtk_Tree_Store);

Implements_Gtk_Tree_Model

package Implements_Gtk_Tree_Model is new Glib.Types.Implements
  (Gtk.Tree_Model.Gtk_Tree_Model, Gtk_Tree_Store_Record, Gtk_Tree_Store);

Implements_Gtk_Tree_Sortable

package Implements_Gtk_Tree_Sortable is new Glib.Types.Implements
  (Gtk.Tree_Sortable.Gtk_Tree_Sortable, Gtk_Tree_Store_Record, Gtk_Tree_Store);

Initialize

procedure Initialize
   (Tree_Store : not null access Gtk_Tree_Store_Record'Class;
    Types      : GType_Array)

Non vararg creation function. Used primarily by language bindings. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Tree_Store
Types

an array of GType types for the columns, from first to last

Insert

procedure Insert
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : out Gtk.Tree_Model.Gtk_Tree_Iter;
    Parent     : Gtk.Tree_Model.Gtk_Tree_Iter;
    Position   : Glib.Gint)

Creates a new row at Position. If parent is non-null, 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.

Parameters
Tree_Store
Iter

An unset Gtk.Tree_Model.Gtk_Tree_Iter to set to the new row

Parent

A valid Gtk.Tree_Model.Gtk_Tree_Iter, or null

Position

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

Insert_After

procedure Insert_After
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : out Gtk.Tree_Model.Gtk_Tree_Iter;
    Parent     : Gtk.Tree_Model.Gtk_Tree_Iter;
    Sibling    : Gtk.Tree_Model.Gtk_Tree_Iter)

Inserts a new row after Sibling. If Sibling is null, then the row will be prepended to Parent 's children. If Parent and Sibling are null, 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.

Parameters
Tree_Store
Iter

An unset Gtk.Tree_Model.Gtk_Tree_Iter to set to the new row

Parent

A valid Gtk.Tree_Model.Gtk_Tree_Iter, or null

Sibling

A valid Gtk.Tree_Model.Gtk_Tree_Iter, or null

Insert_Before

procedure Insert_Before
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : out Gtk.Tree_Model.Gtk_Tree_Iter;
    Parent     : Gtk.Tree_Model.Gtk_Tree_Iter;
    Sibling    : Gtk.Tree_Model.Gtk_Tree_Iter)

Inserts a new row before Sibling. If Sibling is null, then the row will be appended to Parent 's children. If Parent and Sibling are null, 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.

Parameters
Tree_Store
Iter

An unset Gtk.Tree_Model.Gtk_Tree_Iter to set to the new row

Parent

A valid Gtk.Tree_Model.Gtk_Tree_Iter, or null

Sibling

A valid Gtk.Tree_Model.Gtk_Tree_Iter, or null

Is_Ancestor

function Is_Ancestor
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
    Descendant : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean

Returns True if Iter is an ancestor of Descendant. That is, Iter is the parent (or grandparent or great-grandparent) of Descendant.

Parameters
Tree_Store
Iter

A valid Gtk.Tree_Model.Gtk_Tree_Iter

Descendant

A valid Gtk.Tree_Model.Gtk_Tree_Iter

Return Value

True, if Iter is an ancestor of Descendant

Iter_Depth

function Iter_Depth
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter) return Glib.Gint

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

Parameters
Tree_Store
Iter

A valid Gtk.Tree_Model.Gtk_Tree_Iter

Return Value

The depth of Iter

Iter_Is_Valid

function Iter_Is_Valid
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean

WARNING: This function is slow. Only use it for debugging and/or testing purposes. Checks if the given iter is a valid iter for this Gtk.Tree_Store.Gtk_Tree_Store. Since: gtk+ 2.2

Parameters
Tree_Store
Iter

A Gtk.Tree_Model.Gtk_Tree_Iter.

Return Value

True if the iter is valid, False if the iter is invalid.

Move_After

procedure Move_After
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
    Position   : Gtk.Tree_Model.Gtk_Tree_Iter)

Moves Iter in Tree_Store 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 null, Iter will be moved to the start of the level. Since: gtk+ 2.2

Parameters
Tree_Store
Iter

A Gtk.Tree_Model.Gtk_Tree_Iter.

Position

A Gtk.Tree_Model.Gtk_Tree_Iter.

Move_Before

procedure Move_Before
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
    Position   : Gtk.Tree_Model.Gtk_Tree_Iter)

Moves Iter in Tree_Store 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 null, Iter will be moved to the end of the level. Since: gtk+ 2.2

Parameters
Tree_Store
Iter

A Gtk.Tree_Model.Gtk_Tree_Iter.

Position

A Gtk.Tree_Model.Gtk_Tree_Iter or null.

N_Children

function N_Children
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter := Gtk.Tree_Model.Null_Iter)
    return Glib.Gint
Parameters
Tree_Model
Iter
Return Value

Next

procedure Next
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : in out Gtk.Tree_Model.Gtk_Tree_Iter)
Parameters
Tree_Model
Iter

Nth_Child

function Nth_Child
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Parent     : Gtk.Tree_Model.Gtk_Tree_Iter;
    N          : Glib.Gint) return Gtk.Tree_Model.Gtk_Tree_Iter
Parameters
Tree_Model
Parent
N
Return Value

Parent

function Parent
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Child      : Gtk.Tree_Model.Gtk_Tree_Iter)
    return Gtk.Tree_Model.Gtk_Tree_Iter
Parameters
Tree_Model
Child
Return Value

Prepend

procedure Prepend
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : out Gtk.Tree_Model.Gtk_Tree_Iter;
    Parent     : Gtk.Tree_Model.Gtk_Tree_Iter)

Prepends a new row to Tree_Store. If Parent is non-null, 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.

Parameters
Tree_Store
Iter

An unset Gtk.Tree_Model.Gtk_Tree_Iter to set to the prepended row

Parent

A valid Gtk.Tree_Model.Gtk_Tree_Iter, or null

Previous

procedure Previous
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : in out Gtk.Tree_Model.Gtk_Tree_Iter)
Parameters
Tree_Model
Iter

Ref_Node

procedure Ref_Node
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter)
Parameters
Tree_Model
Iter

Remove

procedure Remove
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : in out Gtk.Tree_Model.Gtk_Tree_Iter)

Removes Iter from Tree_Store. After being removed, Iter is set to the next valid row at that level, or invalidated if it previously pointed to the last one.

Parameters
Tree_Store
Iter

A valid Gtk.Tree_Model.Gtk_Tree_Iter

Reorder

procedure Reorder
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Parent     : Gtk.Tree_Model.Gtk_Tree_Iter;
    New_Order  : Gint_Array)

Reorders the children of Parent in Tree_Store to follow the order indicated by New_Order. Note that this function only works with unsorted stores. Since: gtk+ 2.2

Parameters
Tree_Store
Parent

A Gtk.Tree_Model.Gtk_Tree_Iter, or null

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.

Row_Changed

procedure Row_Changed
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Path       : Gtk.Tree_Model.Gtk_Tree_Path;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter)
Parameters
Tree_Model
Path
Iter

Row_Deleted

procedure Row_Deleted
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Path       : Gtk.Tree_Model.Gtk_Tree_Path)
Parameters
Tree_Model
Path

Row_Draggable

function Row_Draggable
   (Self : not null access Gtk_Tree_Store_Record;
    Path : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean
Parameters
Self
Path
Return Value

Row_Drop_Possible

function Row_Drop_Possible
   (Self           : not null access Gtk_Tree_Store_Record;
    Dest_Path      : Gtk.Tree_Model.Gtk_Tree_Path;
    Selection_Data : Gtk.Selection_Data.Gtk_Selection_Data)
    return Boolean
Parameters
Self
Dest_Path
Selection_Data
Return Value

Row_Has_Child_Toggled

procedure Row_Has_Child_Toggled
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Path       : Gtk.Tree_Model.Gtk_Tree_Path;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter)
Parameters
Tree_Model
Path
Iter

Row_Inserted

procedure Row_Inserted
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Path       : Gtk.Tree_Model.Gtk_Tree_Path;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter)
Parameters
Tree_Model
Path
Iter

Rows_Reordered

procedure Rows_Reordered
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Path       : Gtk.Tree_Model.Gtk_Tree_Path;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
    New_Order  : Gint_Array)
Parameters
Tree_Model
Path
Iter
New_Order

Rows_Reordered_With_Length

procedure Rows_Reordered_With_Length
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Path       : Gtk.Tree_Model.Gtk_Tree_Path;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
    New_Order  : Gint_Array;
    Length     : Glib.Gint)
Parameters
Tree_Model
Path
Iter
New_Order
Length

Set

procedure Set
  (Tree_Store : access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Column     : Gint;
   Value      : Glib.C_Proxy)
Parameters
Tree_Store
Iter
Column
Value

Set

procedure Set
  (Tree_Store : access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Column     : Gint;
   Value      : Gint)
Parameters
Tree_Store
Iter
Column
Value

Set

procedure Set
  (Tree_Store : access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Column     : Gint;
   Value      : Glib.Object.GObject)
Parameters
Tree_Store
Iter
Column
Value

Set

procedure Set
  (Tree_Store : access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Column     : Gint;
   Value      : UTF8_String)
Parameters
Tree_Store
Iter
Column
Value

Set

procedure Set
  (Tree_Store : access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Column     : Gint;
   Value      : Boolean)
Parameters
Tree_Store
Iter
Column
Value

Set

procedure Set
  (Tree_Store : access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Column     : Gint;
   Address    : System.Address)
Parameters
Tree_Store
Iter
Column
Address

Set

procedure Set
  (Self       : not null access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Columns    : Glib.Gint_Array;
   Values     : Glib.Values.GValue_Array)

A variant of Set which takes the columns and valus as two arrays. This is more efficient when changing multiple values than calling one of the Set procedures above multiple times.

Parameters
Self
Iter
Columns
Values

Set

procedure Set
  (Self       : not null access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Values     : Glib.Values.GValue_Array)

A variant of the above that is used to set all the columns.

Parameters
Self
Iter
Values

Set_Column_Types

procedure Set_Column_Types
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Types      : GType_Array)

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

Parameters
Tree_Store
Types

An array of GType types, one for each column

Set_Default_Sort_Func

procedure Set_Default_Sort_Func
   (Sortable  : not null access Gtk_Tree_Store_Record;
    Sort_Func : Gtk_Tree_Iter_Compare_Func)

Sets the default comparison function used when sorting to be Sort_Func. If the current sort column id of Sortable is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function. If Sort_Func is null, then there will be no default comparison function. This means that once the model has been sorted, it can't go back to the default state. In this case, when the current sort column id of Sortable is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.

Parameters
Sortable
Sort_Func

The comparison function

Set_Sort_Column_Id

procedure Set_Sort_Column_Id
   (Sortable       : not null access Gtk_Tree_Store_Record;
    Sort_Column_Id : Glib.Gint;
    Order          : Gtk.Enums.Gtk_Sort_Type)
Parameters
Sortable
Sort_Column_Id
Order

Set_Sort_Func

procedure Set_Sort_Func
   (Sortable       : not null access Gtk_Tree_Store_Record;
    Sort_Column_Id : Glib.Gint;
    Sort_Func      : Gtk_Tree_Iter_Compare_Func)

Sets the comparison function used when sorting to be Sort_Func. If the current sort column id of Sortable is the same as Sort_Column_Id, then the model will sort using this function.

Parameters
Sortable
Sort_Column_Id

the sort column id to set the function for

Sort_Func

The comparison function

Set_Ulong

procedure Set_Ulong
  (Tree_Store : access Gtk_Tree_Store_Record;
   Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
   Column     : Gint;
   Value      : Gulong)
Parameters
Tree_Store
Iter
Column
Value

Set_Value

procedure Set_Value
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter;
    Column     : Glib.Gint;
    Value      : Glib.Values.GValue)

Sets the data in the cell specified by Iter and Column. The type of Value must be convertible to the type of the column.

Parameters
Tree_Store
Iter

A valid Gtk.Tree_Model.Gtk_Tree_Iter for the row being modified

Column

column number to modify

Value

new value for the cell

Sort_Column_Changed

procedure Sort_Column_Changed
   (Sortable : not null access Gtk_Tree_Store_Record)
Parameters
Sortable

Swap

procedure Swap
   (Tree_Store : not null access Gtk_Tree_Store_Record;
    A          : Gtk.Tree_Model.Gtk_Tree_Iter;
    B          : Gtk.Tree_Model.Gtk_Tree_Iter)

Swaps A and B in the same level of Tree_Store. Note that this function only works with unsorted stores. Since: gtk+ 2.2

Parameters
Tree_Store
A

A Gtk.Tree_Model.Gtk_Tree_Iter.

B

Another Gtk.Tree_Model.Gtk_Tree_Iter.

Thaw_Sort

procedure Thaw_Sort
  (Tree      : access Gtk.Tree_Store.Gtk_Tree_Store_Record'Class;
   Column_Id : Gint)

Thaw a frozen tree_view. Column_Id should be the value returned by the corresponding call to Freeze_Sort.

Parameters
Tree
Column_Id

Unref_Node

procedure Unref_Node
   (Tree_Model : not null access Gtk_Tree_Store_Record;
    Iter       : Gtk.Tree_Model.Gtk_Tree_Iter)
Parameters
Tree_Model
Iter