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_CONVERT ##### -->
 155 <para>
 156 The "Convert" item.
 157 <inlinegraphic fileref="stock_convert_24.png" format="PNG"></inlinegraphic>
 158 </para>
 159
 160
 161
 162 <!-- ##### MACRO GTK_STOCK_COPY ##### -->
 163 <para>
 164 The "Copy" item.
 165 <inlinegraphic fileref="stock_copy_24.png" format="PNG"></inlinegraphic>
 166 </para>
 167
 168
 169
 170 <!-- ##### MACRO GTK_STOCK_CUT ##### -->
 171 <para>
 172 The "Cut" item.
 173 <inlinegraphic fileref="stock_cut_24.png" format="PNG"></inlinegraphic>
 174 </para>
 175
 176
 177
 178 <!-- ##### MACRO GTK_STOCK_DELETE ##### -->
 179 <para>
 180 The "Delete" item.
 181 <inlinegraphic fileref="stock_trash_24.png" format="PNG"></inlinegraphic>
 182 </para>
 183
 184
 185
 186 <!-- ##### MACRO GTK_STOCK_DIALOG_ERROR ##### -->
 187 <para>
 188 The "Error" item.
 189 <inlinegraphic fileref="stock_dialog_error_48.png" format="PNG"></inlinegraphic>
 190 </para>
 191
 192
 193
 194 <!-- ##### MACRO GTK_STOCK_DIALOG_INFO ##### -->
 195 <para>
 196 The "Information" item.
 197 <inlinegraphic fileref="stock_dialog_info_48.png" format="PNG"></inlinegraphic>
 198 </para>
 199
 200
 201
 202 <!-- ##### MACRO GTK_STOCK_DIALOG_QUESTION ##### -->
 203 <para>
 204 The "Question" item.
 205 <inlinegraphic fileref="stock_dialog_question_48.png" format="PNG"></inlinegraphic>
 206 </para>
 207
 208
 209
 210 <!-- ##### MACRO GTK_STOCK_DIALOG_WARNING ##### -->
 211 <para>
 212 The "Warning" item.
 213 <inlinegraphic fileref="stock_dialog_warning_48.png" format="PNG"></inlinegraphic>
 214 </para>
 215
 216
 217
 218 <!-- ##### MACRO GTK_STOCK_DND ##### -->
 219 <para>
 220 The "Drag-And-Drop" icon.
 221 <inlinegraphic fileref="stock_dnd_32.png" format="PNG"></inlinegraphic>
 222 </para>
 223
 224
 225
 226 <!-- ##### MACRO GTK_STOCK_DND_MULTIPLE ##### -->
 227 <para>
 228 The "Drag-And-Drop multiple" icon.
 229 <inlinegraphic fileref="stock_dnd_multiple_32.png" format="PNG"></inlinegraphic>
 230 </para>
 231
 232
 233
 234 <!-- ##### MACRO GTK_STOCK_EXECUTE ##### -->
 235 <para>
 236 The "Execute" item.
 237 <inlinegraphic fileref="stock_exec_24.png" format="PNG"></inlinegraphic>
 238 </para>
 239
 240
 241
 242 <!-- ##### MACRO GTK_STOCK_FIND ##### -->
 243 <para>
 244 The "Find" item.
 245 <inlinegraphic fileref="stock_search_24.png" format="PNG"></inlinegraphic>
 246 </para>
 247
 248
 249
 250 <!-- ##### MACRO GTK_STOCK_FIND_AND_REPLACE ##### -->
 251 <para>
 252 The "Find and Replace" item.
 253 <inlinegraphic fileref="stock_search_replace_24.png" format="PNG"></inlinegraphic>
 254 </para>
 255
 256
 257
 258 <!-- ##### MACRO GTK_STOCK_FLOPPY ##### -->
 259 <para>
 260 The "Floppy" item.
 261 <inlinegraphic fileref="stock_save_24.png" format="PNG"></inlinegraphic>
 262 </para>
 263
 264
 265
 266 <!-- ##### MACRO GTK_STOCK_GOTO_BOTTOM ##### -->
 267 <para>
 268 The "Bottom" item.
 269 <inlinegraphic fileref="stock_bottom_24.png" format="PNG"></inlinegraphic>
 270 </para>
 271
 272
 273
 274 <!-- ##### MACRO GTK_STOCK_GOTO_FIRST ##### -->
 275 <para>
 276 The "First" item.
 277 <inlinegraphic fileref="stock_first_24.png" format="PNG"></inlinegraphic>
 278 </para>
 279
 280
 281
 282 <!-- ##### MACRO GTK_STOCK_GOTO_LAST ##### -->
 283 <para>
 284 The "Last" item.
 285 <inlinegraphic fileref="stock_last_24.png" format="PNG"></inlinegraphic>
 286 </para>
 287
 288
 289
 290 <!-- ##### MACRO GTK_STOCK_GOTO_TOP ##### -->
 291 <para>
 292 The "Top" item.
 293 <inlinegraphic fileref="stock_top_24.png" format="PNG"></inlinegraphic>
 294 </para>
 295
 296
 297
 298 <!-- ##### MACRO GTK_STOCK_GO_BACK ##### -->
 299 <para>
 300 The "Back" item.
 301 <inlinegraphic fileref="stock_left_arrow_24.png" format="PNG"></inlinegraphic>
 302 </para>
 303
 304
 305
 306 <!-- ##### MACRO GTK_STOCK_GO_DOWN ##### -->
 307 <para>
 308 The "Down" item.
 309 <inlinegraphic fileref="stock_down_arrow_24.png" format="PNG"></inlinegraphic>
 310 </para>
 311
 312
 313
 314 <!-- ##### MACRO GTK_STOCK_GO_FORWARD ##### -->
 315 <para>
 316 The "Forward" item.
 317 <inlinegraphic fileref="stock_right_arrow_24.png" format="PNG"></inlinegraphic>
 318 </para>
 319
 320
 321
 322 <!-- ##### MACRO GTK_STOCK_GO_UP ##### -->
 323 <para>
 324 The "Up" item.
 325 <inlinegraphic fileref="stock_up_arrow_24.png" format="PNG"></inlinegraphic>
 326 </para>
 327
 328
 329
 330 <!-- ##### MACRO GTK_STOCK_HELP ##### -->
 331 <para>
 332 The "Help" item.
 333 <inlinegraphic fileref="stock_help_24.png" format="PNG"></inlinegraphic>
 334 </para>
 335
 336
 337
 338 <!-- ##### MACRO GTK_STOCK_HOME ##### -->
 339 <para>
 340 The "Home" item.
 341 <inlinegraphic fileref="stock_home_24.png" format="PNG"></inlinegraphic>
 342 </para>
 343
 344
 345
 346 <!-- ##### MACRO GTK_STOCK_INDEX ##### -->
 347 <para>
 348 The "Index" item.
 349 <inlinegraphic fileref="stock_index_24.png" format="PNG"></inlinegraphic>
 350 </para>
 351
 352
 353
 354 <!-- ##### MACRO GTK_STOCK_ITALIC ##### -->
 355 <para>
 356 The "Italic" item.
 357 <inlinegraphic fileref="stock_text_italic_24.png" format="PNG"></inlinegraphic>
 358 </para>
 359
 360
 361
 362 <!-- ##### MACRO GTK_STOCK_JUMP_TO ##### -->
 363 <para>
 364 The "Jump to" item.
 365 <inlinegraphic fileref="stock_jump_to_24.png" format="PNG"></inlinegraphic>
 366 </para>
 367
 368
 369
 370 <!-- ##### MACRO GTK_STOCK_JUSTIFY_CENTER ##### -->
 371 <para>
 372 The "Center" item.
 373 <inlinegraphic fileref="stock_align_center_24.png" format="PNG"></inlinegraphic>
 374 </para>
 375
 376
 377
 378 <!-- ##### MACRO GTK_STOCK_JUSTIFY_FILL ##### -->
 379 <para>
 380 The "Fill" item.
 381 <inlinegraphic fileref="stock_align_justify_24.png" format="PNG"></inlinegraphic>
 382 </para>
 383
 384
 385
 386 <!-- ##### MACRO GTK_STOCK_JUSTIFY_LEFT ##### -->
 387 <para>
 388 The "Left" item.
 389 <inlinegraphic fileref="stock_align_left_24.png" format="PNG"></inlinegraphic>
 390 </para>
 391
 392
 393
 394 <!-- ##### MACRO GTK_STOCK_JUSTIFY_RIGHT ##### -->
 395 <para>
 396 The "Right" item.
 397 <inlinegraphic fileref="stock_align_right_24.png" format="PNG"></inlinegraphic>
 398 </para>
 399
 400
 401
 402 <!-- ##### MACRO GTK_STOCK_MISSING_IMAGE ##### -->
 403 <para>
 404 The "Missing image" icon.
 405 <inlinegraphic fileref="stock_broken_image_24.png" format="PNG"></inlinegraphic>
 406 </para>
 407
 408
 409
 410 <!-- ##### MACRO GTK_STOCK_NEW ##### -->
 411 <para>
 412 The "New" item.
 413 <inlinegraphic fileref="stock_new_24.png" format="PNG"></inlinegraphic>
 414 </para>
 415
 416
 417
 418 <!-- ##### MACRO GTK_STOCK_NO ##### -->
 419 <para>
 420 The "No" item.
 421 <inlinegraphic fileref="stock_no_20.png" format="PNG"></inlinegraphic>
 422 </para>
 423
 424
 425
 426 <!-- ##### MACRO GTK_STOCK_OK ##### -->
 427 <para>
 428 The "OK" item.
 429 <inlinegraphic fileref="stock_ok_20.png" format="PNG"></inlinegraphic>
 430 </para>
 431
 432
 433
 434 <!-- ##### MACRO GTK_STOCK_OPEN ##### -->
 435 <para>
 436 The "Open" item.
 437 <inlinegraphic fileref="stock_open_24.png" format="PNG"></inlinegraphic>
 438 </para>
 439
 440
 441
 442 <!-- ##### MACRO GTK_STOCK_PASTE ##### -->
 443 <para>
 444 The "Paste" item.
 445 <inlinegraphic fileref="stock_paste_24.png" format="PNG"></inlinegraphic>
 446 </para>
 447
 448
 449
 450 <!-- ##### MACRO GTK_STOCK_PREFERENCES ##### -->
 451 <para>
 452 The "Preferences" item.
 453 <inlinegraphic fileref="stock_preferences_24.png" format="PNG"></inlinegraphic>
 454 </para>
 455
 456
 457
 458 <!-- ##### MACRO GTK_STOCK_PRINT ##### -->
 459 <para>
 460 The "Print" item.
 461 <inlinegraphic fileref="stock_print_24.png" format="PNG"></inlinegraphic>
 462 </para>
 463
 464
 465
 466 <!-- ##### MACRO GTK_STOCK_PRINT_PREVIEW ##### -->
 467 <para>
 468 The "Print Preview" item.
 469 <inlinegraphic fileref="stock_print_preview_24.png" format="PNG"></inlinegraphic>
 470 </para>
 471
 472
 473
 474 <!-- ##### MACRO GTK_STOCK_PROPERTIES ##### -->
 475 <para>
 476 The "Properties" item.
 477 <inlinegraphic fileref="stock_properties_24.png" format="PNG"></inlinegraphic>
 478 </para>
 479
 480
 481
 482 <!-- ##### MACRO GTK_STOCK_QUIT ##### -->
 483 <para>
 484 The "Quit" item.
 485 <inlinegraphic fileref="stock_exit_24.png" format="PNG"></inlinegraphic>
 486 </para>
 487
 488
 489
 490 <!-- ##### MACRO GTK_STOCK_REDO ##### -->
 491 <para>
 492 The "Redo" item.
 493 <inlinegraphic fileref="stock_redo_24.png" format="PNG"></inlinegraphic>
 494 </para>
 495
 496
 497
 498 <!-- ##### MACRO GTK_STOCK_REFRESH ##### -->
 499 <para>
 500 The "Refresh" item.
 501 <inlinegraphic fileref="stock_refresh_24.png" format="PNG"></inlinegraphic>
 502 </para>
 503
 504
 505
 506 <!-- ##### MACRO GTK_STOCK_REMOVE ##### -->
 507 <para>
 508 The "Remove" item.
 509 <inlinegraphic fileref="stock_remove_24.png" format="PNG"></inlinegraphic>
 510 </para>
 511
 512
 513
 514 <!-- ##### MACRO GTK_STOCK_REVERT_TO_SAVED ##### -->
 515 <para>
 516 The "Revert" item.
 517 <inlinegraphic fileref="stock_revert_24.png" format="PNG"></inlinegraphic>
 518 </para>
 519
 520
 521
 522 <!-- ##### MACRO GTK_STOCK_SAVE ##### -->
 523 <para>
 524 The "Save" item.
 525 <inlinegraphic fileref="stock_save_24.png" format="PNG"></inlinegraphic>
 526 </para>
 527
 528
 529
 530 <!-- ##### MACRO GTK_STOCK_SAVE_AS ##### -->
 531 <para>
 532 The "Save As" item.
 533 <inlinegraphic fileref="stock_save_as_24.png" format="PNG"></inlinegraphic>
 534 </para>
 535
 536
 537
 538 <!-- ##### MACRO GTK_STOCK_SELECT_COLOR ##### -->
 539 <para>
 540 The "Color" item.
 541 <inlinegraphic fileref="stock_colorselector_24.png" format="PNG"></inlinegraphic>
 542 </para>
 543
 544
 545
 546 <!-- ##### MACRO GTK_STOCK_SELECT_FONT ##### -->
 547 <para>
 548 The "Font" item.
 549 <inlinegraphic fileref="stock_font_24.png" format="PNG"></inlinegraphic>
 550 </para>
 551
 552
 553
 554 <!-- ##### MACRO GTK_STOCK_SORT_ASCENDING ##### -->
 555 <para>
 556 The "Ascending" item.
 557 <inlinegraphic fileref="stock_sort_ascending_24.png" format="PNG"></inlinegraphic>
 558 </para>
 559
 560
 561
 562 <!-- ##### MACRO GTK_STOCK_SORT_DESCENDING ##### -->
 563 <para>
 564 The "Descending" item.
 565 <inlinegraphic fileref="stock_sort_descending_24.png" format="PNG"></inlinegraphic>
 566 </para>
 567
 568
 569
 570 <!-- ##### MACRO GTK_STOCK_SPELL_CHECK ##### -->
 571 <para>
 572 The "Spell Check" item.
 573 <inlinegraphic fileref="stock_spellcheck_24.png" format="PNG"></inlinegraphic>
 574 </para>
 575
 576
 577
 578 <!-- ##### MACRO GTK_STOCK_STOP ##### -->
 579 <para>
 580 The "Stop" item.
 581 <inlinegraphic fileref="stock_stop_24.png" format="PNG"></inlinegraphic>
 582 </para>
 583
 584
 585
 586 <!-- ##### MACRO GTK_STOCK_STRIKETHROUGH ##### -->
 587 <para>
 588 The "Strikethrough" item.
 589 <inlinegraphic fileref="stock_text_strikethrough_24.png" format="PNG"></inlinegraphic>
 590 </para>
 591
 592
 593
 594 <!-- ##### MACRO GTK_STOCK_UNDELETE ##### -->
 595 <para>
 596 The "Undelete" item.
 597 <inlinegraphic fileref="stock_undelete_24.png" format="PNG"></inlinegraphic>
 598 </para>
 599
 600
 601
 602 <!-- ##### MACRO GTK_STOCK_UNDERLINE ##### -->
 603 <para>
 604 The "Underline" item.
 605 <inlinegraphic fileref="stock_text_underline_24.png" format="PNG"></inlinegraphic>
 606 </para>
 607
 608
 609
 610 <!-- ##### MACRO GTK_STOCK_UNDO ##### -->
 611 <para>
 612 The "Undo" item.
 613 <inlinegraphic fileref="stock_undo_24.png" format="PNG"></inlinegraphic>
 614 </para>
 615
 616
 617
 618 <!-- ##### MACRO GTK_STOCK_YES ##### -->
 619 <para>
 620 The "Yes" item.
 621 <inlinegraphic fileref="stock_yes_20.png" format="PNG"></inlinegraphic>
 622 </para>
 623
 624
 625
 626 <!-- ##### MACRO GTK_STOCK_ZOOM_100 ##### -->
 627 <para>
 628 The "Zoom 100%" item.
 629 <inlinegraphic fileref="stock_zoom_1_24.png" format="PNG"></inlinegraphic>
 630 </para>
 631
 632
 633
 634 <!-- ##### MACRO GTK_STOCK_ZOOM_FIT ##### -->
 635 <para>
 636 The "Zoom to Fit" item.
 637 <inlinegraphic fileref="stock_zoom_fit_24.png" format="PNG"></inlinegraphic>
 638 </para>
 639
 640
 641
 642 <!-- ##### MACRO GTK_STOCK_ZOOM_IN ##### -->
 643 <para>
 644 The "Zoom In" item.
 645 <inlinegraphic fileref="stock_zoom_in_24.png" format="PNG"></inlinegraphic>
 646 </para>
 647
 648
 649
 650 <!-- ##### MACRO GTK_STOCK_ZOOM_OUT ##### -->
 651 <para>
 652 The "Zoom Out" item.
 653 <inlinegraphic fileref="stock_zoom_out_24.png" format="PNG"></inlinegraphic>
 654 </para>
 655
 656
 657