1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="libgimpwidgets-GimpQueryBox">
7
<refentrytitle>GimpQueryBox</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
13
<refname>GimpQueryBox</refname><refpurpose>Some simple dialogs to enter a single int, double, string or boolean value.</refpurpose>
16
<refsynopsisdiv><title>Synopsis</title>
22
<link linkend="void">void</link> (<link linkend="GimpQueryStringCallback">*GimpQueryStringCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
23
const <link linkend="gchar">gchar</link> *string,
24
<link linkend="gpointer">gpointer</link> data);
25
<link linkend="void">void</link> (<link linkend="GimpQueryIntCallback">*GimpQueryIntCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
26
<link linkend="gint">gint</link> value,
27
<link linkend="gpointer">gpointer</link> data);
28
<link linkend="void">void</link> (<link linkend="GimpQueryDoubleCallback">*GimpQueryDoubleCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
29
<link linkend="gdouble">gdouble</link> value,
30
<link linkend="gpointer">gpointer</link> data);
31
<link linkend="void">void</link> (<link linkend="GimpQuerySizeCallback">*GimpQuerySizeCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
32
<link linkend="gdouble">gdouble</link> size,
33
<link linkend="GimpUnit">GimpUnit</link> unit,
34
<link linkend="gpointer">gpointer</link> data);
35
<link linkend="void">void</link> (<link linkend="GimpQueryBooleanCallback">*GimpQueryBooleanCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
36
<link linkend="gboolean">gboolean</link> value,
37
<link linkend="gpointer">gpointer</link> data);
38
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-string-box">gimp_query_string_box</link> (const <link linkend="gchar">gchar</link> *title,
39
<link linkend="GtkWidget">GtkWidget</link> *parent,
40
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
41
const <link linkend="gchar">gchar</link> *help_id,
42
const <link linkend="gchar">gchar</link> *message,
43
const <link linkend="gchar">gchar</link> *initial,
44
<link linkend="GObject">GObject</link> *object,
45
const <link linkend="gchar">gchar</link> *signal,
46
<link linkend="GimpQueryStringCallback">GimpQueryStringCallback</link> callback,
47
<link linkend="gpointer">gpointer</link> data);
48
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-int-box">gimp_query_int_box</link> (const <link linkend="gchar">gchar</link> *title,
49
<link linkend="GtkWidget">GtkWidget</link> *parent,
50
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
51
const <link linkend="gchar">gchar</link> *help_id,
52
const <link linkend="gchar">gchar</link> *message,
53
<link linkend="gint">gint</link> initial,
54
<link linkend="gint">gint</link> lower,
55
<link linkend="gint">gint</link> upper,
56
<link linkend="GObject">GObject</link> *object,
57
const <link linkend="gchar">gchar</link> *signal,
58
<link linkend="GimpQueryIntCallback">GimpQueryIntCallback</link> callback,
59
<link linkend="gpointer">gpointer</link> data);
60
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-double-box">gimp_query_double_box</link> (const <link linkend="gchar">gchar</link> *title,
61
<link linkend="GtkWidget">GtkWidget</link> *parent,
62
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
63
const <link linkend="gchar">gchar</link> *help_id,
64
const <link linkend="gchar">gchar</link> *message,
65
<link linkend="gdouble">gdouble</link> initial,
66
<link linkend="gdouble">gdouble</link> lower,
67
<link linkend="gdouble">gdouble</link> upper,
68
<link linkend="gint">gint</link> digits,
69
<link linkend="GObject">GObject</link> *object,
70
const <link linkend="gchar">gchar</link> *signal,
71
<link linkend="GimpQueryDoubleCallback">GimpQueryDoubleCallback</link> callback,
72
<link linkend="gpointer">gpointer</link> data);
73
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-size-box">gimp_query_size_box</link> (const <link linkend="gchar">gchar</link> *title,
74
<link linkend="GtkWidget">GtkWidget</link> *parent,
75
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
76
const <link linkend="gchar">gchar</link> *help_id,
77
const <link linkend="gchar">gchar</link> *message,
78
<link linkend="gdouble">gdouble</link> initial,
79
<link linkend="gdouble">gdouble</link> lower,
80
<link linkend="gdouble">gdouble</link> upper,
81
<link linkend="gint">gint</link> digits,
82
<link linkend="GimpUnit">GimpUnit</link> unit,
83
<link linkend="gdouble">gdouble</link> resolution,
84
<link linkend="gboolean">gboolean</link> dot_for_dot,
85
<link linkend="GObject">GObject</link> *object,
86
const <link linkend="gchar">gchar</link> *signal,
87
<link linkend="GimpQuerySizeCallback">GimpQuerySizeCallback</link> callback,
88
<link linkend="gpointer">gpointer</link> data);
89
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-boolean-box">gimp_query_boolean_box</link> (const <link linkend="gchar">gchar</link> *title,
90
<link linkend="GtkWidget">GtkWidget</link> *parent,
91
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
92
const <link linkend="gchar">gchar</link> *help_id,
93
const <link linkend="gchar">gchar</link> *stock_id,
94
const <link linkend="gchar">gchar</link> *message,
95
const <link linkend="gchar">gchar</link> *true_button,
96
const <link linkend="gchar">gchar</link> *false_button,
97
<link linkend="GObject">GObject</link> *object,
98
const <link linkend="gchar">gchar</link> *signal,
99
<link linkend="GimpQueryBooleanCallback">GimpQueryBooleanCallback</link> callback,
100
<link linkend="gpointer">gpointer</link> data);
101
#define <link linkend="GIMP-QUERY-BOX-VBOX:CAPS">GIMP_QUERY_BOX_VBOX</link> (qbox)
114
<title>Description</title>
116
These functions provide simple dialogs for entering a single string,
117
integer, double, boolean or pixel size value.
120
They return a pointer to a <link linkend="GtkDialog"><type>GtkDialog</type></link> which has to be shown with
121
<link linkend="gtk-widget-show"><function>gtk_widget_show()</function></link> by the caller.
124
The dialogs contain an entry widget for the kind of value they ask for
125
and "OK" and "Cancel" buttons. On "Cancel", all query boxes except the
126
boolean one silently destroy themselves. On "OK" the user defined
127
callback function is called and returns the entered value.
132
<title>Details</title>
134
<title><anchor id="GimpQueryStringCallback"/>GimpQueryStringCallback ()</title>
135
<indexterm><primary>GimpQueryStringCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQueryStringCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
136
const <link linkend="gchar">gchar</link> *string,
137
<link linkend="gpointer">gpointer</link> data);</programlisting>
139
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.
140
</para><variablelist role="params">
141
<varlistentry><term><parameter>query_box</parameter> :</term>
142
<listitem><simpara>The query box.
143
</simpara></listitem></varlistentry>
144
<varlistentry><term><parameter>string</parameter> :</term>
145
<listitem><simpara>The entered string.
146
</simpara></listitem></varlistentry>
147
<varlistentry><term><parameter>data</parameter> :</term>
148
<listitem><simpara>The user data.
151
</simpara></listitem></varlistentry>
152
</variablelist></refsect2>
154
<title><anchor id="GimpQueryIntCallback"/>GimpQueryIntCallback ()</title>
155
<indexterm><primary>GimpQueryIntCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQueryIntCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
156
<link linkend="gint">gint</link> value,
157
<link linkend="gpointer">gpointer</link> data);</programlisting>
160
</para><variablelist role="params">
161
<varlistentry><term><parameter>query_box</parameter> :</term>
162
<listitem><simpara>The query box.
163
</simpara></listitem></varlistentry>
164
<varlistentry><term><parameter>value</parameter> :</term>
165
<listitem><simpara>The entered integer value.
166
</simpara></listitem></varlistentry>
167
<varlistentry><term><parameter>data</parameter> :</term>
168
<listitem><simpara>The user data.
171
</simpara></listitem></varlistentry>
172
</variablelist></refsect2>
174
<title><anchor id="GimpQueryDoubleCallback"/>GimpQueryDoubleCallback ()</title>
175
<indexterm><primary>GimpQueryDoubleCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQueryDoubleCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
176
<link linkend="gdouble">gdouble</link> value,
177
<link linkend="gpointer">gpointer</link> data);</programlisting>
180
</para><variablelist role="params">
181
<varlistentry><term><parameter>query_box</parameter> :</term>
182
<listitem><simpara>The query box.
183
</simpara></listitem></varlistentry>
184
<varlistentry><term><parameter>value</parameter> :</term>
185
<listitem><simpara>The entered double value.
186
</simpara></listitem></varlistentry>
187
<varlistentry><term><parameter>data</parameter> :</term>
188
<listitem><simpara>The user data.
191
</simpara></listitem></varlistentry>
192
</variablelist></refsect2>
194
<title><anchor id="GimpQuerySizeCallback"/>GimpQuerySizeCallback ()</title>
195
<indexterm><primary>GimpQuerySizeCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQuerySizeCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
196
<link linkend="gdouble">gdouble</link> size,
197
<link linkend="GimpUnit">GimpUnit</link> unit,
198
<link linkend="gpointer">gpointer</link> data);</programlisting>
201
</para><variablelist role="params">
202
<varlistentry><term><parameter>query_box</parameter> :</term>
203
<listitem><simpara>The query box.
204
</simpara></listitem></varlistentry>
205
<varlistentry><term><parameter>size</parameter> :</term>
206
<listitem><simpara>The entered size in pixels.
207
</simpara></listitem></varlistentry>
208
<varlistentry><term><parameter>unit</parameter> :</term>
209
<listitem><simpara>The selected unit from the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
210
</simpara></listitem></varlistentry>
211
<varlistentry><term><parameter>data</parameter> :</term>
212
<listitem><simpara>The user data.
215
</simpara></listitem></varlistentry>
216
</variablelist></refsect2>
218
<title><anchor id="GimpQueryBooleanCallback"/>GimpQueryBooleanCallback ()</title>
219
<indexterm><primary>GimpQueryBooleanCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQueryBooleanCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
220
<link linkend="gboolean">gboolean</link> value,
221
<link linkend="gpointer">gpointer</link> data);</programlisting>
224
</para><variablelist role="params">
225
<varlistentry><term><parameter>query_box</parameter> :</term>
226
<listitem><simpara>The query box.
227
</simpara></listitem></varlistentry>
228
<varlistentry><term><parameter>value</parameter> :</term>
229
<listitem><simpara>The entered boolean value.
230
</simpara></listitem></varlistentry>
231
<varlistentry><term><parameter>data</parameter> :</term>
232
<listitem><simpara>The user data.
235
</simpara></listitem></varlistentry>
236
</variablelist></refsect2>
238
<title><anchor id="gimp-query-string-box"/>gimp_query_string_box ()</title>
239
<indexterm><primary>gimp_query_string_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_string_box (const <link linkend="gchar">gchar</link> *title,
240
<link linkend="GtkWidget">GtkWidget</link> *parent,
241
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
242
const <link linkend="gchar">gchar</link> *help_id,
243
const <link linkend="gchar">gchar</link> *message,
244
const <link linkend="gchar">gchar</link> *initial,
245
<link linkend="GObject">GObject</link> *object,
246
const <link linkend="gchar">gchar</link> *signal,
247
<link linkend="GimpQueryStringCallback">GimpQueryStringCallback</link> callback,
248
<link linkend="gpointer">gpointer</link> data);</programlisting>
250
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a string value.</para>
253
</para><variablelist role="params">
254
<varlistentry><term><parameter>title</parameter> :</term>
255
<listitem><simpara> The query box dialog's title.
256
</simpara></listitem></varlistentry>
257
<varlistentry><term><parameter>parent</parameter> :</term>
258
<listitem><simpara> The dialog's parent widget.
259
</simpara></listitem></varlistentry>
260
<varlistentry><term><parameter>help_func</parameter> :</term>
261
<listitem><simpara> The help function to show this dialog's help page.
262
</simpara></listitem></varlistentry>
263
<varlistentry><term><parameter>help_id</parameter> :</term>
264
<listitem><simpara> A string identifying this dialog's help page.
265
</simpara></listitem></varlistentry>
266
<varlistentry><term><parameter>message</parameter> :</term>
267
<listitem><simpara> A string which will be shown above the dialog's entry widget.
268
</simpara></listitem></varlistentry>
269
<varlistentry><term><parameter>initial</parameter> :</term>
270
<listitem><simpara> The initial value.
271
</simpara></listitem></varlistentry>
272
<varlistentry><term><parameter>object</parameter> :</term>
273
<listitem><simpara> The object this query box is associated with.
274
</simpara></listitem></varlistentry>
275
<varlistentry><term><parameter>signal</parameter> :</term>
276
<listitem><simpara> The object's signal which will cause the query box to be closed.
277
</simpara></listitem></varlistentry>
278
<varlistentry><term><parameter>callback</parameter> :</term>
279
<listitem><simpara> The function which will be called when the user selects "OK".
280
</simpara></listitem></varlistentry>
281
<varlistentry><term><parameter>data</parameter> :</term>
282
<listitem><simpara> The callback's user data.
283
</simpara></listitem></varlistentry>
284
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
285
</simpara></listitem></varlistentry>
286
</variablelist></refsect2>
288
<title><anchor id="gimp-query-int-box"/>gimp_query_int_box ()</title>
289
<indexterm><primary>gimp_query_int_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_int_box (const <link linkend="gchar">gchar</link> *title,
290
<link linkend="GtkWidget">GtkWidget</link> *parent,
291
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
292
const <link linkend="gchar">gchar</link> *help_id,
293
const <link linkend="gchar">gchar</link> *message,
294
<link linkend="gint">gint</link> initial,
295
<link linkend="gint">gint</link> lower,
296
<link linkend="gint">gint</link> upper,
297
<link linkend="GObject">GObject</link> *object,
298
const <link linkend="gchar">gchar</link> *signal,
299
<link linkend="GimpQueryIntCallback">GimpQueryIntCallback</link> callback,
300
<link linkend="gpointer">gpointer</link> data);</programlisting>
302
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for an integer value.</para>
305
</para><variablelist role="params">
306
<varlistentry><term><parameter>title</parameter> :</term>
307
<listitem><simpara> The query box dialog's title.
308
</simpara></listitem></varlistentry>
309
<varlistentry><term><parameter>parent</parameter> :</term>
310
<listitem><simpara> The dialog's parent widget.
311
</simpara></listitem></varlistentry>
312
<varlistentry><term><parameter>help_func</parameter> :</term>
313
<listitem><simpara> The help function to show this dialog's help page.
314
</simpara></listitem></varlistentry>
315
<varlistentry><term><parameter>help_id</parameter> :</term>
316
<listitem><simpara> A string identifying this dialog's help page.
317
</simpara></listitem></varlistentry>
318
<varlistentry><term><parameter>message</parameter> :</term>
319
<listitem><simpara> A string which will be shown above the dialog's entry widget.
320
</simpara></listitem></varlistentry>
321
<varlistentry><term><parameter>initial</parameter> :</term>
322
<listitem><simpara> The initial value.
323
</simpara></listitem></varlistentry>
324
<varlistentry><term><parameter>lower</parameter> :</term>
325
<listitem><simpara> The lower boundary of the range of possible values.
326
</simpara></listitem></varlistentry>
327
<varlistentry><term><parameter>upper</parameter> :</term>
328
<listitem><simpara> The upper boundray of the range of possible values.
329
</simpara></listitem></varlistentry>
330
<varlistentry><term><parameter>object</parameter> :</term>
331
<listitem><simpara> The object this query box is associated with.
332
</simpara></listitem></varlistentry>
333
<varlistentry><term><parameter>signal</parameter> :</term>
334
<listitem><simpara> The object's signal which will cause the query box to be closed.
335
</simpara></listitem></varlistentry>
336
<varlistentry><term><parameter>callback</parameter> :</term>
337
<listitem><simpara> The function which will be called when the user selects "OK".
338
</simpara></listitem></varlistentry>
339
<varlistentry><term><parameter>data</parameter> :</term>
340
<listitem><simpara> The callback's user data.
341
</simpara></listitem></varlistentry>
342
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
343
</simpara></listitem></varlistentry>
344
</variablelist></refsect2>
346
<title><anchor id="gimp-query-double-box"/>gimp_query_double_box ()</title>
347
<indexterm><primary>gimp_query_double_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_double_box (const <link linkend="gchar">gchar</link> *title,
348
<link linkend="GtkWidget">GtkWidget</link> *parent,
349
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
350
const <link linkend="gchar">gchar</link> *help_id,
351
const <link linkend="gchar">gchar</link> *message,
352
<link linkend="gdouble">gdouble</link> initial,
353
<link linkend="gdouble">gdouble</link> lower,
354
<link linkend="gdouble">gdouble</link> upper,
355
<link linkend="gint">gint</link> digits,
356
<link linkend="GObject">GObject</link> *object,
357
const <link linkend="gchar">gchar</link> *signal,
358
<link linkend="GimpQueryDoubleCallback">GimpQueryDoubleCallback</link> callback,
359
<link linkend="gpointer">gpointer</link> data);</programlisting>
361
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a double value.</para>
364
</para><variablelist role="params">
365
<varlistentry><term><parameter>title</parameter> :</term>
366
<listitem><simpara> The query box dialog's title.
367
</simpara></listitem></varlistentry>
368
<varlistentry><term><parameter>parent</parameter> :</term>
369
<listitem><simpara> The dialog's parent widget.
370
</simpara></listitem></varlistentry>
371
<varlistentry><term><parameter>help_func</parameter> :</term>
372
<listitem><simpara> The help function to show this dialog's help page.
373
</simpara></listitem></varlistentry>
374
<varlistentry><term><parameter>help_id</parameter> :</term>
375
<listitem><simpara> A string identifying this dialog's help page.
376
</simpara></listitem></varlistentry>
377
<varlistentry><term><parameter>message</parameter> :</term>
378
<listitem><simpara> A string which will be shown above the dialog's entry widget.
379
</simpara></listitem></varlistentry>
380
<varlistentry><term><parameter>initial</parameter> :</term>
381
<listitem><simpara> The initial value.
382
</simpara></listitem></varlistentry>
383
<varlistentry><term><parameter>lower</parameter> :</term>
384
<listitem><simpara> The lower boundary of the range of possible values.
385
</simpara></listitem></varlistentry>
386
<varlistentry><term><parameter>upper</parameter> :</term>
387
<listitem><simpara> The upper boundray of the range of possible values.
388
</simpara></listitem></varlistentry>
389
<varlistentry><term><parameter>digits</parameter> :</term>
390
<listitem><simpara> The number of decimal digits the <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> will provide.
391
</simpara></listitem></varlistentry>
392
<varlistentry><term><parameter>object</parameter> :</term>
393
<listitem><simpara> The object this query box is associated with.
394
</simpara></listitem></varlistentry>
395
<varlistentry><term><parameter>signal</parameter> :</term>
396
<listitem><simpara> The object's signal which will cause the query box to be closed.
397
</simpara></listitem></varlistentry>
398
<varlistentry><term><parameter>callback</parameter> :</term>
399
<listitem><simpara> The function which will be called when the user selects "OK".
400
</simpara></listitem></varlistentry>
401
<varlistentry><term><parameter>data</parameter> :</term>
402
<listitem><simpara> The callback's user data.
403
</simpara></listitem></varlistentry>
404
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
405
</simpara></listitem></varlistentry>
406
</variablelist></refsect2>
408
<title><anchor id="gimp-query-size-box"/>gimp_query_size_box ()</title>
409
<indexterm><primary>gimp_query_size_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_size_box (const <link linkend="gchar">gchar</link> *title,
410
<link linkend="GtkWidget">GtkWidget</link> *parent,
411
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
412
const <link linkend="gchar">gchar</link> *help_id,
413
const <link linkend="gchar">gchar</link> *message,
414
<link linkend="gdouble">gdouble</link> initial,
415
<link linkend="gdouble">gdouble</link> lower,
416
<link linkend="gdouble">gdouble</link> upper,
417
<link linkend="gint">gint</link> digits,
418
<link linkend="GimpUnit">GimpUnit</link> unit,
419
<link linkend="gdouble">gdouble</link> resolution,
420
<link linkend="gboolean">gboolean</link> dot_for_dot,
421
<link linkend="GObject">GObject</link> *object,
422
const <link linkend="gchar">gchar</link> *signal,
423
<link linkend="GimpQuerySizeCallback">GimpQuerySizeCallback</link> callback,
424
<link linkend="gpointer">gpointer</link> data);</programlisting>
426
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a size using a
427
<link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.</para>
430
</para><variablelist role="params">
431
<varlistentry><term><parameter>title</parameter> :</term>
432
<listitem><simpara> The query box dialog's title.
433
</simpara></listitem></varlistentry>
434
<varlistentry><term><parameter>parent</parameter> :</term>
435
<listitem><simpara> The dialog's parent widget.
436
</simpara></listitem></varlistentry>
437
<varlistentry><term><parameter>help_func</parameter> :</term>
438
<listitem><simpara> The help function to show this dialog's help page.
439
</simpara></listitem></varlistentry>
440
<varlistentry><term><parameter>help_id</parameter> :</term>
441
<listitem><simpara> A string identifying this dialog's help page.
442
</simpara></listitem></varlistentry>
443
<varlistentry><term><parameter>message</parameter> :</term>
444
<listitem><simpara> A string which will be shown above the dialog's entry widget.
445
</simpara></listitem></varlistentry>
446
<varlistentry><term><parameter>initial</parameter> :</term>
447
<listitem><simpara> The initial value.
448
</simpara></listitem></varlistentry>
449
<varlistentry><term><parameter>lower</parameter> :</term>
450
<listitem><simpara> The lower boundary of the range of possible values.
451
</simpara></listitem></varlistentry>
452
<varlistentry><term><parameter>upper</parameter> :</term>
453
<listitem><simpara> The upper boundray of the range of possible values.
454
</simpara></listitem></varlistentry>
455
<varlistentry><term><parameter>digits</parameter> :</term>
456
<listitem><simpara> The number of decimal digits the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> provide in
458
</simpara></listitem></varlistentry>
459
<varlistentry><term><parameter>unit</parameter> :</term>
460
<listitem><simpara> The unit initially shown by the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
461
</simpara></listitem></varlistentry>
462
<varlistentry><term><parameter>resolution</parameter> :</term>
463
<listitem><simpara> The resolution (in dpi) which will be used for pixel/unit
465
</simpara></listitem></varlistentry>
466
<varlistentry><term><parameter>dot_for_dot</parameter> :</term>
467
<listitem><simpara> <literal>TRUE</literal> if the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>'s initial unit should be "pixels".
468
</simpara></listitem></varlistentry>
469
<varlistentry><term><parameter>object</parameter> :</term>
470
<listitem><simpara> The object this query box is associated with.
471
</simpara></listitem></varlistentry>
472
<varlistentry><term><parameter>signal</parameter> :</term>
473
<listitem><simpara> The object's signal which will cause the query box
475
</simpara></listitem></varlistentry>
476
<varlistentry><term><parameter>callback</parameter> :</term>
477
<listitem><simpara> The function which will be called when the user selects "OK".
478
</simpara></listitem></varlistentry>
479
<varlistentry><term><parameter>data</parameter> :</term>
480
<listitem><simpara> The callback's user data.
481
</simpara></listitem></varlistentry>
482
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
483
</simpara></listitem></varlistentry>
484
</variablelist></refsect2>
486
<title><anchor id="gimp-query-boolean-box"/>gimp_query_boolean_box ()</title>
487
<indexterm><primary>gimp_query_boolean_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_boolean_box (const <link linkend="gchar">gchar</link> *title,
488
<link linkend="GtkWidget">GtkWidget</link> *parent,
489
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
490
const <link linkend="gchar">gchar</link> *help_id,
491
const <link linkend="gchar">gchar</link> *stock_id,
492
const <link linkend="gchar">gchar</link> *message,
493
const <link linkend="gchar">gchar</link> *true_button,
494
const <link linkend="gchar">gchar</link> *false_button,
495
<link linkend="GObject">GObject</link> *object,
496
const <link linkend="gchar">gchar</link> *signal,
497
<link linkend="GimpQueryBooleanCallback">GimpQueryBooleanCallback</link> callback,
498
<link linkend="gpointer">gpointer</link> data);</programlisting>
500
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that asks the user to do a boolean decision.</para>
503
</para><variablelist role="params">
504
<varlistentry><term><parameter>title</parameter> :</term>
505
<listitem><simpara> The query box dialog's title.
506
</simpara></listitem></varlistentry>
507
<varlistentry><term><parameter>parent</parameter> :</term>
508
<listitem><simpara> The dialog's parent widget.
509
</simpara></listitem></varlistentry>
510
<varlistentry><term><parameter>help_func</parameter> :</term>
511
<listitem><simpara> The help function to show this dialog's help page.
512
</simpara></listitem></varlistentry>
513
<varlistentry><term><parameter>help_id</parameter> :</term>
514
<listitem><simpara> A string identifying this dialog's help page.
515
</simpara></listitem></varlistentry>
516
<varlistentry><term><parameter>stock_id</parameter> :</term>
517
<listitem><simpara> A stock_id to specify an icon to appear on the left
518
on the dialog's message.
519
</simpara></listitem></varlistentry>
520
<varlistentry><term><parameter>message</parameter> :</term>
521
<listitem><simpara> A string which will be shown in the query box.
522
</simpara></listitem></varlistentry>
523
<varlistentry><term><parameter>true_button</parameter> :</term>
524
<listitem><simpara> The string to be shown in the dialog's left button.
525
</simpara></listitem></varlistentry>
526
<varlistentry><term><parameter>false_button</parameter> :</term>
527
<listitem><simpara> The string to be shown in the dialog's right button.
528
</simpara></listitem></varlistentry>
529
<varlistentry><term><parameter>object</parameter> :</term>
530
<listitem><simpara> The object this query box is associated with.
531
</simpara></listitem></varlistentry>
532
<varlistentry><term><parameter>signal</parameter> :</term>
533
<listitem><simpara> The object's signal which will cause the query box
535
</simpara></listitem></varlistentry>
536
<varlistentry><term><parameter>callback</parameter> :</term>
537
<listitem><simpara> The function which will be called when the user clicks one
539
</simpara></listitem></varlistentry>
540
<varlistentry><term><parameter>data</parameter> :</term>
541
<listitem><simpara> The callback's user data.
542
</simpara></listitem></varlistentry>
543
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
544
</simpara></listitem></varlistentry>
545
</variablelist></refsect2>
547
<title><anchor id="GIMP-QUERY-BOX-VBOX:CAPS"/>GIMP_QUERY_BOX_VBOX()</title>
548
<indexterm><primary>GIMP_QUERY_BOX_VBOX</primary></indexterm><programlisting>#define GIMP_QUERY_BOX_VBOX(qbox)</programlisting>
550
A macro to access the <link linkend="GtkVBox"><type>GtkVBox</type></link> in a <link linkend="GimpQueryBox"><type>GimpQueryBox</type></link>. Useful if you want to add
552
</para><variablelist role="params">
553
<varlistentry><term><parameter>qbox</parameter> :</term>
557
</simpara></listitem></varlistentry>
558
</variablelist></refsect2>
565
<title>See Also</title>
added
removed
devel-docs/libgimpwidgets/xml/gimpquerybox.xml
