96
93
<title role="details.title">Details</title>
97
94
<refsect2 id="GimpIntComboBox-struct" role="struct">
98
95
<title>GimpIntComboBox</title>
99
<indexterm zone="GimpIntComboBox-struct"><primary>GimpIntComboBox</primary></indexterm><programlisting>typedef struct _GimpIntComboBox GimpIntComboBox;</programlisting>
96
<indexterm zone="GimpIntComboBox-struct"><primary sortas="GimpIntComboBox">GimpIntComboBox</primary></indexterm><programlisting>typedef struct _GimpIntComboBox GimpIntComboBox;</programlisting>
102
98
</para></refsect2>
103
99
<refsect2 id="GimpIntSensitivityFunc" role="function">
104
100
<title>GimpIntSensitivityFunc ()</title>
105
<indexterm zone="GimpIntSensitivityFunc"><primary>GimpIntSensitivityFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpIntSensitivityFunc) (<link linkend="gint">gint</link> value,
101
<indexterm zone="GimpIntSensitivityFunc"><primary sortas="GimpIntSensitivityFunc">GimpIntSensitivityFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpIntSensitivityFunc) (<link linkend="gint">gint</link> value,
106
102
<link linkend="gpointer">gpointer</link> data);</programlisting>
109
104
</para><variablelist role="params">
110
<varlistentry><term><parameter>value</parameter> :</term>
112
</simpara></listitem></varlistentry>
113
<varlistentry><term><parameter>data</parameter> :</term>
115
</simpara></listitem></varlistentry>
116
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
105
<varlistentry><term><parameter>value</parameter> :</term>
107
</simpara></listitem></varlistentry>
108
<varlistentry><term><parameter>data</parameter> :</term>
110
</simpara></listitem></varlistentry>
111
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
119
112
</simpara></listitem></varlistentry>
120
113
</variablelist></refsect2>
121
114
<refsect2 id="gimp-int-combo-box-new" role="function" condition="since:GIMP 2.2">
122
115
<title>gimp_int_combo_box_new ()</title>
123
<indexterm zone="gimp-int-combo-box-new" 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,
116
<indexterm zone="gimp-int-combo-box-new" role="GIMP 2.2"><primary sortas="gimp_int_combo_box_new">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,
124
117
<link linkend="gint">gint</link> first_value,
125
118
...);</programlisting>
127
120
Creates a GtkComboBox that has integer values associated with each
128
item. The items to fill the combo box with are specified as a <link linkend="NULL:CAPS"><literal>NULL</literal></link>
121
item. The items to fill the combo box with are specified as a <link linkend="NULL--CAPS"><literal>NULL</literal></link>
129
122
terminated list of label/value pairs.
132
125
If you need to construct an empty <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>, it's best to use
133
126
g_object_new (GIMP_TYPE_INT_COMBO_BOX, NULL).</para>
136
128
</para><variablelist role="params">
137
<varlistentry><term><parameter>first_label</parameter> :</term>
129
<varlistentry><term><parameter>first_label</parameter> :</term>
138
130
<listitem><simpara> the label of the first item
139
131
</simpara></listitem></varlistentry>
140
<varlistentry><term><parameter>first_value</parameter> :</term>
132
<varlistentry><term><parameter>first_value</parameter> :</term>
141
133
<listitem><simpara> the value of the first item
142
134
</simpara></listitem></varlistentry>
143
<varlistentry><term><parameter>...</parameter> :</term>
144
<listitem><simpara> a <link linkend="NULL:CAPS"><literal>NULL</literal></link> terminated list of more label, value pairs
135
<varlistentry><term><parameter>...</parameter> :</term>
136
<listitem><simpara> a <link linkend="NULL--CAPS"><literal>NULL</literal></link> terminated list of more label, value pairs
145
137
</simpara></listitem></varlistentry>
146
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
138
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
148
140
</simpara></listitem></varlistentry>
149
</variablelist><para role="since">Since GIMP 2.2
141
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
151
142
<refsect2 id="gimp-int-combo-box-new-valist" role="function" condition="since:GIMP 2.2">
152
143
<title>gimp_int_combo_box_new_valist ()</title>
153
<indexterm zone="gimp-int-combo-box-new-valist" 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,
144
<indexterm zone="gimp-int-combo-box-new-valist" role="GIMP 2.2"><primary sortas="gimp_int_combo_box_new_valist">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,
154
145
<link linkend="gint">gint</link> first_value,
155
146
<link linkend="va-list">va_list</link> values);</programlisting>
157
148
A variant of <link linkend="gimp-int-combo-box-new"><function>gimp_int_combo_box_new()</function></link> that takes a va_list of
158
149
label/value pairs. Probably only useful for language bindings.</para>
161
151
</para><variablelist role="params">
162
<varlistentry><term><parameter>first_label</parameter> :</term>
152
<varlistentry><term><parameter>first_label</parameter> :</term>
163
153
<listitem><simpara> the label of the first item
164
154
</simpara></listitem></varlistentry>
165
<varlistentry><term><parameter>first_value</parameter> :</term>
155
<varlistentry><term><parameter>first_value</parameter> :</term>
166
156
<listitem><simpara> the value of the first item
167
157
</simpara></listitem></varlistentry>
168
<varlistentry><term><parameter>values</parameter> :</term>
158
<varlistentry><term><parameter>values</parameter> :</term>
169
159
<listitem><simpara> a va_list with more values
170
160
</simpara></listitem></varlistentry>
171
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
161
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
173
163
</simpara></listitem></varlistentry>
174
</variablelist><para role="since">Since GIMP 2.2
164
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
176
165
<refsect2 id="gimp-int-combo-box-new-array" role="function" condition="since:GIMP 2.2">
177
166
<title>gimp_int_combo_box_new_array ()</title>
178
<indexterm zone="gimp-int-combo-box-new-array" 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,
167
<indexterm zone="gimp-int-combo-box-new-array" role="GIMP 2.2"><primary sortas="gimp_int_combo_box_new_array">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,
179
168
const <link linkend="gchar">gchar</link> *labels[]);</programlisting>
181
170
A variant of <link linkend="gimp-int-combo-box-new"><function>gimp_int_combo_box_new()</function></link> that takes an array of labels.
182
171
The array indices are used as values.</para>
185
173
</para><variablelist role="params">
186
<varlistentry><term><parameter>n_values</parameter> :</term>
174
<varlistentry><term><parameter>n_values</parameter> :</term>
187
175
<listitem><simpara> the number of values
188
176
</simpara></listitem></varlistentry>
189
<varlistentry><term><parameter>labels</parameter> :</term>
177
<varlistentry><term><parameter>labels</parameter> :</term>
190
178
<listitem><simpara> an array of labels (array length must be <parameter>n_values</parameter>)
191
179
</simpara></listitem></varlistentry>
192
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
180
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
194
182
</simpara></listitem></varlistentry>
195
</variablelist><para role="since">Since GIMP 2.2
183
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
197
184
<refsect2 id="gimp-int-combo-box-prepend" role="function" condition="since:GIMP 2.2">
198
185
<title>gimp_int_combo_box_prepend ()</title>
199
<indexterm zone="gimp-int-combo-box-prepend" 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,
186
<indexterm zone="gimp-int-combo-box-prepend" role="GIMP 2.2"><primary sortas="gimp_int_combo_box_prepend">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,
200
187
...);</programlisting>
202
189
This function provides a convenient way to prepend items to a
229
214
The column number must be taken from the enum <link linkend="GimpIntStoreColumns"><type>GimpIntStoreColumns</type></link>.</para>
232
216
</para><variablelist role="params">
233
<varlistentry><term><parameter>combo_box</parameter> :</term>
217
<varlistentry><term><parameter>combo_box</parameter> :</term>
234
218
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
235
219
</simpara></listitem></varlistentry>
236
<varlistentry><term><parameter>...</parameter> :</term>
220
<varlistentry><term><parameter>...</parameter> :</term>
237
221
<listitem><simpara> pairs of column number and value, terminated with -1
238
222
</simpara></listitem></varlistentry>
239
</variablelist><para role="since">Since GIMP 2.2
223
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
241
224
<refsect2 id="gimp-int-combo-box-set-active" role="function" condition="since:GIMP 2.2">
242
225
<title>gimp_int_combo_box_set_active ()</title>
243
<indexterm zone="gimp-int-combo-box-set-active" 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,
226
<indexterm zone="gimp-int-combo-box-set-active" role="GIMP 2.2"><primary sortas="gimp_int_combo_box_set_active">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,
244
227
<link linkend="gint">gint</link> value);</programlisting>
246
229
Looks up the item that belongs to the given <parameter>value</parameter> and makes it the
247
230
selected item in the <parameter>combo_box</parameter>.</para>
250
232
</para><variablelist role="params">
251
<varlistentry><term><parameter>combo_box</parameter> :</term>
233
<varlistentry><term><parameter>combo_box</parameter> :</term>
252
234
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
253
235
</simpara></listitem></varlistentry>
254
<varlistentry><term><parameter>value</parameter> :</term>
236
<varlistentry><term><parameter>value</parameter> :</term>
255
237
<listitem><simpara> an integer value
256
238
</simpara></listitem></varlistentry>
257
<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
239
<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
260
242
</simpara></listitem></varlistentry>
261
</variablelist><para role="since">Since GIMP 2.2
243
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
263
244
<refsect2 id="gimp-int-combo-box-get-active" role="function" condition="since:GIMP 2.2">
264
245
<title>gimp_int_combo_box_get_active ()</title>
265
<indexterm zone="gimp-int-combo-box-get-active" 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,
246
<indexterm zone="gimp-int-combo-box-get-active" role="GIMP 2.2"><primary sortas="gimp_int_combo_box_get_active">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,
266
247
<link linkend="gint">gint</link> *value);</programlisting>
268
249
Retrieves the value of the selected (active) item in the <parameter>combo_box</parameter>.</para>
271
251
</para><variablelist role="params">
272
<varlistentry><term><parameter>combo_box</parameter> :</term>
252
<varlistentry><term><parameter>combo_box</parameter> :</term>
273
253
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
274
254
</simpara></listitem></varlistentry>
275
<varlistentry><term><parameter>value</parameter> :</term>
255
<varlistentry><term><parameter>value</parameter> :</term>
276
256
<listitem><simpara> return location for the integer value
277
257
</simpara></listitem></varlistentry>
278
<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
258
<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
281
261
</simpara></listitem></varlistentry>
282
</variablelist><para role="since">Since GIMP 2.2
262
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
284
263
<refsect2 id="gimp-int-combo-box-connect" role="function" condition="since:GIMP 2.2">
285
264
<title>gimp_int_combo_box_connect ()</title>
286
<indexterm zone="gimp-int-combo-box-connect" 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,
265
<indexterm zone="gimp-int-combo-box-connect" role="GIMP 2.2"><primary sortas="gimp_int_combo_box_connect">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,
287
266
<link linkend="gint">gint</link> value,
288
267
<link linkend="GCallback">GCallback</link> callback,
289
268
<link linkend="gpointer">gpointer</link> data);</programlisting>
299
278
<link linkend="gimp-drawable-combo-box-new"><function>gimp_drawable_combo_box_new()</function></link>. If you pass an invalid initial
300
279
<parameter>value</parameter>, the <parameter>callback</parameter> will be called with the default item active.</para>
303
281
</para><variablelist role="params">
304
<varlistentry><term><parameter>combo_box</parameter> :</term>
282
<varlistentry><term><parameter>combo_box</parameter> :</term>
305
283
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
306
284
</simpara></listitem></varlistentry>
307
<varlistentry><term><parameter>value</parameter> :</term>
285
<varlistentry><term><parameter>value</parameter> :</term>
308
286
<listitem><simpara> the value to set
309
287
</simpara></listitem></varlistentry>
310
<varlistentry><term><parameter>callback</parameter> :</term>
288
<varlistentry><term><parameter>callback</parameter> :</term>
311
289
<listitem><simpara> a callback to connect to the <parameter>combo_box</parameter>'s "changed" signal
312
290
</simpara></listitem></varlistentry>
313
<varlistentry><term><parameter>data</parameter> :</term>
291
<varlistentry><term><parameter>data</parameter> :</term>
314
292
<listitem><simpara> a pointer passed as data to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>
315
293
</simpara></listitem></varlistentry>
316
<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>
294
<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>
318
296
</simpara></listitem></varlistentry>
319
</variablelist><para role="since">Since GIMP 2.2
297
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
321
298
<refsect2 id="gimp-int-combo-box-set-sensitivity" role="function" condition="since:GIMP 2.4">
322
299
<title>gimp_int_combo_box_set_sensitivity ()</title>
323
<indexterm zone="gimp-int-combo-box-set-sensitivity" role="GIMP 2.4"><primary>gimp_int_combo_box_set_sensitivity</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_combo_box_set_sensitivity (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
300
<indexterm zone="gimp-int-combo-box-set-sensitivity" role="GIMP 2.4"><primary sortas="gimp_int_combo_box_set_sensitivity">gimp_int_combo_box_set_sensitivity</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_combo_box_set_sensitivity (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
324
301
<link linkend="GimpIntSensitivityFunc">GimpIntSensitivityFunc</link> func,
325
302
<link linkend="gpointer">gpointer</link> data,
326
303
<link linkend="GDestroyNotify">GDestroyNotify</link> destroy);</programlisting>
333
310
Calling <link linkend="gtk-widget-queue-draw"><function>gtk_widget_queue_draw()</function></link> on the <parameter>combo_box</parameter> will cause the
334
311
sensitivity to be updated.</para>
337
313
</para><variablelist role="params">
338
<varlistentry><term><parameter>combo_box</parameter> :</term>
314
<varlistentry><term><parameter>combo_box</parameter> :</term>
339
315
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
340
316
</simpara></listitem></varlistentry>
341
<varlistentry><term><parameter>func</parameter> :</term>
342
<listitem><simpara> a function that returns a boolean value, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset
317
<varlistentry><term><parameter>func</parameter> :</term>
318
<listitem><simpara> a function that returns a boolean value, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to unset
343
319
</simpara></listitem></varlistentry>
344
<varlistentry><term><parameter>data</parameter> :</term>
320
<varlistentry><term><parameter>data</parameter> :</term>
345
321
<listitem><simpara> data to pass to <parameter>func</parameter>
346
322
</simpara></listitem></varlistentry>
347
<varlistentry><term><parameter>destroy</parameter> :</term>
323
<varlistentry><term><parameter>destroy</parameter> :</term>
348
324
<listitem><simpara> destroy notification for <parameter>data</parameter>
349
325
</simpara></listitem></varlistentry>
350
</variablelist><para role="since">Since GIMP 2.4
326
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
354
329
<refsect1 id="GimpIntComboBox.property-details" role="property_details">
355
330
<title role="property_details.title">Property Details</title>
356
<refsect2 id="GimpIntComboBox--ellipsize"><title>The <literal>"ellipsize"</literal> property</title>
357
<indexterm zone="GimpIntComboBox--ellipsize" role="GIMP 2.4"><primary>GimpIntComboBox:ellipsize</primary></indexterm><programlisting> "ellipsize" <link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link> : Read / Write</programlisting>
331
<refsect2 id="GimpIntComboBox--ellipsize" role="property"><title>The <literal>"ellipsize"</literal> property</title>
332
<indexterm zone="GimpIntComboBox--ellipsize" role="GIMP 2.4"><primary sortas="GimpIntComboBox:ellipsize">GimpIntComboBox:ellipsize</primary></indexterm><programlisting> "ellipsize" <link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link> : Read / Write</programlisting>
359
334
Specifies the preferred place to ellipsize text in the combo-box,
360
335
if the cell renderer does not have enough room to display the
361
336
entire string.</para>
364
338
</para><para>Default value: PANGO_ELLIPSIZE_NONE</para>
339
<para>Since GIMP 2.4</para>