.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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::TreeIter 3"
.TH Gtk2::TreeIter 3 2023-07-25 "perl v5.38.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::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 "CREATING A CUSTOM TREE MODEL" 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 "internal" array reference representation
used by custom Gtk2::TreeModel implementations.  This is the complement to
\&\fBGtk2::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 "CREATING A CUSTOM TREE MODEL" 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 "internal" 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 "internal" 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 "CREATING A CUSTOM TREE MODEL" 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 LGPL.  See Gtk2 for a full notice.