Gtk2::Notebook(3pm)

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

NAME

6       Gtk2::Notebook
7

HIERARCHY

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

INTERFACES

17         Glib::Object::_Unregistered::AtkImplementorIface
18

METHODS

20       widget = Gtk2::Notebook->new
21
22       integer = $notebook->append_page ($child, $tab_label=undef)
23
24           * $child (Gtk2::Widget)
25           * $tab_label (scalar)
26
27           (integer return since Gtk2-Perl 1.080)
28
29       integer = $notebook->append_page_menu ($child, $tab_label, $menu_label)
30
31           * $child (Gtk2::Widget)
32           * $tab_label (Gtk2::Widget or undef)
33           * $menu_label (Gtk2::Widget or undef)
34
35           (integer return since Gtk2-Perl 1.080)
36
37       integer = $notebook->get_current_page
38
39       $notebook->set_current_page ($page_num)
40
41           * $page_num (integer)
42
43       integer = $notebook->get_group_id
44
45       $notebook->set_group_id ($group_id)
46
47           * $group_id (integer)
48
49       integer = $notebook->insert_page ($child, $tab_label, $position)
50
51           * $child (Gtk2::Widget)
52           * $tab_label (scalar)
53           * $position (integer)
54
55           (integer return since Gtk2-Perl 1.080)
56
57       integer = $notebook->insert_page_menu ($child, $tab_label, $menu_label,
58       $position)
59
60           * $child (Gtk2::Widget)
61           * $tab_label (Gtk2::Widget or undef)
62           * $menu_label (Gtk2::Widget or undef)
63           * $position (integer)
64
65           (integer return since Gtk2-Perl 1.080)
66
67       widget or undef = $notebook->get_menu_label ($child)
68
69           * $child (Gtk2::Widget)
70
71       $notebook->set_menu_label ($child, $menu_label=undef)
72
73           * $child (Gtk2::Widget)
74           * $menu_label (Gtk2::Widget or undef)
75
76       string = $notebook->get_menu_label_text ($child)
77
78           * $child (Gtk2::Widget)
79
80       $notebook->set_menu_label_text ($child, $menu_text)
81
82           * $child (Gtk2::Widget)
83           * $menu_text (string)
84
85       integer = $notebook->get_n_pages
86
87       $notebook->next_page
88
89       widget or undef = $notebook->get_nth_page ($page_num)
90
91           * $page_num (integer)
92
93       integer = $notebook->page_num ($child)
94
95           * $child (Gtk2::Widget)
96
97       $notebook->popup_disable
98
99       $notebook->popup_enable
100
101       integer = $notebook->prepend_page ($child, $tab_label=undef)
102
103           * $child (Gtk2::Widget)
104           * $tab_label (scalar)
105
106           (integer return since Gtk2-Perl 1.080)
107
108       integer = $notebook->prepend_page_menu ($child, $tab_label,
109       $menu_label)
110
111           * $child (Gtk2::Widget)
112           * $tab_label (Gtk2::Widget or undef)
113           * $menu_label (Gtk2::Widget or undef)
114
115           (integer return since Gtk2-Perl 1.080)
116
117       $notebook->prev_page
118
119       (expand, fill, pack_type) = $notebook->query_tab_label_packing ($child)
120
121           * $child (Gtk2::Widget)
122
123       $notebook->remove_page ($page_num)
124
125           * $page_num (integer)
126
127       $notebook->reorder_child ($child, $position)
128
129           * $child (Gtk2::Widget)
130           * $position (integer)
131
132       boolean = $notebook->get_scrollable
133
134       $notebook->set_scrollable ($scrollable)
135
136           * $scrollable (boolean)
137
138       boolean = $notebook->get_show_border
139
140       $notebook->set_show_border ($show_border)
141
142           * $show_border (boolean)
143
144       boolean = $notebook->get_show_tabs
145
146       $notebook->set_show_tabs ($show_tabs)
147
148           * $show_tabs (boolean)
149
150       $notebook->set_tab_border ($border_width)
151
152           * $border_width (integer)
153
154       boolean = $notebook->get_tab_detachable ($child)
155
156           * $child (Gtk2::Widget)
157
158       $notebook->set_tab_detachable ($child, $detachable)
159
160           * $child (Gtk2::Widget)
161           * $detachable (boolean)
162
163       $notebook->set_tab_hborder ($tab_hborder)
164
165           * $tab_hborder (integer)
166
167       widget = $notebook->get_tab_label ($child)
168
169           * $child (Gtk2::Widget)
170
171       $notebook->set_tab_label_packing ($child, $expand, $fill, $pack_type)
172
173           * $child (Gtk2::Widget)
174           * $expand (boolean)
175           * $fill (boolean)
176           * $pack_type (Gtk2::PackType)
177
178       $notebook->set_tab_label ($child, $tab_label=undef)
179
180           * $child (Gtk2::Widget)
181           * $tab_label (Gtk2::Widget or undef)
182
183       string = $notebook->get_tab_label_text ($child)
184
185           * $child (Gtk2::Widget)
186
187       $notebook->set_tab_label_text ($child, $tab_text)
188
189           * $child (Gtk2::Widget)
190           * $tab_text (string)
191
192       positiontype = $notebook->get_tab_pos
193
194       $notebook->set_tab_pos ($pos)
195
196           * $pos (Gtk2::PositionType)
197
198       boolean = $notebook->get_tab_reorderable ($child)
199
200           * $child (Gtk2::Widget)
201
202       $notebook->set_tab_reorderable ($child, $reorderable)
203
204           * $child (Gtk2::Widget)
205           * $reorderable (boolean)
206
207       $notebook->set_tab_vborder ($tab_vborder)
208
209           * $tab_vborder (integer)
210
211       Gtk2::Notebook->set_window_creation_hook ($func, $data=undef)
212
213           * $func (scalar)
214           * $data (scalar)
215

