NAME¶
Gtk2::TreePath - wrapper for GtkTreePath
HIERARCHY¶
Glib::Boxed
+----Gtk2::TreePath
METHODS¶
treepath or undef = Gtk2::TreePath->new
($path=undef)¶
- •
- $path (string)
Create a new path. For convenience, if you pass a value for
$path, this is just an alias for
"new_from_string".
treepath = Gtk2::TreePath->new_first¶
treepath or undef = Gtk2::TreePath->new_from_indices
($first_index, ...)¶
- •
- $first_index (integer) a non-negative index value
- •
- ... (list) of zero or more index values
The C API reference docs for this function say to mark the end of the list with
a -1, but Perl doesn't need list terminators, so don't do that.
This is specially implemented to be available for all gtk+ versions.
treepath or undef = Gtk2::TreePath->new_from_string
($path=undef)¶
- •
- $path (string)
$path->append_index ($index_)¶
- •
- $index_ (integer)
integer = $a->compare ($b)¶
- •
- $b (Gtk2::TreePath)
Compares two paths. If
$a appears before
$b in the three, returns -1. If
$b
appears before
$a, returns 1. If the nodes are equal,
returns 0.
integer = $path->get_depth¶
$path->down¶
Moves
$path to point to the first child of the current
path.
list = $path->get_indices¶
Returns a list of integers describing the current indices of
$path.
boolean = $path->is_ancestor ($descendant)¶
- •
- $descendant (Gtk2::TreePath)
boolean = $path->is_descendant ($ancestor)¶
- •
- $ancestor (Gtk2::TreePath)
$path->next¶
Moves
$path to point to the next node at the current depth.
$path->prepend_index ($index_)¶
- •
- $index_ (integer)
boolean = $path->prev¶
Moves
$path to point to the previous node at the current
depth, if it exists. Returns true if there is a previous node and
$path was modified.
string = $path->to_string¶
boolean = $path->up¶
Moves
$path to point to its parent node; returns false if
there is no parent.
SEE ALSO¶
Gtk2, Glib::Boxed
COPYRIGHT¶
Copyright (C) 2003-2011 by the gtk2-perl team.
This software is licensed under the LGPL. See Gtk2 for a full notice.