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 <!-- ##### SECTION Stability_Level ##### -->
  34
  35
  36 <!-- ##### STRUCT GtkNotebook ##### -->
  37 <para>
  38
  39 </para>
  40
  41
  42 <!-- ##### SIGNAL GtkNotebook::change-current-page ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @notebook: the object which received the signal.
  48 @arg1:
  49
  50 <!-- ##### SIGNAL GtkNotebook::focus-tab ##### -->
  51 <para>
  52
  53 </para>
  54
  55 @notebook: the object which received the signal.
  56 @arg1:
  57 @Returns:
  58
  59 <!-- ##### SIGNAL GtkNotebook::move-focus-out ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @notebook: the object which received the signal.
  65 @arg1:
  66
  67 <!-- ##### SIGNAL GtkNotebook::page-added ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @notebook: the object which received the signal.
  73 @widget:
  74 @arg1:
  75
  76 <!-- ##### SIGNAL GtkNotebook::page-removed ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @notebook: the object which received the signal.
  82 @widget:
  83 @arg1:
  84
  85 <!-- ##### SIGNAL GtkNotebook::page-reordered ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @notebook: the object which received the signal.
  91 @widget:
  92 @arg1:
  93
  94 <!-- ##### SIGNAL GtkNotebook::reorder-tab ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @notebook: the object which received the signal.
 100 @arg1:
 101 @Param3:
 102
 103 <!-- ##### SIGNAL GtkNotebook::select-page ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @notebook: the object which received the signal.
 109 @arg1:
 110 @Returns:
 111
 112 <!-- ##### SIGNAL GtkNotebook::switch-page ##### -->
 113 <para>
 114 Emitted when the user or a function changes the current page.
 115 </para>
 116
 117 @notebook: the object which received the signal.
 118 @page: the new current page
 119 @page_num: the index of the page
 120
 121 <!-- ##### ARG GtkNotebook:enable-popup ##### -->
 122 <para>
 123
 124 </para>
 125
 126 <!-- ##### ARG GtkNotebook:group-id ##### -->
 127 <para>
 128
 129 </para>
 130
 131 <!-- ##### ARG GtkNotebook:homogeneous ##### -->
 132 <para>
 133
 134 </para>
 135
 136 <!-- ##### ARG GtkNotebook:page ##### -->
 137 <para>
 138
 139 </para>
 140
 141 <!-- ##### ARG GtkNotebook:scrollable ##### -->
 142 <para>
 143
 144 </para>
 145
 146 <!-- ##### ARG GtkNotebook:show-border ##### -->
 147 <para>
 148
 149 </para>
 150
 151 <!-- ##### ARG GtkNotebook:show-tabs ##### -->
 152 <para>
 153
 154 </para>
 155
 156 <!-- ##### ARG GtkNotebook:tab-border ##### -->
 157 <para>
 158
 159 </para>
 160
 161 <!-- ##### ARG GtkNotebook:tab-hborder ##### -->
 162 <para>
 163
 164 </para>
 165
 166 <!-- ##### ARG GtkNotebook:tab-pos ##### -->
 167 <para>
 168
 169 </para>
 170
 171 <!-- ##### ARG GtkNotebook:tab-vborder ##### -->
 172 <para>
 173
 174 </para>
 175
 176 <!-- ##### ARG GtkNotebook:detachable ##### -->
 177 <para>
 178
 179 </para>
 180
 181 <!-- ##### ARG GtkNotebook:menu-label ##### -->
 182 <para>
 183
 184 </para>
 185
 186 <!-- ##### ARG GtkNotebook:position ##### -->
 187 <para>
 188
 189 </para>
 190
 191 <!-- ##### ARG GtkNotebook:reorderable ##### -->
 192 <para>
 193
 194 </para>
 195
 196 <!-- ##### ARG GtkNotebook:tab-expand ##### -->
 197 <para>
 198
 199 </para>
 200
 201 <!-- ##### ARG GtkNotebook:tab-fill ##### -->
 202 <para>
 203
 204 </para>
 205
 206 <!-- ##### ARG GtkNotebook:tab-label ##### -->
 207 <para>
 208
 209 </para>
 210
 211 <!-- ##### ARG GtkNotebook:tab-pack ##### -->
 212 <para>
 213
 214 </para>
 215
 216 <!-- ##### ARG GtkNotebook:arrow-spacing ##### -->
 217 <para>
 218
 219 </para>
 220
 221 <!-- ##### ARG GtkNotebook:has-backward-stepper ##### -->
 222 <para>
 223
 224 </para>
 225
 226 <!-- ##### ARG GtkNotebook:has-forward-stepper ##### -->
 227 <para>
 228
 229 </para>
 230
 231 <!-- ##### ARG GtkNotebook:has-secondary-backward-stepper ##### -->
 232 <para>
 233
 234 </para>
 235
 236 <!-- ##### ARG GtkNotebook:has-secondary-forward-stepper ##### -->
 237 <para>
 238
 239 </para>
 240
 241 <!-- ##### ARG GtkNotebook:tab-curvature ##### -->
 242 <para>
 243
 244 </para>
 245
 246 <!-- ##### ARG GtkNotebook:tab-overlap ##### -->
 247 <para>
 248
 249 </para>
 250
 251 <!-- ##### STRUCT GtkNotebookPage ##### -->
 252 <para>
 253 The #GtkNotebookPage is an opaque implementation detail of #GtkNotebook.
 254 </para>
 255
 256
 257 <!-- ##### FUNCTION gtk_notebook_new ##### -->
 258 <para>
 259 </para>
 260
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION gtk_notebook_append_page ##### -->
 265 <para>
 266 </para>
 267
 268 @notebook:
 269 @child:
 270 @tab_label:
 271 @Returns:
 272
 273
 274 <!-- ##### FUNCTION gtk_notebook_append_page_menu ##### -->
 275 <para>
 276 </para>
 277
 278 @notebook:
 279 @child:
 280 @tab_label:
 281 @menu_label:
 282 @Returns:
 283
 284
 285 <!-- ##### FUNCTION gtk_notebook_prepend_page ##### -->
 286 <para>
 287 </para>
 288
 289 @notebook:
 290 @child: the
 291 @tab_label:
 292 @Returns:
 293
 294
 295 <!-- ##### FUNCTION gtk_notebook_prepend_page_menu ##### -->
 296 <para>
 297 </para>
 298
 299 @notebook:
 300 @child:
 301 @tab_label:
 302 @menu_label:
 303 @Returns:
 304
 305
 306 <!-- ##### FUNCTION gtk_notebook_insert_page ##### -->
 307 <para>
 308 </para>
 309
 310 @notebook:
 311 @child:
 312 @tab_label:
 313 @position:
 314 @Returns:
 315
 316
 317 <!-- ##### FUNCTION gtk_notebook_insert_page_menu ##### -->
 318 <para>
 319 </para>
 320
 321 @notebook:
 322 @child:
 323 @tab_label:
 324 @menu_label:
 325 @position:
 326 @Returns:
 327
 328
 329 <!-- ##### FUNCTION gtk_notebook_remove_page ##### -->
 330 <para>
 331 </para>
 332
 333 @notebook:
 334 @page_num:
 335
 336
 337 <!-- ##### MACRO gtk_notebook_current_page ##### -->
 338 <para>
 339 Deprecated compatibility macro. Use
 340 gtk_notebook_get_current_page() instead.
 341 </para>
 342
 343
 344
 345 <!-- ##### FUNCTION gtk_notebook_page_num ##### -->
 346 <para>
 347 </para>
 348
 349 @notebook:
 350 @child:
 351 @Returns:
 352
 353
 354 <!-- ##### MACRO gtk_notebook_set_page ##### -->
 355 <para>
 356 Deprecated compatibility macro. Use
 357 gtk_notebook_set_current_page() instead.
 358 </para>
 359
 360
 361
 362 <!-- ##### FUNCTION gtk_notebook_next_page ##### -->
 363 <para>
 364 </para>
 365
 366 @notebook:
 367
 368
 369 <!-- ##### FUNCTION gtk_notebook_prev_page ##### -->
 370 <para>
 371 </para>
 372
 373 @notebook:
 374
 375
 376 <!-- ##### FUNCTION gtk_notebook_reorder_child ##### -->
 377 <para>
 378 </para>
 379
 380 @notebook:
 381 @child:
 382 @position:
 383
 384
 385 <!-- ##### FUNCTION gtk_notebook_set_tab_pos ##### -->
 386 <para>
 387 </para>
 388
 389 @notebook: the notebook widget
 390 @pos: the position
 391
 392
 393 <!-- ##### FUNCTION gtk_notebook_set_show_tabs ##### -->
 394 <para>
 395 </para>
 396
 397 @notebook:
 398 @show_tabs:
 399
 400
 401 <!-- ##### FUNCTION gtk_notebook_set_show_border ##### -->
 402 <para>
 403 </para>
 404
 405 @notebook:
 406 @show_border:
 407
 408
 409 <!-- ##### FUNCTION gtk_notebook_set_scrollable ##### -->
 410 <para>
 411 </para>
 412
 413 @notebook:
 414 @scrollable:
 415
 416
 417 <!-- ##### FUNCTION gtk_notebook_set_tab_border ##### -->
 418 <para>
 419 </para>
 420
 421 @notebook:
 422 @border_width:
 423
 424
 425 <!-- ##### FUNCTION gtk_notebook_popup_enable ##### -->
 426 <para>
 427 </para>
 428
 429 @notebook:
 430
 431
 432 <!-- ##### FUNCTION gtk_notebook_popup_disable ##### -->
 433 <para>
 434 </para>
 435
 436 @notebook:
 437
 438
 439 <!-- ##### FUNCTION gtk_notebook_get_current_page ##### -->
 440 <para>
 441 </para>
 442
 443 @notebook: the notebook widget
 444 @Returns: the page number
 445
 446
 447 <!-- ##### FUNCTION gtk_notebook_get_menu_label ##### -->
 448 <para>
 449 </para>
 450
 451 @notebook:
 452 @child:
 453 @Returns:
 454
 455
 456 <!-- ##### FUNCTION gtk_notebook_get_nth_page ##### -->
 457 <para>
 458 </para>
 459
 460 @notebook:
 461 @page_num:
 462 @Returns:
 463
 464
 465 <!-- ##### FUNCTION gtk_notebook_get_n_pages ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @notebook:
 471 @Returns:
 472
 473
 474 <!-- ##### FUNCTION gtk_notebook_get_tab_label ##### -->
 475 <para>
 476 </para>
 477
 478 @notebook:
 479 @child:
 480 @Returns:
 481
 482
 483 <!-- ##### FUNCTION gtk_notebook_query_tab_label_packing ##### -->
 484 <para>
 485 </para>
 486
 487 @notebook:
 488 @child:
 489 @expand:
 490 @fill:
 491 @pack_type:
 492
 493
 494 <!-- ##### FUNCTION gtk_notebook_set_homogeneous_tabs ##### -->
 495 <para>
 496 </para>
 497
 498 @notebook:
 499 @homogeneous:
 500
 501
 502 <!-- ##### FUNCTION gtk_notebook_set_menu_label ##### -->
 503 <para>
 504 </para>
 505
 506 @notebook:
 507 @child:
 508 @menu_label:
 509
 510
 511 <!-- ##### FUNCTION gtk_notebook_set_menu_label_text ##### -->
 512 <para>
 513 </para>
 514
 515 @notebook:
 516 @child:
 517 @menu_text:
 518
 519
 520 <!-- ##### FUNCTION gtk_notebook_set_tab_hborder ##### -->
 521 <para>
 522 </para>
 523
 524 @notebook:
 525 @tab_hborder:
 526
 527
 528 <!-- ##### FUNCTION gtk_notebook_set_tab_label ##### -->
 529 <para>
 530 </para>
 531
 532 @notebook:
 533 @child:
 534 @tab_label:
 535
 536
 537 <!-- ##### FUNCTION gtk_notebook_set_tab_label_packing ##### -->
 538 <para>
 539 </para>
 540
 541 @notebook:
 542 @child:
 543 @expand:
 544 @fill:
 545 @pack_type:
 546
 547
 548 <!-- ##### FUNCTION gtk_notebook_set_tab_label_text ##### -->
 549 <para>
 550 </para>
 551
 552 @notebook:
 553 @child:
 554 @tab_text:
 555
 556
 557 <!-- ##### FUNCTION gtk_notebook_set_tab_vborder ##### -->
 558 <para>
 559 </para>
 560
 561 @notebook:
 562 @tab_vborder:
 563
 564
 565 <!-- ##### FUNCTION gtk_notebook_set_tab_reorderable ##### -->
 566 <para>
 567
 568 </para>
 569
 570 @notebook:
 571 @child:
 572 @reorderable:
 573
 574
 575 <!-- ##### FUNCTION gtk_notebook_set_tab_detachable ##### -->
 576 <para>
 577
 578 </para>
 579
 580 @notebook:
 581 @child:
 582 @detachable:
 583
 584
 585 <!-- ##### FUNCTION gtk_notebook_get_menu_label_text ##### -->
 586 <para>
 587
 588 </para>
 589
 590 @notebook:
 591 @child:
 592 @Returns:
 593
 594
 595 <!-- ##### FUNCTION gtk_notebook_get_scrollable ##### -->
 596 <para>
 597
 598 </para>
 599
 600 @notebook:
 601 @Returns:
 602
 603
 604 <!-- ##### FUNCTION gtk_notebook_get_show_border ##### -->
 605 <para>
 606
 607 </para>
 608
 609 @notebook:
 610 @Returns:
 611
 612
 613 <!-- ##### FUNCTION gtk_notebook_get_show_tabs ##### -->
 614 <para>
 615
 616 </para>
 617
 618 @notebook:
 619 @Returns:
 620
 621
 622 <!-- ##### FUNCTION gtk_notebook_get_tab_label_text ##### -->
 623 <para>
 624
 625 </para>
 626
 627 @notebook:
 628 @child:
 629 @Returns:
 630
 631
 632 <!-- ##### FUNCTION gtk_notebook_get_tab_pos ##### -->
 633 <para>
 634
 635 </para>
 636
 637 @notebook:
 638 @Returns:
 639
 640
 641 <!-- ##### FUNCTION gtk_notebook_get_tab_reorderable ##### -->
 642 <para>
 643
 644 </para>
 645
 646 @notebook:
 647 @child:
 648 @Returns:
 649
 650
 651 <!-- ##### FUNCTION gtk_notebook_get_tab_detachable ##### -->
 652 <para>
 653
 654 </para>
 655
 656 @notebook:
 657 @child:
 658 @Returns:
 659
 660
 661 <!-- ##### FUNCTION gtk_notebook_set_current_page ##### -->
 662 <para>
 663
 664 </para>
 665
 666 @notebook:
 667 @page_num:
 668
 669
 670 <!-- ##### FUNCTION gtk_notebook_set_group_id ##### -->
 671 <para>
 672
 673 </para>
 674
 675 @notebook:
 676 @group_id:
 677
 678
 679 <!-- ##### FUNCTION gtk_notebook_get_group_id ##### -->
 680 <para>
 681
 682 </para>
 683
 684 @notebook:
 685 @Returns:
 686
 687
 688 <!-- ##### USER_FUNCTION GtkNotebookWindowCreationFunc ##### -->
 689 <para>
 690 A function used by GtkNotebook when a detachable tab is dropped
 691 in the root window, it's used to create a window containing a notebook
 692 where the tab will be attached. This function will also be responsible
 693 of moving/resizing the window and adding the necessary properties to
 694 the notebook (i.e.: group-id).
 695
 696 If the function returns %NULL, the drag will be cancelled.
 697 </para>
 698
 699 @source: The source #GtkNotebook of the drag operation
 700 @page: the child #GtkWidget affected
 701 @x: the X coordinate where the drop happens
 702 @y: the Y coordinate where the drop happens
 703 @data: user data
 704 @Returns: The created #GtkNotebook where the tab will be attached, or NULL to cancel the drag
 705
 706
 707 <!-- ##### FUNCTION gtk_notebook_set_window_creation_hook ##### -->
 708 <para>
 709
 710 </para>
 711
 712 @func:
 713 @data:
 714 @destroy:
 715
 716