PROPERTIES

217       'enable-popup' (boolean : readable / writable / private)
218           If TRUE, pressing the right mouse button on the notebook pops up a
219           menu that you can use to go to a page
220
221       'group-id' (integer : readable / writable / private)
222           Group ID for tabs drag and drop
223
224       'homogeneous' (boolean : readable / writable / private)
225           Whether tabs should have homogeneous sizes
226
227       'page' (integer : readable / writable / private)
228           The index of the current page
229
230       'scrollable' (boolean : readable / writable / private)
231           If TRUE, scroll arrows are added if there are too many tabs to fit
232
233       'show-border' (boolean : readable / writable / private)
234           Whether the border should be shown or not
235
236       'show-tabs' (boolean : readable / writable / private)
237           Whether tabs should be shown or not
238
239       'tab-border' (Glib::UInt : writable / private)
240           Width of the border around the tab labels
241
242       'tab-hborder' (Glib::UInt : readable / writable / private)
243           Width of the horizontal border of tab labels
244
245       'tab-pos' (Gtk2::PositionType : readable / writable / private)
246           Which side of the notebook holds the tabs
247
248       'tab-vborder' (Glib::UInt : readable / writable / private)
249           Width of the vertical border of tab labels
250

SIGNALS

252       switch-page (Gtk2::Notebook, gpointer, Glib::UInt)
253       boolean = focus-tab (Gtk2::Notebook, Gtk2::NotebookTab)
254       boolean = select-page (Gtk2::Notebook, boolean)
255       boolean = change-current-page (Gtk2::Notebook, integer)
256       move-focus-out (Gtk2::Notebook, Gtk2::DirectionType)
257       boolean = reorder-tab (Gtk2::Notebook, Gtk2::DirectionType, boolean)
258       page-reordered (Gtk2::Notebook, Gtk2::Widget, Glib::UInt)
259       page-removed (Gtk2::Notebook, Gtk2::Widget, Glib::UInt)
260       page-added (Gtk2::Notebook, Gtk2::Widget, Glib::UInt)
261

ENUMS AND FLAGS

263       enum Gtk2::DirectionType
264
265       * 'tab-forward' / 'GTK_DIR_TAB_FORWARD'
266       * 'tab-backward' / 'GTK_DIR_TAB_BACKWARD'
267       * 'up' / 'GTK_DIR_UP'
268       * 'down' / 'GTK_DIR_DOWN'
269       * 'left' / 'GTK_DIR_LEFT'
270       * 'right' / 'GTK_DIR_RIGHT'
271
272       enum Gtk2::NotebookTab
273
274       * 'first' / 'GTK_NOTEBOOK_TAB_FIRST'
275       * 'last' / 'GTK_NOTEBOOK_TAB_LAST'
276
277       enum Gtk2::PackType
278
279       * 'start' / 'GTK_PACK_START'
280       * 'end' / 'GTK_PACK_END'
281
282       enum Gtk2::PositionType
283
284       * 'left' / 'GTK_POS_LEFT'
285       * 'right' / 'GTK_POS_RIGHT'
286       * 'top' / 'GTK_POS_TOP'
287       * 'bottom' / 'GTK_POS_BOTTOM'
288

COPYRIGHT

294       Copyright (C) 2003-2007 by the gtk2-perl team.
295
296       This software is licensed under the LGPL.  See Gtk2 for a full notice.
297
298
299
300perl v5.8.8                       2007-03-18                 Gtk2::Notebook(3)