.\" -*- 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::TreeSelection 3"
.TH Gtk2::TreeSelection 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::TreeSelection \- wrapper for GtkTreeSelection
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Object
\&  +\-\-\-\-Gtk2::TreeSelection
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .SS "integer = $selection\->\fBcount_selected_rows\fP"
.el .SS "integer = \f(CW$selection\fP\->\fBcount_selected_rows\fP"
.IX Subsection "integer = $selection->count_selected_rows"
.ie n .SS "boolean = $selection\->\fBiter_is_selected\fP ($iter)"
.el .SS "boolean = \f(CW$selection\fP\->\fBiter_is_selected\fP ($iter)"
.IX Subsection "boolean = $selection->iter_is_selected ($iter)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.ie n .SS "selectionmode = $selection\->\fBget_mode\fP"
.el .SS "selectionmode = \f(CW$selection\fP\->\fBget_mode\fP"
.IX Subsection "selectionmode = $selection->get_mode"
.ie n .SS "$selection\->\fBset_mode\fP ($type)"
.el .SS "\f(CW$selection\fP\->\fBset_mode\fP ($type)"
.IX Subsection "$selection->set_mode ($type)"
.IP \(bu 4
\&\f(CW$type\fR (Gtk2::SelectionMode)
.ie n .SS "boolean = $selection\->\fBpath_is_selected\fP ($path)"
.el .SS "boolean = \f(CW$selection\fP\->\fBpath_is_selected\fP ($path)"
.IX Subsection "boolean = $selection->path_is_selected ($path)"
.IP \(bu 4
\&\f(CW$path\fR (Gtk2::TreePath)
.ie n .SS $selection\->\fBselect_all\fP
.el .SS \f(CW$selection\fP\->\fBselect_all\fP
.IX Subsection "$selection->select_all"
.ie n .SS "$selection\->\fBset_select_function\fP ($func, $data=undef)"
.el .SS "\f(CW$selection\fP\->\fBset_select_function\fP ($func, \f(CW$data\fP=undef)"
.IX Subsection "$selection->set_select_function ($func, $data=undef)"
.IP \(bu 4
\&\f(CW$func\fR (scalar)
.IP \(bu 4
\&\f(CW$data\fR (scalar)
.ie n .SS "$selection\->\fBselect_iter\fP ($iter)"
.el .SS "\f(CW$selection\fP\->\fBselect_iter\fP ($iter)"
.IX Subsection "$selection->select_iter ($iter)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.ie n .SS "$selection\->\fBselect_path\fP ($path)"
.el .SS "\f(CW$selection\fP\->\fBselect_path\fP ($path)"
.IX Subsection "$selection->select_path ($path)"
.IP \(bu 4
\&\f(CW$path\fR (Gtk2::TreePath)
.ie n .SS "$selection\->\fBselect_range\fP ($start_path, $end_path)"
.el .SS "\f(CW$selection\fP\->\fBselect_range\fP ($start_path, \f(CW$end_path\fP)"
.IX Subsection "$selection->select_range ($start_path, $end_path)"
.IP \(bu 4
\&\f(CW$start_path\fR (Gtk2::TreePath)
.IP \(bu 4
\&\f(CW$end_path\fR (Gtk2::TreePath)
.ie n .SS "$selection\->\fBselected_foreach\fP ($func, $data=undef)"
.el .SS "\f(CW$selection\fP\->\fBselected_foreach\fP ($func, \f(CW$data\fP=undef)"
.IX Subsection "$selection->selected_foreach ($func, $data=undef)"
.IP \(bu 4
\&\f(CW$func\fR (subroutine)
.IP \(bu 4
\&\f(CW$data\fR (scalar)
.PP
Call \fR\f(CI$func\fR\fI\fR on every selected row in \fI\fR\f(CI$selection\fR\fI\fR's view.
.ie n .SS "iter = $tree_selection\->\fBget_selected\fP"
.el .SS "iter = \f(CW$tree_selection\fP\->\fBget_selected\fP"
.IX Subsection "iter = $tree_selection->get_selected"
.ie n .SS "(model, iter) = $tree_selection\->\fBget_selected\fP"
.el .SS "(model, iter) = \f(CW$tree_selection\fP\->\fBget_selected\fP"
.IX Subsection "(model, iter) = $tree_selection->get_selected"
Since most of the time you are only interested in the iter, \f(CW\*(C`get_selected\*(C'\fR
returns only the iter in scalar context.
.ie n .SS "@paths = $selection\->\fBget_selected_rows\fP"
.el .SS "\f(CW@paths\fP = \f(CW$selection\fP\->\fBget_selected_rows\fP"
.IX Subsection "@paths = $selection->get_selected_rows"
Returns the Gtk2::TreePath of each selected row, or an empty list if no
rows are selected.  The model is \fInot\fR returned, as documented in the C
API reference.  To get the model, try
\&\f(CW\*(C`$selection\->get_tree_view\->get_model\*(C'\fR.
.ie n .SS "treeview = $selection\->\fBget_tree_view\fP"
.el .SS "treeview = \f(CW$selection\fP\->\fBget_tree_view\fP"
.IX Subsection "treeview = $selection->get_tree_view"
.ie n .SS $selection\->\fBunselect_all\fP
.el .SS \f(CW$selection\fP\->\fBunselect_all\fP
.IX Subsection "$selection->unselect_all"
.ie n .SS "$selection\->\fBunselect_iter\fP ($iter)"
.el .SS "\f(CW$selection\fP\->\fBunselect_iter\fP ($iter)"
.IX Subsection "$selection->unselect_iter ($iter)"
.IP \(bu 4
\&\f(CW$iter\fR (Gtk2::TreeIter)
.ie n .SS "$selection\->\fBunselect_path\fP ($path)"
.el .SS "\f(CW$selection\fP\->\fBunselect_path\fP ($path)"
.IX Subsection "$selection->unselect_path ($path)"
.IP \(bu 4
\&\f(CW$path\fR (Gtk2::TreePath)
.ie n .SS "$selection\->\fBunselect_range\fP ($start_path, $end_path)"
.el .SS "\f(CW$selection\fP\->\fBunselect_range\fP ($start_path, \f(CW$end_path\fP)"
.IX Subsection "$selection->unselect_range ($start_path, $end_path)"
.IP \(bu 4
\&\f(CW$start_path\fR (Gtk2::TreePath)
.IP \(bu 4
\&\f(CW$end_path\fR (Gtk2::TreePath)
.PP
Since: gtk+ 2.2
.ie n .SS "scalar = $selection\->\fBget_user_data\fP"
.el .SS "scalar = \f(CW$selection\fP\->\fBget_user_data\fP"
.IX Subsection "scalar = $selection->get_user_data"
.SH SIGNALS
.IX Header "SIGNALS"
.IP "\fBchanged\fR (Gtk2::TreeSelection)" 4
.IX Item "changed (Gtk2::TreeSelection)"
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::SelectionMode"
.IX Subsection "enum Gtk2::SelectionMode"
.PD 0
.IP \(bu 4
.PD
\&'none' / 'GTK_SELECTION_NONE'
.IP \(bu 4
\&'single' / 'GTK_SELECTION_SINGLE'
.IP \(bu 4
\&'browse' / 'GTK_SELECTION_BROWSE'
.IP \(bu 4
\&'multiple' / 'GTK_SELECTION_MULTIPLE'
.IP \(bu 4
\&'extended' / 'GTK_SELECTION_EXTENDED'
.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.