← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpquerybox.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpquerybox.xml
12
12
<refnamediv>
13
13
<refname>GimpQueryBox</refname>
14
14
<refpurpose>Some simple dialogs to enter a single int, double, string or boolean value.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="libgimpwidgets-GimpQueryBox.synopsis" role="synopsis">
35
34
<link linkend="void">void</link>                (<link linkend="GimpQueryBooleanCallback">*GimpQueryBooleanCallback</link>)         (<link linkend="GtkWidget">GtkWidget</link> *query_box,
36
35
                                                         <link linkend="gboolean">gboolean</link> value,
37
36
                                                         <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,
 
37
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-query-string-box">gimp_query_string_box</link>               (const <link linkend="gchar">gchar</link> *title,
39
38
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
40
39
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
41
40
                                                         const <link linkend="gchar">gchar</link> *help_id,
45
44
                                                         const <link linkend="gchar">gchar</link> *signal,
46
45
                                                         <link linkend="GimpQueryStringCallback">GimpQueryStringCallback</link> callback,
47
46
                                                         <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,
 
47
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-query-int-box">gimp_query_int_box</link>                  (const <link linkend="gchar">gchar</link> *title,
49
48
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
50
49
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
51
50
                                                         const <link linkend="gchar">gchar</link> *help_id,
57
56
                                                         const <link linkend="gchar">gchar</link> *signal,
58
57
                                                         <link linkend="GimpQueryIntCallback">GimpQueryIntCallback</link> callback,
59
58
                                                         <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,
 
59
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-query-double-box">gimp_query_double_box</link>               (const <link linkend="gchar">gchar</link> *title,
61
60
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
62
61
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
63
62
                                                         const <link linkend="gchar">gchar</link> *help_id,
70
69
                                                         const <link linkend="gchar">gchar</link> *signal,
71
70
                                                         <link linkend="GimpQueryDoubleCallback">GimpQueryDoubleCallback</link> callback,
72
71
                                                         <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,
 
72
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-query-size-box">gimp_query_size_box</link>                 (const <link linkend="gchar">gchar</link> *title,
74
73
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
75
74
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
76
75
                                                         const <link linkend="gchar">gchar</link> *help_id,
86
85
                                                         const <link linkend="gchar">gchar</link> *signal,
87
86
                                                         <link linkend="GimpQuerySizeCallback">GimpQuerySizeCallback</link> callback,
88
87
                                                         <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,
 
88
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-query-boolean-box">gimp_query_boolean_box</link>              (const <link linkend="gchar">gchar</link> *title,
90
89
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
91
90
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
92
91
                                                         const <link linkend="gchar">gchar</link> *help_id,
98
97
                                                         const <link linkend="gchar">gchar</link> *signal,
99
98
                                                         <link linkend="GimpQueryBooleanCallback">GimpQueryBooleanCallback</link> callback,
100
99
                                                         <link linkend="gpointer">gpointer</link> data);
101
 
#define             <link linkend="GIMP-QUERY-BOX-VBOX:CAPS">GIMP_QUERY_BOX_VBOX</link>                 (qbox)
 
100
#define             <link linkend="GIMP-QUERY-BOX-VBOX--CAPS">GIMP_QUERY_BOX_VBOX</link>                 (qbox)
102
101
</synopsis>
103
102
</refsynopsisdiv>
104
103
 
132
131
<title role="details.title">Details</title>
133
132
<refsect2 id="GimpQueryStringCallback" role="function">
134
133
<title>GimpQueryStringCallback ()</title>
135
 
