class: GtkTreePathCtors

[259:14] static extends: object

Alternate constructors for GtkTreePath. Usage: GtkTreePathCtors.<name>(...). The primary constructor lives directly on GtkTreePath.

Methods

newFirst ()

Creates a new GtkTreePath. The string representation of this path is “0”.
- @r A new GtkTreePath.
newFromIndices (int first_index, list varargs)

Creates a new path with @first_index and @varargs as indices.
- @p first_index is first integer.
- @p ... is list of integers terminated by -1.
- @r A new GtkTreePath.
newFromIndicesv (list indices)

Creates a new path with the given @indices array of @length.
- @p indices is array of indices.
- @p length is length of @indices array.
- @r A new GtkTreePath.
newFromString (string path)

Creates a new GtkTreePath 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.
- @p path is The string representation of a path.
- @r A new GtkTreePath.

class: GtkTreePath

[12:7] extends: object

An opaque structure representing a path to a row in a model.

Members

handleObj
lib
retainedCallbacks
signalHandlerNames
signalSetterHandlers

Methods

GtkTreePath (Handle = null)

Creates a new GtkTreePath This refers to a row.
- @p Handle is an optional native handle or wrapper whose handle to adopt; when the native constructor is called.
toNativeHandle (Source)

Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.
- @p Source is the raw handle, raw buffer, wrapper, or null.
- @r A raw pointer carrier or null when no pointer is present.
getLib ()

Returns the opened native library for this generated wrapper.
- @r The opened native library.
handle ()

Returns the wrapped NativeHandle.
- @r The wrapped NativeHandle.
isNull ()

Returns true when the wrapped handle is null.
- @r A bool.
describe ()

Returns a small string for debugging generated wrappers.
- @r A string.
append_index (int index_)

Appends a new index to a path. As a result, the depth of the path is increased.
- @p index_ is the index.
- @r None.
compare (object b)

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.
- @p b is a GtkTreePath to compare with.
- @r the relative positions of @a and @b.
copy ()

Creates a new GtkTreePath as a copy of @path.
- @r a new GtkTreePath.
down ()

Moves @path to point to the first child of the current path.
- @r None.
free ()

Frees @path. If @path is %NULL, it simply returns.
- @r None.
get_depth ()

Returns the current depth of @path.
- @r The depth of @path.
get_indices ()

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_path_get_depth().
- @r The current indices.
get_indices_with_depth ()

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.
- @p depth is return location for number of elements returned in the integer array.
- @r The current indices.
is_ancestor (object descendant)

Returns %TRUE if @descendant is a descendant of @path.
- @p descendant is another GtkTreePath.
- @r %TRUE if @descendant is contained inside @path.
is_descendant (object ancestor)

Returns %TRUE if @path is a descendant of @ancestor.
- @p ancestor is another GtkTreePath.
- @r %TRUE if @ancestor contains @path somewhere below it.
next ()

Moves the @path to point to the next node at the current depth.
- @r None.
prepend_index (int index_)

Prepends a new index to a path. As a result, the depth of the path is increased.
- @p index_ is the index.
- @r None.
prev ()

Moves the @path to point to the previous node at the current depth, if it exists.
- @r %TRUE if @path has a previous node, and the move was made.
to_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. If the path has depth 0, %NULL is returned.
- @r A newly-allocated string.
up ()

Moves the @path to point to its parent node, if it has a parent.
- @r %TRUE if @path has a parent, and the move was made.