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. Use
 122 gtk_notebook_get_current_page() instead.
 123 </para>
 124
 125
 126
 127 <!-- ##### FUNCTION gtk_notebook_page_num ##### -->
 128 <para>
 129 </para>
 130
 131 @notebook:
 132 @child:
 133 @Returns:
 134
 135
 136 <!-- ##### MACRO gtk_notebook_set_page ##### -->
 137 <para>
 138 Deprecated compatibility macro. Use
 139 gtk_notebook_set_current_page() instead.
 140 </para>
 141
 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 @child:
 164 @position:
 165
 166
 167 <!-- ##### FUNCTION gtk_notebook_set_tab_pos ##### -->
 168 <para>
 169 </para>
 170
 171 @notebook: the notebook widget
 172 @pos: the position
 173
 174
 175 <!-- ##### FUNCTION gtk_notebook_set_show_tabs ##### -->
 176 <para>
 177 </para>
 178
 179 @notebook:
 180 @show_tabs:
 181
 182
 183 <!-- ##### FUNCTION gtk_notebook_set_show_border ##### -->
 184 <para>
 185 </para>
 186
 187 @notebook:
 188 @show_border:
 189
 190
 191 <!-- ##### FUNCTION gtk_notebook_set_scrollable ##### -->
 192 <para>
 193 </para>
 194
 195 @notebook:
 196 @scrollable:
 197
 198
 199 <!-- ##### FUNCTION gtk_notebook_set_tab_border ##### -->
 200 <para>
 201 </para>
 202
 203 @notebook:
 204 @border_width:
 205
 206
 207 <!-- ##### FUNCTION gtk_notebook_popup_enable ##### -->
 208 <para>
 209 </para>
 210
 211 @notebook:
 212
 213
 214 <!-- ##### FUNCTION gtk_notebook_popup_disable ##### -->
 215 <para>
 216 </para>
 217
 218 @notebook:
 219
 220
 221 <!-- ##### FUNCTION gtk_notebook_get_current_page ##### -->
 222 <para>
 223 </para>
 224
 225 @notebook: the notebook widget
 226 @Returns: the page number
 227
 228
 229 <!-- ##### FUNCTION gtk_notebook_get_menu_label ##### -->
 230 <para>
 231 </para>
 232
 233 @notebook:
 234 @child:
 235 @Returns:
 236
 237
 238 <!-- ##### FUNCTION gtk_notebook_get_nth_page ##### -->
 239 <para>
 240 </para>
 241
 242 @notebook:
 243 @page_num:
 244 @Returns:
 245
 246
 247 <!-- ##### FUNCTION gtk_notebook_get_tab_label ##### -->
 248 <para>
 249 </para>
 250
 251 @notebook:
 252 @child:
 253 @Returns:
 254
 255
 256 <!-- ##### FUNCTION gtk_notebook_query_tab_label_packing ##### -->
 257 <para>
 258 </para>
 259
 260 @notebook:
 261 @child:
 262 @expand:
 263 @fill:
 264 @pack_type:
 265
 266
 267 <!-- ##### FUNCTION gtk_notebook_set_homogeneous_tabs ##### -->
 268 <para>
 269 </para>
 270
 271 @notebook:
 272 @homogeneous:
 273
 274
 275 <!-- ##### FUNCTION gtk_notebook_set_menu_label ##### -->
 276 <para>
 277 </para>
 278
 279 @notebook:
 280 @child:
 281 @menu_label:
 282
 283
 284 <!-- ##### FUNCTION gtk_notebook_set_menu_label_text ##### -->
 285 <para>
 286 </para>
 287
 288 @notebook:
 289 @child:
 290 @menu_text:
 291
 292
 293 <!-- ##### FUNCTION gtk_notebook_set_tab_hborder ##### -->
 294 <para>
 295 </para>
 296
 297 @notebook:
 298 @tab_hborder:
 299
 300
 301 <!-- ##### FUNCTION gtk_notebook_set_tab_label ##### -->
 302 <para>
 303 </para>
 304
 305 @notebook:
 306 @child:
 307 @tab_label:
 308
 309
 310 <!-- ##### FUNCTION gtk_notebook_set_tab_label_packing ##### -->
 311 <para>
 312 </para>
 313
 314 @notebook:
 315 @child:
 316 @expand:
 317 @fill:
 318 @pack_type:
 319
 320
 321 <!-- ##### FUNCTION gtk_notebook_set_tab_label_text ##### -->
 322 <para>
 323 </para>
 324
 325 @notebook:
 326 @child:
 327 @tab_text:
 328
 329
 330 <!-- ##### FUNCTION gtk_notebook_set_tab_vborder ##### -->
 331 <para>
 332 </para>
 333
 334 @notebook:
 335 @tab_vborder:
 336
 337
 338 <!-- ##### FUNCTION gtk_notebook_get_menu_label_text ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @notebook:
 344 @child:
 345 @Returns:
 346
 347
 348 <!-- ##### FUNCTION gtk_notebook_get_scrollable ##### -->
 349 <para>
 350
 351 </para>
 352
 353 @notebook:
 354 @Returns:
 355
 356
 357 <!-- ##### FUNCTION gtk_notebook_get_show_border ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @notebook:
 363 @Returns:
 364
 365
 366 <!-- ##### FUNCTION gtk_notebook_get_show_tabs ##### -->
 367 <para>
 368
 369 </para>
 370
 371 @notebook:
 372 @Returns:
 373
 374
 375 <!-- ##### FUNCTION gtk_notebook_get_tab_label_text ##### -->
 376 <para>
 377
 378 </para>
 379
 380 @notebook:
 381 @child:
 382 @Returns:
 383
 384
 385 <!-- ##### FUNCTION gtk_notebook_get_tab_pos ##### -->
 386 <para>
 387
 388 </para>
 389
 390 @notebook:
 391 @Returns:
 392
 393
 394 <!-- ##### FUNCTION gtk_notebook_set_current_page ##### -->
 395 <para>
 396
 397 </para>
 398
 399 @notebook:
 400 @page_num:
 401
 402
 403 <!-- ##### SIGNAL GtkNotebook::change-current-page ##### -->
 404 <para>
 405
 406 </para>
 407
 408 @notebook: the object which received the signal.
 409 @arg1:
 410 <!-- # Unused Parameters # -->
 411 @Returns:
 412
 413 <!-- ##### SIGNAL GtkNotebook::focus-tab ##### -->
 414 <para>
 415
 416 </para>
 417
 418 @notebook: the object which received the signal.
 419 @arg1:
 420 @Returns:
 421
 422 <!-- ##### SIGNAL GtkNotebook::move-focus-out ##### -->
 423 <para>
 424
 425 </para>
 426
 427 @notebook: the object which received the signal.
 428 @arg1:
 429
 430 <!-- ##### SIGNAL GtkNotebook::select-page ##### -->
 431 <para>
 432
 433 </para>
 434
 435 @notebook: the object which received the signal.
 436 @arg1:
 437 @Returns:
 438
 439 <!-- ##### SIGNAL GtkNotebook::switch-page ##### -->
 440 <para>
 441 Emitted when the user or a function changes the current page.
 442 </para>
 443
 444 @notebook: the object which received the signal.
 445 @page: the new current page
 446 @page_num: the index of the page
 447
 448 <!-- ##### ARG GtkNotebook:tab-pos ##### -->
 449 <para>
 450 The edge at which the tabs for switching pages are drawn.
 451 </para>
 452
 453 <!-- ##### ARG GtkNotebook:show-tabs ##### -->
 454 <para>
 455 Whether to show tabs for the notebook pages.
 456 </para>
 457
 458 <!-- ##### ARG GtkNotebook:show-border ##### -->
 459 <para>
 460 Whether to draw a bevel around the noteobook.
 461 </para>
 462
 463 <!-- ##### ARG GtkNotebook:scrollable ##### -->
 464 <para>
 465 Whether the tab label area will have arrows for scrolling if there
 466 are too many tabs to fit in the area.
 467 </para>
 468
 469 <!-- ##### ARG GtkNotebook:tab-border ##### -->
 470 <para>
 471 Whether the tab labels have a border on all sides.
 472 </para>
 473
 474 <!-- ##### ARG GtkNotebook:tab-hborder ##### -->
 475 <para>
 476 Whether the tab labels have a horizontal border.
 477 </para>
 478
 479 <!-- ##### ARG GtkNotebook:tab-vborder ##### -->
 480 <para>
 481 Whether the tab labels have a vertical border.
 482 </para>
 483
 484 <!-- ##### ARG GtkNotebook:page ##### -->
 485 <para>
 486 The current page
 487 </para>
 488
 489 <!-- ##### ARG GtkNotebook:enable-popup ##### -->
 490 <para>
 491 Whether the popup menu for switching pages is enabled.
 492 </para>
 493
 494 <!-- ##### ARG GtkNotebook:homogeneous ##### -->
 495 <para>
 496 whether the tabs must have all the same size.
 497 </para>
 498