]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkstock.sgml
Misc additions.
[~andy/gtk] / 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. Stock icons may have a RTL variant which gets
27 used for right-to-left locales. 
28 </para>
29
30 <!-- ##### SECTION See_Also ##### -->
31 <para>
32
33 </para>
34
35 <!-- ##### STRUCT GtkStockItem ##### -->
36 <para>
37
38 </para>
39
40 @stock_id: 
41 @label: 
42 @modifier: 
43 @keyval: 
44 @translation_domain: 
45
46 <!-- ##### FUNCTION gtk_stock_add ##### -->
47 <para>
48
49 </para>
50
51 @items: 
52 @n_items: 
53
54
55 <!-- ##### FUNCTION gtk_stock_add_static ##### -->
56 <para>
57
58 </para>
59
60 @items: 
61 @n_items: 
62
63
64 <!-- ##### FUNCTION gtk_stock_item_copy ##### -->
65 <para>
66
67 </para>
68
69 @item: 
70 @Returns: 
71
72
73 <!-- ##### FUNCTION gtk_stock_item_free ##### -->
74 <para>
75
76 </para>
77
78 @item: 
79
80
81 <!-- ##### FUNCTION gtk_stock_list_ids ##### -->
82 <para>
83
84 </para>
85
86 @Returns: 
87
88
89 <!-- ##### FUNCTION gtk_stock_lookup ##### -->
90 <para>
91
92 </para>
93
94 @stock_id: 
95 @item: 
96 @Returns: 
97
98
99 <!-- ##### MACRO GTK_STOCK_ADD ##### -->
100 <para>
101 The "Add" item.
102 <inlinegraphic fileref="stock_add_24.png" format="PNG"></inlinegraphic>
103 </para>
104
105
106
107 <!-- ##### MACRO GTK_STOCK_APPLY ##### -->
108 <para>
109 The "Apply" item.
110 <inlinegraphic fileref="stock_apply_20.png" format="PNG"></inlinegraphic>
111 </para>
112
113
114
115 <!-- ##### MACRO GTK_STOCK_BOLD ##### -->
116 <para>
117 The "Bold" item.
118 <inlinegraphic fileref="stock_text_bold_24.png" format="PNG"></inlinegraphic>
119 </para>
120
121
122
123 <!-- ##### MACRO GTK_STOCK_CANCEL ##### -->
124 <para>
125 The "Cancel" item.
126 <inlinegraphic fileref="stock_cancel_20.png" format="PNG"></inlinegraphic>
127 </para>
128
129
130
131 <!-- ##### MACRO GTK_STOCK_CDROM ##### -->
132 <para>
133 The "CD-Rom" item.
134 <inlinegraphic fileref="stock_cdrom_24.png" format="PNG"></inlinegraphic>
135 </para>
136
137
138
139 <!-- ##### MACRO GTK_STOCK_CLEAR ##### -->
140 <para>
141 The "Clear" item.
142 <inlinegraphic fileref="stock_clear_24.png" format="PNG"></inlinegraphic>
143 </para>
144
145
146
147 <!-- ##### MACRO GTK_STOCK_CLOSE ##### -->
148 <para>
149 The "Close" item.
150 <inlinegraphic fileref="stock_close_24.png" format="PNG"></inlinegraphic>
151 </para>
152
153
154
155 <!-- ##### MACRO GTK_STOCK_COLOR_PICKER ##### -->
156 <para>
157 The "Color Picker" item.
158 <inlinegraphic fileref="stock_color_picker_25.png" format="PNG"></inlinegraphic>
159 </para>
160
161 @Since: 2.2
162
163
164 <!-- ##### MACRO GTK_STOCK_CONVERT ##### -->
165 <para>
166 The "Convert" item.
167 <inlinegraphic fileref="stock_convert_24.png" format="PNG"></inlinegraphic>
168 </para>
169
170
171
172 <!-- ##### MACRO GTK_STOCK_COPY ##### -->
173 <para>
174 The "Copy" item.
175 <inlinegraphic fileref="stock_copy_24.png" format="PNG"></inlinegraphic>
176 </para>
177
178
179
180 <!-- ##### MACRO GTK_STOCK_CUT ##### -->
181 <para>
182 The "Cut" item.
183 <inlinegraphic fileref="stock_cut_24.png" format="PNG"></inlinegraphic>
184 </para>
185
186
187
188 <!-- ##### MACRO GTK_STOCK_DELETE ##### -->
189 <para>
190 The "Delete" item.
191 <inlinegraphic fileref="stock_trash_24.png" format="PNG"></inlinegraphic>
192 </para>
193
194
195
196 <!-- ##### MACRO GTK_STOCK_DIALOG_AUTHENTICATION ##### -->
197 <para>
198 The "Authentication" item.
199 <inlinegraphic fileref="stock_dialog_authentication_48.png" format="PNG"></inlinegraphic>
200 </para>
201
202 @Since: 2.4
203
204
205 <!-- ##### MACRO GTK_STOCK_DIALOG_ERROR ##### -->
206 <para>
207 The "Error" item.
208 <inlinegraphic fileref="stock_dialog_error_48.png" format="PNG"></inlinegraphic>
209 </para>
210
211
212
213 <!-- ##### MACRO GTK_STOCK_DIALOG_INFO ##### -->
214 <para>
215 The "Information" item.
216 <inlinegraphic fileref="stock_dialog_info_48.png" format="PNG"></inlinegraphic>
217 </para>
218
219
220
221 <!-- ##### MACRO GTK_STOCK_DIALOG_QUESTION ##### -->
222 <para>
223 The "Question" item.
224 <inlinegraphic fileref="stock_dialog_question_48.png" format="PNG"></inlinegraphic>
225 </para>
226
227
228
229 <!-- ##### MACRO GTK_STOCK_DIALOG_WARNING ##### -->
230 <para>
231 The "Warning" item.
232 <inlinegraphic fileref="stock_dialog_warning_48.png" format="PNG"></inlinegraphic>
233 </para>
234
235
236
237 <!-- ##### MACRO GTK_STOCK_DIRECTORY ##### -->
238 <para>
239 The "Directory" icon.
240 <inlinegraphic fileref="stock_directory_24.png" format="PNG"></inlinegraphic>
241 </para>
242
243
244
245 <!-- ##### MACRO GTK_STOCK_DND ##### -->
246 <para>
247 The "Drag-And-Drop" icon.
248 <inlinegraphic fileref="stock_dnd_32.png" format="PNG"></inlinegraphic>
249 </para>
250
251
252
253 <!-- ##### MACRO GTK_STOCK_DND_MULTIPLE ##### -->
254 <para>
255 The "Drag-And-Drop multiple" icon.
256 <inlinegraphic fileref="stock_dnd_multiple_32.png" format="PNG"></inlinegraphic>
257 </para>
258
259
260
261 <!-- ##### MACRO GTK_STOCK_EXECUTE ##### -->
262 <para>
263 The "Execute" item.
264 <inlinegraphic fileref="stock_exec_24.png" format="PNG"></inlinegraphic>
265 </para>
266
267
268
269 <!-- ##### MACRO GTK_STOCK_FILE ##### -->
270 <para>
271 <para>
272 The "File" icon.
273 <inlinegraphic fileref="stock_file_24.png" format="PNG"></inlinegraphic>
274 </para>
275 </para>
276
277
278
279 <!-- ##### MACRO GTK_STOCK_FIND ##### -->
280 <para>
281 The "Find" item.
282 <inlinegraphic fileref="stock_search_24.png" format="PNG"></inlinegraphic>
283 </para>
284
285
286
287 <!-- ##### MACRO GTK_STOCK_FIND_AND_REPLACE ##### -->
288 <para>
289 The "Find and Replace" item.
290 <inlinegraphic fileref="stock_search_replace_24.png" format="PNG"></inlinegraphic>
291 </para>
292
293
294
295 <!-- ##### MACRO GTK_STOCK_FLOPPY ##### -->
296 <para>
297 The "Floppy" item.
298 <inlinegraphic fileref="stock_save_24.png" format="PNG"></inlinegraphic>
299 </para>
300
301
302
303 <!-- ##### MACRO GTK_STOCK_GOTO_BOTTOM ##### -->
304 <para>
305 The "Bottom" item.
306 <inlinegraphic fileref="stock_bottom_24.png" format="PNG"></inlinegraphic>
307 </para>
308
309
310
311 <!-- ##### MACRO GTK_STOCK_GOTO_FIRST ##### -->
312 <para>
313 The "First" item.
314 <inlinegraphic fileref="stock_first_24.png" format="PNG"></inlinegraphic>
315 RTL variant
316 <inlinegraphic fileref="stock_last_24.png" format="PNG"></inlinegraphic>
317 </para>
318
319
320
321 <!-- ##### MACRO GTK_STOCK_GOTO_LAST ##### -->
322 <para>
323 The "Last" item.
324 <inlinegraphic fileref="stock_last_24.png" format="PNG"></inlinegraphic>
325 RTL variant
326 <inlinegraphic fileref="stock_first_24.png" format="PNG"></inlinegraphic>
327 </para>
328
329
330
331 <!-- ##### MACRO GTK_STOCK_GOTO_TOP ##### -->
332 <para>
333 The "Top" item.
334 <inlinegraphic fileref="stock_top_24.png" format="PNG"></inlinegraphic>
335 </para>
336
337
338
339 <!-- ##### MACRO GTK_STOCK_GO_BACK ##### -->
340 <para>
341 The "Back" item.
342 <inlinegraphic fileref="stock_left_arrow_24.png" format="PNG"></inlinegraphic>
343 RTL variant
344 <inlinegraphic fileref="stock_right_arrow_24.png" format="PNG"></inlinegraphic>
345 </para>
346
347
348
349 <!-- ##### MACRO GTK_STOCK_GO_DOWN ##### -->
350 <para>
351 The "Down" item.
352 <inlinegraphic fileref="stock_down_arrow_24.png" format="PNG"></inlinegraphic>
353 </para>
354
355
356
357 <!-- ##### MACRO GTK_STOCK_GO_FORWARD ##### -->
358 <para>
359 The "Forward" item.
360 <inlinegraphic fileref="stock_right_arrow_24.png" format="PNG"></inlinegraphic>
361 RTL variant
362 <inlinegraphic fileref="stock_left_arrow_24.png" format="PNG"></inlinegraphic>
363 </para>
364
365
366
367 <!-- ##### MACRO GTK_STOCK_GO_UP ##### -->
368 <para>
369 The "Up" item.
370 <inlinegraphic fileref="stock_up_arrow_24.png" format="PNG"></inlinegraphic>
371 </para>
372
373
374
375 <!-- ##### MACRO GTK_STOCK_HARDDISK ##### -->
376 <para>
377
378 </para>
379
380
381
382 <!-- ##### MACRO GTK_STOCK_HELP ##### -->
383 <para>
384 The "Help" item.
385 <inlinegraphic fileref="stock_help_24.png" format="PNG"></inlinegraphic>
386 </para>
387
388
389
390 <!-- ##### MACRO GTK_STOCK_HOME ##### -->
391 <para>
392 The "Home" item.
393 <inlinegraphic fileref="stock_home_24.png" format="PNG"></inlinegraphic>
394 </para>
395
396
397
398 <!-- ##### MACRO GTK_STOCK_INDENT ##### -->
399 <para>
400
401 </para>
402
403
404
405 <!-- ##### MACRO GTK_STOCK_INDEX ##### -->
406 <para>
407 The "Index" item.
408 <inlinegraphic fileref="stock_index_24.png" format="PNG"></inlinegraphic>
409 </para>
410
411
412
413 <!-- ##### MACRO GTK_STOCK_ITALIC ##### -->
414 <para>
415 The "Italic" item.
416 <inlinegraphic fileref="stock_text_italic_24.png" format="PNG"></inlinegraphic>
417 </para>
418
419
420
421 <!-- ##### MACRO GTK_STOCK_JUMP_TO ##### -->
422 <para>
423 The "Jump to" item.
424 <inlinegraphic fileref="stock_jump_to_24.png" format="PNG"></inlinegraphic>
425 RTL-variant 
426 <inlinegraphic fileref="stock_jump_to_rtl_24.png" format="PNG"></inlinegraphic>
427 </para>
428
429
430
431 <!-- ##### MACRO GTK_STOCK_JUSTIFY_CENTER ##### -->
432 <para>
433 The "Center" item.
434 <inlinegraphic fileref="stock_align_center_24.png" format="PNG"></inlinegraphic>
435 </para>
436
437
438
439 <!-- ##### MACRO GTK_STOCK_JUSTIFY_FILL ##### -->
440 <para>
441 The "Fill" item.
442 <inlinegraphic fileref="stock_align_justify_24.png" format="PNG"></inlinegraphic>
443 </para>
444
445
446
447 <!-- ##### MACRO GTK_STOCK_JUSTIFY_LEFT ##### -->
448 <para>
449 The "Left" item.
450 <inlinegraphic fileref="stock_align_left_24.png" format="PNG"></inlinegraphic>
451 </para>
452
453
454
455 <!-- ##### MACRO GTK_STOCK_JUSTIFY_RIGHT ##### -->
456 <para>
457 The "Right" item.
458 <inlinegraphic fileref="stock_align_right_24.png" format="PNG"></inlinegraphic>
459 </para>
460
461
462
463 <!-- ##### MACRO GTK_STOCK_MISSING_IMAGE ##### -->
464 <para>
465 The "Missing image" icon.
466 <inlinegraphic fileref="stock_broken_image_24.png" format="PNG"></inlinegraphic>
467 </para>
468
469
470
471 <!-- ##### MACRO GTK_STOCK_NETWORK ##### -->
472 <para>
473
474 </para>
475
476
477
478 <!-- ##### MACRO GTK_STOCK_NEW ##### -->
479 <para>
480 The "New" item.
481 <inlinegraphic fileref="stock_new_24.png" format="PNG"></inlinegraphic>
482 </para>
483
484
485
486 <!-- ##### MACRO GTK_STOCK_NO ##### -->
487 <para>
488 The "No" item.
489 <inlinegraphic fileref="stock_no_20.png" format="PNG"></inlinegraphic>
490 </para>
491
492
493
494 <!-- ##### MACRO GTK_STOCK_OK ##### -->
495 <para>
496 The "OK" item.
497 <inlinegraphic fileref="stock_ok_20.png" format="PNG"></inlinegraphic>
498 </para>
499
500
501
502 <!-- ##### MACRO GTK_STOCK_OPEN ##### -->
503 <para>
504 The "Open" item.
505 <inlinegraphic fileref="stock_open_24.png" format="PNG"></inlinegraphic>
506 </para>
507
508
509
510 <!-- ##### MACRO GTK_STOCK_PASTE ##### -->
511 <para>
512 The "Paste" item.
513 <inlinegraphic fileref="stock_paste_24.png" format="PNG"></inlinegraphic>
514 </para>
515
516
517
518 <!-- ##### MACRO GTK_STOCK_PREFERENCES ##### -->
519 <para>
520 The "Preferences" item.
521 <inlinegraphic fileref="stock_preferences_24.png" format="PNG"></inlinegraphic>
522 </para>
523
524
525
526 <!-- ##### MACRO GTK_STOCK_PRINT ##### -->
527 <para>
528 The "Print" item.
529 <inlinegraphic fileref="stock_print_24.png" format="PNG"></inlinegraphic>
530 </para>
531
532
533
534 <!-- ##### MACRO GTK_STOCK_PRINT_PREVIEW ##### -->
535 <para>
536 The "Print Preview" item.
537 <inlinegraphic fileref="stock_print_preview_24.png" format="PNG"></inlinegraphic>
538 </para>
539
540
541
542 <!-- ##### MACRO GTK_STOCK_PROPERTIES ##### -->
543 <para>
544 The "Properties" item.
545 <inlinegraphic fileref="stock_properties_24.png" format="PNG"></inlinegraphic>
546 </para>
547
548
549
550 <!-- ##### MACRO GTK_STOCK_QUIT ##### -->
551 <para>
552 The "Quit" item.
553 <inlinegraphic fileref="stock_exit_24.png" format="PNG"></inlinegraphic>
554 </para>
555
556
557
558 <!-- ##### MACRO GTK_STOCK_REDO ##### -->
559 <para>
560 The "Redo" item.
561 <inlinegraphic fileref="stock_redo_24.png" format="PNG"></inlinegraphic>
562 RTL variant
563 <inlinegraphic fileref="stock_redo_rtl_24.png" format="PNG"></inlinegraphic>
564 </para>
565
566
567
568 <!-- ##### MACRO GTK_STOCK_REFRESH ##### -->
569 <para>
570 The "Refresh" item.
571 <inlinegraphic fileref="stock_refresh_24.png" format="PNG"></inlinegraphic>
572 </para>
573
574
575
576 <!-- ##### MACRO GTK_STOCK_REMOVE ##### -->
577 <para>
578 The "Remove" item.
579 <inlinegraphic fileref="stock_remove_24.png" format="PNG"></inlinegraphic>
580 </para>
581
582
583
584 <!-- ##### MACRO GTK_STOCK_REVERT_TO_SAVED ##### -->
585 <para>
586 The "Revert" item.
587 <inlinegraphic fileref="stock_revert_24.png" format="PNG"></inlinegraphic>
588 RTL variant
589 <inlinegraphic fileref="stock_revert_rtl_24.png" format="PNG"></inlinegraphic>
590 </para>
591
592
593
594 <!-- ##### MACRO GTK_STOCK_SAVE ##### -->
595 <para>
596 The "Save" item.
597 <inlinegraphic fileref="stock_save_24.png" format="PNG"></inlinegraphic>
598 </para>
599
600
601
602 <!-- ##### MACRO GTK_STOCK_SAVE_AS ##### -->
603 <para>
604 The "Save As" item.
605 <inlinegraphic fileref="stock_save_as_24.png" format="PNG"></inlinegraphic>
606 </para>
607
608
609
610 <!-- ##### MACRO GTK_STOCK_SELECT_COLOR ##### -->
611 <para>
612 The "Color" item.
613 <inlinegraphic fileref="stock_colorselector_24.png" format="PNG"></inlinegraphic>
614 </para>
615
616
617
618 <!-- ##### MACRO GTK_STOCK_SELECT_FONT ##### -->
619 <para>
620 The "Font" item.
621 <inlinegraphic fileref="stock_font_24.png" format="PNG"></inlinegraphic>
622 </para>
623
624
625
626 <!-- ##### MACRO GTK_STOCK_SORT_ASCENDING ##### -->
627 <para>
628 The "Ascending" item.
629 <inlinegraphic fileref="stock_sort_ascending_24.png" format="PNG"></inlinegraphic>
630 </para>
631
632
633
634 <!-- ##### MACRO GTK_STOCK_SORT_DESCENDING ##### -->
635 <para>
636 The "Descending" item.
637 <inlinegraphic fileref="stock_sort_descending_24.png" format="PNG"></inlinegraphic>
638 </para>
639
640
641
642 <!-- ##### MACRO GTK_STOCK_SPELL_CHECK ##### -->
643 <para>
644 The "Spell Check" item.
645 <inlinegraphic fileref="stock_spellcheck_24.png" format="PNG"></inlinegraphic>
646 </para>
647
648
649
650 <!-- ##### MACRO GTK_STOCK_STOP ##### -->
651 <para>
652 The "Stop" item.
653 <inlinegraphic fileref="stock_stop_24.png" format="PNG"></inlinegraphic>
654 </para>
655
656
657
658 <!-- ##### MACRO GTK_STOCK_STRIKETHROUGH ##### -->
659 <para>
660 The "Strikethrough" item.
661 <inlinegraphic fileref="stock_text_strikethrough_24.png" format="PNG"></inlinegraphic>
662 </para>
663
664
665
666 <!-- ##### MACRO GTK_STOCK_UNDELETE ##### -->
667 <para>
668 The "Undelete" item.
669 <inlinegraphic fileref="stock_undelete_24.png" format="PNG"></inlinegraphic>
670 RTL variant
671 <inlinegraphic fileref="stock_undelete_rtl_24.png" format="PNG"></inlinegraphic>
672 </para>
673
674
675
676 <!-- ##### MACRO GTK_STOCK_UNDERLINE ##### -->
677 <para>
678 The "Underline" item.
679 <inlinegraphic fileref="stock_text_underline_24.png" format="PNG"></inlinegraphic>
680 </para>
681
682
683
684 <!-- ##### MACRO GTK_STOCK_UNDO ##### -->
685 <para>
686 The "Undo" item.
687 <inlinegraphic fileref="stock_undo_24.png" format="PNG"></inlinegraphic>
688 RTL variant
689 <inlinegraphic fileref="stock_undo_rtl_24.png" format="PNG"></inlinegraphic>
690 </para>
691
692
693
694 <!-- ##### MACRO GTK_STOCK_UNINDENT ##### -->
695 <para>
696
697 </para>
698
699
700
701 <!-- ##### MACRO GTK_STOCK_YES ##### -->
702 <para>
703 The "Yes" item.
704 <inlinegraphic fileref="stock_yes_20.png" format="PNG"></inlinegraphic>
705 </para>
706
707
708
709 <!-- ##### MACRO GTK_STOCK_ZOOM_100 ##### -->
710 <para>
711 The "Zoom 100%" item.
712 <inlinegraphic fileref="stock_zoom_1_24.png" format="PNG"></inlinegraphic>
713 </para>
714
715
716
717 <!-- ##### MACRO GTK_STOCK_ZOOM_FIT ##### -->
718 <para>
719 The "Zoom to Fit" item.
720 <inlinegraphic fileref="stock_zoom_fit_24.png" format="PNG"></inlinegraphic>
721 </para>
722
723
724
725 <!-- ##### MACRO GTK_STOCK_ZOOM_IN ##### -->
726 <para>
727 The "Zoom In" item.
728 <inlinegraphic fileref="stock_zoom_in_24.png" format="PNG"></inlinegraphic>
729 </para>
730
731
732
733 <!-- ##### MACRO GTK_STOCK_ZOOM_OUT ##### -->
734 <para>
735 The "Zoom Out" item.
736 <inlinegraphic fileref="stock_zoom_out_24.png" format="PNG"></inlinegraphic>
737 </para>
738
739
740