gtk2/docs/reference/gtk/tmpl/gtkstock.sgml
Matthias Clasen 9b039be2d4 Typo fix.
2004-11-04  Matthias Clasen  <mclasen@redhat.com>

	* gtk/stock-icons/Makefile.am: Typo fix.

	* gtk/tmpl/gtkstock.sgml: Fix markup.

	* gtk/gtk-docs.sgml:
	* gtk/migrating-GtkAboutDialog.sgml: Add a first version
	of a GnomeAbout --> GtkAboutDialog migration chapter.
2004-11-04 15:23:33 +00:00

869 lines
18 KiB
Plaintext

<!-- ##### 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. Stock icons may have a RTL variant which gets
used for right-to-left locales.
</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_ABOUT ##### -->
<para>
The "About" item.
<inlinegraphic fileref="stock_about_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_ADD ##### -->
<para>
The "Add" item.
<inlinegraphic fileref="stock_add_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_APPLY ##### -->
<para>
The "Apply" item.
<inlinegraphic fileref="stock_apply_20.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_BOLD ##### -->
<para>
The "Bold" item.
<inlinegraphic fileref="stock_text_bold_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CANCEL ##### -->
<para>
The "Cancel" item.
<inlinegraphic fileref="stock_cancel_20.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CDROM ##### -->
<para>
The "CD-Rom" item.
<inlinegraphic fileref="stock_cdrom_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CLEAR ##### -->
<para>
The "Clear" item.
<inlinegraphic fileref="stock_clear_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CLOSE ##### -->
<para>
The "Close" item.
<inlinegraphic fileref="stock_close_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_COLOR_PICKER ##### -->
<para>
The "Color Picker" item.
<inlinegraphic fileref="stock_color_picker_25.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.2
<!-- ##### MACRO GTK_STOCK_CONVERT ##### -->
<para>
The "Convert" item.
<inlinegraphic fileref="stock_convert_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CONNECT ##### -->
<para>
The "Connect" icon.
<inlinegraphic fileref="stock_connect_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_COPY ##### -->
<para>
The "Copy" item.
<inlinegraphic fileref="stock_copy_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_CUT ##### -->
<para>
The "Cut" item.
<inlinegraphic fileref="stock_cut_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DELETE ##### -->
<para>
The "Delete" item.
<inlinegraphic fileref="stock_trash_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIALOG_AUTHENTICATION ##### -->
<para>
The "Authentication" item.
<inlinegraphic fileref="stock_dialog_authentication_48.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.4
<!-- ##### MACRO GTK_STOCK_DIALOG_ERROR ##### -->
<para>
The "Error" item.
<inlinegraphic fileref="stock_dialog_error_48.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIALOG_INFO ##### -->
<para>
The "Information" item.
<inlinegraphic fileref="stock_dialog_info_48.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIALOG_QUESTION ##### -->
<para>
The "Question" item.
<inlinegraphic fileref="stock_dialog_question_48.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIALOG_WARNING ##### -->
<para>
The "Warning" item.
<inlinegraphic fileref="stock_dialog_warning_48.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DIRECTORY ##### -->
<para>
The "Directory" icon.
<inlinegraphic fileref="stock_directory_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_DISCONNECT ##### -->
<para>
The "Disconnect" icon.
<inlinegraphic fileref="stock_disconnect_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_DND ##### -->
<para>
The "Drag-And-Drop" icon.
<inlinegraphic fileref="stock_dnd_32.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_DND_MULTIPLE ##### -->
<para>
The "Drag-And-Drop multiple" icon.
<inlinegraphic fileref="stock_dnd_multiple_32.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_EDIT ##### -->
<para>
The "Edit" item.
<inlinegraphic fileref="stock_edit_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_EXECUTE ##### -->
<para>
The "Execute" item.
<inlinegraphic fileref="stock_exec_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_FILE ##### -->
<para>
<para>
The "File" icon.
<inlinegraphic fileref="stock_file_24.png" format="PNG"></inlinegraphic>
</para>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_FIND ##### -->
<para>
The "Find" item.
<inlinegraphic fileref="stock_search_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_FIND_AND_REPLACE ##### -->
<para>
The "Find and Replace" item.
<inlinegraphic fileref="stock_search_replace_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_FLOPPY ##### -->
<para>
The "Floppy" item.
<inlinegraphic fileref="stock_save_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GOTO_BOTTOM ##### -->
<para>
The "Bottom" item.
<inlinegraphic fileref="stock_bottom_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GOTO_FIRST ##### -->
<para>
The "First" item.
<inlinegraphic fileref="stock_first_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_last_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GOTO_LAST ##### -->
<para>
The "Last" item.
<inlinegraphic fileref="stock_last_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_first_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GOTO_TOP ##### -->
<para>
The "Top" item.
<inlinegraphic fileref="stock_top_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GO_BACK ##### -->
<para>
The "Back" item.
<inlinegraphic fileref="stock_left_arrow_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_right_arrow_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GO_DOWN ##### -->
<para>
The "Down" item.
<inlinegraphic fileref="stock_down_arrow_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GO_FORWARD ##### -->
<para>
The "Forward" item.
<inlinegraphic fileref="stock_right_arrow_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_left_arrow_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_GO_UP ##### -->
<para>
The "Up" item.
<inlinegraphic fileref="stock_up_arrow_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_HARDDISK ##### -->
<para>
The "Harddisk" item.
<inlinegraphic fileref="stock_harddisk_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.4
<!-- ##### MACRO GTK_STOCK_HELP ##### -->
<para>
The "Help" item.
<inlinegraphic fileref="stock_help_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_HOME ##### -->
<para>
The "Home" item.
<inlinegraphic fileref="stock_home_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_INDENT ##### -->
<para>
The "Indent" item.
<inlinegraphic fileref="stock_indent_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.4
<!-- ##### MACRO GTK_STOCK_INDEX ##### -->
<para>
The "Index" item.
<inlinegraphic fileref="stock_index_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ITALIC ##### -->
<para>
The "Italic" item.
<inlinegraphic fileref="stock_text_italic_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUMP_TO ##### -->
<para>
The "Jump to" item.
<inlinegraphic fileref="stock_jump_to_24.png" format="PNG"></inlinegraphic>
RTL-variant
<inlinegraphic fileref="stock_jump_to_rtl_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUSTIFY_CENTER ##### -->
<para>
The "Center" item.
<inlinegraphic fileref="stock_align_center_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUSTIFY_FILL ##### -->
<para>
The "Fill" item.
<inlinegraphic fileref="stock_align_justify_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUSTIFY_LEFT ##### -->
<para>
The "Left" item.
<inlinegraphic fileref="stock_align_left_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_JUSTIFY_RIGHT ##### -->
<para>
The "Right" item.
<inlinegraphic fileref="stock_align_right_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_MEDIA_FORWARD ##### -->
<para>
The "Media Forward" item.
<inlinegraphic fileref="stock_media_forward_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_media_rewind_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_MEDIA_NEXT ##### -->
<para>
The "Media Next" item.
<inlinegraphic fileref="stock_media_next_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_media_previous_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_MEDIA_PAUSE ##### -->
<para>
The "Media Pause" item.
<inlinegraphic fileref="stock_media_pause_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_MEDIA_PLAY ##### -->
<para>
The "Media Play" item.
<inlinegraphic fileref="stock_media_play_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_media_play_rtl_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_MEDIA_PREVIOUS ##### -->
<para>
The "Media Previous" item.
<inlinegraphic fileref="stock_media_previous_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_media_next_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_MEDIA_RECORD ##### -->
<para>
The "Media Record" item.
<inlinegraphic fileref="stock_media_record_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_MEDIA_REWIND ##### -->
<para>
The "Media Rewind" item.
<inlinegraphic fileref="stock_media_rewind_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_media_forward_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_MEDIA_STOP ##### -->
<para>
The "Media Stop" item.
<inlinegraphic fileref="stock_media_stop_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.6
<!-- ##### MACRO GTK_STOCK_MISSING_IMAGE ##### -->
<para>
The "Missing image" icon.
<inlinegraphic fileref="stock_broken_image_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_NETWORK ##### -->
<para>
The "Network" item.
<inlinegraphic fileref="stock_network_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.4
<!-- ##### MACRO GTK_STOCK_NEW ##### -->
<para>
The "New" item.
<inlinegraphic fileref="stock_new_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_NO ##### -->
<para>
The "No" item.
<inlinegraphic fileref="stock_no_20.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_OK ##### -->
<para>
The "OK" item.
<inlinegraphic fileref="stock_ok_20.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_OPEN ##### -->
<para>
The "Open" item.
<inlinegraphic fileref="stock_open_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PASTE ##### -->
<para>
The "Paste" item.
<inlinegraphic fileref="stock_paste_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PREFERENCES ##### -->
<para>
The "Preferences" item.
<inlinegraphic fileref="stock_preferences_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PRINT ##### -->
<para>
The "Print" item.
<inlinegraphic fileref="stock_print_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PRINT_PREVIEW ##### -->
<para>
The "Print Preview" item.
<inlinegraphic fileref="stock_print_preview_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_PROPERTIES ##### -->
<para>
The "Properties" item.
<inlinegraphic fileref="stock_properties_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_QUIT ##### -->
<para>
The "Quit" item.
<inlinegraphic fileref="stock_exit_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_REDO ##### -->
<para>
The "Redo" item.
<inlinegraphic fileref="stock_redo_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_redo_rtl_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_REFRESH ##### -->
<para>
The "Refresh" item.
<inlinegraphic fileref="stock_refresh_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_REMOVE ##### -->
<para>
The "Remove" item.
<inlinegraphic fileref="stock_remove_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_REVERT_TO_SAVED ##### -->
<para>
The "Revert" item.
<inlinegraphic fileref="stock_revert_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_revert_rtl_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SAVE ##### -->
<para>
The "Save" item.
<inlinegraphic fileref="stock_save_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SAVE_AS ##### -->
<para>
The "Save As" item.
<inlinegraphic fileref="stock_save_as_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SELECT_COLOR ##### -->
<para>
The "Color" item.
<inlinegraphic fileref="stock_colorselector_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SELECT_FONT ##### -->
<para>
The "Font" item.
<inlinegraphic fileref="stock_font_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SORT_ASCENDING ##### -->
<para>
The "Ascending" item.
<inlinegraphic fileref="stock_sort_ascending_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SORT_DESCENDING ##### -->
<para>
The "Descending" item.
<inlinegraphic fileref="stock_sort_descending_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_SPELL_CHECK ##### -->
<para>
The "Spell Check" item.
<inlinegraphic fileref="stock_spellcheck_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_STOP ##### -->
<para>
The "Stop" item.
<inlinegraphic fileref="stock_stop_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_STRIKETHROUGH ##### -->
<para>
The "Strikethrough" item.
<inlinegraphic fileref="stock_text_strikethrough_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_UNDELETE ##### -->
<para>
The "Undelete" item.
<inlinegraphic fileref="stock_undelete_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_undelete_rtl_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_UNDERLINE ##### -->
<para>
The "Underline" item.
<inlinegraphic fileref="stock_text_underline_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_UNDO ##### -->
<para>
The "Undo" item.
<inlinegraphic fileref="stock_undo_24.png" format="PNG"></inlinegraphic>
RTL variant
<inlinegraphic fileref="stock_undo_rtl_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_UNINDENT ##### -->
<para>
The "Unindent" item.
<inlinegraphic fileref="stock_unindent_24.png" format="PNG"></inlinegraphic>
</para>
@Since: 2.4
<!-- ##### MACRO GTK_STOCK_YES ##### -->
<para>
The "Yes" item.
<inlinegraphic fileref="stock_yes_20.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ZOOM_100 ##### -->
<para>
The "Zoom 100%" item.
<inlinegraphic fileref="stock_zoom_1_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ZOOM_FIT ##### -->
<para>
The "Zoom to Fit" item.
<inlinegraphic fileref="stock_zoom_fit_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ZOOM_IN ##### -->
<para>
The "Zoom In" item.
<inlinegraphic fileref="stock_zoom_in_24.png" format="PNG"></inlinegraphic>
</para>
<!-- ##### MACRO GTK_STOCK_ZOOM_OUT ##### -->
<para>
The "Zoom Out" item.
<inlinegraphic fileref="stock_zoom_out_24.png" format="PNG"></inlinegraphic>
</para>