~ubuntu-branches/ubuntu/karmic/gimp/karmic-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimpprogress.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2009-03-17 03:00:24 UTC
  • mfrom: (1.1.20 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317030024-gnp1dhd0hnt80f4h
Tags: 2.6.6-0ubuntu1
* New upstream release (LP: #344052)
* debian/patches/04_from_bugzilla_572403.patch:
  - Dropped, the fix is in the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
9
9
<link rel="prev" href="libgimp-gimpproceduraldb.html" title="gimpproceduraldb">
10
10
<link rel="next" href="libgimp-image.html" title="Manupulating Images and their Properties">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
14
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
32
32
<th width="100%" align="center">GIMP Library Reference Manual</th>
33
33
<td><a accesskey="n" href="libgimp-image.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
34
34
</tr>
35
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgimp-gimpprogress.synopsis" class="shortcut">Top</a>
36
 
                   | 
37
 
                  <a href="#libgimp-gimpprogress.description" class="shortcut">Description</a></nobr></td></tr>
 
35
<tr><td colspan="5" class="shortcuts">
 
36
<a href="#libgimp-gimpprogress.synopsis" class="shortcut">Top</a>
 
37
                 | 
 
38
                <a href="#libgimp-gimpprogress.description" class="shortcut">Description</a>
 
39
</td></tr>
38
40
</table>
39
41
<div class="refentry" lang="en">
40
42
<a name="libgimp-gimpprogress"></a><div class="titlepage"></div>
50
52
<pre class="synopsis">
51
53
                    <a class="link" href="libgimp-gimpprogress.html#GimpProgressVtable" title="GimpProgressVtable">GimpProgressVtable</a>;
52
54
<a
53
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
55
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
54
56
>gboolean</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()">gimp_progress_init</a>                  (const <a
55
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
57
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
56
58
>gchar</a> *message);
57
59
<a
58
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
60
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
59
61
>gboolean</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-init-printf" title="gimp_progress_init_printf ()">gimp_progress_init_printf</a>           (const <a
60
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
62
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
61
63
>gchar</a> *format,
62
64
                                                         ...);
63
65
<a
64
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
66
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
65
67
>gboolean</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-update" title="gimp_progress_update ()">gimp_progress_update</a>                (<a
66
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
 
68
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
67
69
>gdouble</a> percentage);
68
70
<a
69
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
71
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
70
72
>gboolean</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-pulse" title="gimp_progress_pulse ()">gimp_progress_pulse</a>                 (void);
71
73
<a
72
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
74
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
73
75
>gboolean</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-set-text" title="gimp_progress_set_text ()">gimp_progress_set_text</a>              (const <a
74
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
76
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
75
77
>gchar</a> *message);
76
78
<a
77
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
79
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
78
80
>gboolean</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-set-text-printf" title="gimp_progress_set_text_printf ()">gimp_progress_set_text_printf</a>       (const <a
79
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
81
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
80
82
>gchar</a> *format,
81
83
                                                         ...);
82
84
<a
83
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
85
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
84
86
>gboolean</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-end" title="gimp_progress_end ()">gimp_progress_end</a>                   (void);
85
87
<a
86
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
88
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
87
89
>gint</a>                <a class="link" href="libgimp-gimpprogress.html#gimp-progress-get-window-handle" title="gimp_progress_get_window_handle ()">gimp_progress_get_window_handle</a>     (void);
88
90
void                (<a class="link" href="libgimp-gimpprogress.html#GimpProgressStartCallback" title="GimpProgressStartCallback ()">*GimpProgressStartCallback</a>)        (const <a
89
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
91
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
90
92
>gchar</a> *message,
91
93
                                                         <a
92
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
94
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
93
95
>gboolean</a> cancelable,
94
96
                                                         <a
95
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
97
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
96
98
>gpointer</a> user_data);
97
99
void                (<a class="link" href="libgimp-gimpprogress.html#GimpProgressEndCallback" title="GimpProgressEndCallback ()">*GimpProgressEndCallback</a>)          (<a
98
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
100
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
99
101
>gpointer</a> user_data);
100
102
void                (<a class="link" href="libgimp-gimpprogress.html#GimpProgressTextCallback" title="GimpProgressTextCallback ()">*GimpProgressTextCallback</a>)         (const <a
101
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
103
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
102
104
>gchar</a> *message,
103
105
                                                         <a
104
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
106
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
105
107
>gpointer</a> user_data);
106
108
void                (<a class="link" href="libgimp-gimpprogress.html#GimpProgressValueCallback" title="GimpProgressValueCallback ()">*GimpProgressValueCallback</a>)        (<a
107
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
 
109
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
108
110
>gdouble</a> percentage,
109
111
                                                         <a
110
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
112
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
111
113
>gpointer</a> user_data);
112
114
const <a
113
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
114
 
