gtknotebook.sgml 6.42 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4
<!-- ##### SECTION Title ##### -->
GtkNotebook

<!-- ##### SECTION Short_Description ##### -->
5
A tabbed notebook container.
Owen Taylor's avatar
Owen Taylor committed
6 7 8

<!-- ##### SECTION Long_Description ##### -->
<para>
9
The #GtkNotebook widget is a #GtkContainer whose children are pages that
10 11 12 13 14 15 16 17 18 19
can be switched between using tab labels along one edge.
</para>
<para>
There are many configuration options for #GtkNotebook. Among other
things, you can choose on which edge the tabs appear
(see gtk_notebook_set_tab_pos()), whether, if there are too many
tabs to fit the noteobook should be made bigger or scrolling
arrows added (see gtk_notebook_set_scrollable), and whether there
will be a popup menu allowing the users to switch pages.
(see gtk_notebook_enable_popup(), gtk_noteobook_disable_popup())
Owen Taylor's avatar
Owen Taylor committed
20 21 22 23
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
24 25 26 27 28 29 30
<variablelist>
<varlistentry>
<term>#GtkContainer</term>
<listitem><para>For functions that apply to every #GtkContainer
(like #GtkList).</para></listitem>
</varlistentry>
</variablelist>
Owen Taylor's avatar
Owen Taylor committed
31 32 33 34 35 36 37 38 39 40
</para>

<!-- ##### STRUCT GtkNotebook ##### -->
<para>

</para>


<!-- ##### STRUCT GtkNotebookPage ##### -->
<para>
41
The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
Owen Taylor's avatar
Owen Taylor committed
42 43
</para>

Owen Taylor's avatar
Owen Taylor committed
44

Owen Taylor's avatar
Owen Taylor committed
45 46 47 48
<!-- ##### FUNCTION gtk_notebook_new ##### -->
<para>
</para>

49
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
50 51 52 53 54 55


<!-- ##### FUNCTION gtk_notebook_append_page ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
56 57 58
@notebook: 
@child: 
@tab_label: 
Owen Taylor's avatar
Owen Taylor committed
59 60 61 62 63 64


<!-- ##### FUNCTION gtk_notebook_append_page_menu ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
65 66 67 68
@notebook: 
@child: 
@tab_label: 
@menu_label: 
Owen Taylor's avatar
Owen Taylor committed
69 70 71 72 73 74


<!-- ##### FUNCTION gtk_notebook_prepend_page ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
75 76 77
@notebook: 
@child: the
@tab_label: 
Owen Taylor's avatar
Owen Taylor committed
78 79 80 81 82 83


<!-- ##### FUNCTION gtk_notebook_prepend_page_menu ##### -->
<para>
</para>

84 85
@notebook: 
@child: 
Owen Taylor's avatar
Owen Taylor committed
86 87
@tab_label: 
@menu_label: 
Owen Taylor's avatar
Owen Taylor committed
88 89 90 91 92 93


<!-- ##### FUNCTION gtk_notebook_insert_page ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
94 95 96 97
@notebook: 
@child: 
@tab_label: 
@position: 
Owen Taylor's avatar
Owen Taylor committed
98 99 100 101 102 103


<!-- ##### FUNCTION gtk_notebook_insert_page_menu ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
104 105 106
@notebook: 
@child: 
@tab_label: 
107
@menu_label: 
Owen Taylor's avatar
Owen Taylor committed
108
@position: 
Owen Taylor's avatar
Owen Taylor committed
109 110 111 112 113 114


<!-- ##### FUNCTION gtk_notebook_remove_page ##### -->
<para>
</para>

115
@notebook: 
Owen Taylor's avatar
Owen Taylor committed
116
@page_num: 
Owen Taylor's avatar
Owen Taylor committed
117 118 119 120


<!-- ##### MACRO gtk_notebook_current_page ##### -->
<para>
121
Compatibility macro; in gtkcompat.h.
Owen Taylor's avatar
Owen Taylor committed
122 123 124 125 126 127 128 129
</para>



<!-- ##### FUNCTION gtk_notebook_page_num ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
130 131 132
@notebook: 
@child: 
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
133 134


135
<!-- ##### MACRO gtk_notebook_set_page ##### -->
Owen Taylor's avatar
Owen Taylor committed
136 137 138
<para>
</para>

139
<!-- # Unused Parameters # -->
Owen Taylor's avatar
Owen Taylor committed
140 141
@notebook: 
@page_num: 
Owen Taylor's avatar
Owen Taylor committed
142 143 144 145 146 147


<!-- ##### FUNCTION gtk_notebook_next_page ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
148
@notebook: 
Owen Taylor's avatar
Owen Taylor committed
149 150 151 152 153 154


<!-- ##### FUNCTION gtk_notebook_prev_page ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
155
@notebook: 
Owen Taylor's avatar
Owen Taylor committed
156 157 158 159 160 161


<!-- ##### FUNCTION gtk_notebook_reorder_child ##### -->
<para>
</para>

162
@notebook
Owen Taylor's avatar
Owen Taylor committed
163 164 165 166 167

@notebook: 
@child: 
@position: 

Owen Taylor's avatar
Owen Taylor committed
168 169 170 171 172

<!-- ##### FUNCTION gtk_notebook_set_tab_pos ##### -->
<para>
</para>

173 174
@notebook: the notebook widget
@pos: the position
Owen Taylor's avatar
Owen Taylor committed
175 176 177 178 179 180


<!-- ##### FUNCTION gtk_notebook_set_show_tabs ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
181 182
@notebook: 
@show_tabs: 
Owen Taylor's avatar
Owen Taylor committed
183 184 185 186 187 188


<!-- ##### FUNCTION gtk_notebook_set_show_border ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
189 190
@notebook: 
@show_border: 
Owen Taylor's avatar
Owen Taylor committed
191 192 193 194 195 196


<!-- ##### FUNCTION gtk_notebook_set_scrollable ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
197 198
@notebook: 
@scrollable: 
Owen Taylor's avatar
Owen Taylor committed
199 200 201 202


<!-- ##### FUNCTION gtk_notebook_set_tab_border ##### -->
<para>
203 204
</para>

Owen Taylor's avatar
Owen Taylor committed
205 206
@notebook: 
@border_width: 
207 208


Owen Taylor's avatar
Owen Taylor committed
209 210 211 212
<!-- ##### FUNCTION gtk_notebook_popup_enable ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
213
@notebook: 
Owen Taylor's avatar
Owen Taylor committed
214 215 216 217 218 219


<!-- ##### FUNCTION gtk_notebook_popup_disable ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
220 221
@notebook: 

Owen Taylor's avatar
Owen Taylor committed
222 223 224 225 226

<!-- ##### FUNCTION gtk_notebook_get_current_page ##### -->
<para>
</para>

227 228
@notebook: the notebook widget
@Returns: the page number
Owen Taylor's avatar
Owen Taylor committed
229 230 231 232 233 234


<!-- ##### FUNCTION gtk_notebook_get_menu_label ##### -->
<para>
</para>

235 236 237
@notebook: 
@child: 
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
238 239 240 241 242 243


<!-- ##### FUNCTION gtk_notebook_get_nth_page ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
244 245 246
@notebook: 
@page_num: 
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
247 248 249 250 251 252


<!-- ##### FUNCTION gtk_notebook_get_tab_label ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
253 254 255
@notebook: 
@child: 
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
256 257 258 259 260 261


<!-- ##### FUNCTION gtk_notebook_query_tab_label_packing ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
262 263 264 265 266
@notebook: 
@child: 
@expand: 
@fill: 
@pack_type: 
Owen Taylor's avatar
Owen Taylor committed
267 268 269 270 271 272


<!-- ##### FUNCTION gtk_notebook_set_homogeneous_tabs ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
273 274
@notebook: 
@homogeneous: 
Owen Taylor's avatar
Owen Taylor committed
275 276 277 278 279 280


<!-- ##### FUNCTION gtk_notebook_set_menu_label ##### -->
<para>
</para>

281 282 283
@notebook: 
@child: 
@menu_label: 
Owen Taylor's avatar
Owen Taylor committed
284 285 286 287 288 289


<!-- ##### FUNCTION gtk_notebook_set_menu_label_text ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
290 291 292
@notebook: 
@child: 
@menu_text: 
Owen Taylor's avatar
Owen Taylor committed
293 294


295 296 297 298
<!-- ##### FUNCTION gtk_notebook_set_tab_hborder ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
299 300
@notebook: 
@tab_hborder: 
301 302


Owen Taylor's avatar
Owen Taylor committed
303 304 305 306
<!-- ##### FUNCTION gtk_notebook_set_tab_label ##### -->
<para>
</para>

307
@notebook: 
Owen Taylor's avatar
Owen Taylor committed
308 309
@child: 
@tab_label: 
Owen Taylor's avatar
Owen Taylor committed
310 311 312 313 314 315


<!-- ##### FUNCTION gtk_notebook_set_tab_label_packing ##### -->
<para>
</para>

316 317
@notebook: 
@child: 
Owen Taylor's avatar
Owen Taylor committed
318
@expand: 
319
@fill: 
Owen Taylor's avatar
Owen Taylor committed
320
@pack_type: 
Owen Taylor's avatar
Owen Taylor committed
321 322 323 324 325 326


<!-- ##### FUNCTION gtk_notebook_set_tab_label_text ##### -->
<para>
</para>

327 328 329
@notebook: 
@child: 
@tab_text: 
Owen Taylor's avatar
Owen Taylor committed
330 331


332 333 334 335
<!-- ##### FUNCTION gtk_notebook_set_tab_vborder ##### -->
<para>
</para>

Owen Taylor's avatar
Owen Taylor committed
336 337
@notebook: 
@tab_vborder: 
338 339


340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
<!-- ##### SIGNAL GtkNotebook::focus-tab ##### -->
<para>

</para>

@notebook: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL GtkNotebook::select-page ##### -->
<para>

</para>

@notebook: the object which received the signal.
@arg1: 

Owen Taylor's avatar
Owen Taylor committed
356 357
<!-- ##### SIGNAL GtkNotebook::switch-page ##### -->
<para>
358
Emitted when the user or a function changes the current page.
Owen Taylor's avatar
Owen Taylor committed
359 360 361
</para>

@notebook: the object which received the signal.
362 363
@page: the new current page
@page_num: the index of the page
Owen Taylor's avatar
Owen Taylor committed
364

Owen Taylor's avatar
Owen Taylor committed
365
<!-- ##### ARG GtkNotebook:tab-pos ##### -->
Owen Taylor's avatar
Owen Taylor committed
366
<para>
Owen Taylor's avatar
Owen Taylor committed
367
The edge at which the tabs for switching pages are drawn.
Owen Taylor's avatar
Owen Taylor committed
368 369
</para>

Owen Taylor's avatar
Owen Taylor committed
370
<!-- ##### ARG GtkNotebook:show-tabs ##### -->
Owen Taylor's avatar
Owen Taylor committed
371
<para>
Owen Taylor's avatar
Owen Taylor committed
372
Whether to show tabs for the notebook pages.
Owen Taylor's avatar
Owen Taylor committed
373 374
</para>

Owen Taylor's avatar
Owen Taylor committed
375
<!-- ##### ARG GtkNotebook:show-border ##### -->
Owen Taylor's avatar
Owen Taylor committed
376
<para>
Owen Taylor's avatar
Owen Taylor committed
377
Whether to draw a bevel around the noteobook.
Owen Taylor's avatar
Owen Taylor committed
378 379
</para>

Owen Taylor's avatar
Owen Taylor committed
380
<!-- ##### ARG GtkNotebook:scrollable ##### -->
Owen Taylor's avatar
Owen Taylor committed
381
<para>
Owen Taylor's avatar
Owen Taylor committed
382 383
Whether the tab label area will have arrows for scrolling if there
are too many tabs to fit in the area.
Owen Taylor's avatar
Owen Taylor committed
384 385
</para>

Owen Taylor's avatar
Owen Taylor committed
386
<!-- ##### ARG GtkNotebook:tab-border ##### -->
Owen Taylor's avatar
Owen Taylor committed
387
<para>
Owen Taylor's avatar
Owen Taylor committed
388
Whether the tab labels have a border on all sides.
Owen Taylor's avatar
Owen Taylor committed
389 390
</para>

Owen Taylor's avatar
Owen Taylor committed
391
<!-- ##### ARG GtkNotebook:tab-hborder ##### -->
Owen Taylor's avatar
Owen Taylor committed
392
<para>
Owen Taylor's avatar
Owen Taylor committed
393
Whether the tab labels have a horizontal border.
Owen Taylor's avatar
Owen Taylor committed
394 395
</para>

Owen Taylor's avatar
Owen Taylor committed
396
<!-- ##### ARG GtkNotebook:tab-vborder ##### -->
Owen Taylor's avatar
Owen Taylor committed
397
<para>
Owen Taylor's avatar
Owen Taylor committed
398
Whether the tab labels have a vertical border.
Owen Taylor's avatar
Owen Taylor committed
399 400
</para>

Owen Taylor's avatar
Owen Taylor committed
401
<!-- ##### ARG GtkNotebook:page ##### -->
Owen Taylor's avatar
Owen Taylor committed
402
<para>
Owen Taylor's avatar
Owen Taylor committed
403
The current page
Owen Taylor's avatar
Owen Taylor committed
404 405
</para>

Owen Taylor's avatar
Owen Taylor committed
406
<!-- ##### ARG GtkNotebook:enable-popup ##### -->
Owen Taylor's avatar
Owen Taylor committed
407
<para>
408
Whether the popup menu for switching pages is enabled.
Owen Taylor's avatar
Owen Taylor committed
409 410
</para>

411 412
<!-- ##### ARG GtkNotebook:homogeneous ##### -->
<para>
413
whether the tabs must have all the same size.
414 415
</para>