1Gtk2::Paned(3)        User Contributed Perl Documentation       Gtk2::Paned(3)
2
3
4

NAME

6       Gtk2::Paned - wrapper for GtkPaned
7

HIERARCHY

9         Glib::Object
10         +----Glib::InitiallyUnowned
11              +----Gtk2::Object
12                   +----Gtk2::Widget
13                        +----Gtk2::Container
14                             +----Gtk2::Paned
15

INTERFACES

17         Glib::Object::_Unregistered::AtkImplementorIface
18         Gtk2::Buildable
19         Gtk2::Orientable
20
21       Gtk2::Paned is the base class for widgets with two panes, arranged
22       either horizontally (Gtk2::HPaned) or vertically (Gtk2::VPaned).  Child
23       widgets are added to the panes of the widget with "$paned->pack1" and
24       "$paned->pack2".  The division between the two children is set by
25       default from the size requests of the children, but it can be adjusted
26       by the user.
27
28       A paned widget draws a separator between the two child widgets and a
29       small handle that the user can drag to adjust the division.  It does
30       not draw any relief around the children or around the separator.
31       Often, it is useful to put each child inside a Gtk2::Frame with the
32       shadow type set to 'in' so that the gutter appears as a ridge.
33
34       Each child has two options that can be set, resize and shrink.  If
35       resize is true, then when the Gtk2::Paned is resized, that child will
36       expand or shrink along with the paned widget.  If shrink is true, then
37       when that child can be made smaller than its requisition by the user.
38       Setting shrink to FALSE allows the application to set a minimum size.
39       If resize is false for both children, then this is treated as if resize
40       is true for both children.
41
42       The application can set the position of the slider as if it were set by
43       the user, by calling "$paned->set_position".
44

METHODS

46   $paned->add1 ($child)
47       •   $child (Gtk2::Widget)
48
49   $paned->add2 ($child)
50       •   $child (Gtk2::Widget)
51
52   widget = $paned->child1
53   widget = $paned->get_child1
54   boolean = $paned->child1_resize
55   $paned->child1_resize (newval)
56       •   $newval (boolean)
57
58       "child1_resize" determines whether the first child should expand when
59       $paned is resized.
60
61   boolean = $paned->child1_shrink
62   $paned->child1_shrink (newval)
63       •   $newval (boolean)
64
65       "child1_shrink" determines whether the first child may be made smaller
66       than its requisition.
67
68   widget = $paned->child2
69   widget = $paned->get_child2
70   boolean = $paned->child2_resize
71   $paned->child2_resize (newval)
72       •   $newval (boolean)
73
74       "child2_resize" determines whether the second child should expand when
75       $paned is resized.
76
77   boolean = $paned->child2_shrink
78   $paned->child2_shrink (newval)
79       •   $newval (boolean)
80
81       "child2_shrink" determines whether the second child may be made smaller
82       than its requisition.
83
84   $paned->compute_position ($allocation, $child1_req, $child2_req)
85       •   $allocation (integer)
86
87       •   $child1_req (integer)
88
89       •   $child2_req (integer)
90
91   window = $paned->get_handle_window
92       Since: gtk+ 2.20
93
94   $paned->pack1 ($child, $resize, $shrink)
95       •   $child (Gtk2::Widget)
96
97       •   $resize (boolean)
98
99       •   $shrink (boolean)
100
101   $paned->pack2 ($child, $resize, $shrink)
102       •   $child (Gtk2::Widget)
103
104       •   $resize (boolean)
105
106       •   $shrink (boolean)
107
108   integer = $paned->get_position
109   $paned->set_position ($position)
110       •   $position (integer)
111

PROPERTIES

113       'max-position' (integer : default INT_MAX : readable / private /
114       static-nick / static-blurb)
115           Largest possible value for the "position" property
116
117       'min-position' (integer : default 0 : readable / private / static-nick
118       / static-blurb)
119           Smallest possible value for the "position" property
120
121       'position' (integer : default 0 : readable / writable / private /
122       static-nick / static-blurb)
123           Position of paned separator in pixels (0 means all the way to the
124           left/top)
125
126       'position-set' (boolean : default false : readable / writable / private
127       / static-nick / static-blurb)
128           TRUE if the Position property should be used
129

CHILD PROPERTIES

131       'resize' (boolean : default true : readable / writable / private /
132       static-nick / static-blurb)
133           If TRUE, the child expands and shrinks along with the paned widget
134
135       'shrink' (boolean : default true : readable / writable / private /
136       static-nick / static-blurb)
137           If TRUE, the child can be made smaller than its requisition
138

STYLE PROPERTIES

140       'handle-size' (integer : default 5 : readable / private / static-nick /
141       static-blurb)
142           Width of handle
143

SIGNALS

145       boolean = accept-position (Gtk2::Paned)
146       boolean = cancel-position (Gtk2::Paned)
147       boolean = cycle-child-focus (Gtk2::Paned, boolean)
148       boolean = cycle-handle-focus (Gtk2::Paned, boolean)
149       boolean = move-handle (Gtk2::Paned, Gtk2::ScrollType)
150       boolean = toggle-handle-focus (Gtk2::Paned)
151

ENUMS AND FLAGS

153   enum Gtk2::ScrollType
154       •   'none' / 'GTK_SCROLL_NONE'
155
156       •   'jump' / 'GTK_SCROLL_JUMP'
157
158       •   'step-backward' / 'GTK_SCROLL_STEP_BACKWARD'
159
160       •   'step-forward' / 'GTK_SCROLL_STEP_FORWARD'
161
162       •   'page-backward' / 'GTK_SCROLL_PAGE_BACKWARD'
163
164       •   'page-forward' / 'GTK_SCROLL_PAGE_FORWARD'
165
166       •   'step-up' / 'GTK_SCROLL_STEP_UP'
167
168       •   'step-down' / 'GTK_SCROLL_STEP_DOWN'
169
170       •   'page-up' / 'GTK_SCROLL_PAGE_UP'
171
172       •   'page-down' / 'GTK_SCROLL_PAGE_DOWN'
173
174       •   'step-left' / 'GTK_SCROLL_STEP_LEFT'
175
176       •   'step-right' / 'GTK_SCROLL_STEP_RIGHT'
177
178       •   'page-left' / 'GTK_SCROLL_PAGE_LEFT'
179
180       •   'page-right' / 'GTK_SCROLL_PAGE_RIGHT'
181
182       •   'start' / 'GTK_SCROLL_START'
183
184       •   'end' / 'GTK_SCROLL_END'
185

SEE ALSO

187       Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget,
188       Gtk2::Container
189
191       Copyright (C) 2003-2011 by the gtk2-perl team.
192
193       This software is licensed under the LGPL.  See Gtk2 for a full notice.
194
195
196
197perl v5.32.1                      2021-01-27                    Gtk2::Paned(3)
Impressum