1Gtk2::TreePath(3)     User Contributed Perl Documentation    Gtk2::TreePath(3)
2
3
4

NAME

6       Gtk2::TreePath
7

HIERARCHY

9         Glib::Boxed
10         +----Gtk2::TreePath
11

METHODS

13       treepath or undef = Gtk2::TreePath->new ($path=undef)
14
15           * $path (string)
16
17           Create a new path.  For convenience, if you pass a value for $path,
18           this is just an alias for "new_from_string".
19
20       treepath = Gtk2::TreePath->new_first
21
22       treepath or undef = Gtk2::TreePath->new_from_indices ($first_index,
23       ...)
24
25           * $first_index (integer) a non-negative index value
26           * ... (list) of zero or more index values
27
28           The C API reference docs for this function say to mark the end of
29           the list with a -1, but Perl doesn't need list terminators, so
30           don't do that.
31
32           This is specially implemented to be available for all gtk+ ver‐
33           sions.
34
35       treepath or undef = Gtk2::TreePath->new_from_string ($path=undef)
36
37           * $path (string)
38
39       $path->append_index ($index_)
40
41           * $index_ (integer)
42
43       integer = $a->compare ($b)
44
45           * $b (Gtk2::TreePath)
46
47           Compares two paths.  If $a appears before $b in the three, returns
48           -1.  If $b appears before $a, returns 1.  If the nodes are equal,
49           returns 0.
50
51       integer = $path->get_depth
52
53       $path->down
54
55           Moves $path to point to the first child of the current path.
56
57       list = $path->get_indices
58
59           Returns a list of integers describing the current indices of $path.
60
61       boolean = $path->is_ancestor ($descendant)
62
63           * $descendant (Gtk2::TreePath)
64
65       boolean = $path->is_descendant ($ancestor)
66
67           * $ancestor (Gtk2::TreePath)
68
69       $path->next
70
71           Moves $path to point to the next node at the current depth.
72
73       $path->prepend_index ($index_)
74
75           * $index_ (integer)
76
77       boolean = $path->prev
78
79           Moves $path to point to the previous node at the current depth, if
80           it exists.  Returns true if there is a previous node and $path was
81           modified.
82
83       string = $path->to_string
84
85       boolean = $path->up
86
87           Moves $path to point to its parent node; returns false if there is
88           no parent.
89

SEE ALSO

91       Gtk2, Glib::Boxed
92

94       Copyright (C) 2003-2007 by the gtk2-perl team.
95
96       This software is licensed under the LGPL.  See Gtk2 for a full notice.
97
98
99
100perl v5.8.8                       2007-03-18                 Gtk2::TreePath(3)
Impressum