.\" -*- 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::TreeModelFilter 3"
.TH Gtk2::TreeModelFilter 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::TreeModelFilter \- wrapper for GtkTreeModelFilter
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Object
\&  +\-\-\-\-Gtk2::TreeModelFilter
.Ve
.SH INTERFACES
.IX Header "INTERFACES"
.Vb 2
\&  Gtk2::TreeModel
\&  Gtk2::TreeDragSource
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .SS "treemodelfilter = Gtk2::TreeModelFilter\->\fBnew\fP ($child_model, $root=undef)"
.el .SS "treemodelfilter = Gtk2::TreeModelFilter\->\fBnew\fP ($child_model, \f(CW$root\fP=undef)"
.IX Subsection "treemodelfilter = Gtk2::TreeModelFilter->new ($child_model, $root=undef)"
.IP \(bu 4
\&\f(CW$child_model\fR (Gtk2::TreeModel)
.IP \(bu 4
\&\f(CW$root\fR (Gtk2::TreePath or undef)
.ie n .SS $filter\->\fBclear_cache\fP
.el .SS \f(CW$filter\fP\->\fBclear_cache\fP
.IX Subsection "$filter->clear_cache"
.ie n .SS "treeiter = $filter\->\fBconvert_child_iter_to_iter\fP ($child_iter)"
.el .SS "treeiter = \f(CW$filter\fP\->\fBconvert_child_iter_to_iter\fP ($child_iter)"
.IX Subsection "treeiter = $filter->convert_child_iter_to_iter ($child_iter)"
.IP \(bu 4
\&\f(CW$child_iter\fR (Gtk2::TreeIter)
.ie n .SS "treepath or undef = $filter\->\fBconvert_child_path_to_path\fP ($child_path)"
.el .SS "treepath or undef = \f(CW$filter\fP\->\fBconvert_child_path_to_path\fP ($child_path)"
.IX Subsection "treepath or undef = $filter->convert_child_path_to_path ($child_path)"
.IP \(bu 4
\&\f(CW$child_path\fR (Gtk2::TreePath)
.ie n .SS "treeiter = $filter\->\fBconvert_iter_to_child_iter\fP ($filter_iter)"
.el .SS "treeiter = \f(CW$filter\fP\->\fBconvert_iter_to_child_iter\fP ($filter_iter)"
.IX Subsection "treeiter = $filter->convert_iter_to_child_iter ($filter_iter)"
.IP \(bu 4
\&\f(CW$filter_iter\fR (Gtk2::TreeIter)
.ie n .SS "treepath or undef = $path\->\fBconvert_path_to_child_path\fP ($filter_path)"
.el .SS "treepath or undef = \f(CW$path\fP\->\fBconvert_path_to_child_path\fP ($filter_path)"
.IX Subsection "treepath or undef = $path->convert_path_to_child_path ($filter_path)"
.IP \(bu 4
\&\f(CW$filter_path\fR (Gtk2::TreePath)
.ie n .SS "treemodel = $filter\->\fBget_model\fP"
.el .SS "treemodel = \f(CW$filter\fP\->\fBget_model\fP"
.IX Subsection "treemodel = $filter->get_model"
.ie n .SS "$filter\->\fBset_modify_func\fP ($types, $func=undef, $data=undef)"
.el .SS "\f(CW$filter\fP\->\fBset_modify_func\fP ($types, \f(CW$func\fP=undef, \f(CW$data\fP=undef)"
.IX Subsection "$filter->set_modify_func ($types, $func=undef, $data=undef)"
.IP \(bu 4
\&\f(CW$types\fR (scalar) type name string for one column, or an arrayref of type names for multiple columns
.IP \(bu 4
\&\f(CW$func\fR (scalar)
.IP \(bu 4
\&\f(CW$data\fR (scalar)
.PP
func is called as
.PP
.Vb 3
\&    sub myfunc {
\&      my ($filter, $iter, $column_num, $data) = @_;
\&      ...
.Ve
.PP
and should return the value from the filtered model that iter row and
column number.
.ie n .SS $filter\->\fBrefilter\fP
.el .SS \f(CW$filter\fP\->\fBrefilter\fP
.IX Subsection "$filter->refilter"
.ie n .SS "$filter\->\fBset_visible_column\fP ($column)"
.el .SS "\f(CW$filter\fP\->\fBset_visible_column\fP ($column)"
.IX Subsection "$filter->set_visible_column ($column)"
.IP \(bu 4
\&\f(CW$column\fR (integer)
.ie n .SS "$filter\->\fBset_visible_func\fP ($func, $data=undef)"
.el .SS "\f(CW$filter\fP\->\fBset_visible_func\fP ($func, \f(CW$data\fP=undef)"
.IX Subsection "$filter->set_visible_func ($func, $data=undef)"
.IP \(bu 4
\&\f(CW$func\fR (scalar)
.IP \(bu 4
\&\f(CW$data\fR (scalar)
.SH PROPERTIES
.IX Header "PROPERTIES"
.IP "'child\-model' (Gtk2::TreeModel : default undef : readable / writable / construct-only / private / static-nick / static-blurb)" 4
.IX Item "'child-model' (Gtk2::TreeModel : default undef : readable / writable / construct-only / private / static-nick / static-blurb)"
The model for the filtermodel to filter
.IP "'virtual\-root' (Gtk2::TreePath : default undef : readable / writable / construct-only / private / static-nick / static-blurb)" 4
.IX Item "'virtual-root' (Gtk2::TreePath : default undef : readable / writable / construct-only / private / static-nick / static-blurb)"
The virtual root (relative to the child model) for this filtermodel
.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.