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