>gchar</a>*        <a class="link" href="libgimp-gimpprogress.html#gimp-progress-install-vtable" title="gimp_progress_install_vtable ()">gimp_progress_install_vtable</a>        (const <a class="link" href="libgimp-gimpprogress.html#GimpProgressVtable" title="GimpProgressVtable">GimpProgressVtable</a> *vtable,
 
115
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
116
>gchar</a> *       <a class="link" href="libgimp-gimpprogress.html#gimp-progress-install-vtable" title="gimp_progress_install_vtable ()">gimp_progress_install_vtable</a>        (const <a class="link" href="libgimp-gimpprogress.html#GimpProgressVtable" title="GimpProgressVtable">GimpProgressVtable</a> *vtable,
115
117
                                                         <a
116
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
118
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
117
119
>gpointer</a> user_data);
118
120
const <a
119
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
120
 
>gchar</a>*        <a class="link" href="libgimp-gimpprogress.html#gimp-progress-install" title="gimp_progress_install ()">gimp_progress_install</a>               (<a class="link" href="libgimp-gimpprogress.html#GimpProgressStartCallback" title="GimpProgressStartCallback ()">GimpProgressStartCallback</a> start_callback,
 
121
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
122
>gchar</a> *       <a class="link" href="libgimp-gimpprogress.html#gimp-progress-install" title="gimp_progress_install ()">gimp_progress_install</a>               (<a class="link" href="libgimp-gimpprogress.html#GimpProgressStartCallback" title="GimpProgressStartCallback ()">GimpProgressStartCallback</a> start_callback,
121
123
                                                         <a class="link" href="libgimp-gimpprogress.html#GimpProgressEndCallback" title="GimpProgressEndCallback ()">GimpProgressEndCallback</a> end_callback,
122
124
                                                         <a class="link" href="libgimp-gimpprogress.html#GimpProgressTextCallback" title="GimpProgressTextCallback ()">GimpProgressTextCallback</a> text_callback,
123
125
                                                         <a class="link" href="libgimp-gimpprogress.html#GimpProgressValueCallback" title="GimpProgressValueCallback ()">GimpProgressValueCallback</a> value_callback,
124
126
                                                         <a
125
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
127
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
126
128
>gpointer</a> user_data);
127
129
<a
128
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
130
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
129
131
>gpointer</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-uninstall" title="gimp_progress_uninstall ()">gimp_progress_uninstall</a>             (const <a
130
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
132
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
131
133
>gchar</a> *progress_callback);
132
134
<a
133
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
135
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
134
136
>gboolean</a>            <a class="link" href="libgimp-gimpprogress.html#gimp-progress-cancel" title="gimp_progress_cancel ()">gimp_progress_cancel</a>                (const <a
135
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
137
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
136
138
>gchar</a> *progress_callback);
137
139
</pre>
138
140
</div>
171
173
} GimpProgressVtable;
172
174
</pre>
173
175
<p>
174
 
 
175
176
</p>
176
177
</div>
177
178
<hr>
178
179
<div class="refsect2" lang="en">
179
180
<a name="gimp-progress-init"></a><h3>gimp_progress_init ()</h3>
180
181
<pre class="programlisting"><a
181
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
182
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
182
183
>gboolean</a>            gimp_progress_init                  (const <a
183
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
184
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
184
185
>gchar</a> *message);</pre>
185
186
<p>
186
187
Initializes the progress bar for the current plug-in.
189
190
Initializes the progress bar for the current plug-in. It is only
190
191
valid to call this procedure from a plug-in.</p>
191
192
<p>
192
 
 
193
193
</p>
194
194
<div class="variablelist"><table border="0">
195
195
<col align="left" valign="top">
211
211
<div class="refsect2" lang="en">
212
212
<a name="gimp-progress-init-printf"></a><h3>gimp_progress_init_printf ()</h3>
213
213
<pre class="programlisting"><a
214
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
214
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
215
215
>gboolean</a>            gimp_progress_init_printf           (const <a
216
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
216
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
217
217
>gchar</a> *format,
218
218
                                                         ...);</pre>
