.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Gtk2::TreeIter 3pm"
.TH Gtk2::TreeIter 3pm "2015-02-24" "perl v5.14.2" "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::TreeIter \- wrapper for GtkTreeIter
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Boxed
\&  +\-\-\-\-Gtk2::TreeIter
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  package MyCustomListStore;
\&
\&  use Glib::Object::Subclass
\&      Glib::Object::,
\&      interfaces => [ Gtk2::TreeModel:: ],
\&      ;
\&
\&  ...
\&
\&  sub set {
\&      my $list = shift;
\&      my $iter = shift; # a Gtk2::TreeIter
\&
\&      # this method needs access to the internal representation
\&      # of the iter, as the model implementation sees it:
\&      my $arrayref = $iter\->to_arrayref ($list\->{stamp});
\&      ...
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The methods described here are only of use in custom Gtk2::TreeModel
implementations; they are not safe to be used on generic iters or in
application code.  See \*(L"\s-1CREATING\s0 A \s-1CUSTOM\s0 \s-1TREE\s0 \s-1MODEL\s0\*(R" in Gtk2::TreeModel for
more information.
.SH "METHODS"
.IX Header "METHODS"
.SS "treeiter = Gtk2::TreeIter\->\fBnew_from_arrayref\fP ($sv_iter)"
.IX Subsection "treeiter = Gtk2::TreeIter->new_from_arrayref ($sv_iter)"
.IP "\(bu" 4
\&\f(CW$sv_iter\fR (scalar)
.PP
Create a new Gtk2::TreeIter from the \*(L"internal\*(R" array reference representation
used by custom Gtk2::TreeModel implementations.  This is the complement to
\&\fIGtk2::TreeIter::to_arrayref()\fR, and is used when you need to create and return
a new iter from a method that is not one of the Gtk2::TreeModelIface
interface vfuncs.  See \*(L"\s-1CREATING\s0 A \s-1CUSTOM\s0 \s-1TREE\s0 \s-1MODEL\s0\*(R" in Gtk2::TreeModel for
more information.
.ie n .SS "$iter\->\fBset\fP ($from)"
.el .SS "\f(CW$iter\fP\->\fBset\fP ($from)"
.IX Subsection "$iter->set ($from)"
.IP "\(bu" 4
\&\f(CW$from\fR (scalar)
.PP
Set the contents of \f(CW$iter\fR.  \f(CW$from\fR can be either another Gtk2::TreeIter
or an \*(L"internal\*(R" arrayref form as above.
.PP
Often you create a new iter instead of modifying an existing one, but
\&\f(CW\*(C`set\*(C'\fR lets you to implement things in the style of the \f(CW\*(C`remove\*(C'\fR
method of Gtk2::ListStore and Gtk2::TreeStore.
.PP
A set can also explicitly invalidate an iter by zapping its stamp, so
nobody can accidentally use it again.
.PP
.Vb 1
\&    $iter\->set ([0,0,undef,undef]);
.Ve
.ie n .SS "scalar = $iter\->\fBto_arrayref\fP ($stamp)"
.el .SS "scalar = \f(CW$iter\fP\->\fBto_arrayref\fP ($stamp)"
.IX Subsection "scalar = $iter->to_arrayref ($stamp)"
.IP "\(bu" 4
\&\f(CW$stamp\fR (integer)
.PP
Convert a boxed Gtk2::TreeIter reference into the \*(L"internal\*(R" array reference
representation used by custom Gtk2::TreeModel implementations.  This is
necessary when you need to get to the data inside your iters in methods
which are not the vfuncs of the Gtk2::TreeModelIface interface.  The stamp
must match; this protects the binding code from potential memory faults
when attempting to convert an iter that doesn't actually belong to your
model.  See \*(L"\s-1CREATING\s0 A \s-1CUSTOM\s0 \s-1TREE\s0 \s-1MODEL\s0\*(R" in Gtk2::TreeModel for
more information.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Boxed, Gtk2::TreeModel
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL\s0.  See Gtk2 for a full notice.