This structure refers to a row.
Class GtkTreePath
| Methods | |
| append_index | Appends a new index to a path. |
| compare | Compares two paths. |
| copy | Creates a new GtkTreePath as a copy of path. |
| down | Moves path to point to the first child of the current path. |
| get_depth | Returns the current depth of path. |
| get_indices | Returns the current indices of path. |
| is_ancestor | Returns TRUE if descendant is a descendant of path. |
| is_descendant | Returns TRUE if path is a descendant of ancestor. |
| new_first | Creates a new GtkTreePath. The string representation of this path is "0" |
| new_from_string | Creates a new GtkTreePath initialized to path. |
| next | Moves the path to point to the next node at the current depth. |
| prepend_index | Prepends a new index to a path. |
| prev | Moves the path to point to the previous node at the current depth, if it exists. |
| to_string | Generates a string representation of the path. |
| up | Moves the path to point to its parent node, if it has a parent. |
Appends a new index to a path.
GtkTreePath.append_index( index )
| index | The index. |
As a result, the depth of the path is increased.
Compares two paths.
GtkTreePath.compare( b )
| b | A GtkTreePath to compare with. |
| Return | The relative positions of a and b |
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.
Creates a new GtkTreePath as a copy of path.
GtkTreePath.copy()
| Return | A new GtkTreePath. |
Moves path to point to the first child of the current path.
GtkTreePath.down()
Returns the current depth of path.
GtkTreePath.get_depth()
| Return | The depth of path |
Returns the current indices of path.
GtkTreePath.get_indices()
| Return | An array of the current indices, or NULL. |
This is an array of integers, each representing a node in a tree.
Returns TRUE if descendant is a descendant of path.
GtkTreePath.is_ancestor( descendant )
| descendant | another GtkTreePath |
| Return | TRUE if descendant is contained inside path |
Returns TRUE if path is a descendant of ancestor.
GtkTreePath.is_descendant( ancestor )
| ancestor | another GtkTreePath |
| Return | TRUE if ancestor contains path somewhere below it |
Creates a new GtkTreePath. The string representation of this path is "0"
GtkTreePath.new_first()
| Return | a GtkTreePath |
Creates a new GtkTreePath initialized to path.
GtkTreePath.new_from_string( path )
| path | The string representation of a path. |
| Return | A newly-created GtkTreePath, or NULL |
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.
Moves the path to point to the next node at the current depth.
GtkTreePath.next()
Prepends a new index to a path.
GtkTreePath.prepend_index( index )
| index | The index |
As a result, the depth of the path is increased.
Moves the path to point to the previous node at the current depth, if it exists.
GtkTreePath.prev()
Generates a string representation of the path.
GtkTreePath.to_string()
| Return | a string |
This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
Moves the path to point to its parent node, if it has a parent.
GtkTreePath.up()
| Return | TRUE if path has a parent, and the move was made. |