219
219
<p>
223
223
Initializes the progress bar for the current plug-in. It is only
224
224
valid to call this procedure from a plug-in.</p>
225
225
<p>
226
 
 
227
226
</p>
228
227
<div class="variablelist"><table border="0">
229
228
<col align="left" valign="top">
241
240
<tr>
242
241
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
243
242
<td> <a
244
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
243
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
245
244
><code class="literal">TRUE</code></a> on success.
246
245
 
247
246
</td>
248
247
</tr>
249
248
</tbody>
250
249
</table></div>
251
 
<p class="since">Since  GIMP 2.4
252
 
</p>
 
250
<p class="since">Since GIMP 2.4</p>
253
251
</div>
254
252
<hr>
255
253
<div class="refsect2" lang="en">
256
254
<a name="gimp-progress-update"></a><h3>gimp_progress_update ()</h3>
257
255
<pre class="programlisting"><a
258
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
256
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
259
257
>gboolean</a>            gimp_progress_update                (<a
260
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
 
258
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
261
259
>gdouble</a> percentage);</pre>
262
260
<p>
263
261
Updates the progress bar for the current plug-in.</p>
264
262
<p>
265
 
 
266
263
</p>
267
264
<div class="variablelist"><table border="0">
268
265
<col align="left" valign="top">
284
281
<div class="refsect2" lang="en">
285
282
<a name="gimp-progress-pulse"></a><h3>gimp_progress_pulse ()</h3>
286
283
<pre class="programlisting"><a
287
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
284
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
288
285
>gboolean</a>            gimp_progress_pulse                 (void);</pre>
289
286
<p>
290
287
Pulses the progress bar for the current plug-in.
296
293
made. This usually causes the the progress bar to enter \"activity
297
294
mode\", where a block bounces back and forth.</p>
298
295
<p>
299
 
 
300
296
</p>
301
297
<div class="variablelist"><table border="0">
302
298
<col align="left" valign="top">
307
303
</td>
308
304
</tr></tbody>
309
305
</table></div>
310
 
<p class="since">Since  GIMP 2.4
311
 
</p>
 
306
<p class="since">Since GIMP 2.4</p>
312
307
</div>
313
308
<hr>
314
309
<div class="refsect2" lang="en">
315
310
<a name="gimp-progress-set-text"></a><h3>gimp_progress_set_text ()</h3>
316
311
<pre class="programlisting"><a
317
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
312
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
318
313
>gboolean</a>            gimp_progress_set_text              (const <a
319
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
314
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
320
315
>gchar</a> *message);</pre>
321
316
<p>
322
317
Changes the text in the progress bar for the current plug-in.
326
321
current plug-in. Unlike <a class="link" href="libgimp-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()"><code class="function">gimp_progress_init()</code></a> it does not change the
327
322
displayed value.</p>
328
323
<p>
329
 
 
330
324
</p>
331
325
<div class="variablelist"><table border="0">
332
326
<col align="left" valign="top">
344
338
</tr>
345
339
</tbody>
346
340
</table></div>
347
 
<p class="since">Since  GIMP 2.4
348
 
</p>
 
