File: gtk-stock-items.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
links: PTS
area: main
in suites: sarge
size: 8,304 kB
ctags: 3,741
sloc: makefile: 38
file content (28 lines) | stat: -rw-r--r-- 20,247 bytes
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Stock Items</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="previous" href="gtk-functions.html" title="gtk Functions"><link rel="next" href="gtk-constants.html" title="gtk Constants"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Stock Items</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gtk-functions.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="gtk-constants.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="gtk-stock-items"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Stock Items</h2><p>Stock Items &#8212; prebuilt common menu/toolbar items and corresponding
icons</p></div><div class="refsect1" lang="en"><a name="id3667150"></a><h2>Synopsis</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
<span class="bold"><b>Functions</b></span>

<code class="methodsynopsis">    def <span class="methodname"><a href="gtk-stock-items.html#function-gtk--stock-add" title="gtk.stock_add">gtk.stock_add</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>items</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="gtk-stock-items.html#function-gtk--stock-lookup" title="gtk.stock_lookup">gtk.stock_lookup</a></span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>stock_id</tt></i></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="gtk-stock-items.html#function-gtk--stock-list-ids" title="gtk.stock_list_ids">gtk.stock_list_ids</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt></tt></b></span></span>)</code></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3667221"></a><h2>Description</h2><p>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 <tt class="literal">gtk.STOCK_OPEN</tt> are
provided to avoid typing mistakes in the strings. Applications can register
their own stock items in addition to those built-in to
<tt class="literal">PyGTK</tt>.</p><p>The stock items are:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.STOCK_ABOUT</tt></span></td><td><img src="icons/stock_about_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_ADD</tt></span></td><td><img src="icons/stock_add_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_APPLY</tt></span></td><td><img src="icons/stock_apply_20.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_BOLD</tt></span></td><td><img src="icons/stock_text_bold_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_CANCEL</tt></span></td><td><img src="icons/stock_cancel_20.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_CDROM</tt></span></td><td><img src="icons/stock_cdrom_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_CLEAR</tt></span></td><td><img src="icons/stock_clear_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_CLOSE</tt></span></td><td><img src="icons/stock_close_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_COLOR_PICKER</tt></span></td><td><img src="icons/stock_color_picker_25.png"> Available in GTK+ 2.2 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_CONVERT</tt></span></td><td><img src="icons/stock_convert_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_CONNECT</tt></span></td><td><img src="icons/stock_connect_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_COPY</tt></span></td><td><img src="icons/stock_copy_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_CUT</tt></span></td><td><img src="icons/stock_cut_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DELETE</tt></span></td><td><img src="icons/stock_trash_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DIALOG_AUTHENTICATION</tt></span></td><td><img src="icons/stock_dialog_authentication_48.png"> Available in GTK+ 2.4 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DIALOG_ERROR</tt></span></td><td><img src="icons/stock_dialog_error_48.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DIALOG_INFO</tt></span></td><td><img src="icons/stock_dialog_info_48.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DIALOG_QUESTION</tt></span></td><td><img src="icons/stock_dialog_question_48.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DIALOG_WARNING</tt></span></td><td><img src="icons/stock_dialog_warning_48.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DIRECTORY</tt></span></td><td><img src="icons/stock_directory_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DND</tt></span></td><td><img src="icons/stock_dnd_32.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_DND_MULTIPLE</tt></span></td><td><img src="icons/stock_dnd_multiple_32.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_EDIT</tt></span></td><td><img src="icons/stock_edit_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_EXECUTE</tt></span></td><td><img src="icons/stock_exec_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_FILE</tt></span></td><td><img src="icons/stock_file_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_FIND</tt></span></td><td><img src="icons/stock_search_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_FIND_AND_REPLACE</tt></span></td><td><img src="icons/stock_search_replace_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_FLOPPY</tt></span></td><td><img src="icons/stock_save_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_GOTO_BOTTOM</tt></span></td><td><img src="icons/stock_bottom_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_GOTO_FIRST</tt></span></td><td><img src="icons/stock_first_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_GOTO_LAST</tt></span></td><td><img src="icons/stock_last_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_GOTO_TOP</tt></span></td><td><img src="icons/stock_top_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_GO_BACK</tt></span></td><td><img src="icons/stock_left_arrow_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_GO_DOWN</tt></span></td><td><img src="icons/stock_down_arrow_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_GO_FORWARD</tt></span></td><td><img src="icons/stock_right_arrow_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_GO_UP</tt></span></td><td><img src="icons/stock_up_arrow_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_HARDDISK</tt></span></td><td><img src="icons/stock_harddisk_24.png"> Available in GTK+ 2.4 and above</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_HELP</tt></span></td><td><img src="icons/stock_help_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_HOME</tt></span></td><td><img src="icons/stock_home_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_INDENT</tt></span></td><td><img src="icons/stock_text_indent_24.png"> Available in GTK+ 2.4 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_INDEX</tt></span></td><td><img src="icons/stock_index_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_ITALIC</tt></span></td><td><img src="icons/stock_text_italic_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_JUMP_TO</tt></span></td><td><img src="icons/stock_jump_to_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_JUSTIFY_CENTER</tt></span></td><td><img src="icons/stock_align_center_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_JUSTIFY_FILL</tt></span></td><td><img src="icons/stock_align_justify_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_JUSTIFY_LEFT</tt></span></td><td><img src="icons/stock_align_left_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_JUSTIFY_RIGHT</tt></span></td><td><img src="icons/stock_align_right_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MEDIA_FORWARD</tt></span></td><td><img src="icons/stock_media_forward_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MEDIA_NEXT</tt></span></td><td><img src="icons/stock_media_next_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MEDIA_PAUSE</tt></span></td><td><img src="icons/stock_media_pause_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MEDIA_PLAY</tt></span></td><td><img src="icons/stock_media_play_24.png"> RTL version is <img src="icons/stock_media_play_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MEDIA_PREVIOUS</tt></span></td><td><img src="icons/stock_media_previous_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MEDIA_RECORD</tt></span></td><td><img src="icons/stock_media_record_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MEDIA_REWIND</tt></span></td><td><img src="icons/stock_media_rewind_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MEDIA_STOP</tt></span></td><td><img src="icons/stock_media_stop_24.png"> Available in GTK+ 2.6 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_MISSING_IMAGE</tt></span></td><td><img src="icons/stock_broken_image_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_NETWORK</tt></span></td><td><img src="icons/stock_network_24.png">
Available in GTK+ 2.4 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_NEW</tt></span></td><td><img src="icons/stock_new_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_NO</tt></span></td><td><img src="icons/stock_no_20.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_OK</tt></span></td><td><img src="icons/stock_ok_20.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_OPEN</tt></span></td><td><img src="icons/stock_open_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_PASTE</tt></span></td><td><img src="icons/stock_paste_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_PREFERENCES</tt></span></td><td><img src="icons/stock_preferences_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_PRINT</tt></span></td><td><img src="icons/stock_print_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_PRINT_PREVIEW</tt></span></td><td><img src="icons/stock_print_preview_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_PROPERTIES</tt></span></td><td><img src="icons/stock_properties_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_QUIT</tt></span></td><td><img src="icons/stock_exit_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_REDO</tt></span></td><td><img src="icons/stock_redo_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_REFRESH</tt></span></td><td><img src="icons/stock_refresh_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_REMOVE</tt></span></td><td><img src="icons/stock_remove_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_REVERT_TO_SAVED</tt></span></td><td><img src="icons/stock_revert_24.png"> RTL version is <img src="icons/stock_revert_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_SAVE</tt></span></td><td><img src="icons/stock_save_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_SAVE_AS</tt></span></td><td><img src="icons/stock_save_as_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_SELECT_COLOR</tt></span></td><td><img src="icons/stock_colorselector_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_SELECT_FONT</tt></span></td><td><img src="icons/stock_font_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_SORT_ASCENDING</tt></span></td><td><img src="icons/stock_sort_ascending_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_SORT_DESCENDING</tt></span></td><td><img src="icons/stock_sort_descending_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_SPELL_CHECK</tt></span></td><td><img src="icons/stock_spellcheck_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_STOP</tt></span></td><td><img src="icons/stock_stop_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_STRIKETHROUGH</tt></span></td><td><img src="icons/stock_text_strikethrough_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_UNDELETE</tt></span></td><td><img src="icons/stock_undelete_24.png"> RTL version is <img src="icons/stock_undelete_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_UNDERLINE</tt></span></td><td><img src="icons/stock_text_underline_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_UNDO</tt></span></td><td><img src="icons/stock_undo_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_UNINDENT</tt></span></td><td><img src="icons/stock_text_unindent_24.png"> Available in GTK+ 2.4 and above.</td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_YES</tt></span></td><td><img src="icons/stock_yes_20.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_ZOOM_100</tt></span></td><td><img src="icons/stock_zoom_1_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_ZOOM_FIT</tt></span></td><td><img src="icons/stock_zoom_fit_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_ZOOM_IN</tt></span></td><td><img src="icons/stock_zoom_in_24.png"></td></tr><tr><td><span class="term"><tt class="literal">gtk.STOCK_ZOOM_OUT</tt></span></td><td><img src="icons/stock_zoom_out_24.png"></td></tr></tbody></table><p></p></div><div class="refsect1" lang="en"><a name="id3669160"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--stock-add"></a><h3>gtk.stock_add</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.stock_add</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>items</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>items</tt></b>:</span></td><td>a list or tuple containing 5-tuples of stock
	  items</td></tr></tbody></table><p>The <tt class="function">gtk.stock_add</tt>() function registers each
of the stock items in the list or tuple specified by
<i class="parameter"><tt>items</tt></i>. The stock items are specified by a 5-tuple
containing:</p><div class="itemizedlist"><ul type="disc"><li>stock_id - a string identifier</li><li>label - a string to use for a label</li><li>modifier - a modifier mask (see the <a href="gdk-constants.html#gdk-modifier-constants">GDK Modifier Constants</a> section for more detail on
modifiers)</li><li>keyval - an integer key value (see <a href="class-gdkkeymap.html" title="gtk.gdk.Keymap"><tt class="classname">gtk.gdk.Keymap</tt></a>)
	  Together with the modifiers specifies an accelerator.</li><li>translation_domain - a string identifier of a translation
	  domain</li></ul></div><p>If an item already exists with the same stock ID as one of the
items, the old item gets replaced.</p></div><div class="refsect2" lang="en"><a name="function-gtk--stock-lookup"></a><h3>gtk.stock_lookup</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.stock_lookup</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>stock_id</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>stock_id</tt></i>:</span></td><td>a stock item name</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a 5-tuple containing the stock item info or
	  <tt class="literal">None</tt> if <i class="parameter"><tt>stock_id</tt></i> is
	  unknown</td></tr></tbody></table><p>The <tt class="function">gtk.stock_lookup</tt>() function looks up
the stock item identified by <i class="parameter"><tt>stock_id</tt></i> and returns a
5-tuple containing its information. If <i class="parameter"><tt>stock_id</tt></i> is
not known this function returns <tt class="literal">None</tt>. See the <a href="gtk-stock-items.html#function-gtk--stock-add" title="gtk.stock_add"><tt class="function">gtk.stock_add</tt>()</a>
function for more detail.</p></div><div class="refsect2" lang="en"><a name="function-gtk--stock-list-ids"></a><h3>gtk.stock_list_ids</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.stock_list_ids</span>()</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a list of known stock IDs</td></tr></tbody></table><p>The <tt class="function">gtk.stock_list_ids</tt>() function returns a
list containing all of the known stock IDs added to a <a href="class-gtkiconfactory.html" title="gtk.IconFactory"><tt class="classname">gtk.IconFactory</tt></a>
or registered with the <a href="gtk-stock-items.html#function-gtk--stock-add" title="gtk.stock_add"><tt class="function">gtk.stock_add</tt>()</a>
function.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gtk-functions.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="gtk-constants.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk Functions</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk Constants</td></tr></table></div></body></html>