.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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::Paned 3pm"
.TH Gtk2::Paned 3pm "2019-09-16" "perl v5.28.1" "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::Paned \- wrapper for GtkPaned
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 6
\&  Glib::Object
\&  +\-\-\-\-Glib::InitiallyUnowned
\&       +\-\-\-\-Gtk2::Object
\&            +\-\-\-\-Gtk2::Widget
\&                 +\-\-\-\-Gtk2::Container
\&                      +\-\-\-\-Gtk2::Paned
.Ve
.SH "INTERFACES"
.IX Header "INTERFACES"
.Vb 3
\&  Glib::Object::_Unregistered::AtkImplementorIface
\&  Gtk2::Buildable
\&  Gtk2::Orientable
.Ve
.PP
Gtk2::Paned is the base class for widgets with two panes, arranged either
horizontally (Gtk2::HPaned) or vertically (Gtk2::VPaned).  Child widgets are
added to the panes of the widget with \f(CW\*(C`$paned\->pack1\*(C'\fR and
\&\f(CW\*(C`$paned\->pack2\*(C'\fR.  The division between the two children is set by default
from the size requests of the children, but it can be adjusted by the user.
.PP
A paned widget draws a separator between the two child widgets and a small
handle that the user can drag to adjust the division.  It does not draw any
relief around the children or around the separator.  Often, it is useful to put
each child inside a Gtk2::Frame with the shadow type set to 'in' so that the
gutter appears as a ridge.
.PP
Each child has two options that can be set, resize and shrink.  If resize is
true, then when the Gtk2::Paned is resized, that child will expand or shrink
along with the paned widget.  If shrink is true, then when that child can be
made smaller than its requisition by the user.  Setting shrink to \s-1FALSE\s0 allows
the application to set a minimum size.  If resize is false for both children,
then this is treated as if resize is true for both children.
.PP
The application can set the position of the slider as if it were set by the
user, by calling \f(CW\*(C`$paned\->set_position\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "$paned\->\fBadd1\fP ($child)"
.el .SS "\f(CW$paned\fP\->\fBadd1\fP ($child)"
.IX Subsection "$paned->add1 ($child)"
.IP "\(bu" 4
\&\f(CW$child\fR (Gtk2::Widget)
.ie n .SS "$paned\->\fBadd2\fP ($child)"
.el .SS "\f(CW$paned\fP\->\fBadd2\fP ($child)"
.IX Subsection "$paned->add2 ($child)"
.IP "\(bu" 4
\&\f(CW$child\fR (Gtk2::Widget)
.ie n .SS "widget = $paned\->\fBchild1\fP"
.el .SS "widget = \f(CW$paned\fP\->\fBchild1\fP"
.IX Subsection "widget = $paned->child1"
.ie n .SS "widget = $paned\->\fBget_child1\fP"
.el .SS "widget = \f(CW$paned\fP\->\fBget_child1\fP"
.IX Subsection "widget = $paned->get_child1"
.ie n .SS "boolean = $paned\->\fBchild1_resize\fP"
.el .SS "boolean = \f(CW$paned\fP\->\fBchild1_resize\fP"
.IX Subsection "boolean = $paned->child1_resize"
.ie n .SS "$paned\->\fBchild1_resize\fP (newval)"
.el .SS "\f(CW$paned\fP\->\fBchild1_resize\fP (newval)"
.IX Subsection "$paned->child1_resize (newval)"
.IP "\(bu" 4
\&\f(CW$newval\fR (boolean)
.PP
\&\f(CW\*(C`child1_resize\*(C'\fR determines whether the first child should expand when 
\&\fI\f(CI$paned\fI\fR is resized.
.ie n .SS "boolean = $paned\->\fBchild1_shrink\fP"
.el .SS "boolean = \f(CW$paned\fP\->\fBchild1_shrink\fP"
.IX Subsection "boolean = $paned->child1_shrink"
.ie n .SS "$paned\->\fBchild1_shrink\fP (newval)"
.el .SS "\f(CW$paned\fP\->\fBchild1_shrink\fP (newval)"
.IX Subsection "$paned->child1_shrink (newval)"
.IP "\(bu" 4
\&\f(CW$newval\fR (boolean)
.PP
\&\f(CW\*(C`child1_shrink\*(C'\fR determines whether the first child may be made smaller
than its requisition.
.ie n .SS "widget = $paned\->\fBchild2\fP"
.el .SS "widget = \f(CW$paned\fP\->\fBchild2\fP"
.IX Subsection "widget = $paned->child2"
.ie n .SS "widget = $paned\->\fBget_child2\fP"
.el .SS "widget = \f(CW$paned\fP\->\fBget_child2\fP"
.IX Subsection "widget = $paned->get_child2"
.ie n .SS "boolean = $paned\->\fBchild2_resize\fP"
.el .SS "boolean = \f(CW$paned\fP\->\fBchild2_resize\fP"
.IX Subsection "boolean = $paned->child2_resize"
.ie n .SS "$paned\->\fBchild2_resize\fP (newval)"
.el .SS "\f(CW$paned\fP\->\fBchild2_resize\fP (newval)"
.IX Subsection "$paned->child2_resize (newval)"
.IP "\(bu" 4
\&\f(CW$newval\fR (boolean)
.PP
\&\f(CW\*(C`child2_resize\*(C'\fR determines whether the second child should expand when 
\&\fI\f(CI$paned\fI\fR is resized.
.ie n .SS "boolean = $paned\->\fBchild2_shrink\fP"
.el .SS "boolean = \f(CW$paned\fP\->\fBchild2_shrink\fP"
.IX Subsection "boolean = $paned->child2_shrink"
.ie n .SS "$paned\->\fBchild2_shrink\fP (newval)"
.el .SS "\f(CW$paned\fP\->\fBchild2_shrink\fP (newval)"
.IX Subsection "$paned->child2_shrink (newval)"
.IP "\(bu" 4
\&\f(CW$newval\fR (boolean)
.PP
\&\f(CW\*(C`child2_shrink\*(C'\fR determines whether the second child may be made smaller
than its requisition.
.ie n .SS "$paned\->\fBcompute_position\fP ($allocation, $child1_req, $child2_req)"
.el .SS "\f(CW$paned\fP\->\fBcompute_position\fP ($allocation, \f(CW$child1_req\fP, \f(CW$child2_req\fP)"
.IX Subsection "$paned->compute_position ($allocation, $child1_req, $child2_req)"
.IP "\(bu" 4
\&\f(CW$allocation\fR (integer)
.IP "\(bu" 4
\&\f(CW$child1_req\fR (integer)
.IP "\(bu" 4
\&\f(CW$child2_req\fR (integer)
.ie n .SS "window = $paned\->\fBget_handle_window\fP"
.el .SS "window = \f(CW$paned\fP\->\fBget_handle_window\fP"
.IX Subsection "window = $paned->get_handle_window"
Since: gtk+ 2.20
.ie n .SS "$paned\->\fBpack1\fP ($child, $resize, $shrink)"
.el .SS "\f(CW$paned\fP\->\fBpack1\fP ($child, \f(CW$resize\fP, \f(CW$shrink\fP)"
.IX Subsection "$paned->pack1 ($child, $resize, $shrink)"
.IP "\(bu" 4
\&\f(CW$child\fR (Gtk2::Widget)
.IP "\(bu" 4
\&\f(CW$resize\fR (boolean)
.IP "\(bu" 4
\&\f(CW$shrink\fR (boolean)
.ie n .SS "$paned\->\fBpack2\fP ($child, $resize, $shrink)"
.el .SS "\f(CW$paned\fP\->\fBpack2\fP ($child, \f(CW$resize\fP, \f(CW$shrink\fP)"
.IX Subsection "$paned->pack2 ($child, $resize, $shrink)"
.IP "\(bu" 4
\&\f(CW$child\fR (Gtk2::Widget)
.IP "\(bu" 4
\&\f(CW$resize\fR (boolean)
.IP "\(bu" 4
\&\f(CW$shrink\fR (boolean)
.ie n .SS "integer = $paned\->\fBget_position\fP"
.el .SS "integer = \f(CW$paned\fP\->\fBget_position\fP"
.IX Subsection "integer = $paned->get_position"
.ie n .SS "$paned\->\fBset_position\fP ($position)"
.el .SS "\f(CW$paned\fP\->\fBset_position\fP ($position)"
.IX Subsection "$paned->set_position ($position)"
.IP "\(bu" 4
\&\f(CW$position\fR (integer)
.SH "PROPERTIES"
.IX Header "PROPERTIES"
.IP "'max\-position' (integer : default \s-1INT_MAX :\s0 readable / private)" 4
.IX Item "'max-position' (integer : default INT_MAX : readable / private)"
Largest possible value for the \*(L"position\*(R" property
.IP "'min\-position' (integer : default 0 : readable / private)" 4
.IX Item "'min-position' (integer : default 0 : readable / private)"
Smallest possible value for the \*(L"position\*(R" property
.IP "'position' (integer : default 0 : readable / writable / private)" 4
.IX Item "'position' (integer : default 0 : readable / writable / private)"
Position of paned separator in pixels (0 means all the way to the left/top)
.IP "'position\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'position-set' (boolean : default false : readable / writable / private)"
\&\s-1TRUE\s0 if the Position property should be used
.SH "CHILD PROPERTIES"
.IX Header "CHILD PROPERTIES"
.IP "'resize' (boolean : default true : readable / writable / private)" 4
.IX Item "'resize' (boolean : default true : readable / writable / private)"
If \s-1TRUE,\s0 the child expands and shrinks along with the paned widget
.IP "'shrink' (boolean : default true : readable / writable / private)" 4
.IX Item "'shrink' (boolean : default true : readable / writable / private)"
If \s-1TRUE,\s0 the child can be made smaller than its requisition
.SH "STYLE PROPERTIES"
.IX Header "STYLE PROPERTIES"
.IP "'handle\-size' (integer : default 5 : readable / private)" 4
.IX Item "'handle-size' (integer : default 5 : readable / private)"
Width of handle
.SH "SIGNALS"
.IX Header "SIGNALS"
.IP "boolean = \fBaccept-position\fR (Gtk2::Paned)" 4
.IX Item "boolean = accept-position (Gtk2::Paned)"
.PD 0
.IP "boolean = \fBcancel-position\fR (Gtk2::Paned)" 4
.IX Item "boolean = cancel-position (Gtk2::Paned)"
.IP "boolean = \fBcycle-child-focus\fR (Gtk2::Paned, boolean)" 4
.IX Item "boolean = cycle-child-focus (Gtk2::Paned, boolean)"
.IP "boolean = \fBcycle-handle-focus\fR (Gtk2::Paned, boolean)" 4
.IX Item "boolean = cycle-handle-focus (Gtk2::Paned, boolean)"
.IP "boolean = \fBmove-handle\fR (Gtk2::Paned, Gtk2::ScrollType)" 4
.IX Item "boolean = move-handle (Gtk2::Paned, Gtk2::ScrollType)"
.IP "boolean = \fBtoggle-handle-focus\fR (Gtk2::Paned)" 4
.IX Item "boolean = toggle-handle-focus (Gtk2::Paned)"
.PD
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::ScrollType"
.IX Subsection "enum Gtk2::ScrollType"
.IP "\(bu" 4
\&'none' / '\s-1GTK_SCROLL_NONE\s0'
.IP "\(bu" 4
\&'jump' / '\s-1GTK_SCROLL_JUMP\s0'
.IP "\(bu" 4
\&'step\-backward' / '\s-1GTK_SCROLL_STEP_BACKWARD\s0'
.IP "\(bu" 4
\&'step\-forward' / '\s-1GTK_SCROLL_STEP_FORWARD\s0'
.IP "\(bu" 4
\&'page\-backward' / '\s-1GTK_SCROLL_PAGE_BACKWARD\s0'
.IP "\(bu" 4
\&'page\-forward' / '\s-1GTK_SCROLL_PAGE_FORWARD\s0'
.IP "\(bu" 4
\&'step\-up' / '\s-1GTK_SCROLL_STEP_UP\s0'
.IP "\(bu" 4
\&'step\-down' / '\s-1GTK_SCROLL_STEP_DOWN\s0'
.IP "\(bu" 4
\&'page\-up' / '\s-1GTK_SCROLL_PAGE_UP\s0'
.IP "\(bu" 4
\&'page\-down' / '\s-1GTK_SCROLL_PAGE_DOWN\s0'
.IP "\(bu" 4
\&'step\-left' / '\s-1GTK_SCROLL_STEP_LEFT\s0'
.IP "\(bu" 4
\&'step\-right' / '\s-1GTK_SCROLL_STEP_RIGHT\s0'
.IP "\(bu" 4
\&'page\-left' / '\s-1GTK_SCROLL_PAGE_LEFT\s0'
.IP "\(bu" 4
\&'page\-right' / '\s-1GTK_SCROLL_PAGE_RIGHT\s0'
.IP "\(bu" 4
\&'start' / '\s-1GTK_SCROLL_START\s0'
.IP "\(bu" 4
\&'end' / '\s-1GTK_SCROLL_END\s0'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL.\s0  See Gtk2 for a full notice.