341
<p class="since">Since GIMP 2.4</p>
349
342
</div>
350
343
<hr>
351
344
<div class="refsect2" lang="en">
352
345
<a name="gimp-progress-set-text-printf"></a><h3>gimp_progress_set_text_printf ()</h3>
353
346
<pre class="programlisting"><a
354
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
347
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
355
348
>gboolean</a>            gimp_progress_set_text_printf       (const <a
356
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
349
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
357
350
>gchar</a> *format,
358
351
                                                         ...);</pre>
359
352
<p>
364
357
current plug-in. Unlike <a class="link" href="libgimp-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()"><code class="function">gimp_progress_init()</code></a> it does not change the
365
358
displayed value.</p>
366
359
<p>
367
 
 
368
360
</p>
369
361
<div class="variablelist"><table border="0">
370
362
<col align="left" valign="top">
382
374
<tr>
383
375
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
384
376
<td> <a
385
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
377
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
386
378
><code class="literal">TRUE</code></a> on success.
387
379
 
388
380
</td>
389
381
</tr>
390
382
</tbody>
391
383
</table></div>
392
 
<p class="since">Since  GIMP 2.4
393
 
</p>
 
384
<p class="since">Since GIMP 2.4</p>
394
385
</div>
395
386
<hr>
396
387
<div class="refsect2" lang="en">
397
388
<a name="gimp-progress-end"></a><h3>gimp_progress_end ()</h3>
398
389
<pre class="programlisting"><a
399
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
390
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
400
391
>gboolean</a>            gimp_progress_end                   (void);</pre>
401
392
<p>
402
393
Ends the progress bar for the current plug-in.
406
397
don't need to call this, they just exit when the work is done. It is
407
398
only valid to call this procedure from a plug-in.</p>
408
399
<p>
409
 
 
410
400
</p>
411
401
<div class="variablelist"><table border="0">
412
402
<col align="left" valign="top">
417
407
</td>
418
408
</tr></tbody>
419
409
</table></div>
420
 
<p class="since">Since  GIMP 2.4
421
 
</p>
 
410
<p class="since">Since GIMP 2.4</p>
422
411
</div>
423
412
<hr>
424
413
<div class="refsect2" lang="en">
425
414
<a name="gimp-progress-get-window-handle"></a><h3>gimp_progress_get_window_handle ()</h3>
426
415
<pre class="programlisting"><a
427
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
 
416
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
428
417
>gint</a>                gimp_progress_get_window_handle     (void);</pre>
429
418
<p>
430
419
Returns the native window ID of the toplevel window this plug-in's
434
423
This function returns the native window ID of the toplevel window
435
424
this plug-in\'s progress is displayed in.</p>
436
425
<p>
437
 
 
438
426
</p>
439
427
<div class="variablelist"><table border="0">
440
428
<col align="left" valign="top">
445
433
</td>
446
434
</tr></tbody>
447
435
</table></div>
448
 
<p class="since">Since  GIMP 2.2
449
 
</p>
 
