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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkoptionmenu">
<refnamediv>
<refname>gtk.OptionMenu</refname>
<refpurpose>a widget used to provide a list of valid choices.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.OptionMenu</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkbutton">gtk.Button</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gtkoptionmenu">gtk.OptionMenu</link></methodname>
<methodparam></methodparam> </constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkoptionmenu--get-menu">get_menu</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkoptionmenu--set-menu">set_menu</link></methodname>
<methodparam><parameter
role="keyword">menu</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkoptionmenu--remove-menu">remove_menu</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkoptionmenu--get-history">get_history</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkoptionmenu--set-history">set_history</link></methodname>
<methodparam><parameter
role="keyword">index</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbin">gtk.Bin</link>
+-- <link linkend="class-gtkbutton">gtk.Button</link>
+-- <link linkend="class-gtkoptionmenu">gtk.OptionMenu</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkoptionmenu">
<title>gtk.OptionMenu Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<para><link linkend="properties-gtkbutton">gtk.Button Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"menu"</entry>
<entry>Read-Write</entry>
<entry>The menu of options.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkoptionmenu">
<title>gtk.OptionMenu Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtkbutton">gtk.Button Style Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"indicator-size"</entry>
<entry>Read</entry>
<entry>The size of the dropdown indicator</entry>
</row>
<row valign="top">
<entry>"indicator-spacing"</entry>
<entry>Read</entry>
<entry>The spacing around the indicator.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkoptionmenu">
<title>gtk.OptionMenu Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkbutton">gtk.Button Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link
linkend="signal-gtkoptionmenu--changed">changed</link>"</term>
<listitem>
<methodsynopsis
language="python"><methodname>callback</methodname>
<methodparam><parameter>optionmenu</parameter>
</methodparam>
<methodparam><parameter>user_param1</parameter>
</methodparam>
<methodparam><parameter>...</parameter>
</methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<warning>
<para><link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
is deprecated in PyGTK 2.4; use the <link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
instead.</para>
</warning>
<para>A <link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
is a widget allows the user to choose from a list of valid choices from an
associated menu. The <link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
displays the last selected choice. When activated (clicked) the <link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
displays a popup <link
linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> which allows
the user to make a new choice. Using a <link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
is simple:</para>
<itemizedlist>
<listitem>
<simpara>build a <link
linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> using <link
linkend="constructor-gtkmenu"><methodname>gtk.Menu</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara>then append menu items to it using <link
linkend="method-gtkmenushell--append"><methodname>gtk.MenuShell.append</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara>associate the menu with the option menu using <link
linkend="method-gtkoptionmenu--set-menu"><methodname>set_menu</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara>set the selected menu item with <link
linkend="method-gtkoptionmenu--set-history"><methodname>set_history</methodname>()</link></simpara>
</listitem>
<listitem>
<simpara>connect to the "changed" signal on the option menu; in the
"changed" signal</simpara>
</listitem>
<listitem>
<simpara>check the new selected menu item with <link
linkend="method-gtkoptionmenu--get-history"><methodname>get_history</methodname>()</link>.</simpara>
</listitem>
</itemizedlist>
</refsect1>
<refsect1 id="constructor-gtkoptionmenu">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.OptionMenu</methodname>
<methodparam></methodparam> </constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new optionmenu widget</simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>
widget.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkoptionmenu--get-menu">
<title>gtk.OptionMenu.get_menu</title>
<programlisting><methodsynopsis language="python">
<methodname>get_menu</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a menu widget or <literal>None</literal> if no
menu is associated</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_menu</methodname>() method returns the menu
that is associated with the optionmenu or <literal>None</literal> if no menu
is associated.</para>
</refsect2>
<refsect2 id="method-gtkoptionmenu--set-menu">
<title>gtk.OptionMenu.set_menu</title>
<programlisting><methodsynopsis language="python">
<methodname>set_menu</methodname>
<methodparam><parameter
role="keyword">menu</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">menu</parameter> :</term>
<listitem><simpara>a menu to be associated with the
optionmenu</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_menu</methodname>() method associates the
<link linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> widget
specified by <parameter>menu</parameter> with the optionmenu thus providing
the way for a user to select a new choice. A simple menu, avoiding the use
of tearoff menu items, submenus, and accelerators, should be used.</para>
</refsect2>
<refsect2 id="method-gtkoptionmenu--remove-menu">
<title>gtk.OptionMenu.remove_menu</title>
<programlisting><methodsynopsis language="python">
<methodname>remove_menu</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<para>The <methodname>remove_menu</methodname>() method removes the
currently associated menu from the optionmenu.</para>
</refsect2>
<refsect2 id="method-gtkoptionmenu--get-history">
<title>gtk.OptionMenu.get_history</title>
<programlisting><methodsynopsis language="python">
<methodname>get_history</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the index of the selected menu item, or -1 if
there are no menu items</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_history</methodname>() method returns the
index of the currently selected menu item or -1 if there are no menu items.
The menu items are numbered from top to bottom, starting with 0.</para>
</refsect2>
<refsect2 id="method-gtkoptionmenu--set-history">
<title>gtk.OptionMenu.set_history</title>
<programlisting><methodsynopsis language="python">
<methodname>set_history</methodname>
<methodparam><parameter
role="keyword">index</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">index</parameter> :</term>
<listitem><simpara>the index of the menu item to display as the
selected optionmenu choice</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>set_history</methodname>() method selects the
menu item specified by <parameter>index</parameter> as the displayed
optionmenu choice.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkoptionmenu--changed">
<title>The "changed" gtk.OptionMenu Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>optionmenu</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>optionmenu</parameter> :</term>
<listitem><simpara>the optionmenu that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<para>The "changed" signal is emitted when a new optionmenu choice is
made.</para>
</refsect2>
</refsect1>
</refentry>
|
