<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>GtkImageMenuItem: GTK+ 2 Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="GTK+ 2 Reference Manual"> <link rel="up" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar"> <link rel="prev" href="GtkMenuItem.html" title="GtkMenuItem"> <link rel="next" href="GtkRadioMenuItem.html" title="GtkRadioMenuItem"> <meta name="generator" content="GTK-Doc V1.24.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> <a href="#GtkImageMenuItem.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> <a href="#GtkImageMenuItem.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> <a href="#GtkImageMenuItem.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> <a href="#GtkImageMenuItem.properties" class="shortcut">Properties</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="MenusAndCombos.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="GtkMenuItem.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="GtkRadioMenuItem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="GtkImageMenuItem"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="GtkImageMenuItem.top_of_page"></a>GtkImageMenuItem</span></h2> <p>GtkImageMenuItem — A menu item with an icon</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="GtkImageMenuItem.functions"></a><h2>Functions</h2> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="functions_return"> <col class="functions_name"> </colgroup> <tbody> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-set-image" title="gtk_image_menu_item_set_image ()">gtk_image_menu_item_set_image</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-get-image" title="gtk_image_menu_item_get_image ()">gtk_image_menu_item_get_image</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-new" title="gtk_image_menu_item_new ()">gtk_image_menu_item_new</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-new-from-stock" title="gtk_image_menu_item_new_from_stock ()">gtk_image_menu_item_new_from_stock</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-new-with-label" title="gtk_image_menu_item_new_with_label ()">gtk_image_menu_item_new_with_label</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-new-with-mnemonic" title="gtk_image_menu_item_new_with_mnemonic ()">gtk_image_menu_item_new_with_mnemonic</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-get-use-stock" title="gtk_image_menu_item_get_use_stock ()">gtk_image_menu_item_get_use_stock</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-set-use-stock" title="gtk_image_menu_item_set_use_stock ()">gtk_image_menu_item_set_use_stock</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-get-always-show-image" title="gtk_image_menu_item_get_always_show_image ()">gtk_image_menu_item_get_always_show_image</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-set-always-show-image" title="gtk_image_menu_item_set_always_show_image ()">gtk_image_menu_item_set_always_show_image</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">void</span> </td> <td class="function_name"> <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-set-accel-group" title="gtk_image_menu_item_set_accel_group ()">gtk_image_menu_item_set_accel_group</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="GtkImageMenuItem.properties"></a><h2>Properties</h2> <div class="informaltable"><table border="0"> <colgroup> <col width="150px" class="properties_type"> <col width="300px" class="properties_name"> <col width="200px" class="properties_flags"> </colgroup> <tbody> <tr> <td class="property_type"> <a class="link" href="gtk2-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a> *</td> <td class="property_name"><a class="link" href="GtkImageMenuItem.html#GtkImageMenuItem--accel-group" title="The “accel-group” property">accel-group</a></td> <td class="property_flags">Write</td> </tr> <tr> <td class="property_type"><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> <td class="property_name"><a class="link" href="GtkImageMenuItem.html#GtkImageMenuItem--always-show-image" title="The “always-show-image” property">always-show-image</a></td> <td class="property_flags">Read / Write / Construct</td> </tr> <tr> <td class="property_type"> <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *</td> <td class="property_name"><a class="link" href="GtkImageMenuItem.html#GtkImageMenuItem--image" title="The “image” property">image</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> <td class="property_name"><a class="link" href="GtkImageMenuItem.html#GtkImageMenuItem--use-stock" title="The “use-stock” property">use-stock</a></td> <td class="property_flags">Read / Write / Construct</td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="GtkImageMenuItem.other"></a><h2>Types and Values</h2> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="name"> <col class="description"> </colgroup> <tbody><tr> <td class="datatype_keyword">struct</td> <td class="function_name"><a class="link" href="GtkImageMenuItem.html#GtkImageMenuItem-struct" title="struct GtkImageMenuItem">GtkImageMenuItem</a></td> </tr></tbody> </table></div> </div> <div class="refsect1"> <a name="GtkImageMenuItem.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="screen"> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> <span class="lineart">╰──</span> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> <span class="lineart">╰──</span> <a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a> <span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> <span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a> <span class="lineart">╰──</span> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a> <span class="lineart">╰──</span> <a class="link" href="GtkItem.html" title="GtkItem">GtkItem</a> <span class="lineart">╰──</span> <a class="link" href="GtkMenuItem.html" title="GtkMenuItem">GtkMenuItem</a> <span class="lineart">╰──</span> GtkImageMenuItem </pre> </div> <div class="refsect1"> <a name="GtkImageMenuItem.implemented-interfaces"></a><h2>Implemented Interfaces</h2> <p> GtkImageMenuItem implements AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and <a class="link" href="GtkActivatable.html" title="GtkActivatable">GtkActivatable</a>.</p> </div> <div class="refsect1"> <a name="GtkImageMenuItem.includes"></a><h2>Includes</h2> <pre class="synopsis">#include <gtk/gtk.h> </pre> </div> <div class="refsect1"> <a name="GtkImageMenuItem.description"></a><h2>Description</h2> <p> A GtkImageMenuItem is a menu item which has an icon next to the text label. </p> <p> Note that the user can disable display of menu icons, so make sure to still fill in the text label. </p> </div> <div class="refsect1"> <a name="GtkImageMenuItem.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="gtk-image-menu-item-set-image"></a><h3>gtk_image_menu_item_set_image ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> gtk_image_menu_item_set_image (<em class="parameter"><code><a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> *image_menu_item</code></em>, <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *image</code></em>);</pre> <p>Sets the image of <em class="parameter"><code>image_menu_item</code></em> to the given widget. Note that it depends on the show-menu-images setting whether the image will be displayed or not.</p> <div class="refsect3"> <a name="gtk-image-menu-item-set-image.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>image_menu_item</p></td> <td class="parameter_description"><p>a <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a>.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>image</p></td> <td class="parameter_description"><p> a widget to set as the image for the menu item. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-get-image"></a><h3>gtk_image_menu_item_get_image ()</h3> <pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_image_menu_item_get_image (<em class="parameter"><code><a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> *image_menu_item</code></em>);</pre> <p>Gets the widget that is currently set as the image of <em class="parameter"><code>image_menu_item</code></em> . See <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-set-image" title="gtk_image_menu_item_set_image ()"><code class="function">gtk_image_menu_item_set_image()</code></a>.</p> <div class="refsect3"> <a name="gtk-image-menu-item-get-image.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>image_menu_item</p></td> <td class="parameter_description"><p>a <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-image-menu-item-get-image.returns"></a><h4>Returns</h4> <p> the widget set as image of <em class="parameter"><code>image_menu_item</code></em> . </p> <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-new"></a><h3>gtk_image_menu_item_new ()</h3> <pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_image_menu_item_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> <p>Creates a new <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> with an empty label.</p> <div class="refsect3"> <a name="gtk-image-menu-item-new.returns"></a><h4>Returns</h4> <p>a new <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a>.</p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-new-from-stock"></a><h3>gtk_image_menu_item_new_from_stock ()</h3> <pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_image_menu_item_new_from_stock (<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>, <em class="parameter"><code><a class="link" href="gtk2-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a> *accel_group</code></em>);</pre> <p>Creates a new <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> containing the image and text from a stock item. Some stock ids have preprocessor macros like <a class="link" href="gtk2-Stock-Items.html#GTK-STOCK-OK:CAPS" title="GTK_STOCK_OK"><span class="type">GTK_STOCK_OK</span></a> and <a class="link" href="gtk2-Stock-Items.html#GTK-STOCK-APPLY:CAPS" title="GTK_STOCK_APPLY"><span class="type">GTK_STOCK_APPLY</span></a>.</p> <p>If you want this menu item to have changeable accelerators, then pass in <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for accel_group. Next call <a class="link" href="GtkMenuItem.html#gtk-menu-item-set-accel-path" title="gtk_menu_item_set_accel_path ()"><code class="function">gtk_menu_item_set_accel_path()</code></a> with an appropriate path for the menu item, use <a class="link" href="gtk2-Stock-Items.html#gtk-stock-lookup" title="gtk_stock_lookup ()"><code class="function">gtk_stock_lookup()</code></a> to look up the standard accelerator for the stock item, and if one is found, call <a class="link" href="gtk2-Accelerator-Maps.html#gtk-accel-map-add-entry" title="gtk_accel_map_add_entry ()"><code class="function">gtk_accel_map_add_entry()</code></a> to register it.</p> <div class="refsect3"> <a name="gtk-image-menu-item-new-from-stock.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>stock_id</p></td> <td class="parameter_description"><p>the name of the stock item.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>accel_group</p></td> <td class="parameter_description"><p> the <a class="link" href="gtk2-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a> to add the menu items accelerator to, or <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-image-menu-item-new-from-stock.returns"></a><h4>Returns</h4> <p>a new <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a>.</p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-new-with-label"></a><h3>gtk_image_menu_item_new_with_label ()</h3> <pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_image_menu_item_new_with_label (<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);</pre> <p>Creates a new <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> containing a label.</p> <div class="refsect3"> <a name="gtk-image-menu-item-new-with-label.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>label</p></td> <td class="parameter_description"><p>the text of the menu item.</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-image-menu-item-new-with-label.returns"></a><h4>Returns</h4> <p>a new <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a>.</p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-new-with-mnemonic"></a><h3>gtk_image_menu_item_new_with_mnemonic ()</h3> <pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_image_menu_item_new_with_mnemonic (<em class="parameter"><code>const <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);</pre> <p>Creates a new <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> containing a label. The label will be created using <a class="link" href="GtkLabel.html#gtk-label-new-with-mnemonic" title="gtk_label_new_with_mnemonic ()"><code class="function">gtk_label_new_with_mnemonic()</code></a>, so underscores in <em class="parameter"><code>label</code></em> indicate the mnemonic for the menu item.</p> <div class="refsect3"> <a name="gtk-image-menu-item-new-with-mnemonic.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>label</p></td> <td class="parameter_description"><p>the text of the menu item, with an underscore in front of the mnemonic character</p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-image-menu-item-new-with-mnemonic.returns"></a><h4>Returns</h4> <p>a new <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a></p> </div> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-get-use-stock"></a><h3>gtk_image_menu_item_get_use_stock ()</h3> <pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_image_menu_item_get_use_stock (<em class="parameter"><code><a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> *image_menu_item</code></em>);</pre> <p>Checks whether the label set in the menuitem is used as a stock id to select the stock item for the item.</p> <div class="refsect3"> <a name="gtk-image-menu-item-get-use-stock.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>image_menu_item</p></td> <td class="parameter_description"><p>a <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-image-menu-item-get-use-stock.returns"></a><h4>Returns</h4> <p> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the label set in the menuitem is used as a stock id to select the stock item for the item</p> </div> <p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-set-use-stock"></a><h3>gtk_image_menu_item_set_use_stock ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> gtk_image_menu_item_set_use_stock (<em class="parameter"><code><a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> *image_menu_item</code></em>, <em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_stock</code></em>);</pre> <p>If <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the label set in the menuitem is used as a stock id to select the stock item for the item.</p> <div class="refsect3"> <a name="gtk-image-menu-item-set-use-stock.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>image_menu_item</p></td> <td class="parameter_description"><p>a <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>use_stock</p></td> <td class="parameter_description"><p><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the menuitem should use a stock item</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-get-always-show-image"></a><h3>gtk_image_menu_item_get_always_show_image ()</h3> <pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_image_menu_item_get_always_show_image (<em class="parameter"><code><a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> *image_menu_item</code></em>);</pre> <p>Returns whether the menu item will ignore the <a class="link" href="GtkSettings.html#GtkSettings--gtk-menu-images" title="The “gtk-menu-images” property"><span class="type">“gtk-menu-images”</span></a> setting and always show the image, if available.</p> <div class="refsect3"> <a name="gtk-image-menu-item-get-always-show-image.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody><tr> <td class="parameter_name"><p>image_menu_item</p></td> <td class="parameter_description"><p>a <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-image-menu-item-get-always-show-image.returns"></a><h4>Returns</h4> <p> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the menu item will always show the image</p> </div> <p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-set-always-show-image"></a><h3>gtk_image_menu_item_set_always_show_image ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> gtk_image_menu_item_set_always_show_image (<em class="parameter"><code><a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> *image_menu_item</code></em>, <em class="parameter"><code><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> always_show</code></em>);</pre> <p>If <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the menu item will ignore the <a class="link" href="GtkSettings.html#GtkSettings--gtk-menu-images" title="The “gtk-menu-images” property"><span class="type">“gtk-menu-images”</span></a> setting and always show the image, if available.</p> <p>Use this property if the menuitem would be useless or hard to use without the image.</p> <div class="refsect3"> <a name="gtk-image-menu-item-set-always-show-image.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>image_menu_item</p></td> <td class="parameter_description"><p>a <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>always_show</p></td> <td class="parameter_description"><p><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the menuitem should always show the image</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p> </div> <hr> <div class="refsect2"> <a name="gtk-image-menu-item-set-accel-group"></a><h3>gtk_image_menu_item_set_accel_group ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> gtk_image_menu_item_set_accel_group (<em class="parameter"><code><a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a> *image_menu_item</code></em>, <em class="parameter"><code><a class="link" href="gtk2-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a> *accel_group</code></em>);</pre> <p>Specifies an <em class="parameter"><code>accel_group</code></em> to add the menu items accelerator to (this only applies to stock items so a stock item must already be set, make sure to call <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-set-use-stock" title="gtk_image_menu_item_set_use_stock ()"><code class="function">gtk_image_menu_item_set_use_stock()</code></a> and <a class="link" href="GtkMenuItem.html#gtk-menu-item-set-label" title="gtk_menu_item_set_label ()"><code class="function">gtk_menu_item_set_label()</code></a> with a valid stock item first).</p> <p>If you want this menu item to have changeable accelerators then you shouldnt need this (see <a class="link" href="GtkImageMenuItem.html#gtk-image-menu-item-new-from-stock" title="gtk_image_menu_item_new_from_stock ()"><code class="function">gtk_image_menu_item_new_from_stock()</code></a>).</p> <div class="refsect3"> <a name="gtk-image-menu-item-set-accel-group.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> <col class="parameters_description"> <col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> <td class="parameter_name"><p>image_menu_item</p></td> <td class="parameter_description"><p>a <a class="link" href="GtkImageMenuItem.html" title="GtkImageMenuItem"><span class="type">GtkImageMenuItem</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>accel_group</p></td> <td class="parameter_description"><p>the <a class="link" href="gtk2-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a></p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p> </div> </div> <div class="refsect1"> <a name="GtkImageMenuItem.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="GtkImageMenuItem-struct"></a><h3>struct GtkImageMenuItem</h3> <pre class="programlisting">struct GtkImageMenuItem;</pre> <p> </p> </div> </div> <div class="refsect1"> <a name="GtkImageMenuItem.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="GtkImageMenuItem--accel-group"></a><h3>The <code class="literal">“accel-group”</code> property</h3> <pre class="programlisting"> “accel-group” <a class="link" href="gtk2-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a> *</pre> <p>The Accel Group to use for stock accelerator keys</p> <p>Flags: Write</p> <p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p> </div> <hr> <div class="refsect2"> <a name="GtkImageMenuItem--always-show-image"></a><h3>The <code class="literal">“always-show-image”</code> property</h3> <pre class="programlisting"> “always-show-image” <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> <p>If <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the menu item will ignore the <a class="link" href="GtkSettings.html#GtkSettings--gtk-menu-images" title="The “gtk-menu-images” property"><span class="type">“gtk-menu-images”</span></a> setting and always show the image, if available.</p> <p>Use this property if the menuitem would be useless or hard to use without the image.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: FALSE</p> <p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p> </div> <hr> <div class="refsect2"> <a name="GtkImageMenuItem--image"></a><h3>The <code class="literal">“image”</code> property</h3> <pre class="programlisting"> “image” <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *</pre> <p>Child widget to appear next to the menu text.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="GtkImageMenuItem--use-stock"></a><h3>The <code class="literal">“use-stock”</code> property</h3> <pre class="programlisting"> “use-stock” <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> <p>If <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the label set in the menuitem is used as a stock id to select the stock item for the item.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: FALSE</p> <p class="since">Since: <a class="link" href="api-index-2-16.html#api-index-2.16">2.16</a></p> </div> </div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.24.1</div> </body> </html>