436
<p class="since">Since GIMP 2.2</p>
450
437
</div>
451
438
<hr>
452
439
<div class="refsect2" lang="en">
453
440
<a name="GimpProgressStartCallback"></a><h3>GimpProgressStartCallback ()</h3>
454
441
<pre class="programlisting">void                (*GimpProgressStartCallback)        (const <a
455
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
442
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
456
443
>gchar</a> *message,
457
444
                                                         <a
458
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
445
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
459
446
>gboolean</a> cancelable,
460
447
                                                         <a
461
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
448
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
462
449
>gpointer</a> user_data);</pre>
463
450
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
464
451
<h3 class="title">Warning</h3>
465
452
<p><code class="literal">GimpProgressStartCallback</code> is deprecated and should not be used in newly-written code.</p>
466
453
</div>
467
454
<p>
468
 
 
469
455
</p>
470
456
<div class="variablelist"><table border="0">
471
457
<col align="left" valign="top">
483
469
<tr>
484
470
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
485
471
<td>
486
 
 
487
 
 
488
472
</td>
489
473
</tr>
490
474
</tbody>
494
478
<div class="refsect2" lang="en">
495
479
<a name="GimpProgressEndCallback"></a><h3>GimpProgressEndCallback ()</h3>
496
480
<pre class="programlisting">void                (*GimpProgressEndCallback)          (<a
497
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
481
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
498
482
>gpointer</a> user_data);</pre>
499
483
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
500
484
<h3 class="title">Warning</h3>
501
485
<p><code class="literal">GimpProgressEndCallback</code> is deprecated and should not be used in newly-written code.</p>
502
486
</div>
503
487
<p>
504
 
 
505
488
</p>
506
489
<div class="variablelist"><table border="0">
507
490
<col align="left" valign="top">
508
491
<tbody><tr>
509
492
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
510
493
<td>
511
 
 
512
 
 
513
494
</td>
514
495
</tr></tbody>
515
496
</table></div>
518
499
<div class="refsect2" lang="en">
519
500
<a name="GimpProgressTextCallback"></a><h3>GimpProgressTextCallback ()</h3>
520
501
<pre class="programlisting">void                (*GimpProgressTextCallback)         (const <a
521
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
502
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
522
503
>gchar</a> *message,
523
504
                                                         <a
524
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
505
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
525
506
>gpointer</a> user_data);</pre>
526
507
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
527
508
<h3 class="title">Warning</h3>
528
509
<p><code class="literal">GimpProgressTextCallback</code> is deprecated and should not be used in newly-written code.</p>
529
510
</div>
530
511
<p>
531
 
 
532
512
</p>
533
513
<div class="variablelist"><table border="0">
534
514
<col align="left" valign="top">
541
521
<tr>
542
522
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
543
523
<td>
544
 
 
545
 
 
546
524
</td>
547
525
</tr>
548
526
</tbody>
552
530
<div class="refsect2" lang="en">
553
531
<a name="GimpProgressValueCallback"></a><h3>GimpProgressValueCallback ()</h3>
554
532
<pre class="programlisting">void                (*GimpProgressValueCallback)        (<a
555
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
 
533
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
556
534
>gdouble</a> percentage,
557
535
                                                         <a
558
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
536
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
559
537
>gpointer</a> user_data);</pre>
560
538
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
561
539
<h3 class="title">Warning</h3>
562
540
<p><code class="literal">GimpProgressValueCallback</code> is deprecated and should not be used in newly-written code.</p>
563
541
</div>
564
542
<p>
565
 
 
566
543
</p>
567
544
<div class="variablelist"><table border="0">
568
545
<col align="left" valign="top">
575
552
<tr>
576
553
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
577
554
<td>
578
 
 
579
 
 
580
555
</td>
581
556
</tr>
582
557
</tbody>
586
561
<div class="refsect2" lang="en">
587
562
<a name="gimp-progress-install-vtable"></a><h3>gimp_progress_install_vtable ()</h3>
588
563
<pre class="programlisting">const <a
589
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
590
 
