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