W Wrapl, The Programming Language

Libraries:Gtk:Gtk:TreePath

Types

T

Constants

Nil : T

Functions

GetType() : Gtk.GObject.Type.T



New() : Gtk.Gtk.TreePath.T

Creates a new T. This structure refers to a row.

Returns A newly created T.


NewFirst() : Gtk.Gtk.TreePath.T

Creates a new T. The string representation of this path is "0"

Returns A new T.


NewFromIndices(first_index @ Std.Integer.SmallT, ... @ Std.Object.T) : Gtk.Gtk.TreePath.T

Creates a new path with first_index and varargs as indices.

first_index first integer
Returns A newly created T.


NewFromString(path @ Std.String.T) : Gtk.Gtk.TreePath.T

Creates a new T 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.
Returns A newly-created T, or NULL


Methods

:"="(_ @ T, _ @ T)

:AppendIndex(self @ T, index_ @ Std.Integer.SmallT) : Std.Object.T

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

path A T.
index_ The index.


:Compare(self @ T, b @ Gtk.Gtk.TreePath.T) : Std.Integer.SmallT

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.

a A T.
b A T to compare with.
Returns The relative positions of a and b


:Copy(self @ T) : Gtk.Gtk.TreePath.T

Creates a new T as a copy of path.

path A T.
Returns A new T.


:Down(self @ T) : Std.Object.T

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

path A T.


:Free(self @ T) : Std.Object.T

Frees path.

path A T.


:GetDepth(self @ T) : Std.Integer.SmallT

Returns the current depth of path.

path A T.
Returns The depth of path


:GetIndices(self @ T) : Agg.List.T

Returns the current indices of path. This is an array of integers, each representing a node in a tree. It also returns the number of elements in the array. The array should not be freed.

path A T.
depth Number of elements returned in the integer array
Returns The current indices, or NULL. [array length=depth][transfer none]


:IsAncestor(self @ T, descendant @ Gtk.Gtk.TreePath.T) : Std.Symbol.T

Returns TRUE if descendant is a descendant of path.

path a T
descendant another T
Returns TRUE if descendant is contained inside path


:IsDescendant(self @ T, ancestor @ Gtk.Gtk.TreePath.T) : Std.Symbol.T

Returns TRUE if path is a descendant of ancestor.

path a T
ancestor another T
Returns TRUE if ancestor contains path somewhere below it


:Next(self @ T) : Std.Object.T

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

path A T.


:PrependIndex(self @ T, index_ @ Std.Integer.SmallT) : Std.Object.T

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

path A T.
index_ The index.


:Prev(self @ T) : Std.Symbol.T

Moves the path to point to the previous node at the current depth, if it exists.

path A T.
Returns TRUE if path has a previous node, and the move was made.


:ToString(self @ T) : Std.String.T

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.

path A T
Returns A newly-allocated string. Must be freed with g_free().


:Up(self @ T) : Std.Symbol.T

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

path A T.
Returns TRUE if path has a parent, and the move was made.


:"~="(_ @ T, _ @ T)