>gchar</a>*        gimp_progress_install_vtable        (const <a class="link" href="libgimp-gimpprogress.html#GimpProgressVtable" title="GimpProgressVtable">GimpProgressVtable</a> *vtable,
 
564
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
565
>gchar</a> *       gimp_progress_install_vtable        (const <a class="link" href="libgimp-gimpprogress.html#GimpProgressVtable" title="GimpProgressVtable">GimpProgressVtable</a> *vtable,
591
566
                                                         <a
592
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
567
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
593
568
>gpointer</a> user_data);</pre>
594
569
<p>
595
570
</p>
596
571
<p>
597
 
 
598
572
</p>
599
573
<div class="variablelist"><table border="0">
600
574
<col align="left" valign="top">
617
591
</tr>
618
592
</tbody>
619
593
</table></div>
620
 
<p class="since">Since  GIMP 2.4
621
 
</p>
 
594
<p class="since">Since GIMP 2.4</p>
622
595
</div>
623
596
<hr>
624
597
<div class="refsect2" lang="en">
625
598
<a name="gimp-progress-install"></a><h3>gimp_progress_install ()</h3>
626
599
<pre class="programlisting">const <a
627
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
628
 
>gchar</a>*        gimp_progress_install               (<a class="link" href="libgimp-gimpprogress.html#GimpProgressStartCallback" title="GimpProgressStartCallback ()">GimpProgressStartCallback</a> start_callback,
 
600
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
601
>gchar</a> *       gimp_progress_install               (<a class="link" href="libgimp-gimpprogress.html#GimpProgressStartCallback" title="GimpProgressStartCallback ()">GimpProgressStartCallback</a> start_callback,
629
602
                                                         <a class="link" href="libgimp-gimpprogress.html#GimpProgressEndCallback" title="GimpProgressEndCallback ()">GimpProgressEndCallback</a> end_callback,
630
603
                                                         <a class="link" href="libgimp-gimpprogress.html#GimpProgressTextCallback" title="GimpProgressTextCallback ()">GimpProgressTextCallback</a> text_callback,
631
604
                                                         <a class="link" href="libgimp-gimpprogress.html#GimpProgressValueCallback" title="GimpProgressValueCallback ()">GimpProgressValueCallback</a> value_callback,
632
605
                                                         <a
633
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
606
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
634
607
>gpointer</a> user_data);</pre>
635
608
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
636
609
<h3 class="title">Warning</h3>
639
612
<p>
640
613
</p>
641
614
<p>
642
 
 
643
615
</p>
644
616
<div class="variablelist"><table border="0">
645
617
<col align="left" valign="top">
677
649
</tr>
678
650
</tbody>
679
651
</table></div>
680
 
<p class="since">Since  GIMP 2.2
681
 
 
682
 
Note that since GIMP 2.4, @value_callback can be called with
683
 
negative values. This is triggered by calls to gimp_progress_pulse().
684
 
The callback should then implement a progress indicating business,
685
 
e.g. by calling gtk_progress_bar_pulse().
686
 
</p>
 
652
<p class="since">Since GIMP 2.2</p>
687
653
</div>
688
654
<hr>
689
655
<div class="refsect2" lang="en">
690
656
<a name="gimp-progress-uninstall"></a><h3>gimp_progress_uninstall ()</h3>
691
657
<pre class="programlisting"><a
692
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
 
658
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
693
659
>gpointer</a>            gimp_progress_uninstall             (const <a
694
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
660
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
695
661
>gchar</a> *progress_callback);</pre>
696
662
<p>
697
663
Uninstalls a temporary progress procedure that was installed using
698
664
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-install" title="gimp_progress_install ()"><code class="function">gimp_progress_install()</code></a>.</p>
699
665
<p>
700
 
 
701
666
</p>
702
667
<div class="variablelist"><table border="0">
703
668
<col align="left" valign="top">
715
680
</tr>
716
681
</tbody>
717
682
</table></div>
718
 
<p class="since">Since  GIMP 2.2
719
 
</p>
 
683
<p class="since">Since GIMP 2.2</p>
720
684
</div>
721
685
<hr>
722
686
<div class="refsect2" lang="en">
723
687
<a name="gimp-progress-cancel"></a><h3>gimp_progress_cancel ()</h3>
724
688
<pre class="programlisting"><a
725
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
689
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
726
690
>gboolean</a>            gimp_progress_cancel                (const <a
727
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
691
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
728
692
>gchar</a> *progress_callback);</pre>
729
693
<p>
730
694
Cancels a running progress.
732
696
<p>
733
697
This function cancels the currently running progress.</p>
734
698
<p>
735
 
 
736
699
</p>
737
700
<div class="variablelist"><table border="0">
738
701
<col align="left" valign="top">
750
713
</tr>
751
714
</tbody>
752
715
</table></div>
753
 
<p class="since">Since  GIMP 2.2
754
 
</p>
 
716
<p class="since">Since GIMP 2.2</p>
755
717
</div>
756
718
</div>
757
719
</div>
758
720
<div class="footer">
759
721
<hr>
760
 
          Generated by GTK-Doc V1.10</div>
 
722
          Generated by GTK-Doc V1.11</div>
761
723
</body>
762
724
</html>