gtk2/docs/reference/gtk/tmpl/gtkstock.sgml

658 lines
12 KiB
Plaintext
Raw Normal View History

<!-- ##### SECTION Title ##### -->
Stock Items
<!-- ##### SECTION Short_Description ##### -->
Prebuilt common menu/toolbar items and corresponding icons
<!-- ##### SECTION Long_Description ##### -->
<para>
Stock items represent commonly-used menu or toolbar items such as
"Open" or "Exit". Each stock item is identified by a stock ID;
stock IDs are just strings, but macros such as #GTK_STOCK_OPEN are
provided to avoid typing mistakes in the strings.
Applications can register their own stock items in addition to those
built-in to GTK+.
</para>
<para>
Each stock ID can be associated with a #GtkStockItem, which contains
the user-visible label, keyboard accelerator, and translation domain
of the menu or toolbar item; and/or with an icon stored in a
#GtkIconFactory. See <link
linkend="gtk-Themeable-Stock-Images">GtkIconFactory</link> for
more information on stock icons. The connection between a
#GtkStockItem and stock icons is purely conventional (by virtue of
using the same stock ID); it's possible to register a stock item but
no icon, and vice versa.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkStockItem ##### -->
<para>
</para>
@stock_id:
@label:
@modifier:
@keyval:
@translation_domain:
<!-- ##### FUNCTION gtk_stock_add ##### -->
<para>
</para>
@items:
@n_items:
<!-- ##### FUNCTION gtk_stock_add_static ##### -->
<para>
</para>
@items:
@n_items:
<!-- ##### FUNCTION gtk_stock_item_copy ##### -->
<para>
</para>
@item:
@Returns:
<!-- ##### FUNCTION gtk_stock_item_free ##### -->
<para>
</para>
@item:
<!-- ##### FUNCTION gtk_stock_list_ids ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_stock_lookup ##### -->
<para>
</para>
@stock_id:
@item:
@Returns:
<!-- ##### MACRO GTK_STOCK_ADD ##### -->
<para>
The "Add" item.
<inlinegraphic fileref="stock_add.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_APPLY ##### -->
<para>
The "Apply" item.
<inlinegraphic fileref="stock_button_apply.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_BOLD ##### -->
<para>
The "Bold" item.
<inlinegraphic fileref="stock_text_bold.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CANCEL ##### -->
<para>
The "Cancel" item.
<inlinegraphic fileref="stock_button_cancel.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CDROM ##### -->
<para>
The "CD-Rom" item.
<inlinegraphic fileref="stock_cdrom.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CLEAR ##### -->
<para>
The "Clear" item.
<inlinegraphic fileref="stock_clear.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CLOSE ##### -->
<para>
The "Close" item.
<inlinegraphic fileref="stock_close.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CONVERT ##### -->
<para>
The "Convert" item.
<inlinegraphic fileref="stock_convert.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_COPY ##### -->
<para>
The "Copy" item.
<inlinegraphic fileref="stock_menu_copy.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CUT ##### -->
<para>
The "Cut" item.
<inlinegraphic fileref="stock_menu_cut.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DELETE ##### -->
<para>
The "Delete" item.
<inlinegraphic fileref="stock_menu_trash.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIALOG_ERROR ##### -->
<para>
The "Error" item.
<inlinegraphic fileref="dialog_error.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIALOG_INFO ##### -->
<para>
The "Information" item.
<inlinegraphic fileref="dialog_info.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIALOG_QUESTION ##### -->
<para>
The "Question" item.
<inlinegraphic fileref="dialog_question.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIALOG_WARNING ##### -->
<para>
The "Warning" item.
<inlinegraphic fileref="dialog_warning.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DND ##### -->
<para>
The "Drag-And-Drop" icon.
<inlinegraphic fileref="stock_dnd.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DND_MULTIPLE ##### -->
<para>
The "Drag-And-Drop multiple" icon.
<inlinegraphic fileref="stock_dnd_multiple.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_EXECUTE ##### -->
<para>
The "Execute" item.
<inlinegraphic fileref="stock_exec.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_FIND ##### -->
<para>
The "Find" item.
<inlinegraphic fileref="stock_search.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_FIND_AND_REPLACE ##### -->
<para>
The "Find and Replace" item.
<inlinegraphic fileref="stock_search_replace.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_FLOPPY ##### -->
<para>
The "Floppy" item.
<inlinegraphic fileref="stock_save.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GOTO_BOTTOM ##### -->
<para>
The "Bottom" item.
<inlinegraphic fileref="stock_bottom.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GOTO_FIRST ##### -->
<para>
The "First" item.
<inlinegraphic fileref="stock_first.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GOTO_LAST ##### -->
<para>
The "Last" item.
<inlinegraphic fileref="stock_last.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GOTO_TOP ##### -->
<para>
The "Top" item.
<inlinegraphic fileref="stock_top.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GO_BACK ##### -->
<para>
The "Back" item.
<inlinegraphic fileref="stock_left_arrow.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GO_DOWN ##### -->
<para>
The "Down" item.
<inlinegraphic fileref="stock_down_arrow.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GO_FORWARD ##### -->
<para>
The "Forward" item.
<inlinegraphic fileref="stock_right_arrow.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GO_UP ##### -->
<para>
The "Up" item.
<inlinegraphic fileref="stock_up_arrow.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_HELP ##### -->
<para>
The "Help" item.
<inlinegraphic fileref="stock_help.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_HOME ##### -->
<para>
The "Home" item.
<inlinegraphic fileref="stock_home.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_INDEX ##### -->
<para>
The "Index" item.
<inlinegraphic fileref="stock_index.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ITALIC ##### -->
<para>
The "Italic" item.
<inlinegraphic fileref="stock_text_italic.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUMP_TO ##### -->
<para>
The "Jump to" item.
<inlinegraphic fileref="stock_jump_to.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUSTIFY_CENTER ##### -->
<para>
The "Center" item.
<inlinegraphic fileref="stock_align_center.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUSTIFY_FILL ##### -->
<para>
The "Fill" item.
<inlinegraphic fileref="stock_align_justify.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUSTIFY_LEFT ##### -->
<para>
The "Left" item.
<inlinegraphic fileref="stock_align_left.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUSTIFY_RIGHT ##### -->
<para>
The "Right" item.
<inlinegraphic fileref="stock_align_right.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_MISSING_IMAGE ##### -->
<para>
The "Missing image" icon.
<inlinegraphic fileref="dialog_error.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_NEW ##### -->
<para>
The "New" item.
<inlinegraphic fileref="stock_new.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_NO ##### -->
<para>
The "No" item.
<inlinegraphic fileref="stock_button_no.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_OK ##### -->
<para>
The "OK" item.
<inlinegraphic fileref="stock_button_ok.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_OPEN ##### -->
<para>
The "Open" item.
<inlinegraphic fileref="stock_open.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PASTE ##### -->
<para>
The "Paste" item.
<inlinegraphic fileref="stock_paste.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PREFERENCES ##### -->
<para>
The "Preferences" item.
<inlinegraphic fileref="stock_preferences.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PRINT ##### -->
<para>
The "Print" item.
<inlinegraphic fileref="stock_print.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PRINT_PREVIEW ##### -->
<para>
The "Print Preview" item.
<inlinegraphic fileref="stock_print_preview.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PROPERTIES ##### -->
<para>
The "Properties" item.
<inlinegraphic fileref="stock_properties.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_QUIT ##### -->
<para>
The "Quit" item.
<inlinegraphic fileref="stock_exit.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_REDO ##### -->
<para>
The "Redo" item.
<inlinegraphic fileref="stock_redo.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_REFRESH ##### -->
<para>
The "Refresh" item.
<inlinegraphic fileref="stock_refresh.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_REMOVE ##### -->
<para>
The "Remove" item.
<inlinegraphic fileref="stock_remove.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_REVERT_TO_SAVED ##### -->
<para>
The "Revert" item.
<inlinegraphic fileref="stock_revert.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SAVE ##### -->
<para>
The "Save" item.
<inlinegraphic fileref="stock_save.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SAVE_AS ##### -->
<para>
The "Save As" item.
<inlinegraphic fileref="stock_save_as.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SELECT_COLOR ##### -->
<para>
The "Color" item.
<inlinegraphic fileref="stock_colorselector.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SELECT_FONT ##### -->
<para>
The "Font" item.
<inlinegraphic fileref="stock_font.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SORT_ASCENDING ##### -->
<para>
The "Ascending" item.
<inlinegraphic fileref="stock_sort_ascending.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SORT_DESCENDING ##### -->
<para>
The "Descending" item.
<inlinegraphic fileref="stock_sort_descending.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SPELL_CHECK ##### -->
<para>
The "Spell Check" item.
<inlinegraphic fileref="stock_spellcheck.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_STOP ##### -->
<para>
The "Stop" item.
<inlinegraphic fileref="stock_stop.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_STRIKETHROUGH ##### -->
<para>
The "Strikethrough" item.
<inlinegraphic fileref="stock_text_strikeout.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_UNDELETE ##### -->
<para>
The "Undelete" item.
<inlinegraphic fileref="stock_undelete.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_UNDERLINE ##### -->
<para>
The "Underline" item.
<inlinegraphic fileref="stock_text_underline.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_UNDO ##### -->
<para>
The "Undo" item.
<inlinegraphic fileref="stock_undo.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_YES ##### -->
<para>
The "Yes" item.
<inlinegraphic fileref="stock_button_yes.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ZOOM_100 ##### -->
<para>
The "Zoom 100%" item.
<inlinegraphic fileref="stock_zoom_1.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ZOOM_FIT ##### -->
<para>
The "Zoom to Fit" item.
<inlinegraphic fileref="stock_zoom_fit.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ZOOM_IN ##### -->
<para>
The "Zoom In" item.
<inlinegraphic fileref="stock_zoom_in.png" format="png"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ZOOM_OUT ##### -->
<para>
The "Zoom Out" item.
<inlinegraphic fileref="stock_zoom_out.png" format="png"></inlinegraphic>
</para>