Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkstock.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Stock Items
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 Prebuilt common menu/toolbar items and corresponding icons
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 Stock items represent commonly-used menu or toolbar items such as
  11 "Open" or "Exit". Each stock item is identified by a stock ID;
  12 stock IDs are just strings, but macros such as #GTK_STOCK_OPEN are
  13 provided to avoid typing mistakes in the strings.
  14 Applications can register their own stock items in addition to those
  15 built-in to GTK+.
  16 </para>
  17 <para>
  18 Each stock ID can be associated with a #GtkStockItem, which contains
  19 the user-visible label, keyboard accelerator, and translation domain
  20 of the menu or toolbar item; and/or with an icon stored in a
  21 #GtkIconFactory. See <link
  22 linkend="gtk-Themeable-Stock-Images">GtkIconFactory</link> for
  23 more information on stock icons. The connection between a
  24 #GtkStockItem and stock icons is purely conventional (by virtue of
  25 using the same stock ID); it's possible to register a stock item but
  26 no icon, and vice versa.
  27 </para>
  28
  29 <!-- ##### SECTION See_Also ##### -->
  30 <para>
  31
  32 </para>
  33
  34 <!-- ##### STRUCT GtkStockItem ##### -->
  35 <para>
  36
  37 </para>
  38
  39 @stock_id:
  40 @label:
  41 @modifier:
  42 @keyval:
  43 @translation_domain:
  44
  45 <!-- ##### FUNCTION gtk_stock_add ##### -->
  46 <para>
  47
  48 </para>
  49
  50 @items:
  51 @n_items:
  52
  53
  54 <!-- ##### FUNCTION gtk_stock_add_static ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @items:
  60 @n_items:
  61
  62
  63 <!-- ##### FUNCTION gtk_stock_item_copy ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @item:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION gtk_stock_item_free ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @item:
  78
  79
  80 <!-- ##### FUNCTION gtk_stock_list_ids ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @Returns:
  86
  87
  88 <!-- ##### FUNCTION gtk_stock_lookup ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @stock_id:
  94 @item:
  95 @Returns:
  96
  97
  98 <!-- ##### MACRO GTK_STOCK_ADD ##### -->
  99 <para>
 100 The "Add" item.
 101 <inlinegraphic fileref="stock_add_24.png" format="PNG"></inlinegraphic>
 102 </para>
 103
 104
 105
 106 <!-- ##### MACRO GTK_STOCK_APPLY ##### -->
 107 <para>
 108 The "Apply" item.
 109 <inlinegraphic fileref="stock_apply_20.png" format="PNG"></inlinegraphic>
 110 </para>
 111
 112
 113
 114 <!-- ##### MACRO GTK_STOCK_BOLD ##### -->
 115 <para>
 116 The "Bold" item.
 117 <inlinegraphic fileref="stock_text_bold_24.png" format="PNG"></inlinegraphic>
 118 </para>
 119
 120
 121
 122 <!-- ##### MACRO GTK_STOCK_CANCEL ##### -->
 123 <para>
 124 The "Cancel" item.
 125 <inlinegraphic fileref="stock_cancel_20.png" format="PNG"></inlinegraphic>
 126 </para>
 127
 128
 129
 130 <!-- ##### MACRO GTK_STOCK_CDROM ##### -->
 131 <para>
 132 The "CD-Rom" item.
 133 <inlinegraphic fileref="stock_cdrom_24.png" format="PNG"></inlinegraphic>
 134 </para>
 135
 136
 137
 138 <!-- ##### MACRO GTK_STOCK_CLEAR ##### -->
 139 <para>
 140 The "Clear" item.
 141 <inlinegraphic fileref="stock_clear_24.png" format="PNG"></inlinegraphic>
 142 </para>
 143
 144
 145
 146 <!-- ##### MACRO GTK_STOCK_CLOSE ##### -->
 147 <para>
 148 The "Close" item.
 149 <inlinegraphic fileref="stock_close_24.png" format="PNG"></inlinegraphic>
 150 </para>
 151
 152
 153
 154 <!-- ##### MACRO GTK_STOCK_COLOR_PICKER ##### -->
 155 <para>
 156 The "Color Picker" item.
 157 <inlinegraphic fileref="stock_colorselector_24.png" format="PNG"></inlinegraphic>
 158 </para>
 159
 160 @Since: 2.2
 161
 162
 163 <!-- ##### MACRO GTK_STOCK_CONVERT ##### -->
 164 <para>
 165 The "Convert" item.
 166 <inlinegraphic fileref="stock_convert_24.png" format="PNG"></inlinegraphic>
 167 </para>
 168
 169
 170
 171 <!-- ##### MACRO GTK_STOCK_COPY ##### -->
 172 <para>
 173 The "Copy" item.
 174 <inlinegraphic fileref="stock_copy_24.png" format="PNG"></inlinegraphic>
 175 </para>
 176
 177
 178
 179 <!-- ##### MACRO GTK_STOCK_CUT ##### -->
 180 <para>
 181 The "Cut" item.
 182 <inlinegraphic fileref="stock_cut_24.png" format="PNG"></inlinegraphic>
 183 </para>
 184
 185
 186
 187 <!-- ##### MACRO GTK_STOCK_DELETE ##### -->
 188 <para>
 189 The "Delete" item.
 190 <inlinegraphic fileref="stock_trash_24.png" format="PNG"></inlinegraphic>
 191 </para>
 192
 193
 194
 195 <!-- ##### MACRO GTK_STOCK_DIALOG_ERROR ##### -->
 196 <para>
 197 The "Error" item.
 198 <inlinegraphic fileref="stock_dialog_error_48.png" format="PNG"></inlinegraphic>
 199 </para>
 200
 201
 202
 203 <!-- ##### MACRO GTK_STOCK_DIALOG_INFO ##### -->
 204 <para>
 205 The "Information" item.
 206 <inlinegraphic fileref="stock_dialog_info_48.png" format="PNG"></inlinegraphic>
 207 </para>
 208
 209
 210
 211 <!-- ##### MACRO GTK_STOCK_DIALOG_QUESTION ##### -->
 212 <para>
 213 The "Question" item.
 214 <inlinegraphic fileref="stock_dialog_question_48.png" format="PNG"></inlinegraphic>
 215 </para>
 216
 217
 218
 219 <!-- ##### MACRO GTK_STOCK_DIALOG_WARNING ##### -->
 220 <para>
 221 The "Warning" item.
 222 <inlinegraphic fileref="stock_dialog_warning_48.png" format="PNG"></inlinegraphic>
 223 </para>
 224
 225
 226
 227 <!-- ##### MACRO GTK_STOCK_DND ##### -->
 228 <para>
 229 The "Drag-And-Drop" icon.
 230 <inlinegraphic fileref="stock_dnd_32.png" format="PNG"></inlinegraphic>
 231 </para>
 232
 233
 234
 235 <!-- ##### MACRO GTK_STOCK_DND_MULTIPLE ##### -->
 236 <para>
 237 The "Drag-And-Drop multiple" icon.
 238 <inlinegraphic fileref="stock_dnd_multiple_32.png" format="PNG"></inlinegraphic>
 239 </para>
 240
 241
 242
 243 <!-- ##### MACRO GTK_STOCK_EXECUTE ##### -->
 244 <para>
 245 The "Execute" item.
 246 <inlinegraphic fileref="stock_exec_24.png" format="PNG"></inlinegraphic>
 247 </para>
 248
 249
 250
 251 <!-- ##### MACRO GTK_STOCK_FIND ##### -->
 252 <para>
 253 The "Find" item.
 254 <inlinegraphic fileref="stock_search_24.png" format="PNG"></inlinegraphic>
 255 </para>
 256
 257
 258
 259 <!-- ##### MACRO GTK_STOCK_FIND_AND_REPLACE ##### -->
 260 <para>
 261 The "Find and Replace" item.
 262 <inlinegraphic fileref="stock_search_replace_24.png" format="PNG"></inlinegraphic>
 263 </para>
 264
 265
 266
 267 <!-- ##### MACRO GTK_STOCK_FLOPPY ##### -->
 268 <para>
 269 The "Floppy" item.
 270 <inlinegraphic fileref="stock_save_24.png" format="PNG"></inlinegraphic>
 271 </para>
 272
 273
 274
 275 <!-- ##### MACRO GTK_STOCK_GOTO_BOTTOM ##### -->
 276 <para>
 277 The "Bottom" item.
 278 <inlinegraphic fileref="stock_bottom_24.png" format="PNG"></inlinegraphic>
 279 </para>
 280
 281
 282
 283 <!-- ##### MACRO GTK_STOCK_GOTO_FIRST ##### -->
 284 <para>
 285 The "First" item.
 286 <inlinegraphic fileref="stock_first_24.png" format="PNG"></inlinegraphic>
 287 </para>
 288
 289
 290
 291 <!-- ##### MACRO GTK_STOCK_GOTO_LAST ##### -->
 292 <para>
 293 The "Last" item.
 294 <inlinegraphic fileref="stock_last_24.png" format="PNG"></inlinegraphic>
 295 </para>
 296
 297
 298
 299 <!-- ##### MACRO GTK_STOCK_GOTO_TOP ##### -->
 300 <para>
 301 The "Top" item.
 302 <inlinegraphic fileref="stock_top_24.png" format="PNG"></inlinegraphic>
 303 </para>
 304
 305
 306
 307 <!-- ##### MACRO GTK_STOCK_GO_BACK ##### -->
 308 <para>
 309 The "Back" item.
 310 <inlinegraphic fileref="stock_left_arrow_24.png" format="PNG"></inlinegraphic>
 311 </para>
 312
 313
 314
 315 <!-- ##### MACRO GTK_STOCK_GO_DOWN ##### -->
 316 <para>
 317 The "Down" item.
 318 <inlinegraphic fileref="stock_down_arrow_24.png" format="PNG"></inlinegraphic>
 319 </para>
 320
 321
 322
 323 <!-- ##### MACRO GTK_STOCK_GO_FORWARD ##### -->
 324 <para>
 325 The "Forward" item.
 326 <inlinegraphic fileref="stock_right_arrow_24.png" format="PNG"></inlinegraphic>
 327 </para>
 328
 329
 330
 331 <!-- ##### MACRO GTK_STOCK_GO_UP ##### -->
 332 <para>
 333 The "Up" item.
 334 <inlinegraphic fileref="stock_up_arrow_24.png" format="PNG"></inlinegraphic>
 335 </para>
 336
 337
 338
 339 <!-- ##### MACRO GTK_STOCK_HELP ##### -->
 340 <para>
 341 The "Help" item.
 342 <inlinegraphic fileref="stock_help_24.png" format="PNG"></inlinegraphic>
 343 </para>
 344
 345
 346
 347 <!-- ##### MACRO GTK_STOCK_HOME ##### -->
 348 <para>
 349 The "Home" item.
 350 <inlinegraphic fileref="stock_home_24.png" format="PNG"></inlinegraphic>
 351 </para>
 352
 353
 354
 355 <!-- ##### MACRO GTK_STOCK_INDEX ##### -->
 356 <para>
 357 The "Index" item.
 358 <inlinegraphic fileref="stock_index_24.png" format="PNG"></inlinegraphic>
 359 </para>
 360
 361
 362
 363 <!-- ##### MACRO GTK_STOCK_ITALIC ##### -->
 364 <para>
 365 The "Italic" item.
 366 <inlinegraphic fileref="stock_text_italic_24.png" format="PNG"></inlinegraphic>
 367 </para>
 368
 369
 370
 371 <!-- ##### MACRO GTK_STOCK_JUMP_TO ##### -->
 372 <para>
 373 The "Jump to" item.
 374 <inlinegraphic fileref="stock_jump_to_24.png" format="PNG"></inlinegraphic>
 375 </para>
 376
 377
 378
 379 <!-- ##### MACRO GTK_STOCK_JUSTIFY_CENTER ##### -->
 380 <para>
 381 The "Center" item.
 382 <inlinegraphic fileref="stock_align_center_24.png" format="PNG"></inlinegraphic>
 383 </para>
 384
 385
 386
 387 <!-- ##### MACRO GTK_STOCK_JUSTIFY_FILL ##### -->
 388 <para>
 389 The "Fill" item.
 390 <inlinegraphic fileref="stock_align_justify_24.png" format="PNG"></inlinegraphic>
 391 </para>
 392
 393
 394
 395 <!-- ##### MACRO GTK_STOCK_JUSTIFY_LEFT ##### -->
 396 <para>
 397 The "Left" item.
 398 <inlinegraphic fileref="stock_align_left_24.png" format="PNG"></inlinegraphic>
 399 </para>
 400
 401
 402
 403 <!-- ##### MACRO GTK_STOCK_JUSTIFY_RIGHT ##### -->
 404 <para>
 405 The "Right" item.
 406 <inlinegraphic fileref="stock_align_right_24.png" format="PNG"></inlinegraphic>
 407 </para>
 408
 409
 410
 411 <!-- ##### MACRO GTK_STOCK_MISSING_IMAGE ##### -->
 412 <para>
 413 The "Missing image" icon.
 414 <inlinegraphic fileref="stock_broken_image_24.png" format="PNG"></inlinegraphic>
 415 </para>
 416
 417
 418
 419 <!-- ##### MACRO GTK_STOCK_NEW ##### -->
 420 <para>
 421 The "New" item.
 422 <inlinegraphic fileref="stock_new_24.png" format="PNG"></inlinegraphic>
 423 </para>
 424
 425
 426
 427 <!-- ##### MACRO GTK_STOCK_NO ##### -->
 428 <para>
 429 The "No" item.
 430 <inlinegraphic fileref="stock_no_20.png" format="PNG"></inlinegraphic>
 431 </para>
 432
 433
 434
 435 <!-- ##### MACRO GTK_STOCK_OK ##### -->
 436 <para>
 437 The "OK" item.
 438 <inlinegraphic fileref="stock_ok_20.png" format="PNG"></inlinegraphic>
 439 </para>
 440
 441
 442
 443 <!-- ##### MACRO GTK_STOCK_OPEN ##### -->
 444 <para>
 445 The "Open" item.
 446 <inlinegraphic fileref="stock_open_24.png" format="PNG"></inlinegraphic>
 447 </para>
 448
 449
 450
 451 <!-- ##### MACRO GTK_STOCK_PASTE ##### -->
 452 <para>
 453 The "Paste" item.
 454 <inlinegraphic fileref="stock_paste_24.png" format="PNG"></inlinegraphic>
 455 </para>
 456
 457
 458
 459 <!-- ##### MACRO GTK_STOCK_PREFERENCES ##### -->
 460 <para>
 461 The "Preferences" item.
 462 <inlinegraphic fileref="stock_preferences_24.png" format="PNG"></inlinegraphic>
 463 </para>
 464
 465
 466
 467 <!-- ##### MACRO GTK_STOCK_PRINT ##### -->
 468 <para>
 469 The "Print" item.
 470 <inlinegraphic fileref="stock_print_24.png" format="PNG"></inlinegraphic>
 471 </para>
 472
 473
 474
 475 <!-- ##### MACRO GTK_STOCK_PRINT_PREVIEW ##### -->
 476 <para>
 477 The "Print Preview" item.
 478 <inlinegraphic fileref="stock_print_preview_24.png" format="PNG"></inlinegraphic>
 479 </para>
 480
 481
 482
 483 <!-- ##### MACRO GTK_STOCK_PROPERTIES ##### -->
 484 <para>
 485 The "Properties" item.
 486 <inlinegraphic fileref="stock_properties_24.png" format="PNG"></inlinegraphic>
 487 </para>
 488
 489
 490
 491 <!-- ##### MACRO GTK_STOCK_QUIT ##### -->
 492 <para>
 493 The "Quit" item.
 494 <inlinegraphic fileref="stock_exit_24.png" format="PNG"></inlinegraphic>
 495 </para>
 496
 497
 498
 499 <!-- ##### MACRO GTK_STOCK_REDO ##### -->
 500 <para>
 501 The "Redo" item.
 502 <inlinegraphic fileref="stock_redo_24.png" format="PNG"></inlinegraphic>
 503 </para>
 504
 505
 506
 507 <!-- ##### MACRO GTK_STOCK_REFRESH ##### -->
 508 <para>
 509 The "Refresh" item.
 510 <inlinegraphic fileref="stock_refresh_24.png" format="PNG"></inlinegraphic>
 511 </para>
 512
 513
 514
 515 <!-- ##### MACRO GTK_STOCK_REMOVE ##### -->
 516 <para>
 517 The "Remove" item.
 518 <inlinegraphic fileref="stock_remove_24.png" format="PNG"></inlinegraphic>
 519 </para>
 520
 521
 522
 523 <!-- ##### MACRO GTK_STOCK_REVERT_TO_SAVED ##### -->
 524 <para>
 525 The "Revert" item.
 526 <inlinegraphic fileref="stock_revert_24.png" format="PNG"></inlinegraphic>
 527 </para>
 528
 529
 530
 531 <!-- ##### MACRO GTK_STOCK_SAVE ##### -->
 532 <para>
 533 The "Save" item.
 534 <inlinegraphic fileref="stock_save_24.png" format="PNG"></inlinegraphic>
 535 </para>
 536
 537
 538
 539 <!-- ##### MACRO GTK_STOCK_SAVE_AS ##### -->
 540 <para>
 541 The "Save As" item.
 542 <inlinegraphic fileref="stock_save_as_24.png" format="PNG"></inlinegraphic>
 543 </para>
 544
 545
 546
 547 <!-- ##### MACRO GTK_STOCK_SELECT_COLOR ##### -->
 548 <para>
 549 The "Color" item.
 550 <inlinegraphic fileref="stock_colorselector_24.png" format="PNG"></inlinegraphic>
 551 </para>
 552
 553
 554
 555 <!-- ##### MACRO GTK_STOCK_SELECT_FONT ##### -->
 556 <para>
 557 The "Font" item.
 558 <inlinegraphic fileref="stock_font_24.png" format="PNG"></inlinegraphic>
 559 </para>
 560
 561
 562
 563 <!-- ##### MACRO GTK_STOCK_SORT_ASCENDING ##### -->
 564 <para>
 565 The "Ascending" item.
 566 <inlinegraphic fileref="stock_sort_ascending_24.png" format="PNG"></inlinegraphic>
 567 </para>
 568
 569
 570
 571 <!-- ##### MACRO GTK_STOCK_SORT_DESCENDING ##### -->
 572 <para>
 573 The "Descending" item.
 574 <inlinegraphic fileref="stock_sort_descending_24.png" format="PNG"></inlinegraphic>
 575 </para>
 576
 577
 578
 579 <!-- ##### MACRO GTK_STOCK_SPELL_CHECK ##### -->
 580 <para>
 581 The "Spell Check" item.
 582 <inlinegraphic fileref="stock_spellcheck_24.png" format="PNG"></inlinegraphic>
 583 </para>
 584
 585
 586
 587 <!-- ##### MACRO GTK_STOCK_STOP ##### -->
 588 <para>
 589 The "Stop" item.
 590 <inlinegraphic fileref="stock_stop_24.png" format="PNG"></inlinegraphic>
 591 </para>
 592
 593
 594
 595 <!-- ##### MACRO GTK_STOCK_STRIKETHROUGH ##### -->
 596 <para>
 597 The "Strikethrough" item.
 598 <inlinegraphic fileref="stock_text_strikethrough_24.png" format="PNG"></inlinegraphic>
 599 </para>
 600
 601
 602
 603 <!-- ##### MACRO GTK_STOCK_UNDELETE ##### -->
 604 <para>
 605 The "Undelete" item.
 606 <inlinegraphic fileref="stock_undelete_24.png" format="PNG"></inlinegraphic>
 607 </para>
 608
 609
 610
 611 <!-- ##### MACRO GTK_STOCK_UNDERLINE ##### -->
 612 <para>
 613 The "Underline" item.
 614 <inlinegraphic fileref="stock_text_underline_24.png" format="PNG"></inlinegraphic>
 615 </para>
 616
 617
 618
 619 <!-- ##### MACRO GTK_STOCK_UNDO ##### -->
 620 <para>
 621 The "Undo" item.
 622 <inlinegraphic fileref="stock_undo_24.png" format="PNG"></inlinegraphic>
 623 </para>
 624
 625
 626
 627 <!-- ##### MACRO GTK_STOCK_YES ##### -->
 628 <para>
 629 The "Yes" item.
 630 <inlinegraphic fileref="stock_yes_20.png" format="PNG"></inlinegraphic>
 631 </para>
 632
 633
 634
 635 <!-- ##### MACRO GTK_STOCK_ZOOM_100 ##### -->
 636 <para>
 637 The "Zoom 100%" item.
 638 <inlinegraphic fileref="stock_zoom_1_24.png" format="PNG"></inlinegraphic>
 639 </para>
 640
 641
 642
 643 <!-- ##### MACRO GTK_STOCK_ZOOM_FIT ##### -->
 644 <para>
 645 The "Zoom to Fit" item.
 646 <inlinegraphic fileref="stock_zoom_fit_24.png" format="PNG"></inlinegraphic>
 647 </para>
 648
 649
 650
 651 <!-- ##### MACRO GTK_STOCK_ZOOM_IN ##### -->
 652 <para>
 653 The "Zoom In" item.
 654 <inlinegraphic fileref="stock_zoom_in_24.png" format="PNG"></inlinegraphic>
 655 </para>
 656
 657
 658
 659 <!-- ##### MACRO GTK_STOCK_ZOOM_OUT ##### -->
 660 <para>
 661 The "Zoom Out" item.
 662 <inlinegraphic fileref="stock_zoom_out_24.png" format="PNG"></inlinegraphic>
 663 </para>
 664
 665
 666