<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class GtkMenuItem</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkMenuBar.html">Previous: Class GtkMenuBar</a></li>
<li class="next"><a href="gtk_GtkMenuShell.html">Next: Class GtkMenuShell</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.85</span>Class GtkMenuItem</h1><p class="brief">The widget used for item in menus </p>
<pre class="prototype">Class GtkMenuItem</pre>
<p>The GtkMenuItem widget and the derived widgets are the only valid childs for menus. Their function is to correctly handle highlighting, alignment, events and submenus. </p>
<p>As it derives from GtkBin it can hold any valid child widget, altough only a few are really useful. </p>
<p>[...] </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#activate">activate</a></td><td>Emits the "activate" signal on the given item. </td></tr>
<tr><td><a href="#deselect">deselect</a></td><td>Emits the "deselect" signal on the given item. </td></tr>
<tr><td><a href="#get_accel_path">get_accel_path</a></td><td>Retrieve the accelerator path that was previously set on menu_item. </td></tr>
<tr><td><a href="#get_label">get_label</a></td><td>Gets the text on the menu_item label </td></tr>
<tr><td><a href="#get_right_justified">get_right_justified</a></td><td>Gets whether the menu item appears justified at the right side of the menu bar. </td></tr>
<tr><td><a href="#get_submenu">get_submenu</a></td><td>Gets the submenu underneath this menu item, if any. </td></tr>
<tr><td><a href="#get_use_underline">get_use_underline</a></td><td>Checks if an underline in the text indicates the next character should be used for the mnemonic accelerator key. </td></tr>
<tr><td><a href="#new_with_label">new_with_label</a></td><td>Creates a new GtkMenuItem whose child is a GtkLabel. </td></tr>
<tr><td><a href="#new_with_mnemonic">new_with_mnemonic</a></td><td>Creates a new GtkMenuItem containing a label. </td></tr>
<tr><td><a href="#select">select</a></td><td>Emits the "select" signal on the given item. </td></tr>
<tr><td><a href="#set_accel_path">set_accel_path</a></td><td>Set the accelerator path on menu_item, through which runtime changes of the menu item's accelerator caused by the user can be identified and saved to persistant storage (see gtk_accel_map_save() on this). </td></tr>
<tr><td><a href="#set_label">set_label</a></td><td>Sets text on the menu_item label </td></tr>
<tr><td><a href="#set_right_justified">set_right_justified</a></td><td>Sets whether the menu item appears justified at the right side of a menu bar. </td></tr>
<tr><td><a href="#set_submenu">set_submenu</a></td><td>Sets or replaces the menu item's submenu, or removes it when a NULL submenu is passed. </td></tr>
<tr><td><a href="#set_use_underline">set_use_underline</a></td><td>If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key. </td></tr>
<tr><td><a href="#signal_activate">signal_activate</a></td><td>Emitted when the item is activated. </td></tr>
<tr><td><a href="#signal_activate_item">signal_activate_item</a></td><td>Emitted when the item is activated, but also if the menu item has a submenu. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="activate">activate</a></h3><p class="brief">Emits the "activate" signal on the given item. </p>
<pre class="prototype">GtkMenuItem.activate()</pre>
<h3><a name="deselect">deselect</a></h3><p class="brief">Emits the "deselect" signal on the given item. </p>
<pre class="prototype">GtkMenuItem.deselect()</pre>
<p>Behaves exactly like gtk_item_deselect. </p>
<h3><a name="get_accel_path">get_accel_path</a></h3><p class="brief">Retrieve the accelerator path that was previously set on menu_item. </p>
<pre class="prototype">GtkMenuItem.get_accel_path()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">the accelerator path corresponding to this menu item's functionality, or NULL if not set </td></tr>
</tbody>
</table>
<h3><a name="get_label">get_label</a></h3><p class="brief">Gets the text on the menu_item label </p>
<pre class="prototype">GtkMenuItem.get_label()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">The text in the menu_item label. </td></tr>
</tbody>
</table>
<h3><a name="get_right_justified">get_right_justified</a></h3><p class="brief">Gets whether the menu item appears justified at the right side of the menu bar. </p>
<pre class="prototype">GtkMenuItem.get_right_justified()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if the menu item will appear at the far right if added to a menu bar. </td></tr>
</tbody>
</table>
<h3><a name="get_submenu">get_submenu</a></h3><p class="brief">Gets the submenu underneath this menu item, if any. </p>
<pre class="prototype">GtkMenuItem.get_submenu()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">submenu for this menu item, or NULL if none. </td></tr>
</tbody>
</table>
<h3><a name="get_use_underline">get_use_underline</a></h3><p class="brief">Checks if an underline in the text indicates the next character should be used for the mnemonic accelerator key. </p>
<pre class="prototype">GtkMenuItem.get_use_underline()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if an embedded underline in the label indicates the mnemonic accelerator key. </td></tr>
</tbody>
</table>
<h3><a name="new_with_label">new_with_label</a></h3><p class="brief">Creates a new GtkMenuItem whose child is a GtkLabel. </p>
<pre class="prototype">GtkMenuItem.new_with_label( label )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">label</td><td class="content"> the text for the label </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">the newly created GtkMenuItem </td></tr>
</tbody>
</table>
<h3><a name="new_with_mnemonic">new_with_mnemonic</a></h3><p class="brief">Creates a new GtkMenuItem containing a label. </p>
<pre class="prototype">GtkMenuItem.new_with_mnemonic( label )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">label</td><td class="content"> The text of the button, with an underscore in front of the mnemonic character </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">a new GtkMenuItem </td></tr>
</tbody>
</table>
<p>The label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the menu item. </p>
<h3><a name="select">select</a></h3><p class="brief">Emits the "select" signal on the given item. </p>
<pre class="prototype">GtkMenuItem.select()</pre>
<p>Behaves exactly like gtk_item_select. </p>
<h3><a name="set_accel_path">set_accel_path</a></h3><p class="brief">Set the accelerator path on menu_item, through which runtime changes of the menu item's accelerator caused by the user can be identified and saved to persistant storage (see gtk_accel_map_save() on this). </p>
<pre class="prototype">GtkMenuItem.set_accel_path( accel_path )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">accel_path</td><td class="content"> accelerator path, corresponding to this menu item's functionality, or NULL to unset the current path </td></tr>
</tbody>
</table>
<p>To setup a default accelerator for this menu item, call gtk_accel_map_add_entry() with the same accel_path. See also gtk_accel_map_add_entry() on the specifics of accelerator paths, and gtk_menu_set_accel_path() for a more convenient variant of this function. </p>
<p>This function is basically a convenience wrapper that handles calling gtk_widget_set_accel_path() with the appropriate accelerator group for the menu item. </p>
<p>Note that you do need to set an accelerator on the parent menu with gtk_menu_set_accel_group() for this to work. </p>
<h3><a name="set_label">set_label</a></h3><p class="brief">Sets text on the menu_item label </p>
<pre class="prototype">GtkMenuItem.set_label( label )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">label</td><td class="content"> the text you want to set </td></tr>
</tbody>
</table>
<h3><a name="set_right_justified">set_right_justified</a></h3><p class="brief">Sets whether the menu item appears justified at the right side of a menu bar. </p>
<pre class="prototype">GtkMenuItem.set_right_justified( right_justified )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">right_justified</td><td class="content"> if TRUE the menu item will appear at the far right if added to a menu bar. </td></tr>
</tbody>
</table>
<p>This was traditionally done for "Help" menu items, but is now considered a bad idea. (If the widget layout is reversed for a right-to-left language like Hebrew or Arabic, right-justified-menu-items appear at the left.) </p>
<h3><a name="set_submenu">set_submenu</a></h3><p class="brief">Sets or replaces the menu item's submenu, or removes it when a NULL submenu is passed. </p>
<pre class="prototype">GtkMenuItem.set_submenu( submenu )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">submenu</td><td class="content"> the submenu, or NULL. </td></tr>
</tbody>
</table>
<h3><a name="set_use_underline">set_use_underline</a></h3><p class="brief">If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key. </p>
<pre class="prototype">GtkMenuItem.set_use_underline( setting )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">setting</td><td class="content"> TRUE if underlines in the text indicate mnemonics </td></tr>
</tbody>
</table>
<h3><a name="signal_activate">signal_activate</a></h3><p class="brief">Emitted when the item is activated. </p>
<pre class="prototype">GtkMenuItem.signal_activate()</pre>
<h3><a name="signal_activate_item">signal_activate_item</a></h3><p class="brief">Emitted when the item is activated, but also if the menu item has a submenu. </p>
<pre class="prototype">GtkMenuItem.signal_activate_item()</pre>
<p>For normal applications, the relevant signal is "activate". </p>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkMenuBar.html">Previous: Class GtkMenuBar</a></li>
<li class="next"><a href="gtk_GtkMenuShell.html">Next: Class GtkMenuShell</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
