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
|
<?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-gtkcomboboxtext">
<refnamediv>
<refname>gtk.ComboBoxText</refname> <refpurpose>A simple, text-only combo box (new in PyGTK 2.24)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.ComboBoxText</classname></ooclass>
<ooclass><classname><link linkend="class-gtkcombobox">gtk.ComboBox</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkcomboboxtext">gtk.ComboBoxText</link></methodname>
<methodparam></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcomboboxtext--append-text">append_text</link></methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcomboboxtext--insert-text">insert_text</link></methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcomboboxtext--prepend-text">prepend_text</link></methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcomboboxtext--remove">remove</link></methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcomboboxtext--get-active-text">get_active_text</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-gtk--combo-box-text-new-with-entry">gtk.combo_box_text_new_with_entry</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</programlisting>
</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-gtkcombobox">gtk.ComboBox</link>
+-- <link linkend="class-gtkcomboboxtext">gtk.ComboBoxText</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
<link linkend="class-atkimplementor"><classname>atk.ImplementorIFace</classname></link>
<link linkend="class-gtkcelleditable"><classname>gtk.CellEditable</classname></link>
<link linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkcomboboxtext">
<title>gtk.ComboBoxText 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-gtkcombobox">gtk.ComboBox Properties</link></para>
</refsect1>
<refsect1 id="style-properties-gtkcomboboxtext">
<title>gtk.ComboBoxText Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtkcombobox">gtk.ComboBox Style Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtkcomboboxtext">
<title>gtk.ComboBoxText 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-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcombobox">gtk.ComboBox Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<note>
<para>This widget is available in GTK+ 2.24 and PyGTK 2.24 and above.</para>
</note>
<para>A <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>
is a simple variant of <link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
that hides the model-view complexity for simple text-only use cases.</para>
</refsect1>
<refsect1 id="constructor-gtkcomboboxtext">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.ComboBox</methodname>
<methodparam></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A new <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.24 and above.</para>
</note>
<para>Creates a new <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>,
which is a <link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link> just displaying strings.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkcomboboxtext--append-text">
<title>gtk.ComboBoxText.append_text</title>
<programlisting><methodsynopsis language="python">
<methodname>append_text</methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>A string.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.24 and above.</para>
</note>
<para>The <methodname>append_text</methodname>() method appends the string specified
by <parameter>text</parameter> to the list of strings stored in the combo box
<link linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>.</para>
</refsect2>
<refsect2 id="method-gtkcomboboxtext--insert-text">
<title>gtk.ComboBoxText.insert_text</title>
<programlisting><methodsynopsis language="python">
<methodname>insert_text</methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>A model index where the text should be inserted.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>A string.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.24 and above.</para>
</note>
<para>The <methodname>insert_text</methodname>() method inserts the string specified
by <parameter>text</parameter> in the combo box <link linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
at the index specified by <parameter>position</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkcomboboxtext--prepend-text">
<title>gtk.ComboBoxText.prepend_text</title>
<programlisting><methodsynopsis language="python">
<methodname>prepend_text</methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>A string.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.24 and above.</para>
</note>
<para>The <methodname>prepend_text</methodname>() method prepends the string specified
by <parameter>text</parameter> to the list of strings stored in the
<link linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
associated with the combo_box.</para>
</refsect2>
<refsect2 id="method-gtkcomboboxtext--remove">
<title>gtk.ComboBoxText.remove</title>
<programlisting><methodsynopsis language="python">
<methodname>remove</methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>Index of the item to remove.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.24 and above.</para>
</note>
<para>The <methodname>remove_text</methodname>() method removes the string at
the index specified by <parameter>position</parameter> in the associated
<link linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>.</para>
</refsect2>
<refsect2 id="method-gtkcomboboxtext--get-active-text">
<title>gtk.ComboBoxText.get_active_text</title>
<programlisting><methodsynopsis language="python">
<methodname>get_active_text</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The currently active text.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.24 and above.</para>
</note>
<para>The <methodname>get_active_text</methodname>() method returns
the currently active string or <literal>None</literal> if no entry is
selected.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-gtk--combo-box-text-new-with-entry">
<title>gtk.combo_box_text_new_with_entry</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.combo_box_text_new_with_entry</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A new <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.24 and above.</para>
</note>
<para>The <function>gtk.combo_box_new_text</function>() function creates a new
<link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>,
which is a <link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
just displaying strings. The combo box created by this function has an entry.</para>
</refsect2>
</refsect1>
</refentry>
|
