Gtk2::Paned(3pm)

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

NAME

6       Gtk2::Paned
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         Glib::Object::_Unregistered::GtkOrientable
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 beween 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
59           when $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
66           smaller 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
75           when $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
82           smaller 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   $paned->pack1 ($child, $resize, $shrink)
92           ·   $child (Gtk2::Widget)
93
94           ·   $resize (boolean)
95
96           ·   $shrink (boolean)
97
98   $paned->pack2 ($child, $resize, $shrink)
99           ·   $child (Gtk2::Widget)
100
101           ·   $resize (boolean)
102
103           ·   $shrink (boolean)
104
105   integer = $paned->get_position
106   $paned->set_position ($position)
107           ·   $position (integer)
108

PROPERTIES

110       'max-position' (integer : readable / private)
111           Largest possible value for the "position" property
112
113       'min-position' (integer : readable / private)
114           Smallest possible value for the "position" property
115
116       'position' (integer : readable / writable / private)
117           Position of paned separator in pixels (0 means all the way to the
118           left/top)
119
120       'position-set' (boolean : readable / writable / private)
121           TRUE if the Position property should be used
122

SIGNALS

124       boolean = cycle-child-focus (Gtk2::Paned, boolean)
125       boolean = toggle-handle-focus (Gtk2::Paned)
126       boolean = move-handle (Gtk2::Paned, Gtk2::ScrollType)
127       boolean = cycle-handle-focus (Gtk2::Paned, boolean)
128       boolean = accept-position (Gtk2::Paned)
129       boolean = cancel-position (Gtk2::Paned)
130

ENUMS AND FLAGS

132   enum Gtk2::ScrollType
133       ·   'none' / 'GTK_SCROLL_NONE'
134
135       ·   'jump' / 'GTK_SCROLL_JUMP'
136
137       ·   'step-backward' / 'GTK_SCROLL_STEP_BACKWARD'
138
139       ·   'step-forward' / 'GTK_SCROLL_STEP_FORWARD'
140
141       ·   'page-backward' / 'GTK_SCROLL_PAGE_BACKWARD'
142
143       ·   'page-forward' / 'GTK_SCROLL_PAGE_FORWARD'
144
145       ·   'step-up' / 'GTK_SCROLL_STEP_UP'
146
147       ·   'step-down' / 'GTK_SCROLL_STEP_DOWN'
148
149       ·   'page-up' / 'GTK_SCROLL_PAGE_UP'
150
151       ·   'page-down' / 'GTK_SCROLL_PAGE_DOWN'
152
153       ·   'step-left' / 'GTK_SCROLL_STEP_LEFT'
154
155       ·   'step-right' / 'GTK_SCROLL_STEP_RIGHT'
156
157       ·   'page-left' / 'GTK_SCROLL_PAGE_LEFT'
158
159       ·   'page-right' / 'GTK_SCROLL_PAGE_RIGHT'
160
161       ·   'start' / 'GTK_SCROLL_START'
162
163       ·   'end' / 'GTK_SCROLL_END'
164

COPYRIGHT

170       Copyright (C) 2003-2008 by the gtk2-perl team.
171
172       This software is licensed under the LGPL.  See Gtk2 for a full notice.
173
174
175
176perl v5.12.0                      2010-05-02                    Gtk2::Paned(3)