.\" -*- 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::ListStore 3"
.TH Gtk2::ListStore 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::ListStore \- wrapper for GtkListStore
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Object
\&  +\-\-\-\-Gtk2::ListStore
.Ve
.SH INTERFACES
.IX Header "INTERFACES"
.Vb 5
\&  Gtk2::TreeModel
\&  Gtk2::TreeDragSource
\&  Gtk2::TreeDragDest
\&  Gtk2::TreeSortable
\&  Gtk2::Buildable
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "liststore = Gtk2::ListStore\->\fBnew\fP (...)"
.IX Subsection "liststore = Gtk2::ListStore->new (...)"
.IP \(bu 4
\&... (list) of strings
.ie n .SS "treeiter = $list_store\->\fBappend\fP"
.el .SS "treeiter = \f(CW$list_store\fP\->\fBappend\fP"
.IX Subsection "treeiter = $list_store->append"
.ie n .SS $list_store\->\fBclear\fP
.el .SS \f(CW$list_store\fP\->\fBclear\fP
.IX Subsection "$list_store->clear"
.ie n .SS "$list_store\->\fBset_column_types\fP (...)"
.el .SS "\f(CW$list_store\fP\->\fBset_column_types\fP (...)"
.IX Subsection "$list_store->set_column_types (...)"
.IP \(bu 4
\&... (list) of strings
.ie n .SS "$list_store\->\fBset\fP ($iter, $col1, $val1, ...)"
.el .SS "\f(CW$list_store\fP\->\fBset\fP ($iter, \f(CW$col1\fP, \f(CW$val1\fP, ...)"
.IX Subsection "$list_store->set ($iter, $col1, $val1, ...)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.IP \(bu 4
\&\f(CW$col1\fR (integer) the first column number
.IP \(bu 4
\&\f(CW$val1\fR (scalar) the first value
.IP \(bu 4
\&... (list) pairs of column numbers and values
.ie n .SS "treeiter = $list_store\->\fBinsert\fP ($position)"
.el .SS "treeiter = \f(CW$list_store\fP\->\fBinsert\fP ($position)"
.IX Subsection "treeiter = $list_store->insert ($position)"
.IP \(bu 4
\&\f(CW$position\fR (integer)
.ie n .SS "treeiter = $list_store\->\fBinsert_after\fP ($sibling)"
.el .SS "treeiter = \f(CW$list_store\fP\->\fBinsert_after\fP ($sibling)"
.IX Subsection "treeiter = $list_store->insert_after ($sibling)"
.IP \(bu 4
\&\f(CW$sibling\fR (Gtk2::TreeIter or undef)
.ie n .SS "treeiter = $list_store\->\fBinsert_before\fP ($sibling)"
.el .SS "treeiter = \f(CW$list_store\fP\->\fBinsert_before\fP ($sibling)"
.IX Subsection "treeiter = $list_store->insert_before ($sibling)"
.IP \(bu 4
\&\f(CW$sibling\fR (Gtk2::TreeIter or undef)
.ie n .SS "treeiter = $list_store\->\fBinsert_with_values\fP ($position, ...)"
.el .SS "treeiter = \f(CW$list_store\fP\->\fBinsert_with_values\fP ($position, ...)"
.IX Subsection "treeiter = $list_store->insert_with_values ($position, ...)"
.IP \(bu 4
\&\f(CW$position\fR (integer) position to insert the new row
.IP \(bu 4
\&... (list) pairs of column numbers and values
.PP
Like doing insert followed by set, except that insert_with_values emits only
the row-inserted signal, rather than row-inserted, row-changed, and, if the
store is sorted, rows-reordered as in the multiple-operation case.
Since emitting the rows-reordered signal repeatedly can affect the performance
of the program, insert_with_values should generally be preferred when
inserting rows in a sorted list store.
.PP
Since: gtk+ 2.6
.ie n .SS "boolean = $list_store\->\fBiter_is_valid\fP ($iter)"
.el .SS "boolean = \f(CW$list_store\fP\->\fBiter_is_valid\fP ($iter)"
.IX Subsection "boolean = $list_store->iter_is_valid ($iter)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.PP
Since: gtk+ 2.2
.ie n .SS "$store\->\fBmove_after\fP ($iter, $position)"
.el .SS "\f(CW$store\fP\->\fBmove_after\fP ($iter, \f(CW$position\fP)"
.IX Subsection "$store->move_after ($iter, $position)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.IP \(bu 4
\&\f(CW$position\fR (Gtk2::TreeIter or undef)
.PP
Since: gtk+ 2.2
.ie n .SS "$store\->\fBmove_before\fP ($iter, $position)"
.el .SS "\f(CW$store\fP\->\fBmove_before\fP ($iter, \f(CW$position\fP)"
.IX Subsection "$store->move_before ($iter, $position)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.IP \(bu 4
\&\f(CW$position\fR (Gtk2::TreeIter or undef)
.PP
Since: gtk+ 2.2
.ie n .SS "treeiter = $list_store\->\fBprepend\fP"
.el .SS "treeiter = \f(CW$list_store\fP\->\fBprepend\fP"
.IX Subsection "treeiter = $list_store->prepend"
.ie n .SS "boolean = $list_store\->\fBremove\fP ($iter)"
.el .SS "boolean = \f(CW$list_store\fP\->\fBremove\fP ($iter)"
.IX Subsection "boolean = $list_store->remove ($iter)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.PP
The return is always a boolean in the style of Gtk 2.2.x and up, even
when running on Gtk 2.0.x.
.ie n .SS "$store\->\fBreorder\fP (...)"
.el .SS "\f(CW$store\fP\->\fBreorder\fP (...)"
.IX Subsection "$store->reorder (...)"
.IP \(bu 4
\&... (list) of integers the reordered posistions
.PP
Reorders store to follow the order indicated by new_order. Note that this
function only works with unsorted stores.
.PP
A list of position should be passed, one for each item in the list.
.PP
Since: gtk+ 2.2
.ie n .SS "$store\->\fBswap\fP ($a, $b)"
.el .SS "\f(CW$store\fP\->\fBswap\fP ($a, \f(CW$b\fP)"
.IX Subsection "$store->swap ($a, $b)"
.IP \(bu 4
\&\f(CW$a\fR (Gtk2::TreeIter)
.IP \(bu 4
\&\f(CW$b\fR (Gtk2::TreeIter)
.PP
Since: gtk+ 2.2
.ie n .SS "$list_store\->\fBset_value\fP ($iter, $col, $val)"
.el .SS "\f(CW$list_store\fP\->\fBset_value\fP ($iter, \f(CW$col\fP, \f(CW$val\fP)"
.IX Subsection "$list_store->set_value ($iter, $col, $val)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.IP \(bu 4
\&\f(CW$val\fR (scalar)
.IP \(bu 4
\&\f(CW$col\fR (integer)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object
.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.