Files
gtk3/docs/reference/gtk/tmpl/gtkoptionmenu.sgml
Owen Taylor 85c05a86c0 === Released 2.3.1 ===
Mon Dec  8 10:54:44 2003  Owen Taylor  <otaylor@redhat.com>

        * === Released 2.3.1 ===

        * NEWS: Updates for 2.3.1

        * configure.in: Version 2.3.1, interface age 0, binary age 301.

        * gtk/gtkmenuitem.c (gtk_menu_item_can_activate_accel):
        Rename from gtk_menu_item_real_can_activate_accel() to
        match GTK+ convention, improve comment.

        * gtk/gtkwidget.c: Document gtk_widget_can_activate_accel(),
        can ::can-activate-accel signal.

        * gtk/gtkwidget.c (closure_accel_activate): Fix spelling
        in comment.

        * gtk/gtkmenu.c (gtk_menu_real_can_activate_accel): Clean
        up comment.

        * gtk/gtkcellview{,menuitem}.[ch]: Move GET_PRIVATE() macros
        into the .c file.

Mon Dec  8 12:09:21 2003  Owen Taylor  <otaylor@redhat.com>

        * gtk/gtkicontheme.c (find_builtin_icon): Fix a
        missing 'else'. (#128816, Jorn Baayen)
2003-12-08 22:55:03 +00:00

113 lines
2.6 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>
<para>
Using a #GtkOptionMenu is simple; build a #GtkMenu, by calling
gtk_menu_new(), then appending menu items to it with
gtk_menu_shell_append(). Set that menu on the option menu
with gtk_option_menu_set_menu(). Set the selected menu item with
gtk_option_menu_set_history(); connect to the "changed" signal on
the option menu; in the "changed" signal, check the new selected
menu item with gtk_option_menu_get_history().
</para>
<!-- ##### SECTION See_Also ##### -->
<!-- ##### STRUCT GtkOptionMenu ##### -->
<para>
The #GtkOptionMenu-struct struct contains private data only, and
should be accessed using the functions below.
</para>
<!-- ##### SIGNAL GtkOptionMenu::changed ##### -->
<para>
</para>
@optionmenu: the object which received the signal.
<!-- ##### ARG GtkOptionMenu:menu ##### -->
<para>
</para>
<!-- ##### ARG GtkOptionMenu:indicator-size ##### -->
<para>
</para>
<!-- ##### ARG GtkOptionMenu:indicator-spacing ##### -->
<para>
</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.
<!-- ##### FUNCTION gtk_option_menu_get_history ##### -->
<para>
</para>
@option_menu:
@Returns: