← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric

« back to all changes in this revision

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

  • 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
https://launchpad.net/bugs/344052
* 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:
devel-docs/libgimp/xml/gimpprogress.xml
12
12
<refnamediv>
13
13
<refname>gimpprogress</refname>
14
14
<refpurpose>Functions for embedding the progress bar into a plug-in's GUI.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="libgimp-gimpprogress.synopsis" role="synopsis">
38
37
                                                         <link linkend="gpointer">gpointer</link> user_data);
39
38
<link linkend="void">void</link>                (<link linkend="GimpProgressValueCallback">*GimpProgressValueCallback</link>)        (<link linkend="gdouble">gdouble</link> percentage,
40
39
                                                         <link linkend="gpointer">gpointer</link> user_data);
41
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-progress-install-vtable">gimp_progress_install_vtable</link>        (const <link linkend="GimpProgressVtable">GimpProgressVtable</link> *vtable,
 
40
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-progress-install-vtable">gimp_progress_install_vtable</link>        (const <link linkend="GimpProgressVtable">GimpProgressVtable</link> *vtable,
42
41
                                                         <link linkend="gpointer">gpointer</link> user_data);
43
 
const <link linkend="gchar">gchar</link>*        <link linkend="gimp-progress-install">gimp_progress_install</link>               (<link linkend="GimpProgressStartCallback">GimpProgressStartCallback</link> start_callback,
 
42
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-progress-install">gimp_progress_install</link>               (<link linkend="GimpProgressStartCallback">GimpProgressStartCallback</link> start_callback,
44
43
                                                         <link linkend="GimpProgressEndCallback">GimpProgressEndCallback</link> end_callback,
45
44
                                                         <link linkend="GimpProgressTextCallback">GimpProgressTextCallback</link> text_callback,
46
45
                                                         <link linkend="GimpProgressValueCallback">GimpProgressValueCallback</link> value_callback,
69
68
<title role="details.title">Details</title>
70
69
<refsect2 id="GimpProgressVtable" role="struct">
71
70
<title>GimpProgressVtable</title>
72
 
<indexterm zone="GimpProgressVtable"><primary>GimpProgressVtable</primary></indexterm><programlisting>typedef struct {
 
71
<indexterm zone="GimpProgressVtable"><primary sortas="GimpProgressVtable">GimpProgressVtable</primary></indexterm><programlisting>typedef struct {
73
72
  void    (* start)        (const gchar *message,
74
73
                            gboolean     cancelable,
75
74
                            gpointer     user_data);
94
93
} GimpProgressVtable;
95
94
</programlisting>
96
95
<para>
97
 
 
98
96
</para></refsect2>
99
97
<refsect2 id="gimp-progress-init" role="function">
100
98
<title>gimp_progress_init ()</title>
101
 
<indexterm zone="gimp-progress-init"><primary>gimp_progress_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_init                  (const <link linkend="gchar">gchar</link> *message);</programlisting>
 
99
<indexterm zone="gimp-progress-init"><primary sortas="gimp_progress_init">gimp_progress_init</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_init                  (const <link linkend="gchar">gchar</link> *message);</programlisting>
102
100
<para>
103
101
Initializes the progress bar for the current plug-in.
104
102
</para>
106
104
Initializes the progress bar for the current plug-in. It is only
107
105
valid to call this procedure from a plug-in.</para>
108
106
<para>
109
 
 
110
107
</para><variablelist role="params">
111
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
108
<varlistentry><term><parameter>message</parameter>&#160;:</term>
112
109
<listitem><simpara> Message to use in the progress dialog.
113
110
</simpara></listitem></varlistentry>
114
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
111
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
115
112
</simpara></listitem></varlistentry>
116
113
</variablelist></refsect2>
117
114
<refsect2 id="gimp-progress-init-printf" role="function" condition="since:GIMP 2.4">
118
115
<title>gimp_progress_init_printf ()</title>
119
 
<indexterm zone="gimp-progress-init-printf" role="GIMP 2.4"><primary>gimp_progress_init_printf</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_init_printf           (const <link linkend="gchar">gchar</link> *format,
 
116
<indexterm zone="gimp-progress-init-printf" role="GIMP 2.4"><primary sortas="gimp_progress_init_printf">gimp_progress_init_printf</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_init_printf           (const <link linkend="gchar">gchar</link> *format,
120
117
                                                         ...);</programlisting>
121
118
<para>
122
119
Initializes the progress bar for the current plug-in.
125
122
Initializes the progress bar for the current plug-in. It is only
126
123
valid to call this procedure from a plug-in.</para>
127
124
<para>
128
 
 
129
125
</para><variablelist role="params">
130
 
<varlistentry><term><parameter>format</parameter>&nbsp;:</term>
 
126
<varlistentry><term><parameter>format</parameter>&#160;:</term>
131
127
<listitem><simpara> a standard <link linkend="printf"><function>printf()</function></link> format string
132
128
</simpara></listitem></varlistentry>
133
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
129
<varlistentry><term><parameter>...</parameter>&#160;:</term>
134
130
<listitem><simpara> arguments for <parameter>format</parameter>
135
131
</simpara></listitem></varlistentry>
136
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success.
 
132
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success.
137
133
 
138
134
</simpara></listitem></varlistentry>
139
 
</variablelist><para role="since">Since  GIMP 2.4
140
 
</para></refsect2>
 
135
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
141
136
<refsect2 id="gimp-progress-update" role="function">
142
137
<title>gimp_progress_update ()</title>
143
 
<indexterm zone="gimp-progress-update"><primary>gimp_progress_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_update                (<link linkend="gdouble">gdouble</link> percentage);</programlisting>
 
138
<indexterm zone="gimp-progress-update"><primary sortas="gimp_progress_update">gimp_progress_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_update                (<link linkend="gdouble">gdouble</link> percentage);</programlisting>
144
139
<para>
145
140
Updates the progress bar for the current plug-in.</para>
146
141
<para>
147
 
 
148
142
</para><variablelist role="params">
149
 
<varlistentry><term><parameter>percentage</parameter>&nbsp;:</term>
 
143
<varlistentry><term><parameter>percentage</parameter>&#160;:</term>
150
144
<listitem><simpara> Percentage of progress completed (in the range from 0.0 to 1.0).
151
145
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
146
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
153
147
</simpara></listitem></varlistentry>
154
148
</variablelist></refsect2>
155
149
<refsect2 id="gimp-progress-pulse" role="function" condition="since:GIMP 2.4">
156
150
<title>gimp_progress_pulse ()</title>
157
 
<indexterm zone="gimp-progress-pulse" role="GIMP 2.4"><primary>gimp_progress_pulse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_pulse                 (void);</programlisting>
 
151
<indexterm zone="gimp-progress-pulse" role="GIMP 2.4"><primary sortas="gimp_progress_pulse">gimp_progress_pulse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_pulse                 (void);</programlisting>
158
152
<para>
159
153
Pulses the progress bar for the current plug-in.
160
154
</para>
165
159
made. This usually causes the the progress bar to enter \"activity
166
160
mode\", where a block bounces back and forth.</para>
167
161
<para>
168
 
 
169
162
</para><variablelist role="params">
170
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
163
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
171
164
 
172
165
</simpara></listitem></varlistentry>
173
 
</variablelist><para role="since">Since  GIMP 2.4
174
 
</para></refsect2>
 
166
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
175
167
<refsect2 id="gimp-progress-set-text" role="function" condition="since:GIMP 2.4">
176
168
<title>gimp_progress_set_text ()</title>
177
 
<indexterm zone="gimp-progress-set-text" role="GIMP 2.4"><primary>gimp_progress_set_text</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_set_text              (const <link linkend="gchar">gchar</link> *message);</programlisting>
 
169
<indexterm zone="gimp-progress-set-text" role="GIMP 2.4"><primary sortas="gimp_progress_set_text">gimp_progress_set_text</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_set_text              (const <link linkend="gchar">gchar</link> *message);</programlisting>
178
170
<para>
179
171
Changes the text in the progress bar for the current plug-in.
180
172
</para>
183
175
current plug-in. Unlike <link linkend="gimp-progress-init"><function>gimp_progress_init()</function></link> it does not change the
184
176
displayed value.</para>
185
177
<para>
186
 
 
187
178
</para><variablelist role="params">
188
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
179
<varlistentry><term><parameter>message</parameter>&#160;:</term>
189
180
<listitem><simpara> Message to use in the progress dialog.
190
181
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
182
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
192
183
 
193
184
</simpara></listitem></varlistentry>
194
 
</variablelist><para role="since">Since  GIMP 2.4
195
 
</para></refsect2>
 
185
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
196
186
<refsect2 id="gimp-progress-set-text-printf" role="function" condition="since:GIMP 2.4">
197
187
<title>gimp_progress_set_text_printf ()</title>
198
 
<indexterm zone="gimp-progress-set-text-printf" role="GIMP 2.4"><primary>gimp_progress_set_text_printf</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_set_text_printf       (const <link linkend="gchar">gchar</link> *format,
 
188
<indexterm zone="gimp-progress-set-text-printf" role="GIMP 2.4"><primary sortas="gimp_progress_set_text_printf">gimp_progress_set_text_printf</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_set_text_printf       (const <link linkend="gchar">gchar</link> *format,
199
189
                                                         ...);</programlisting>
200
190
<para>
201
191
Changes the text in the progress bar for the current plug-in.
205
195
current plug-in. Unlike <link linkend="gimp-progress-init"><function>gimp_progress_init()</function></link> it does not change the
206
196
displayed value.</para>
207
197
<para>
208
 
 
209
198
</para><variablelist role="params">
210
 
<varlistentry><term><parameter>format</parameter>&nbsp;:</term>
 
199
<varlistentry><term><parameter>format</parameter>&#160;:</term>
211
200
<listitem><simpara> a standard <link linkend="printf"><function>printf()</function></link> format string
212
201
</simpara></listitem></varlistentry>
213
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
202
<varlistentry><term><parameter>...</parameter>&#160;:</term>
214
203
<listitem><simpara> arguments for <parameter>format</parameter>
215
204
</simpara></listitem></varlistentry>
216
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success.
 
205
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> on success.
217
206
 
218
207
</simpara></listitem></varlistentry>
219
 
</variablelist><para role="since">Since  GIMP 2.4
220
 
</para></refsect2>
 
208
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
221
209
<refsect2 id="gimp-progress-end" role="function" condition="since:GIMP 2.4">
222
210
<title>gimp_progress_end ()</title>
223
 
<indexterm zone="gimp-progress-end" role="GIMP 2.4"><primary>gimp_progress_end</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_end                   (void);</programlisting>
 
211
<indexterm zone="gimp-progress-end" role="GIMP 2.4"><primary sortas="gimp_progress_end">gimp_progress_end</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_end                   (void);</programlisting>
224
212
<para>
225
213
Ends the progress bar for the current plug-in.
226
214
</para>
229
217
don't need to call this, they just exit when the work is done. It is
230
218
only valid to call this procedure from a plug-in.</para>
231
219
<para>
232
 
 
233
220
</para><variablelist role="params">
234
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
221
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
235
222
 
236
223
</simpara></listitem></varlistentry>
237
 
</variablelist><para role="since">Since  GIMP 2.4
238
 
</para></refsect2>
 
224
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
239
225
<refsect2 id="gimp-progress-get-window-handle" role="function" condition="since:GIMP 2.2">
240
226
<title>gimp_progress_get_window_handle ()</title>
241
 
<indexterm zone="gimp-progress-get-window-handle" role="GIMP 2.2"><primary>gimp_progress_get_window_handle</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_progress_get_window_handle     (void);</programlisting>
 
227
<indexterm zone="gimp-progress-get-window-handle" role="GIMP 2.2"><primary sortas="gimp_progress_get_window_handle">gimp_progress_get_window_handle</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_progress_get_window_handle     (void);</programlisting>
242
228
<para>
243
229
Returns the native window ID of the toplevel window this plug-in's
244
230
progress is displayed in.
247
233
This function returns the native window ID of the toplevel window
248
234
this plug-in\'s progress is displayed in.</para>
249
235
<para>
250
 
 
251
236
</para><variablelist role="params">
252
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The progress bar's toplevel window.
 
237
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The progress bar's toplevel window.
253
238
 
254
239
</simpara></listitem></varlistentry>
255
 
</variablelist><para role="since">Since  GIMP 2.2
256
 
</para></refsect2>
 
240
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
257
241
<refsect2 id="GimpProgressStartCallback" role="function" condition="deprecated:">
258
242
<title>GimpProgressStartCallback ()</title>
259
 
<indexterm zone="GimpProgressStartCallback" role="deprecated"><primary>GimpProgressStartCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpProgressStartCallback)        (const <link linkend="gchar">gchar</link> *message,
 
243
<indexterm zone="GimpProgressStartCallback" role="deprecated"><primary sortas="GimpProgressStartCallback">GimpProgressStartCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpProgressStartCallback)        (const <link linkend="gchar">gchar</link> *message,
260
244
                                                         <link linkend="gboolean">gboolean</link> cancelable,
261
245
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
262
246
<warning><para><literal>GimpProgressStartCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
263
247
<para>
264
 
 
265
248
</para><variablelist role="params">
266
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
267
 
<listitem><simpara>
268
 
</simpara></listitem></varlistentry>
269
 
<varlistentry><term><parameter>cancelable</parameter>&nbsp;:</term>
270
 
<listitem><simpara>
271
 
</simpara></listitem></varlistentry>
272
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
273
 
<listitem><simpara>
274
 
 
275
 
 
 
249
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
250
<listitem><simpara>
 
251
</simpara></listitem></varlistentry>
 
252
<varlistentry><term><parameter>cancelable</parameter>&#160;:</term>
 
253
<listitem><simpara>
 
254
</simpara></listitem></varlistentry>
 
255
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
 
256
<listitem><simpara>
276
257
</simpara></listitem></varlistentry>
277
258
</variablelist></refsect2>
278
259
<refsect2 id="GimpProgressEndCallback" role="function" condition="deprecated:">
279
260
<title>GimpProgressEndCallback ()</title>
280
 
<indexterm zone="GimpProgressEndCallback" role="deprecated"><primary>GimpProgressEndCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpProgressEndCallback)          (<link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
261
<indexterm zone="GimpProgressEndCallback" role="deprecated"><primary sortas="GimpProgressEndCallback">GimpProgressEndCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpProgressEndCallback)          (<link linkend="gpointer">gpointer</link> user_data);</programlisting>
281
262
<warning><para><literal>GimpProgressEndCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
282
263
<para>
283
 
 
284
264
</para><variablelist role="params">
285
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
265
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
286
266
<listitem><simpara>
287
 
 
288
 
 
289
267
</simpara></listitem></varlistentry>
290
268
</variablelist></refsect2>
291
269
<refsect2 id="GimpProgressTextCallback" role="function" condition="deprecated:">
292
270
<title>GimpProgressTextCallback ()</title>
293
 
<indexterm zone="GimpProgressTextCallback" role="deprecated"><primary>GimpProgressTextCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpProgressTextCallback)         (const <link linkend="gchar">gchar</link> *message,
 
271
<indexterm zone="GimpProgressTextCallback" role="deprecated"><primary sortas="GimpProgressTextCallback">GimpProgressTextCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpProgressTextCallback)         (const <link linkend="gchar">gchar</link> *message,
294
272
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
295
273
<warning><para><literal>GimpProgressTextCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
296
274
<para>
297
 
 
298
275
</para><variablelist role="params">
299
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
276
<varlistentry><term><parameter>message</parameter>&#160;:</term>
300
277
<listitem><simpara>
301
278
</simpara></listitem></varlistentry>
302
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
279
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
303
280
<listitem><simpara>
304
 
 
305
 
 
306
281
</simpara></listitem></varlistentry>
307
282
</variablelist></refsect2>
308
283
<refsect2 id="GimpProgressValueCallback" role="function" condition="deprecated:">
309
284
<title>GimpProgressValueCallback ()</title>
310
 
<indexterm zone="GimpProgressValueCallback" role="deprecated"><primary>GimpProgressValueCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpProgressValueCallback)        (<link linkend="gdouble">gdouble</link> percentage,
 
285
<indexterm zone="GimpProgressValueCallback" role="deprecated"><primary sortas="GimpProgressValueCallback">GimpProgressValueCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GimpProgressValueCallback)        (<link linkend="gdouble">gdouble</link> percentage,
311
286
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
312
287
<warning><para><literal>GimpProgressValueCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
313
288
<para>
314
 
 
315
289
</para><variablelist role="params">
316
 
<varlistentry><term><parameter>percentage</parameter>&nbsp;:</term>
 
290
<varlistentry><term><parameter>percentage</parameter>&#160;:</term>
317
291
<listitem><simpara>
318
292
</simpara></listitem></varlistentry>
319
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
293
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
320
294
<listitem><simpara>
321
 
 
322
 
 
323
295
</simpara></listitem></varlistentry>
324
296
</variablelist></refsect2>
325
297
<refsect2 id="gimp-progress-install-vtable" role="function" condition="since:GIMP 2.4">
326
298
<title>gimp_progress_install_vtable ()</title>
327
 
<indexterm zone="gimp-progress-install-vtable" role="GIMP 2.4"><primary>gimp_progress_install_vtable</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_progress_install_vtable        (const <link linkend="GimpProgressVtable">GimpProgressVtable</link> *vtable,
 
299
<indexterm zone="gimp-progress-install-vtable" role="GIMP 2.4"><primary sortas="gimp_progress_install_vtable">gimp_progress_install_vtable</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_progress_install_vtable        (const <link linkend="GimpProgressVtable">GimpProgressVtable</link> *vtable,
328
300
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
329
301
<para>
330
302
</para>
331
303
<para>
332
 
 
333
304
</para><variablelist role="params">
334
 
<varlistentry><term><parameter>vtable</parameter>&nbsp;:</term>
 
305
<varlistentry><term><parameter>vtable</parameter>&#160;:</term>
335
306
<listitem><simpara>    a pointer to a <parameter>GimpProgressVtable</parameter>.
336
307
</simpara></listitem></varlistentry>
337
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
308
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
338
309
<listitem><simpara> a pointer that is passed as user_data to all vtable functions.
339
310
</simpara></listitem></varlistentry>
340
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the name of the temporary procedure that's been installed
 
311
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the name of the temporary procedure that's been installed
341
312
 
342
313
</simpara></listitem></varlistentry>
343
 
</variablelist><para role="since">Since  GIMP 2.4
344
 
</para></refsect2>
345
 
<refsect2 id="gimp-progress-install" role="function" condition="deprecated:|since">
 
314
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
 
315
<refsect2 id="gimp-progress-install" role="function" condition="deprecated:|since:GIMP 2.2">
346
316
<title>gimp_progress_install ()</title>
347
 
<indexterm zone="gimp-progress-install" role="deprecated"><primary>gimp_progress_install</primary></indexterm><indexterm zone="gimp-progress-install" role="GIMP 2.2
348
 
 
349
 
Note that since GIMP 2.4, @value_callback can be called with
350
 
negative values. This is triggered by calls to gimp_progress_pulse().
351
 
The callback should then implement a progress indicating business,
352
 
e.g. by calling gtk_progress_bar_pulse()."><primary>gimp_progress_install</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gimp_progress_install               (<link linkend="GimpProgressStartCallback">GimpProgressStartCallback</link> start_callback,
 
317
<indexterm zone="gimp-progress-install" role="deprecated"><primary sortas="gimp_progress_install">gimp_progress_install</primary></indexterm><indexterm zone="gimp-progress-install" role="GIMP 2.2"><primary sortas="gimp_progress_install">gimp_progress_install</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_progress_install               (<link linkend="GimpProgressStartCallback">GimpProgressStartCallback</link> start_callback,
353
318
                                                         <link linkend="GimpProgressEndCallback">GimpProgressEndCallback</link> end_callback,
354
319
                                                         <link linkend="GimpProgressTextCallback">GimpProgressTextCallback</link> text_callback,
355
320
                                                         <link linkend="GimpProgressValueCallback">GimpProgressValueCallback</link> value_callback,
358
323
<para>
359
324
</para>
360
325
<para>
361
 
 
362
326
</para><variablelist role="params">
363
 
<varlistentry><term><parameter>start_callback</parameter>&nbsp;:</term>
 
327
<varlistentry><term><parameter>start_callback</parameter>&#160;:</term>
364
328
<listitem><simpara> the function to call when progress starts
365
329
</simpara></listitem></varlistentry>
366
 
<varlistentry><term><parameter>end_callback</parameter>&nbsp;:</term>
 
330
<varlistentry><term><parameter>end_callback</parameter>&#160;:</term>
367
331
<listitem><simpara>   the function to call when progress finishes
368
332
</simpara></listitem></varlistentry>
369
 
<varlistentry><term><parameter>text_callback</parameter>&nbsp;:</term>
 
333
<varlistentry><term><parameter>text_callback</parameter>&#160;:</term>
370
334
<listitem><simpara>  the function to call to change the text
371
335
</simpara></listitem></varlistentry>
372
 
<varlistentry><term><parameter>value_callback</parameter>&nbsp;:</term>
 
336
<varlistentry><term><parameter>value_callback</parameter>&#160;:</term>
373
337
<listitem><simpara> the function to call to change the value
374
338
</simpara></listitem></varlistentry>
375
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
339
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
376
340
<listitem><simpara>      a pointer that is returned when uninstalling the progress
377
341
</simpara></listitem></varlistentry>
378
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the name of the temporary procedure that's been installed
 
342
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the name of the temporary procedure that's been installed
379
343
 
380
344
</simpara></listitem></varlistentry>
381
 
</variablelist><para role="since">Since  GIMP 2.2
382
 
 
383
 
Note that since GIMP 2.4, @value_callback can be called with
384
 
negative values. This is triggered by calls to gimp_progress_pulse().
385
 
The callback should then implement a progress indicating business,
386
 
e.g. by calling gtk_progress_bar_pulse().
387
 
</para></refsect2>
 
345
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
388
346
<refsect2 id="gimp-progress-uninstall" role="function" condition="since:GIMP 2.2">
389
347
<title>gimp_progress_uninstall ()</title>
390
 
<indexterm zone="gimp-progress-uninstall" role="GIMP 2.2"><primary>gimp_progress_uninstall</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            gimp_progress_uninstall             (const <link linkend="gchar">gchar</link> *progress_callback);</programlisting>
 
348
<indexterm zone="gimp-progress-uninstall" role="GIMP 2.2"><primary sortas="gimp_progress_uninstall">gimp_progress_uninstall</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            gimp_progress_uninstall             (const <link linkend="gchar">gchar</link> *progress_callback);</programlisting>
391
349
<para>
392
350
Uninstalls a temporary progress procedure that was installed using
393
351
<link linkend="gimp-progress-install"><function>gimp_progress_install()</function></link>.</para>
394
352
<para>
395
 
 
396
353
</para><variablelist role="params">
397
 
<varlistentry><term><parameter>progress_callback</parameter>&nbsp;:</term>
 
354
<varlistentry><term><parameter>progress_callback</parameter>&#160;:</term>
398
355
<listitem><simpara> the name of the temporary procedure to uninstall
399
356
</simpara></listitem></varlistentry>
400
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <parameter>user_data</parameter> that was passed to <link linkend="gimp-progress-install"><function>gimp_progress_install()</function></link>.
 
357
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <parameter>user_data</parameter> that was passed to <link linkend="gimp-progress-install"><function>gimp_progress_install()</function></link>.
401
358
 
402
359
</simpara></listitem></varlistentry>
403
 
</variablelist><para role="since">Since  GIMP 2.2
404
 
</para></refsect2>
 
360
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
405
361
<refsect2 id="gimp-progress-cancel" role="function" condition="since:GIMP 2.2">
406
362
<title>gimp_progress_cancel ()</title>
407
 
<indexterm zone="gimp-progress-cancel" role="GIMP 2.2"><primary>gimp_progress_cancel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_cancel                (const <link linkend="gchar">gchar</link> *progress_callback);</programlisting>
 
363
<indexterm zone="gimp-progress-cancel" role="GIMP 2.2"><primary sortas="gimp_progress_cancel">gimp_progress_cancel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_progress_cancel                (const <link linkend="gchar">gchar</link> *progress_callback);</programlisting>
408
364
<para>
409
365
Cancels a running progress.
410
366
</para>
411
367
<para>
412
368
This function cancels the currently running progress.</para>
413
369
<para>
414
 
 
415
370
</para><variablelist role="params">
416
 
<varlistentry><term><parameter>progress_callback</parameter>&nbsp;:</term>
 
371
<varlistentry><term><parameter>progress_callback</parameter>&#160;:</term>
417
372
<listitem><simpara> The name of the callback registered for this progress.
418
373
</simpara></listitem></varlistentry>
419
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
374
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
420
375
 
421
376
</simpara></listitem></varlistentry>
422
 
</variablelist><para role="since">Since  GIMP 2.2
423
 
</para></refsect2>
 
377
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
424
378
 
425
379
</refsect1>
426
380