gtk2/docs/reference/gtk/tmpl/gtkoptionmenu.sgml
Damon Chaplin 372c4d2627 ran make templates, to fix problems with structs.
1999-09-22  Damon Chaplin  <damon@karuna.freeserve.co.uk>

	* gtk/tmpl/*.sgml: ran make templates, to fix problems with structs.

	* gtk/gtk-sections.txt: rearranged GtkCombo section.

	* gtk/tmpl/gtkvseparator.sgml:
	* gtk/tmpl/gtkhseparator.sgml:
	* gtk/tmpl/gtkgc.sgml:
	* gtk/tmpl/gtkfeatures.sgml:
	* gtk/tmpl/gtktipsquery.sgml:
	* gtk/tmpl/gtkitem.sgml:
	* gtk/tmpl/gtkinvisible.sgml:
	* gtk/tmpl/gtkgamma.sgml:
	* gtk/tmpl/gtkdata.sgml:
	* gtk/tmpl/gtkcurve.sgml:
	* gtk/tmpl/gtkcombo.sgml:
	* gtk/tmpl/gtkaccellabel.sgml: documented.
1999-09-22 21:30:57 +00:00

72 lines
1.8 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkOptionMenu
<!-- ##### SECTION Short_Description ##### -->
a widget used to choose from a list of valid choices.
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkOptionMenu is a widget that allows the user to choose from a
list of valid choices. The #GtkOptionMenu displays the selected
choice. When activated the #GtkOptionMenu displays a popup #GtkMenu
which allows the user to make a new choice.
</para>
<!-- ##### SECTION See_Also ##### -->
<!-- ##### STRUCT GtkOptionMenu ##### -->
<para>
The #GtkOptionMenu-struct struct contains private data only, and
should be accessed using the functions below.
</para>
<!-- ##### FUNCTION gtk_option_menu_new ##### -->
<para>
Creates a new #GtkOptionMenu.
</para>
@Returns: a new #GtkOptionMenu.
<!-- ##### FUNCTION gtk_option_menu_get_menu ##### -->
<para>
Returns the #GtkMenu associated with the #GtkOptionMenu.
</para>
@option_menu: a #GtkOptionMenu.
@Returns: the #GtkMenu associated with the #GtkOptionMenu.
<!-- ##### FUNCTION gtk_option_menu_set_menu ##### -->
<para>
Provides the #GtkMenu that is popped up to allow the user to choose
a new value. You should provide a simple menu avoiding the
use of tearoff menu items, submenus, and accelerators.
</para>
@option_menu: a #GtkOptionMenu.
@menu: the #GtkMenu to associate with the #GtkOptionMenu.
<!-- ##### FUNCTION gtk_option_menu_remove_menu ##### -->
<para>
Removes the menu from the option menu.
</para>
@option_menu: a #GtkOptionMenu.
<!-- ##### FUNCTION gtk_option_menu_set_history ##### -->
<para>
Selects the menu item specified by @index making it the newly
selected value for the option menu.
</para>
@option_menu: a #GtkOptionMenu.
@index: the index of the menu item to select. Index values are from
0 to n-1.