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

METHODS

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

PROPERTIES

121       'max-position' (integer : readable / private)
122           Largest possible value for the "position" property
123
124       'min-position' (integer : readable / private)
125           Smallest possible value for the "position" property
126
127       'position' (integer : readable / writable / private)
128           Position of paned separator in pixels (0 means all the way to the
129           left/top)
130
131       'position-set' (boolean : readable / writable / private)
132           TRUE if the Position property should be used
133

SIGNALS

135       boolean = cycle-child-focus (Gtk2::Paned, boolean)
136       boolean = toggle-handle-focus (Gtk2::Paned)
137       boolean = move-handle (Gtk2::Paned, Gtk2::ScrollType)
138       boolean = cycle-handle-focus (Gtk2::Paned, boolean)
139       boolean = accept-position (Gtk2::Paned)
140       boolean = cancel-position (Gtk2::Paned)
141

ENUMS AND FLAGS

143       enum Gtk2::ScrollType
144
145       * 'none' / 'GTK_SCROLL_NONE'
146       * 'jump' / 'GTK_SCROLL_JUMP'
147       * 'step-backward' / 'GTK_SCROLL_STEP_BACKWARD'
148       * 'step-forward' / 'GTK_SCROLL_STEP_FORWARD'
149       * 'page-backward' / 'GTK_SCROLL_PAGE_BACKWARD'
150       * 'page-forward' / 'GTK_SCROLL_PAGE_FORWARD'
151       * 'step-up' / 'GTK_SCROLL_STEP_UP'
152       * 'step-down' / 'GTK_SCROLL_STEP_DOWN'
153       * 'page-up' / 'GTK_SCROLL_PAGE_UP'
154       * 'page-down' / 'GTK_SCROLL_PAGE_DOWN'
155       * 'step-left' / 'GTK_SCROLL_STEP_LEFT'
156       * 'step-right' / 'GTK_SCROLL_STEP_RIGHT'
157       * 'page-left' / 'GTK_SCROLL_PAGE_LEFT'
158       * 'page-right' / 'GTK_SCROLL_PAGE_RIGHT'
159       * 'start' / 'GTK_SCROLL_START'
160       * 'end' / 'GTK_SCROLL_END'
161

COPYRIGHT

167       Copyright (C) 2003-2007 by the gtk2-perl team.
168
169       This software is licensed under the LGPL.  See Gtk2 for a full notice.
170
171
172
173perl v5.8.8                       2007-03-18                    Gtk2::Paned(3)