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           Largest possible value for the "position" property
115
116       'min-position' (integer : default 0 : readable / private)
117           Smallest possible value for the "position" property
118
119       'position' (integer : default 0 : readable / writable / private)
120           Position of paned separator in pixels (0 means all the way to the
121           left/top)
122
123       'position-set' (boolean : default false : readable / writable /
124       private)
125           TRUE if the Position property should be used
126

CHILD PROPERTIES

128       'resize' (boolean : default true : readable / writable / private)
129           If TRUE, the child expands and shrinks along with the paned widget
130
131       'shrink' (boolean : default true : readable / writable / private)
132           If TRUE, the child can be made smaller than its requisition
133

STYLE PROPERTIES

135       'handle-size' (integer : default 5 : readable / private)
136           Width of handle
137

SIGNALS

139       boolean = accept-position (Gtk2::Paned)
140       boolean = cancel-position (Gtk2::Paned)
141       boolean = cycle-child-focus (Gtk2::Paned, boolean)
142       boolean = cycle-handle-focus (Gtk2::Paned, boolean)
143       boolean = move-handle (Gtk2::Paned, Gtk2::ScrollType)
144       boolean = toggle-handle-focus (Gtk2::Paned)
145

ENUMS AND FLAGS

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

SEE ALSO

181       Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget,
182       Gtk2::Container
183
185       Copyright (C) 2003-2011 by the gtk2-perl team.
186
187       This software is licensed under the LGPL.  See Gtk2 for a full notice.
188
189
190
191perl v5.30.0                      2019-07-26                    Gtk2::Paned(3)
Impressum