Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtknotebook.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkNotebook
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A tabbed notebook container.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkNotebook widget is a #GtkContainer whose children are pages that
  10 can be switched between using tab labels along one edge.
  11 </para>
  12 <para>
  13 There are many configuration options for #GtkNotebook. Among other
  14 things, you can choose on which edge the tabs appear
  15 (see gtk_notebook_set_tab_pos()), whether, if there are too many
  16 tabs to fit the noteobook should be made bigger or scrolling
  17 arrows added (see gtk_notebook_set_scrollable), and whether there
  18 will be a popup menu allowing the users to switch pages.
  19 (see gtk_notebook_enable_popup(), gtk_noteobook_disable_popup())
  20 </para>
  21
  22 <!-- ##### SECTION See_Also ##### -->
  23 <para>
  24 <variablelist>
  25 <varlistentry>
  26 <term>#GtkContainer</term>
  27 <listitem><para>For functions that apply to every #GtkContainer
  28 (like #GtkList).</para></listitem>
  29 </varlistentry>
  30 </variablelist>
  31 </para>
  32
  33 <!-- ##### STRUCT GtkNotebook ##### -->
  34 <para>
  35
  36 </para>
  37
  38
  39 <!-- ##### STRUCT GtkNotebookPage ##### -->
  40 <para>
  41 The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
  42 </para>
  43
  44
  45 <!-- ##### FUNCTION gtk_notebook_new ##### -->
  46 <para>
  47 </para>
  48
  49 @Returns:
  50
  51
  52 <!-- ##### FUNCTION gtk_notebook_append_page ##### -->
  53 <para>
  54 </para>
  55
  56 @notebook:
  57 @child:
  58 @tab_label:
  59
  60
  61 <!-- ##### FUNCTION gtk_notebook_append_page_menu ##### -->
  62 <para>
  63 </para>
  64
  65 @notebook:
  66 @child:
  67 @tab_label:
  68 @menu_label:
  69
  70
  71 <!-- ##### FUNCTION gtk_notebook_prepend_page ##### -->
  72 <para>
  73 </para>
  74
  75 @notebook:
  76 @child: the
  77 @tab_label:
  78
  79
  80 <!-- ##### FUNCTION gtk_notebook_prepend_page_menu ##### -->
  81 <para>
  82 </para>
  83
  84 @notebook:
  85 @child:
  86 @tab_label:
  87 @menu_label:
  88
  89
  90 <!-- ##### FUNCTION gtk_notebook_insert_page ##### -->
  91 <para>
  92 </para>
  93
  94 @notebook:
  95 @child:
  96 @tab_label:
  97 @position:
  98
  99
 100 <!-- ##### FUNCTION gtk_notebook_insert_page_menu ##### -->
 101 <para>
 102 </para>
 103
 104 @notebook:
 105 @child:
 106 @tab_label:
 107 @menu_label:
 108 @position:
 109
 110
 111 <!-- ##### FUNCTION gtk_notebook_remove_page ##### -->
 112 <para>
 113 </para>
 114
 115 @notebook:
 116 @page_num:
 117
 118
 119 <!-- ##### MACRO gtk_notebook_current_page ##### -->
 120 <para>
 121 Deprecated compatibility macro.
 122 </para>
 123
 124
 125
 126 <!-- ##### FUNCTION gtk_notebook_page_num ##### -->
 127 <para>
 128 </para>
 129
 130 @notebook:
 131 @child:
 132 @Returns:
 133
 134
 135 <!-- ##### MACRO gtk_notebook_set_page ##### -->
 136 <para>
 137 </para>
 138
 139 <!-- # Unused Parameters # -->
 140 @notebook:
 141 @page_num:
 142
 143
 144 <!-- ##### FUNCTION gtk_notebook_next_page ##### -->
 145 <para>
 146 </para>
 147
 148 @notebook:
 149
 150
 151 <!-- ##### FUNCTION gtk_notebook_prev_page ##### -->
 152 <para>
 153 </para>
 154
 155 @notebook:
 156
 157
 158 <!-- ##### FUNCTION gtk_notebook_reorder_child ##### -->
 159 <para>
 160 </para>
 161
 162 @notebook
 163
 164 @notebook:
 165 @child:
 166 @position:
 167
 168
 169 <!-- ##### FUNCTION gtk_notebook_set_tab_pos ##### -->
 170 <para>
 171 </para>
 172
 173 @notebook: the notebook widget
 174 @pos: the position
 175
 176
 177 <!-- ##### FUNCTION gtk_notebook_set_show_tabs ##### -->
 178 <para>
 179 </para>
 180
 181 @notebook:
 182 @show_tabs:
 183
 184
 185 <!-- ##### FUNCTION gtk_notebook_set_show_border ##### -->
 186 <para>
 187 </para>
 188
 189 @notebook:
 190 @show_border:
 191
 192
 193 <!-- ##### FUNCTION gtk_notebook_set_scrollable ##### -->
 194 <para>
 195 </para>
 196
 197 @notebook:
 198 @scrollable:
 199
 200
 201 <!-- ##### FUNCTION gtk_notebook_set_tab_border ##### -->
 202 <para>
 203 </para>
 204
 205 @notebook:
 206 @border_width:
 207
 208
 209 <!-- ##### FUNCTION gtk_notebook_popup_enable ##### -->
 210 <para>
 211 </para>
 212
 213 @notebook:
 214
 215
 216 <!-- ##### FUNCTION gtk_notebook_popup_disable ##### -->
 217 <para>
 218 </para>
 219
 220 @notebook:
 221
 222
 223 <!-- ##### FUNCTION gtk_notebook_get_current_page ##### -->
 224 <para>
 225 </para>
 226
 227 @notebook: the notebook widget
 228 @Returns: the page number
 229
 230
 231 <!-- ##### FUNCTION gtk_notebook_get_menu_label ##### -->
 232 <para>
 233 </para>
 234
 235 @notebook:
 236 @child:
 237 @Returns:
 238
 239
 240 <!-- ##### FUNCTION gtk_notebook_get_nth_page ##### -->
 241 <para>
 242 </para>
 243
 244 @notebook:
 245 @page_num:
 246 @Returns:
 247
 248
 249 <!-- ##### FUNCTION gtk_notebook_get_tab_label ##### -->
 250 <para>
 251 </para>
 252
 253 @notebook:
 254 @child:
 255 @Returns:
 256
 257
 258 <!-- ##### FUNCTION gtk_notebook_query_tab_label_packing ##### -->
 259 <para>
 260 </para>
 261
 262 @notebook:
 263 @child:
 264 @expand:
 265 @fill:
 266 @pack_type:
 267
 268
 269 <!-- ##### FUNCTION gtk_notebook_set_homogeneous_tabs ##### -->
 270 <para>
 271 </para>
 272
 273 @notebook:
 274 @homogeneous:
 275
 276
 277 <!-- ##### FUNCTION gtk_notebook_set_menu_label ##### -->
 278 <para>
 279 </para>
 280
 281 @notebook:
 282 @child:
 283 @menu_label:
 284
 285
 286 <!-- ##### FUNCTION gtk_notebook_set_menu_label_text ##### -->
 287 <para>
 288 </para>
 289
 290 @notebook:
 291 @child:
 292 @menu_text:
 293
 294
 295 <!-- ##### FUNCTION gtk_notebook_set_tab_hborder ##### -->
 296 <para>
 297 </para>
 298
 299 @notebook:
 300 @tab_hborder:
 301
 302
 303 <!-- ##### FUNCTION gtk_notebook_set_tab_label ##### -->
 304 <para>
 305 </para>
 306
 307 @notebook:
 308 @child:
 309 @tab_label:
 310
 311
 312 <!-- ##### FUNCTION gtk_notebook_set_tab_label_packing ##### -->
 313 <para>
 314 </para>
 315
 316 @notebook:
 317 @child:
 318 @expand:
 319 @fill:
 320 @pack_type:
 321
 322
 323 <!-- ##### FUNCTION gtk_notebook_set_tab_label_text ##### -->
 324 <para>
 325 </para>
 326
 327 @notebook:
 328 @child:
 329 @tab_text:
 330
 331
 332 <!-- ##### FUNCTION gtk_notebook_set_tab_vborder ##### -->
 333 <para>
 334 </para>
 335
 336 @notebook:
 337 @tab_vborder:
 338
 339
 340 <!-- ##### FUNCTION gtk_notebook_get_menu_label_text ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @notebook:
 346 @child:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION gtk_notebook_get_scrollable ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @notebook:
 356 @Returns:
 357
 358
 359 <!-- ##### FUNCTION gtk_notebook_get_show_border ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @notebook:
 365 @Returns:
 366
 367
 368 <!-- ##### FUNCTION gtk_notebook_get_show_tabs ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @notebook:
 374 @Returns:
 375
 376
 377 <!-- ##### FUNCTION gtk_notebook_get_tab_label_text ##### -->
 378 <para>
 379
 380 </para>
 381
 382 @notebook:
 383 @child:
 384 @Returns:
 385
 386
 387 <!-- ##### FUNCTION gtk_notebook_get_tab_pos ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @notebook:
 393 @Returns:
 394
 395
 396 <!-- ##### FUNCTION gtk_notebook_set_current_page ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @notebook:
 402 @page_num:
 403
 404
 405 <!-- ##### SIGNAL GtkNotebook::focus-tab ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @notebook: the object which received the signal.
 411 @arg1:
 412
 413 <!-- ##### SIGNAL GtkNotebook::select-page ##### -->
 414 <para>
 415
 416 </para>
 417
 418 @notebook: the object which received the signal.
 419 @arg1:
 420
 421 <!-- ##### SIGNAL GtkNotebook::switch-page ##### -->
 422 <para>
 423 Emitted when the user or a function changes the current page.
 424 </para>
 425
 426 @notebook: the object which received the signal.
 427 @page: the new current page
 428 @page_num: the index of the page
 429
 430 <!-- ##### ARG GtkNotebook:tab-pos ##### -->
 431 <para>
 432 The edge at which the tabs for switching pages are drawn.
 433 </para>
 434
 435 <!-- ##### ARG GtkNotebook:show-tabs ##### -->
 436 <para>
 437 Whether to show tabs for the notebook pages.
 438 </para>
 439
 440 <!-- ##### ARG GtkNotebook:show-border ##### -->
 441 <para>
 442 Whether to draw a bevel around the noteobook.
 443 </para>
 444
 445 <!-- ##### ARG GtkNotebook:scrollable ##### -->
 446 <para>
 447 Whether the tab label area will have arrows for scrolling if there
 448 are too many tabs to fit in the area.
 449 </para>
 450
 451 <!-- ##### ARG GtkNotebook:tab-border ##### -->
 452 <para>
 453 Whether the tab labels have a border on all sides.
 454 </para>
 455
 456 <!-- ##### ARG GtkNotebook:tab-hborder ##### -->
 457 <para>
 458 Whether the tab labels have a horizontal border.
 459 </para>
 460
 461 <!-- ##### ARG GtkNotebook:tab-vborder ##### -->
 462 <para>
 463 Whether the tab labels have a vertical border.
 464 </para>
 465
 466 <!-- ##### ARG GtkNotebook:page ##### -->
 467 <para>
 468 The current page
 469 </para>
 470
 471 <!-- ##### ARG GtkNotebook:enable-popup ##### -->
 472 <para>
 473 Whether the popup menu for switching pages is enabled.
 474 </para>
 475
 476 <!-- ##### ARG GtkNotebook:homogeneous ##### -->
 477 <para>
 478 whether the tabs must have all the same size.
 479 </para>
 480