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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!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="GimpIntComboBox">
<refmeta>
<refentrytitle id="top_of_page">GimpIntComboBox</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpIntComboBox</refname>
<refpurpose>A widget providing a popup menu of integer values (e.g. enums).</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpIntComboBox-struct">GimpIntComboBox</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-int-combo-box-new">gimp_int_combo_box_new</link> (const <link linkend="gchar">gchar</link> *first_label,
<link linkend="gint">gint</link> first_value,
...);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-int-combo-box-new-valist">gimp_int_combo_box_new_valist</link> (const <link linkend="gchar">gchar</link> *first_label,
<link linkend="gint">gint</link> first_value,
<link linkend="va-list">va_list</link> values);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-int-combo-box-new-array">gimp_int_combo_box_new_array</link> (<link linkend="gint">gint</link> n_values,
const <link linkend="gchar">gchar</link> *labels[]);
<link linkend="void">void</link> <link linkend="gimp-int-combo-box-prepend">gimp_int_combo_box_prepend</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
...);
<link linkend="void">void</link> <link linkend="gimp-int-combo-box-append">gimp_int_combo_box_append</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
...);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-int-combo-box-set-active">gimp_int_combo_box_set_active</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
<link linkend="gint">gint</link> value);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-int-combo-box-get-active">gimp_int_combo_box_get_active</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
<link linkend="gint">gint</link> *value);
<link linkend="gulong">gulong</link> <link linkend="gimp-int-combo-box-connect">gimp_int_combo_box_connect</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
<link linkend="gint">gint</link> value,
<link linkend="GCallback">GCallback</link> callback,
<link linkend="gpointer">gpointer</link> data);
</synopsis>
</refsynopsisdiv>
<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkComboBox">GtkComboBox</link>
+----GimpIntComboBox
</synopsis>
</refsect1>
<refsect1 id="impl_interfaces">
<title id="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpIntComboBox implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkCellEditable">GtkCellEditable</link> and <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
</refsect1>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
A widget providing a popup menu of integer values (e.g. enums).
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpIntComboBox-struct" role="struct"/>GimpIntComboBox</title>
<indexterm><primary>GimpIntComboBox</primary></indexterm><programlisting>typedef struct _GimpIntComboBox GimpIntComboBox;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-combo-box-new" role="function" condition="since:GIMP 2.2"/>gimp_int_combo_box_new ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_int_combo_box_new (const <link linkend="gchar">gchar</link> *first_label,
<link linkend="gint">gint</link> first_value,
...);</programlisting>
<para>
Creates a GtkComboBox that has integer values associated with each
item. The items to fill the combo box with are specified as a <link linkend="NULL:CAPS"><literal>NULL</literal></link>
terminated list of label/value pairs.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>first_label</parameter> :</term>
<listitem><simpara> the label of the first item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>first_value</parameter> :</term>
<listitem><simpara> the value of the first item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated list of more label, value pairs
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-combo-box-new-valist" role="function" condition="since:GIMP 2.2"/>gimp_int_combo_box_new_valist ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_combo_box_new_valist</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_int_combo_box_new_valist (const <link linkend="gchar">gchar</link> *first_label,
<link linkend="gint">gint</link> first_value,
<link linkend="va-list">va_list</link> values);</programlisting>
<para>
A variant of <link linkend="gimp-int-combo-box-new"><function>gimp_int_combo_box_new()</function></link> that takes a va_list of
label/value pairs. Probably only useful for language bindings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>first_label</parameter> :</term>
<listitem><simpara> the label of the first item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>first_value</parameter> :</term>
<listitem><simpara> the value of the first item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>values</parameter> :</term>
<listitem><simpara> a va_list with more values
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-combo-box-new-array" role="function" condition="since:GIMP 2.2"/>gimp_int_combo_box_new_array ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_combo_box_new_array</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_int_combo_box_new_array (<link linkend="gint">gint</link> n_values,
const <link linkend="gchar">gchar</link> *labels[]);</programlisting>
<para>
A variant of <link linkend="gimp-int-combo-box-new"><function>gimp_int_combo_box_new()</function></link> that takes an array of labels.
The array indices are used as values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>n_values</parameter> :</term>
<listitem><simpara> the number of values
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>labels</parameter> :</term>
<listitem><simpara> an array of labels (array length must be <parameter>n_values</parameter>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-combo-box-prepend" role="function" condition="since:GIMP 2.2"/>gimp_int_combo_box_prepend ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_combo_box_prepend</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_combo_box_prepend (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
...);</programlisting>
<para>
This function provides a convenient way to prepend items to a
<link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>. It prepends a row to the <parameter>combo_box</parameter>'s list store
and calls <link linkend="gtk-list-store-set"><function>gtk_list_store_set()</function></link> for you.
</para>
<para>
The column number must be taken from the enum <link linkend="GimpIntStoreColumns"><type>GimpIntStoreColumns</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>combo_box</parameter> :</term>
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> pairs of column number and value, terminated with -1
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-combo-box-append" role="function" condition="since:GIMP 2.2"/>gimp_int_combo_box_append ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_combo_box_append</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_combo_box_append (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
...);</programlisting>
<para>
This function provides a convenient way to append items to a
<link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>. It appends a row to the <parameter>combo_box</parameter>'s list store
and calls <link linkend="gtk-list-store-set"><function>gtk_list_store_set()</function></link> for you.
</para>
<para>
The column number must be taken from the enum <link linkend="GimpIntStoreColumns"><type>GimpIntStoreColumns</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>combo_box</parameter> :</term>
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> pairs of column number and value, terminated with -1
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-combo-box-set-active" role="function" condition="since:GIMP 2.2"/>gimp_int_combo_box_set_active ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_combo_box_set_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_int_combo_box_set_active (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
<link linkend="gint">gint</link> value);</programlisting>
<para>
Looks up the item that belongs to the given <parameter>value</parameter> and makes it the
selected item in the <parameter>combo_box</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>combo_box</parameter> :</term>
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> an integer value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if there was no item for
this value.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-combo-box-get-active" role="function" condition="since:GIMP 2.2"/>gimp_int_combo_box_get_active ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_combo_box_get_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_int_combo_box_get_active (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
<link linkend="gint">gint</link> *value);</programlisting>
<para>
Retrieves the value of the selected (active) item in the <parameter>combo_box</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>combo_box</parameter> :</term>
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> return location for the integer value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>value</parameter> has been set or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if no item was
active.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-int-combo-box-connect" role="function" condition="since:GIMP 2.2"/>gimp_int_combo_box_connect ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_int_combo_box_connect</primary></indexterm><programlisting><link linkend="gulong">gulong</link> gimp_int_combo_box_connect (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
<link linkend="gint">gint</link> value,
<link linkend="GCallback">GCallback</link> callback,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
A convenience function that sets the inital <parameter>value</parameter> of a
<link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> and connects <parameter>callback</parameter> to the "changed"
signal.
</para>
<para>
This function also calls the <parameter>callback</parameter> once after setting the
initial <parameter>value</parameter>. This is often convenient when working with combo
boxes that select a default active item (like for example
gimp_drawable_combo_box_new). If you pass an invalid initial
<parameter>value</parameter>, the <parameter>callback</parameter> will be called with the default item active.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>combo_box</parameter> :</term>
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the value to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter> :</term>
<listitem><simpara> a callback to connect to the <parameter>combo_box</parameter>'s "changed" signal
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> a pointer passed as data to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the signal handler ID as returned by <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>
|