<indexterm zone="GimpQueryStringCallback"><primary>GimpQueryStringCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQueryStringCallback)          (<link linkend="GtkWidget">GtkWidget</link> *query_box,
 
134
<indexterm zone="GimpQueryStringCallback"><primary sortas="GimpQueryStringCallback">GimpQueryStringCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQueryStringCallback)          (<link linkend="GtkWidget">GtkWidget</link> *query_box,
136
135
                                                         const <link linkend="gchar">gchar</link> *string,
137
136
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
138
137
<para>
139
138
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.
140
139
</para><variablelist role="params">
141
 
<varlistentry><term><parameter>query_box</parameter>&nbsp;:</term>
 
140
<varlistentry><term><parameter>query_box</parameter>&#160;:</term>
142
141
<listitem><simpara>The query box.
143
142
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>string</parameter>&nbsp;:</term>
 
143
<varlistentry><term><parameter>string</parameter>&#160;:</term>
145
144
<listitem><simpara>The entered string.
146
145
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
146
<varlistentry><term><parameter>data</parameter>&#160;:</term>
148
147
<listitem><simpara>The user data.
149
 
 
150
 
 
151
148
</simpara></listitem></varlistentry>
152
149
</variablelist></refsect2>
153
150
<refsect2 id="GimpQueryIntCallback" role="function">
154
151
<title>GimpQueryIntCallback ()</title>
155
 
<indexterm zone="GimpQueryIntCallback"><primary>GimpQueryIntCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQueryIntCallback)             (<link linkend="GtkWidget">GtkWidget</link> *query_box,
 
152
<indexterm zone="GimpQueryIntCallback"><primary sortas="GimpQueryIntCallback">GimpQueryIntCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQueryIntCallback)             (<link linkend="GtkWidget">GtkWidget</link> *query_box,
156
153
                                                         <link linkend="gint">gint</link> value,
157
154
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
158
155
<para>
159
 
 
160
156
</para><variablelist role="params">
161
 
<varlistentry><term><parameter>query_box</parameter>&nbsp;:</term>
 
157
<varlistentry><term><parameter>query_box</parameter>&#160;:</term>
162
158
<listitem><simpara>The query box.
163
159
</simpara></listitem></varlistentry>
164
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
160
<varlistentry><term><parameter>value</parameter>&#160;:</term>
165
161
<listitem><simpara>The entered integer value.
166
162
</simpara></listitem></varlistentry>
167
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
163
<varlistentry><term><parameter>data</parameter>&#160;:</term>
168
164
<listitem><simpara>The user data.
169
 
 
170
 
 
171
165
</simpara></listitem></varlistentry>
172
166
</variablelist></refsect2>
173
167
<refsect2 id="GimpQueryDoubleCallback" role="function">
174
168
<title>GimpQueryDoubleCallback ()</title>
175
 
<indexterm zone="GimpQueryDoubleCallback"><primary>GimpQueryDoubleCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQueryDoubleCallback)          (<link linkend="GtkWidget">GtkWidget</link> *query_box,
 
169
<indexterm zone="GimpQueryDoubleCallback"><primary sortas="GimpQueryDoubleCallback">GimpQueryDoubleCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQueryDoubleCallback)          (<link linkend="GtkWidget">GtkWidget</link> *query_box,
176
170
                                                         <link linkend="gdouble">gdouble</link> value,
177
171
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
178
172
<para>
179
 
 
180
173
</para><variablelist role="params">
181
 
<varlistentry><term><parameter>query_box</parameter>&nbsp;:</term>
 
174
<varlistentry><term><parameter>query_box</parameter>&#160;:</term>
182
175
<listitem><simpara>The query box.
183
176
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
177
<varlistentry><term><parameter>value</parameter>&#160;:</term>
185
178
<listitem><simpara>The entered double value.
186
179
</simpara></listitem></varlistentry>
187
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
180
<varlistentry><term><parameter>data</parameter>&#160;:</term>
188
181
<listitem><simpara>The user data.
189
 
 
190
 
 
191
182
</simpara></listitem></varlistentry>
192
183
</variablelist></refsect2>
193
184
<refsect2 id="GimpQuerySizeCallback" role="function">
194
185
<title>GimpQuerySizeCallback ()</title>
195
 
<indexterm zone="GimpQuerySizeCallback"><primary>GimpQuerySizeCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQuerySizeCallback)            (<link linkend="GtkWidget">GtkWidget</link> *query_box,
 
186
<indexterm zone="GimpQuerySizeCallback"><primary sortas="GimpQuerySizeCallback">GimpQuerySizeCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQuerySizeCallback)            (<link linkend="GtkWidget">GtkWidget</link> *query_box,
196
187
                                                         <link linkend="gdouble">gdouble</link> size,
197
188
                                                         <link linkend="GimpUnit">GimpUnit</link> unit,
198
189
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
199
190
<para>
200
 
 
201
191
</para><variablelist role="params">
202
 
<varlistentry><term><parameter>query_box</parameter>&nbsp;:</term>
 
192
<varlistentry><term><parameter>query_box</parameter>&#160;:</term>
203
193
<listitem><simpara>The query box.
204
194
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>size</parameter>&nbsp;:</term>
 
195
<varlistentry><term><parameter>size</parameter>&#160;:</term>
206
196
<listitem><simpara>The entered size in pixels.
207
197
</simpara></listitem></varlistentry>
208
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
198
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
209
199
<listitem><simpara>The selected unit from the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
210
200
</simpara></listitem></varlistentry>
211
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
201
<varlistentry><term><parameter>data</parameter>&#160;:</term>
212
202
<listitem><simpara>The user data.
213
 
 
214
 
 
215
203
</simpara></listitem></varlistentry>
216
204
</variablelist></refsect2>
217
205
<refsect2 id="GimpQueryBooleanCallback" role="function">
218
206
<title>GimpQueryBooleanCallback ()</title>
219
 
<indexterm zone="GimpQueryBooleanCallback"><primary>GimpQueryBooleanCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQueryBooleanCallback)         (<link linkend="GtkWidget">GtkWidget</link> *query_box,
 
207
<indexterm zone="GimpQueryBooleanCallback"><primary sortas="GimpQueryBooleanCallback">GimpQueryBooleanCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpQueryBooleanCallback)         (<link linkend="GtkWidget">GtkWidget</link> *query_box,
220
208
                                                         <link linkend="gboolean">gboolean</link> value,
221
209
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
222
210
<para>
223
 
 
224
211
</para><variablelist role="params">
225
 
<varlistentry><term><parameter>query_box</parameter>&nbsp;:</term>
 
212
<varlistentry><term><parameter>query_box</parameter>&#160;:</term>
226
213
<listitem><simpara>The query box.
227
214
</simpara></listitem></varlistentry>
228
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
215
<varlistentry><term><parameter>value</parameter>&#160;:</term>
229
216
<listitem><simpara>The entered boolean value.
230
217
</simpara></listitem></varlistentry>
231
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
218
<varlistentry><term><parameter>data</parameter>&#160;:</term>
232
219
<listitem><simpara>The user data.
233
 
 
234
 
 
235
220
</simpara></listitem></varlistentry>
236
221
</variablelist></refsect2>
237
222
<refsect2 id="gimp-query-string-box" role="function">
238
223
<title>gimp_query_string_box ()</title>
239
 
<indexterm zone="gimp-query-string-box"><primary>gimp_query_string_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_query_string_box               (const <link linkend="gchar">gchar</link> *title,
 
224
<indexterm zone="gimp-query-string-box"><primary sortas="gimp_query_string_box">gimp_query_string_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_query_string_box               (const <link linkend="gchar">gchar</link> *title,
240
225
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
241
226
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
242
227
                                                         const <link linkend="gchar">gchar</link> *help_id,
249
234
<para>
250
235
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a string value.</para>
251
236
<para>
252
 
 
253
237
</para><variablelist role="params">
254
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
238
<varlistentry><term><parameter>title</parameter>&#160;:</term>
255
239
<listitem><simpara>     The query box dialog's title.
256
240
</simpara></listitem></varlistentry>
257
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
 
241
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
258
242
<listitem><simpara>    The dialog's parent widget.
259
243
</simpara></listitem></varlistentry>
260
 
<varlistentry><term><parameter>help_func</parameter>&nbsp;:</term>
 
244
<varlistentry><term><parameter>help_func</parameter>&#160;:</term>
261
245
<listitem><simpara> The help function to show this dialog's help page.
262
246
</simpara></listitem></varlistentry>
263
 
<varlistentry><term><parameter>help_id</parameter>&nbsp;:</term>
 
247
<varlistentry><term><parameter>help_id</parameter>&#160;:</term>
264
248
<listitem><simpara>   A string identifying this dialog's help page.
265
249
</simpara></listitem></varlistentry>
266
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
250
<varlistentry><term><parameter>message</parameter>&#160;:</term>
267
251
<listitem><simpara>   A string which will be shown above the dialog's entry widget.
268
252
</simpara></listitem></varlistentry>
269
 
<varlistentry><term><parameter>initial</parameter>&nbsp;:</term>
 
253
<varlistentry><term><parameter>initial</parameter>&#160;:</term>
270
254
<listitem><simpara>   The initial value.
271
255
</simpara></listitem></varlistentry>
272
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
 
256
<varlistentry><term><parameter>object</parameter>&#160;:</term>
273
257
<listitem><simpara>    The object this query box is associated with.
274
258
</simpara></listitem></varlistentry>
275
 
<varlistentry><term><parameter>signal</parameter>&nbsp;:</term>
 
259
<varlistentry><term><parameter>signal</parameter>&#160;:</term>
276
260
<listitem><simpara>    The object's signal which will cause the query box to be closed.
277
261
</simpara></listitem></varlistentry>
278
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
262
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
279
263
<listitem><simpara>  The function which will be called when the user selects "OK".
280
264
</simpara></listitem></varlistentry>
281
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
265
<varlistentry><term><parameter>data</parameter>&#160;:</term>
282
266
<listitem><simpara>      The callback's user data.
283
267
</simpara></listitem></varlistentry>
284
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
 
268
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
285
269
</simpara></listitem></varlistentry>
286
270
</variablelist></refsect2>
287
271
<refsect2 id="gimp-query-int-box" role="function">
288
272
<title>gimp_query_int_box ()</title>
289
 
<indexterm zone="gimp-query-int-box"><primary>gimp_query_int_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_query_int_box                  (const <link linkend="gchar">gchar</link> *title,
 
273
<indexterm zone="gimp-query-int-box"><primary sortas="gimp_query_int_box">gimp_query_int_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_query_int_box                  (const <link linkend="gchar">gchar</link> *title,
290
274
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
291
275
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
292
276
                                                         const <link linkend="gchar">gchar</link> *help_id,
301
285
<para>
302
286
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for an integer value.</para>
303
287
<para>
304
 
 
305
288
</para><variablelist role="params">
306
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
289
<varlistentry><term><parameter>title</parameter>&#160;:</term>
307
290
<listitem><simpara>     The query box dialog's title.
308
291
</simpara></listitem></varlistentry>
309
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
 
292
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
310
293
<listitem><simpara>    The dialog's parent widget.
311
294
</simpara></listitem></varlistentry>
312
 
<varlistentry><term><parameter>help_func</parameter>&nbsp;:</term>
 
295
<varlistentry><term><parameter>help_func</parameter>&#160;:</term>
313
296
<listitem><simpara> The help function to show this dialog's help page.
314
297
</simpara></listitem></varlistentry>
315
 
<varlistentry><term><parameter>help_id</parameter>&nbsp;:</term>
 
298
<varlistentry><term><parameter>help_id</parameter>&#160;:</term>
316
299
<listitem><simpara>   A string identifying this dialog's help page.
317
300
</simpara></listitem></varlistentry>
318
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
301
<varlistentry><term><parameter>message</parameter>&#160;:</term>
319
302
<listitem><simpara>   A string which will be shown above the dialog's entry widget.
320
303
</simpara></listitem></varlistentry>
321
 
<varlistentry><term><parameter>initial</parameter>&nbsp;:</term>
 
304
<varlistentry><term><parameter>initial</parameter>&#160;:</term>
322
305
<listitem><simpara>   The initial value.
323
306
</simpara></listitem></varlistentry>
324
 
<varlistentry><term><parameter>lower</parameter>&nbsp;:</term>
 
307
<varlistentry><term><parameter>lower</parameter>&#160;:</term>
325
308
<listitem><simpara>     The lower boundary of the range of possible values.
326
309
</simpara></listitem></varlistentry>
327
 
<varlistentry><term><parameter>upper</parameter>&nbsp;:</term>
 
310
<varlistentry><term><parameter>upper</parameter>&#160;:</term>
328
311
<listitem><simpara>     The upper boundray of the range of possible values.
329
312
</simpara></listitem></varlistentry>
330
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
 
313
<varlistentry><term><parameter>object</parameter>&#160;:</term>
331
314
<listitem><simpara>    The object this query box is associated with.
332
315
</simpara></listitem></varlistentry>
333
 
<varlistentry><term><parameter>signal</parameter>&nbsp;:</term>
 
316
<varlistentry><term><parameter>signal</parameter>&#160;:</term>
334
317
<listitem><simpara>    The object's signal which will cause the query box to be closed.
335
318
</simpara></listitem></varlistentry>
336
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
319
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
337
320
<listitem><simpara>  The function which will be called when the user selects "OK".
338
321
</simpara></listitem></varlistentry>
339
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
322
<varlistentry><term><parameter>data</parameter>&#160;:</term>
340
323
<listitem><simpara>      The callback's user data.
341
324
</simpara></listitem></varlistentry>
342
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
 
325
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
343
326
</simpara></listitem></varlistentry>
344
327
</variablelist></refsect2>
345
328
<refsect2 id="gimp-query-double-box" role="function">
346
329
<title>gimp_query_double_box ()</title>
347
 
<indexterm zone="gimp-query-double-box"><primary>gimp_query_double_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_query_double_box               (const <link linkend="gchar">gchar</link> *title,
 
330
<indexterm zone="gimp-query-double-box"><primary sortas="gimp_query_double_box">gimp_query_double_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_query_double_box               (const <link linkend="gchar">gchar</link> *title,
348
331
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
349
332
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
350
333
                                                         const <link linkend="gchar">gchar</link> *help_id,
360
343
<para>
361
344
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a double value.</para>
362
345
<para>
363
 
 
364
346
</para><variablelist role="params">
365
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
347
<varlistentry><term><parameter>title</parameter>&#160;:</term>
366
348
<listitem><simpara>     The query box dialog's title.
367
349
</simpara></listitem></varlistentry>
368
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
 
350
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
369
351
<listitem><simpara>    The dialog's parent widget.
370
352
</simpara></listitem></varlistentry>
371
 
<varlistentry><term><parameter>help_func</parameter>&nbsp;:</term>
 
353
<varlistentry><term><parameter>help_func</parameter>&#160;:</term>
372
354
<listitem><simpara> The help function to show this dialog's help page.
373
355
</simpara></listitem></varlistentry>
374
 
<varlistentry><term><parameter>help_id</parameter>&nbsp;:</term>
 
356
<varlistentry><term><parameter>help_id</parameter>&#160;:</term>
375
357
<listitem><simpara>   A string identifying this dialog's help page.
376
358
</simpara></listitem></varlistentry>
377
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
359
<varlistentry><term><parameter>message</parameter>&#160;:</term>
378
360
<listitem><simpara>   A string which will be shown above the dialog's entry widget.
379
361
</simpara></listitem></varlistentry>
380
 
<varlistentry><term><parameter>initial</parameter>&nbsp;:</term>
 
362
<varlistentry><term><parameter>initial</parameter>&#160;:</term>
381
363
<listitem><simpara>   The initial value.
382
364
</simpara></listitem></varlistentry>
383
 
<varlistentry><term><parameter>lower</parameter>&nbsp;:</term>
 
365
<varlistentry><term><parameter>lower</parameter>&#160;:</term>
384
366
<listitem><simpara>     The lower boundary of the range of possible values.
385
367
</simpara></listitem></varlistentry>
386
 
<varlistentry><term><parameter>upper</parameter>&nbsp;:</term>
 
368
<varlistentry><term><parameter>upper</parameter>&#160;:</term>
387
369
<listitem><simpara>     The upper boundray of the range of possible values.
388
370
</simpara></listitem></varlistentry>
389
 
<varlistentry><term><parameter>digits</parameter>&nbsp;:</term>
 
371
<varlistentry><term><parameter>digits</parameter>&#160;:</term>
390
372
<listitem><simpara>    The number of decimal digits the <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> will provide.
391
373
</simpara></listitem></varlistentry>
392
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
 
374
<varlistentry><term><parameter>object</parameter>&#160;:</term>
393
375
<listitem><simpara>    The object this query box is associated with.
394
376
</simpara></listitem></varlistentry>
395
 
<varlistentry><term><parameter>signal</parameter>&nbsp;:</term>
 
377
<varlistentry><term><parameter>signal</parameter>&#160;:</term>
396
378
<listitem><simpara>    The object's signal which will cause the query box to be closed.
397
379
</simpara></listitem></varlistentry>
398
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
380
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
399
381
<listitem><simpara>  The function which will be called when the user selects "OK".
400
382
</simpara></listitem></varlistentry>
401
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
383
<varlistentry><term><parameter>data</parameter>&#160;:</term>
402
384
<listitem><simpara>      The callback's user data.
403
385
</simpara></listitem></varlistentry>
404
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
 
386
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
405
387
</simpara></listitem></varlistentry>
406
388
</variablelist></refsect2>
407
389
<refsect2 id="gimp-query-size-box" role="function">
408
390
<title>gimp_query_size_box ()</title>
409
 
<indexterm zone="gimp-query-size-box"><primary>gimp_query_size_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_query_size_box                 (const <link linkend="gchar">gchar</link> *title,
 
391
<indexterm zone="gimp-query-size-box"><primary sortas="gimp_query_size_box">gimp_query_size_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_query_size_box                 (const <link linkend="gchar">gchar</link> *title,
410
392
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
411
393
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
412
394
                                                         const <link linkend="gchar">gchar</link> *help_id,
426
408
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a size using a
427
409
<link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.</para>
428
410
<para>
429
 
 
430
411
</para><variablelist role="params">
431
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
412
<varlistentry><term><parameter>title</parameter>&#160;:</term>
432
413
<listitem><simpara>       The query box dialog's title.
433
414
</simpara></listitem></varlistentry>
434
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
 
415
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
435
416
<listitem><simpara>      The dialog's parent widget.
436
417
</simpara></listitem></varlistentry>
437
 
<varlistentry><term><parameter>help_func</parameter>&nbsp;:</term>
 
418
<varlistentry><term><parameter>help_func</parameter>&#160;:</term>
438
419
<listitem><simpara>   The help function to show this dialog's help page.
439
420
</simpara></listitem></varlistentry>
440
 
<varlistentry><term><parameter>help_id</parameter>&nbsp;:</term>
 
421
<varlistentry><term><parameter>help_id</parameter>&#160;:</term>
441
422
<listitem><simpara>     A string identifying this dialog's help page.
442
423
</simpara></listitem></varlistentry>
443
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
424
<varlistentry><term><parameter>message</parameter>&#160;:</term>
444
425
<listitem><simpara>     A string which will be shown above the dialog's entry widget.
445
426
</simpara></listitem></varlistentry>
446
 
<varlistentry><term><parameter>initial</parameter>&nbsp;:</term>
 
427
<varlistentry><term><parameter>initial</parameter>&#160;:</term>
447
428
<listitem><simpara>     The initial value.
448
429
</simpara></listitem></varlistentry>
449
 
<varlistentry><term><parameter>lower</parameter>&nbsp;:</term>
 
430
<varlistentry><term><parameter>lower</parameter>&#160;:</term>
450
431
<listitem><simpara>       The lower boundary of the range of possible values.
451
432
</simpara></listitem></varlistentry>
452
 
<varlistentry><term><parameter>upper</parameter>&nbsp;:</term>
 
433
<varlistentry><term><parameter>upper</parameter>&#160;:</term>
453
434
<listitem><simpara>       The upper boundray of the range of possible values.
454
435
</simpara></listitem></varlistentry>
455
 
<varlistentry><term><parameter>digits</parameter>&nbsp;:</term>
 
436
<varlistentry><term><parameter>digits</parameter>&#160;:</term>
456
437
<listitem><simpara>      The number of decimal digits the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> provide in
457
438
              "pixel" mode.
458
439
</simpara></listitem></varlistentry>
459
 
<varlistentry><term><parameter>unit</parameter>&nbsp;:</term>
 
440
<varlistentry><term><parameter>unit</parameter>&#160;:</term>
460
441
<listitem><simpara>        The unit initially shown by the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
461
442
</simpara></listitem></varlistentry>
462
 
<varlistentry><term><parameter>resolution</parameter>&nbsp;:</term>
 
443
<varlistentry><term><parameter>resolution</parameter>&#160;:</term>
463
444
<listitem><simpara>  The resolution (in dpi) which will be used for pixel/unit
464
445
              calculations.
465
446
</simpara></listitem></varlistentry>
466
 
<varlistentry><term><parameter>dot_for_dot</parameter>&nbsp;:</term>
467
 
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>'s initial unit should be "pixels".
 
447
<varlistentry><term><parameter>dot_for_dot</parameter>&#160;:</term>
 
448
<listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>'s initial unit should be "pixels".
468
449
</simpara></listitem></varlistentry>
469
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
 
450
<varlistentry><term><parameter>object</parameter>&#160;:</term>
470
451
<listitem><simpara>      The object this query box is associated with.
471
452
</simpara></listitem></varlistentry>
472
 
<varlistentry><term><parameter>signal</parameter>&nbsp;:</term>
 
453
<varlistentry><term><parameter>signal</parameter>&#160;:</term>
473
454
<listitem><simpara>      The object's signal which will cause the query box
474
455
              to be closed.
475
456
</simpara></listitem></varlistentry>
476
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
457
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
477
458
<listitem><simpara>    The function which will be called when the user selects "OK".
478
459
</simpara></listitem></varlistentry>
479
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
460
<varlistentry><term><parameter>data</parameter>&#160;:</term>
480
461
<listitem><simpara>        The callback's user data.
481
462
</simpara></listitem></varlistentry>
482
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
 
463
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
483
464
</simpara></listitem></varlistentry>
484
465
</variablelist></refsect2>
485
466
<refsect2 id="gimp-query-boolean-box" role="function">
486
467
<title>gimp_query_boolean_box ()</title>
487
 
<indexterm zone="gimp-query-boolean-box"><primary>gimp_query_boolean_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_query_boolean_box              (const <link linkend="gchar">gchar</link> *title,
 
468
<indexterm zone="gimp-query-boolean-box"><primary sortas="gimp_query_boolean_box">gimp_query_boolean_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_query_boolean_box              (const <link linkend="gchar">gchar</link> *title,
488
469
                                                         <link linkend="GtkWidget">GtkWidget</link> *parent,
489
470
                                                         <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
490
471
                                                         const <link linkend="gchar">gchar</link> *help_id,
499
480
<para>
500
481
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that asks the user to do a boolean decision.</para>
501
482
<para>
502
 
 
503
483
</para><variablelist role="params">
504
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
484
<varlistentry><term><parameter>title</parameter>&#160;:</term>
505
485
<listitem><simpara>        The query box dialog's title.
506
486
</simpara></listitem></varlistentry>
507
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
 
487
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
508
488
<listitem><simpara>       The dialog's parent widget.
509
489
</simpara></listitem></varlistentry>
510
 
<varlistentry><term><parameter>help_func</parameter>&nbsp;:</term>
 
490
<varlistentry><term><parameter>help_func</parameter>&#160;:</term>
511
491
<listitem><simpara>    The help function to show this dialog's help page.
512
492
</simpara></listitem></varlistentry>
513
 
<varlistentry><term><parameter>help_id</parameter>&nbsp;:</term>
 
493
<varlistentry><term><parameter>help_id</parameter>&#160;:</term>
514
494
<listitem><simpara>      A string identifying this dialog's help page.
515
495
</simpara></listitem></varlistentry>
516
 
<varlistentry><term><parameter>stock_id</parameter>&nbsp;:</term>
 
496
<varlistentry><term><parameter>stock_id</parameter>&#160;:</term>
517
497
<listitem><simpara>     A stock_id to specify an icon to appear on the left
518
498
               on the dialog's message.
519
499
</simpara></listitem></varlistentry>
520
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
500
<varlistentry><term><parameter>message</parameter>&#160;:</term>
521
501
<listitem><simpara>      A string which will be shown in the query box.
522
502
</simpara></listitem></varlistentry>
523
 
<varlistentry><term><parameter>true_button</parameter>&nbsp;:</term>
 
503
<varlistentry><term><parameter>true_button</parameter>&#160;:</term>
524
504
<listitem><simpara>  The string to be shown in the dialog's left button.
525
505
</simpara></listitem></varlistentry>
526
 
<varlistentry><term><parameter>false_button</parameter>&nbsp;:</term>
 
506
<varlistentry><term><parameter>false_button</parameter>&#160;:</term>
527
507
<listitem><simpara> The string to be shown in the dialog's right button.
528
508
</simpara></listitem></varlistentry>
529
 
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
 
509
<varlistentry><term><parameter>object</parameter>&#160;:</term>
530
510
<listitem><simpara>       The object this query box is associated with.
531
511
</simpara></listitem></varlistentry>
532
 
<varlistentry><term><parameter>signal</parameter>&nbsp;:</term>
 
512
<varlistentry><term><parameter>signal</parameter>&#160;:</term>
533
513
<listitem><simpara>       The object's signal which will cause the query box
534
514
               to be closed.
535
515
</simpara></listitem></varlistentry>
536
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
516
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
537
517
<listitem><simpara>     The function which will be called when the user clicks one
538
518
               of the buttons.
539
519
</simpara></listitem></varlistentry>
540
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
520
<varlistentry><term><parameter>data</parameter>&#160;:</term>
541
521
<listitem><simpara>         The callback's user data.
542
522
</simpara></listitem></varlistentry>
543
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
 
523
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
544
524
</simpara></listitem></varlistentry>
545
525
</variablelist></refsect2>
546
 
<refsect2 id="GIMP-QUERY-BOX-VBOX:CAPS" role="macro">
 
526
<refsect2 id="GIMP-QUERY-BOX-VBOX--CAPS" role="macro">
547
527
<title>GIMP_QUERY_BOX_VBOX()</title>
548
 
<indexterm zone="GIMP-QUERY-BOX-VBOX:CAPS"><primary>GIMP_QUERY_BOX_VBOX</primary></indexterm><programlisting>#define             GIMP_QUERY_BOX_VBOX(qbox)</programlisting>
 
528
<indexterm zone="GIMP-QUERY-BOX-VBOX--CAPS"><primary sortas="GIMP_QUERY_BOX_VBOX">GIMP_QUERY_BOX_VBOX</primary></indexterm><programlisting>#define             GIMP_QUERY_BOX_VBOX(qbox)</programlisting>
549
529
<para>
550
530
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
551
531
more widgets.
552
532
</para><variablelist role="params">
553
 
<varlistentry><term><parameter>qbox</parameter>&nbsp;:</term>
 
533
<varlistentry><term><parameter>qbox</parameter>&#160;:</term>
554
534
<listitem><simpara>
555
 
 
556
 
 
557
535
</simpara></listitem></varlistentry>
558
536
</variablelist></refsect2>
559
537