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