.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::TreePath 3"
.TH Gtk2::TreePath 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Gtk2::TreePath \- wrapper for GtkTreePath
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Boxed
\&  +\-\-\-\-Gtk2::TreePath
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "treepath or undef = Gtk2::TreePath\->\fBnew\fP ($path=undef)"
.IX Subsection "treepath or undef = Gtk2::TreePath->new ($path=undef)"
.IP \(bu 4
\&\f(CW$path\fR (string)
.PP
Create a new path.  For convenience, if you pass a value for \fR\f(CI$path\fR\fI\fR,
this is just an alias for \f(CW\*(C`new_from_string\*(C'\fR.
.SS "treepath = Gtk2::TreePath\->\fBnew_first\fP"
.IX Subsection "treepath = Gtk2::TreePath->new_first"
.SS "treepath or undef = Gtk2::TreePath\->\fBnew_from_indices\fP ($first_index, ...)"
.IX Subsection "treepath or undef = Gtk2::TreePath->new_from_indices ($first_index, ...)"
.IP \(bu 4
\&\f(CW$first_index\fR (integer) a non-negative index value
.IP \(bu 4
\&... (list) of zero or more index values
.PP
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.
.PP
This is specially implemented to be available for all gtk+ versions.
.SS "treepath or undef = Gtk2::TreePath\->\fBnew_from_string\fP ($path=undef)"
.IX Subsection "treepath or undef = Gtk2::TreePath->new_from_string ($path=undef)"
.IP \(bu 4
\&\f(CW$path\fR (string)
.ie n .SS "$path\->\fBappend_index\fP ($index_)"
.el .SS "\f(CW$path\fP\->\fBappend_index\fP ($index_)"
.IX Subsection "$path->append_index ($index_)"
.IP \(bu 4
\&\f(CW$index_\fR (integer)
.ie n .SS "integer = $a\->\fBcompare\fP ($b)"
.el .SS "integer = \f(CW$a\fP\->\fBcompare\fP ($b)"
.IX Subsection "integer = $a->compare ($b)"
.IP \(bu 4
\&\f(CW$b\fR (Gtk2::TreePath)
.PP
Compares two paths.  If \fR\f(CI$a\fR\fI\fR appears before \fI\fR\f(CI$b\fR\fI\fR in the three, returns \-1.
If \fI\fR\f(CI$b\fR\fI\fR appears before \fI\fR\f(CI$a\fR\fI\fR, returns 1.  If the nodes are equal, returns 0.
.ie n .SS "integer = $path\->\fBget_depth\fP"
.el .SS "integer = \f(CW$path\fP\->\fBget_depth\fP"
.IX Subsection "integer = $path->get_depth"
.ie n .SS $path\->\fBdown\fP
.el .SS \f(CW$path\fP\->\fBdown\fP
.IX Subsection "$path->down"
Moves \fR\f(CI$path\fR\fI\fR to point to the first child of the current path.
.ie n .SS "list = $path\->\fBget_indices\fP"
.el .SS "list = \f(CW$path\fP\->\fBget_indices\fP"
.IX Subsection "list = $path->get_indices"
Returns a list of integers describing the current indices of \fR\f(CI$path\fR\fI\fR.
.ie n .SS "boolean = $path\->\fBis_ancestor\fP ($descendant)"
.el .SS "boolean = \f(CW$path\fP\->\fBis_ancestor\fP ($descendant)"
.IX Subsection "boolean = $path->is_ancestor ($descendant)"
.IP \(bu 4
\&\f(CW$descendant\fR (Gtk2::TreePath)
.ie n .SS "boolean = $path\->\fBis_descendant\fP ($ancestor)"
.el .SS "boolean = \f(CW$path\fP\->\fBis_descendant\fP ($ancestor)"
.IX Subsection "boolean = $path->is_descendant ($ancestor)"
.IP \(bu 4
\&\f(CW$ancestor\fR (Gtk2::TreePath)
.ie n .SS $path\->\fBnext\fP
.el .SS \f(CW$path\fP\->\fBnext\fP
.IX Subsection "$path->next"
Moves \fR\f(CI$path\fR\fI\fR to point to the next node at the current depth.
.ie n .SS "$path\->\fBprepend_index\fP ($index_)"
.el .SS "\f(CW$path\fP\->\fBprepend_index\fP ($index_)"
.IX Subsection "$path->prepend_index ($index_)"
.IP \(bu 4
\&\f(CW$index_\fR (integer)
.ie n .SS "boolean = $path\->\fBprev\fP"
.el .SS "boolean = \f(CW$path\fP\->\fBprev\fP"
.IX Subsection "boolean = $path->prev"
Moves \fR\f(CI$path\fR\fI\fR to point to the previous node at the current depth, if it
exists.  Returns true if there is a previous node and \fI\fR\f(CI$path\fR\fI\fR was modified.
.ie n .SS "string = $path\->\fBto_string\fP"
.el .SS "string = \f(CW$path\fP\->\fBto_string\fP"
.IX Subsection "string = $path->to_string"
.ie n .SS "boolean = $path\->\fBup\fP"
.el .SS "boolean = \f(CW$path\fP\->\fBup\fP"
.IX Subsection "boolean = $path->up"
Moves \fR\f(CI$path\fR\fI\fR to point to its parent node; returns false if there is no
parent.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Boxed
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the LGPL.  See Gtk2 for a full notice.