summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkoptionmenu.sgml
blob: c659448942093d3e3db8c23f4fa6b7cf69d4d942 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<!-- ##### 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.


<!-- ##### FUNCTION gtk_option_menu_get_history ##### -->
<para>

</para>

@option_menu: 
@Returns: