forked from AuroraMiddleware/gtk
25472c7578
2000-02-29 Damon Chaplin <damon@helixcode.com>
* gtk/tmpl/gtkmenuitem.sgml: minor fix from Nicolas GEORGE
<nicolas.george@ens.fr>.
152 lines
3.4 KiB
Plaintext
152 lines
3.4 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GtkMenuItem
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
the widget used for item in menus
|
|
|
|
<!-- ##### 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.
|
|
</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>
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GtkMenuItem ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@item: the parent class object
|
|
@submenu: the submenu attached to this item; read only
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_new ##### -->
|
|
<para>
|
|
Creates a new #GtkMenuItem.
|
|
</para>
|
|
|
|
@Returns: the newly created #GtkMenuItem
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_new_with_label ##### -->
|
|
<para>
|
|
Creates a new #GtkMenuItem whose child is a simple #GtlLabel.
|
|
</para>
|
|
|
|
@label: the text for the label
|
|
@Returns: the newly created #GtkMenuItem
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_set_submenu ##### -->
|
|
<para>
|
|
Sets the widget submenu, or changes it.
|
|
</para>
|
|
|
|
@menu_item: the menu item widget
|
|
@submenu: the submenu
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_remove_submenu ##### -->
|
|
<para>
|
|
Removes the widget's submenu.
|
|
</para>
|
|
|
|
@menu_item: the menu item widget
|
|
|
|
|
|
<!-- ##### 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.
|
|
</para>
|
|
|
|
@menu_item: the menu item
|
|
@placement: the submenu placement
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_configure ##### -->
|
|
<para>
|
|
Sets whether the menu item should show a submenu indicator, which is a right
|
|
arrow.
|
|
</para>
|
|
|
|
@menu_item: the menu item
|
|
@show_toggle_indicator: unused
|
|
@show_submenu_indicator: whether to show the arrow or not
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_select ##### -->
|
|
<para>
|
|
Emits the "select" signal on the given item. Behaves exactly like
|
|
#gtk_item_select.
|
|
</para>
|
|
|
|
@menu_item: the menu item
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_deselect ##### -->
|
|
<para>
|
|
Emits the "deselect" signal on the given item. Behaves exactly like
|
|
#gtk_item_deselect.
|
|
</para>
|
|
|
|
@menu_item: the menu item
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_activate ##### -->
|
|
<para>
|
|
Emits the "activate" signal on the given item
|
|
</para>
|
|
|
|
@menu_item: the menu item
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_menu_item_right_justify ##### -->
|
|
<para>
|
|
Sets the menu item to be right-justified. Only useful for menu bars.
|
|
</para>
|
|
|
|
@menu_item: the menu item
|
|
|
|
|
|
<!-- ##### SIGNAL GtkMenuItem::activate ##### -->
|
|
<para>
|
|
Emitted when the item is activated.
|
|
</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".
|
|
</para>
|
|
|
|
@menuitem: the object which received the signal.
|
|
|