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

184 lines
3.8 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
GtkMenuItem
<!-- ##### SECTION Short_Description ##### -->
the widget used for item in menus
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
As it derives from #GtkBin it can hold any valid child widget, altough
only a few are really useful.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkBin</term>
<listitem><para>for how to handle the child.</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkItem</term>
<listitem><para>is the abstract class for all sorts of items.</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkMenuShell</term>
<listitem><para>is always the parent of #GtkMenuItem.</para></listitem>
</varlistentry>
</variablelist>
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### STRUCT GtkMenuItem ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_menu_item_new ##### -->
<para>
Creates a new #GtkMenuItem.
1999-08-16 18:51:52 +00:00
</para>
@Returns: the newly created #GtkMenuItem
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_new_with_label ##### -->
<para>
Creates a new #GtkMenuItem whose child is a simple #GtlLabel.
1999-08-16 18:51:52 +00:00
</para>
@label: the text for the label
@Returns: the newly created #GtkMenuItem
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_set_submenu ##### -->
<para>
Sets the widget submenu, or changes it.
1999-08-16 18:51:52 +00:00
</para>
@menu_item: the menu item widget
@submenu: the submenu
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_remove_submenu ##### -->
<para>
Removes the widget's submenu.
1999-08-16 18:51:52 +00:00
</para>
@menu_item: the menu item widget
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_set_placement ##### -->
<para>
Specifies the placement of the submenu around the menu item. The placement
is usually #GTK_LEFT_RIGHT for menu items in a popup menu and
#GTK_TOP_BOTTOM in menu bars.
</para>
<para>
This function is useless in usual applications.
1999-08-16 18:51:52 +00:00
</para>
@menu_item: the menu item
@placement: the submenu placement
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_configure ##### -->
<para>
Sets whether the menu item should show a submenu indicator, which is a right
arrow.
1999-08-16 18:51:52 +00:00
</para>
@menu_item: the menu item
@show_toggle_indicator: unused
@show_submenu_indicator: whether to show the arrow or not
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_select ##### -->
<para>
Emits the "select" signal on the given item. Behaves exactly like
#gtk_item_select.
1999-08-16 18:51:52 +00:00
</para>
@menu_item: the menu item
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_deselect ##### -->
<para>
Emits the "deselect" signal on the given item. Behaves exactly like
#gtk_item_deselect.
1999-08-16 18:51:52 +00:00
</para>
@menu_item: the menu item
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_activate ##### -->
<para>
Emits the "activate" signal on the given item
1999-08-16 18:51:52 +00:00
</para>
@menu_item: the menu item
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_toggle_size_request ##### -->
<para>
</para>
@menu_item:
@requisition:
<!-- ##### FUNCTION gtk_menu_item_toggle_size_allocate ##### -->
<para>
</para>
@menu_item:
@allocation:
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_menu_item_right_justify ##### -->
<para>
Sets the menu item to be right-justified. Only useful for menu bars.
1999-08-16 18:51:52 +00:00
</para>
@menu_item: the menu item
1999-08-16 18:51:52 +00:00
<!-- ##### SIGNAL GtkMenuItem::activate ##### -->
<para>
Emitted when the item is activated.
1999-08-16 18:51:52 +00:00
</para>
@menuitem: the object which received the signal.
<!-- ##### SIGNAL GtkMenuItem::activate-item ##### -->
<para>
Emitted when the item is activated, but also if the menu item has a
submenu. For normal applications, the relevant signal is "activate".
1999-08-16 18:51:52 +00:00
</para>
@menuitem: the object which received the signal.
<!-- ##### SIGNAL GtkMenuItem::toggle-size-allocate ##### -->
<para>
</para>
@menuitem: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GtkMenuItem::toggle-size-request ##### -->
<para>
</para>
@menuitem: the object which received the signal.
@arg1: