.\" -*- 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::Container 3"
.TH Gtk2::Container 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::Container \- wrapper for GtkContainer
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 5
\&  Glib::Object
\&  +\-\-\-\-Glib::InitiallyUnowned
\&       +\-\-\-\-Gtk2::Object
\&            +\-\-\-\-Gtk2::Widget
\&                 +\-\-\-\-Gtk2::Container
.Ve
.SH INTERFACES
.IX Header "INTERFACES"
.Vb 2
\&  Glib::Object::_Unregistered::AtkImplementorIface
\&  Gtk2::Buildable
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .SS "$container\->\fBadd\fP ($widget)"
.el .SS "\f(CW$container\fP\->\fBadd\fP ($widget)"
.IX Subsection "$container->add ($widget)"
.IP \(bu 4
\&\f(CW$widget\fR (Gtk2::Widget)
.ie n .SS "$container\->\fBadd_with_properties\fP ($widget, ...)"
.el .SS "\f(CW$container\fP\->\fBadd_with_properties\fP ($widget, ...)"
.IX Subsection "$container->add_with_properties ($widget, ...)"
.IP \(bu 4
\&\f(CW$widget\fR (Gtk2::Widget)
.IP \(bu 4
\&... (list) list of property name/value pairs
.ie n .SS "integer = $container\->\fBget_border_width\fP"
.el .SS "integer = \f(CW$container\fP\->\fBget_border_width\fP"
.IX Subsection "integer = $container->get_border_width"
.ie n .SS "$container\->\fBset_border_width\fP ($border_width)"
.el .SS "\f(CW$container\fP\->\fBset_border_width\fP ($border_width)"
.IX Subsection "$container->set_border_width ($border_width)"
.IP \(bu 4
\&\f(CW$border_width\fR (integer)
.ie n .SS $container\->\fBcheck_resize\fP
.el .SS \f(CW$container\fP\->\fBcheck_resize\fP
.IX Subsection "$container->check_resize"
.ie n .SS "list = $container\->\fBchild_get\fP ($child, ...)"
.el .SS "list = \f(CW$container\fP\->\fBchild_get\fP ($child, ...)"
.IX Subsection "list = $container->child_get ($child, ...)"
.IP \(bu 4
\&\f(CW$child\fR (Gtk2::Widget)
.IP \(bu 4
\&... (list) list of property names
.PP
Returns a list of properties of the child.
.ie n .SS "list = $container\->\fBchild_get_property\fP ($child, ...)"
.el .SS "list = \f(CW$container\fP\->\fBchild_get_property\fP ($child, ...)"
.IX Subsection "list = $container->child_get_property ($child, ...)"
.IP \(bu 4
\&\f(CW$child\fR (Gtk2::Widget)
.IP \(bu 4
\&... (list)
.PP
Alias for child_get
.ie n .SS "$container\->\fBchild_set\fP ($child, ...)"
.el .SS "\f(CW$container\fP\->\fBchild_set\fP ($child, ...)"
.IX Subsection "$container->child_set ($child, ...)"
.IP \(bu 4
\&\f(CW$child\fR (Gtk2::Widget)
.IP \(bu 4
\&... (list) list of property name/value pairs
.PP
Sets a list of properties on the child.
.ie n .SS "$container\->\fBchild_set_property\fP ($child, ...)"
.el .SS "\f(CW$container\fP\->\fBchild_set_property\fP ($child, ...)"
.IX Subsection "$container->child_set_property ($child, ...)"
.IP \(bu 4
\&\f(CW$child\fR (Gtk2::Widget)
.IP \(bu 4
\&... (list)
.PP
Alias for child_set
.ie n .SS "string = $container\->\fBchild_type\fP"
.el .SS "string = \f(CW$container\fP\->\fBchild_type\fP"
.IX Subsection "string = $container->child_type"
.ie n .SS "list = $container\->\fBget_children\fP"
.el .SS "list = \f(CW$container\fP\->\fBget_children\fP"
.IX Subsection "list = $container->get_children"
Returns a list of Gtk2::Widget's, the children of the container.
.ie n .SS "pspec or undef = $object_or_class_name\->\fBfind_child_property\fP ($name)"
.el .SS "pspec or undef = \f(CW$object_or_class_name\fP\->\fBfind_child_property\fP ($name)"
.IX Subsection "pspec or undef = $object_or_class_name->find_child_property ($name)"
.IP \(bu 4
\&\f(CW$name\fR (string)
.PP
Return a \f(CW\*(C`Glib::ParamSpec\*(C'\fR for child property \f(CW$name\fR on container
\&\f(CW$object_or_class_name\fR.  If there's no property \f(CW$name\fR then return
\&\f(CW\*(C`undef\*(C'\fR.  See Glib::Object \f(CW\*(C`list_properties\*(C'\fR for the fields in a
ParamSpec.
.ie n .SS "list = $container\->\fBget_focus_chain\fP"
.el .SS "list = \f(CW$container\fP\->\fBget_focus_chain\fP"
.IX Subsection "list = $container->get_focus_chain"
Returns a list of Gtk2::Widgets, the focus chain.
.ie n .SS "$container\->\fBset_focus_chain\fP (...)"
.el .SS "\f(CW$container\fP\->\fBset_focus_chain\fP (...)"
.IX Subsection "$container->set_focus_chain (...)"
.IP \(bu 4
\&... (list) of Gtk2::Widget's, the focus chain
.PP
Sets a focus chain, overriding the one computed automatically by GTK+.
.PP
In principle each widget in the chain should be a descendant of the container,
but this is not enforced by this method, since it's allowed to set the focus
chain before you pack the widgets, or have a widget in the chain that isn't
always packed. The necessary checks are done when the focus chain is actually
traversed.
.ie n .SS "widget or undef = $container\->\fBget_focus_child\fP"
.el .SS "widget or undef = \f(CW$container\fP\->\fBget_focus_child\fP"
.IX Subsection "widget or undef = $container->get_focus_child"
Since: gtk+ 2.14
.ie n .SS "$container\->\fBset_focus_child\fP ($child)"
.el .SS "\f(CW$container\fP\->\fBset_focus_child\fP ($child)"
.IX Subsection "$container->set_focus_child ($child)"
.IP \(bu 4
\&\f(CW$child\fR (Gtk2::Widget or undef)
.ie n .SS "adjustment or undef = $container\->\fBget_focus_hadjustment\fP"
.el .SS "adjustment or undef = \f(CW$container\fP\->\fBget_focus_hadjustment\fP"
.IX Subsection "adjustment or undef = $container->get_focus_hadjustment"
.ie n .SS "$container\->\fBset_focus_hadjustment\fP ($adjustment)"
.el .SS "\f(CW$container\fP\->\fBset_focus_hadjustment\fP ($adjustment)"
.IX Subsection "$container->set_focus_hadjustment ($adjustment)"
.IP \(bu 4
\&\f(CW$adjustment\fR (Gtk2::Adjustment or undef)
.ie n .SS "adjustment or undef = $container\->\fBget_focus_vadjustment\fP"
.el .SS "adjustment or undef = \f(CW$container\fP\->\fBget_focus_vadjustment\fP"
.IX Subsection "adjustment or undef = $container->get_focus_vadjustment"
.ie n .SS "$container\->\fBset_focus_vadjustment\fP ($adjustment)"
.el .SS "\f(CW$container\fP\->\fBset_focus_vadjustment\fP ($adjustment)"
.IX Subsection "$container->set_focus_vadjustment ($adjustment)"
.IP \(bu 4
\&\f(CW$adjustment\fR (Gtk2::Adjustment or undef)
.ie n .SS "$container\->\fBforall\fP ($callback, $callback_data=undef)"
.el .SS "\f(CW$container\fP\->\fBforall\fP ($callback, \f(CW$callback_data\fP=undef)"
.IX Subsection "$container->forall ($callback, $callback_data=undef)"
.IP \(bu 4
\&\f(CW$callback\fR (subroutine) Code to invoke on each child widget
.IP \(bu 4
\&\f(CW$callback_data\fR (scalar)
.PP
Invoke \fR\f(CI$callback\fR\fI\fR on each child of \fI\fR\f(CI$container\fR\fI\fR, including "internal"
children.  Most applications should not use this function.  Compare
with \fIGtk2::Container::foreach\fR.
.ie n .SS "$container\->\fBforeach\fP ($callback, $callback_data=undef)"
.el .SS "\f(CW$container\fP\->\fBforeach\fP ($callback, \f(CW$callback_data\fP=undef)"
.IX Subsection "$container->foreach ($callback, $callback_data=undef)"
.IP \(bu 4
\&\f(CW$callback\fR (subroutine) Code to invoke on each child widget
.IP \(bu 4
\&\f(CW$callback_data\fR (scalar)
.PP
Invoke \fR\f(CI$callback\fR\fI\fR on each child of \fI\fR\f(CI$container\fR\fI\fR, ignoring "internal"
children.
.ie n .SS "list = $object_or_class_name\->\fBlist_child_properties\fP"
.el .SS "list = \f(CW$object_or_class_name\fP\->\fBlist_child_properties\fP"
.IX Subsection "list = $object_or_class_name->list_child_properties"
Return a list of \f(CW\*(C`Glib::ParamSpec\*(C'\fR objects which are the child
properties available for children of a container
\&\f(CW$object_or_class_name\fR.  See Glib::Object \f(CW\*(C`list_properties\*(C'\fR for
the fields in a ParamSpec.
.ie n .SS "$container\->\fBpropagate_expose\fP ($child, $event)"
.el .SS "\f(CW$container\fP\->\fBpropagate_expose\fP ($child, \f(CW$event\fP)"
.IX Subsection "$container->propagate_expose ($child, $event)"
.IP \(bu 4
\&\f(CW$child\fR (Gtk2::Widget)
.IP \(bu 4
\&\f(CW$event\fR (Gtk2::Gdk::Event)
.ie n .SS "$container\->\fBset_reallocate_redraws\fP ($needs_redraws)"
.el .SS "\f(CW$container\fP\->\fBset_reallocate_redraws\fP ($needs_redraws)"
.IX Subsection "$container->set_reallocate_redraws ($needs_redraws)"
.IP \(bu 4
\&\f(CW$needs_redraws\fR (boolean)
.ie n .SS "$container\->\fBremove\fP ($widget)"
.el .SS "\f(CW$container\fP\->\fBremove\fP ($widget)"
.IX Subsection "$container->remove ($widget)"
.IP \(bu 4
\&\f(CW$widget\fR (Gtk2::Widget)
.ie n .SS $container\->\fBresize_children\fP
.el .SS \f(CW$container\fP\->\fBresize_children\fP
.IX Subsection "$container->resize_children"
.ie n .SS "resizemode = $container\->\fBget_resize_mode\fP"
.el .SS "resizemode = \f(CW$container\fP\->\fBget_resize_mode\fP"
.IX Subsection "resizemode = $container->get_resize_mode"
.ie n .SS "$container\->\fBset_resize_mode\fP ($resize_mode)"
.el .SS "\f(CW$container\fP\->\fBset_resize_mode\fP ($resize_mode)"
.IX Subsection "$container->set_resize_mode ($resize_mode)"
.IP \(bu 4
\&\f(CW$resize_mode\fR (Gtk2::ResizeMode)
.ie n .SS $container\->\fBunset_focus_chain\fP
.el .SS \f(CW$container\fP\->\fBunset_focus_chain\fP
.IX Subsection "$container->unset_focus_chain"
.SH PROPERTIES
.IX Header "PROPERTIES"
.IP "'border\-width' (Glib::UInt : default 0 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'border-width' (Glib::UInt : default 0 : readable / writable / private / static-nick / static-blurb)"
The width of the empty border outside the containers children
.IP "'child' (Gtk2::Widget : default undef : writable / private / static-nick / static-blurb)" 4
.IX Item "'child' (Gtk2::Widget : default undef : writable / private / static-nick / static-blurb)"
Can be used to add a new child to the container
.IP "'resize\-mode' (Gtk2::ResizeMode : default ""parent"" : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'resize-mode' (Gtk2::ResizeMode : default ""parent"" : readable / writable / private / static-nick / static-blurb)"
Specify how resize events are handled
.SH SIGNALS
.IX Header "SIGNALS"
.IP "\fBadd\fR (Gtk2::Container, Gtk2::Widget)" 4
.IX Item "add (Gtk2::Container, Gtk2::Widget)"
.PD 0
.IP "\fBcheck-resize\fR (Gtk2::Container)" 4
.IX Item "check-resize (Gtk2::Container)"
.IP "\fBremove\fR (Gtk2::Container, Gtk2::Widget)" 4
.IX Item "remove (Gtk2::Container, Gtk2::Widget)"
.IP "\fBset-focus-child\fR (Gtk2::Container, Gtk2::Widget)" 4
.IX Item "set-focus-child (Gtk2::Container, Gtk2::Widget)"
.PD
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::ResizeMode"
.IX Subsection "enum Gtk2::ResizeMode"
.IP \(bu 4
\&'parent' / 'GTK_RESIZE_PARENT'
.IP \(bu 4
\&'queue' / 'GTK_RESIZE_QUEUE'
.IP \(bu 4
\&'immediate' / 'GTK_RESIZE_IMMEDIATE'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget
.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.