← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpprogress.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpprogress</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
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
 
<link rel="next" href="libgimp-image.html" title="Manupulating Images and all their Properties">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
10
<link rel="next" href="libgimp-image.html" title="Manupulating Images and their Properties">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
14
 
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
 
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
 
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
<link rel="index" href="libgimp-index.html" title="Index">
 
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
21
24
</head>
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-image.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
33
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2536579" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2559302" class="shortcut">Top</a>
32
35
                  &#160;|&#160;
33
 
                  <a href="#id2575763" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2609859" class="shortcut">Description</a></nobr></td></tr>
34
37
</table>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpprogress"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
38
41
<td valign="top">
39
42
<h2>
40
 
<a name="id2536579"></a><span class="refentrytitle">gimpprogress</span>
 
43
<a name="id2559302"></a><span class="refentrytitle">gimpprogress</span>
41
44
</h2>
42
45
<p>gimpprogress &#8212; Functions for embedding the progress bar into a plug-in's GUI.</p>
43
46
</td>
49
52
 
50
53
 
51
54
 
52
 
void        (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">*GimpProgressStartCallback</a>)    (const gchar *message,
53
 
                                             gboolean cancelable,
54
 
                                             gpointer user_data);
55
 
void        (<a href="libgimp-gimpprogress.html#GimpProgressEndCallback">*GimpProgressEndCallback</a>)      (gpointer user_data);
56
 
void        (<a href="libgimp-gimpprogress.html#GimpProgressTextCallback">*GimpProgressTextCallback</a>)     (const gchar *message,
57
 
                                             gpointer user_data);
58
 
void        (<a href="libgimp-gimpprogress.html#GimpProgressValueCallback">*GimpProgressValueCallback</a>)    (gdouble percentage,
59
 
                                             gpointer user_data);
60
 
gboolean    <a href="libgimp-gimpprogress.html#gimp-progress-init">gimp_progress_init</a>              (const gchar *message);
61
 
gboolean    <a href="libgimp-gimpprogress.html#gimp-progress-update">gimp_progress_update</a>            (gdouble percentage);
62
 
const gchar* <a href="libgimp-gimpprogress.html#gimp-progress-install">gimp_progress_install</a>          (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
63
 
                                             <a href="libgimp-gimpprogress.html#GimpProgressEndCallback">GimpProgressEndCallback</a> end_callback,
64
 
                                             <a href="libgimp-gimpprogress.html#GimpProgressTextCallback">GimpProgressTextCallback</a> text_callback,
65
 
                                             <a href="libgimp-gimpprogress.html#GimpProgressValueCallback">GimpProgressValueCallback</a> value_callback,
66
 
                                             gpointer user_data);
67
 
gpointer    <a href="libgimp-gimpprogress.html#gimp-progress-uninstall">gimp_progress_uninstall</a>         (const gchar *progress_callback);
68
 
gboolean    <a href="libgimp-gimpprogress.html#gimp-progress-cancel">gimp_progress_cancel</a>            (const gchar *progress_callback);
 
55
                    <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a>;
 
56
gboolean            <a href="libgimp-gimpprogress.html#gimp-progress-init">gimp_progress_init</a>                  (const gchar *message);
 
57
gboolean            <a href="libgimp-gimpprogress.html#gimp-progress-init-printf">gimp_progress_init_printf</a>           (const gchar *format,
 
58
                                                         ...);
 
59
gboolean            <a href="libgimp-gimpprogress.html#gimp-progress-update">gimp_progress_update</a>                (gdouble percentage);
 
60
gboolean            <a href="libgimp-gimpprogress.html#gimp-progress-pulse">gimp_progress_pulse</a>                 (void);
 
61
gboolean            <a href="libgimp-gimpprogress.html#gimp-progress-set-text">gimp_progress_set_text</a>              (const gchar *message);
 
62
gboolean            <a href="libgimp-gimpprogress.html#gimp-progress-set-text-printf">gimp_progress_set_text_printf</a>       (const gchar *format,
 
63
                                                         ...);
 
64
gpointer            <a href="libgimp-gimpprogress.html#gimp-progress-uninstall">gimp_progress_uninstall</a>             (const gchar *progress_callback);
 
65
gboolean            <a href="libgimp-gimpprogress.html#gimp-progress-cancel">gimp_progress_cancel</a>                (const gchar *progress_callback);
 
66
gint                <a href="libgimp-gimpprogress.html#gimp-progress-get-window-handle">gimp_progress_get_window_handle</a>     (void);
 
67
void                (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">*GimpProgressStartCallback</a>)        (const gchar *message,
 
68
                                                         gboolean cancelable,
 
69
                                                         gpointer user_data);
 
70
void                (<a href="libgimp-gimpprogress.html#GimpProgressEndCallback">*GimpProgressEndCallback</a>)          (gpointer user_data);
 
71
void                (<a href="libgimp-gimpprogress.html#GimpProgressTextCallback">*GimpProgressTextCallback</a>)         (const gchar *message,
 
72
                                                         gpointer user_data);
 
73
void                (<a href="libgimp-gimpprogress.html#GimpProgressValueCallback">*GimpProgressValueCallback</a>)        (gdouble percentage,
 
74
                                                         gpointer user_data);
 
75
const gchar*        <a href="libgimp-gimpprogress.html#gimp-progress-install-vtable">gimp_progress_install_vtable</a>        (const <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a> *vtable,
 
76
                                                         gpointer user_data);
 
77
const gchar*        <a href="libgimp-gimpprogress.html#gimp-progress-install">gimp_progress_install</a>               (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
 
78
                                                         <a href="libgimp-gimpprogress.html#GimpProgressEndCallback">GimpProgressEndCallback</a> end_callback,
 
79
                                                         <a href="libgimp-gimpprogress.html#GimpProgressTextCallback">GimpProgressTextCallback</a> text_callback,
 
80
                                                         <a href="libgimp-gimpprogress.html#GimpProgressValueCallback">GimpProgressValueCallback</a> value_callback,
 
81
                                                         gpointer user_data);
69
82
</pre>
70
83
</div>
71
84
<div class="refsect1" lang="en">
72
 
<a name="id2575763"></a><h2>Description</h2>
 
85
<a name="id2609859"></a><h2>Description</h2>
73
86
<p>
74
87
Functions for embedding the progress bar into a plug-in's GUI.
75
88
</p>
76
89
</div>
77
90
<div class="refsect1" lang="en">
78
 
<a name="id2575780"></a><h2>Details</h2>
79
 
<div class="refsect2" lang="en">
80
 
<a name="id2575791"></a><h3>
81
 
<a name="GimpProgressStartCallback"></a>GimpProgressStartCallback ()</h3>
82
 
<a class="indexterm" name="id2575802"></a><pre class="programlisting">void        (*GimpProgressStartCallback)    (const gchar *message,
83
 
                                             gboolean cancelable,
84
 
                                             gpointer user_data);</pre>
85
 
<p>
86
 
 
87
 
</p>
88
 
<div class="variablelist"><table border="0">
89
 
<col align="left" valign="top">
90
 
<tbody>
91
 
<tr>
92
 
<td>
93
 
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
94
 
<td>
95
 
</td>
96
 
</tr>
97
 
<tr>
98
 
<td>
99
 
<span class="term"><em class="parameter"><code>cancelable</code></em>&#160;:</span></td>
100
 
<td>
101
 
</td>
102
 
</tr>
103
 
<tr>
104
 
<td>
105
 
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
106
 
<td>
107
 
 
108
 
 
109
 
</td>
110
 
</tr>
111
 
</tbody>
112
 
</table></div>
113
 
</div>
114
 
<hr>
115
 
<div class="refsect2" lang="en">
116
 
<a name="id2575890"></a><h3>
117
 
<a name="GimpProgressEndCallback"></a>GimpProgressEndCallback ()</h3>
118
 
<a class="indexterm" name="id2575901"></a><pre class="programlisting">void        (*GimpProgressEndCallback)      (gpointer user_data);</pre>
119
 
<p>
120
 
 
121
 
</p>
122
 
<div class="variablelist"><table border="0">
123
 
<col align="left" valign="top">
124
 
<tbody><tr>
125
 
<td>
126
 
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
127
 
<td>
128
 
 
129
 
 
130
 
</td>
131
 
</tr></tbody>
132
 
</table></div>
133
 
</div>
134
 
<hr>
135
 
<div class="refsect2" lang="en">
136
 
<a name="id2575946"></a><h3>
137
 
<a name="GimpProgressTextCallback"></a>GimpProgressTextCallback ()</h3>
138
 
<a class="indexterm" name="id2575957"></a><pre class="programlisting">void        (*GimpProgressTextCallback)     (const gchar *message,
139
 
                                             gpointer user_data);</pre>
140
 
<p>
141
 
 
142
 
</p>
143
 
<div class="variablelist"><table border="0">
144
 
<col align="left" valign="top">
145
 
<tbody>
146
 
<tr>
147
 
<td>
148
 
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
149
 
<td>
150
 
</td>
151
 
</tr>
152
 
<tr>
153
 
<td>
154
 
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
155
 
<td>
156
 
 
157
 
 
158
 
</td>
159
 
</tr>
160
 
</tbody>
161
 
</table></div>
162
 
</div>
163
 
<hr>
164
 
<div class="refsect2" lang="en">
165
 
<a name="id2523190"></a><h3>
166
 
<a name="GimpProgressValueCallback"></a>GimpProgressValueCallback ()</h3>
167
 
<a class="indexterm" name="id2523202"></a><pre class="programlisting">void        (*GimpProgressValueCallback)    (gdouble percentage,
168
 
                                             gpointer user_data);</pre>
169
 
<p>
170
 
 
171
 
</p>
172
 
<div class="variablelist"><table border="0">
173
 
<col align="left" valign="top">
174
 
<tbody>
175
 
<tr>
176
 
<td>
177
 
<span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
178
 
<td>
179
 
</td>
180
 
</tr>
181
 
<tr>
182
 
<td>
183
 
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
184
 
<td>
185
 
 
186
 
 
187
 
</td>
188
 
</tr>
189
 
</tbody>
190
 
</table></div>
191
 
</div>
192
 
<hr>
193
 
<div class="refsect2" lang="en">
194
 
<a name="id2523268"></a><h3>
 
91
<a name="id2609875"></a><h2>Details</h2>
 
92
<div class="refsect2" lang="en">
 
93
<a name="id2609886"></a><h3>
 
94
<a name="GimpProgressVtable"></a>GimpProgressVtable</h3>
 
95
<a class="indexterm" name="id2609899"></a><pre class="programlisting">typedef struct {
 
96
  void    (* start)        (const gchar *message,
 
97
                            gboolean     cancelable,
 
98
                            gpointer     user_data);
 
99
  void    (* end)          (gpointer     user_data);
 
100
  void    (* set_text)     (const gchar *message,
 
101
                            gpointer     user_data);
 
102
  void    (* set_value)    (gdouble      percentage,
 
103
                            gpointer     user_data);
 
104
  void    (* pulse)        (gpointer     user_data);
 
105
 
 
106
  guint32 (* get_window)   (gpointer     user_data);
 
107
 
 
108
  /* Padding for future expansion. Must be initialized with NULL! */
 
109
  void (* _gimp_reserved1) (void);
 
110
  void (* _gimp_reserved2) (void);
 
111
  void (* _gimp_reserved3) (void);
 
112
  void (* _gimp_reserved4) (void);
 
113
  void (* _gimp_reserved5) (void);
 
114
  void (* _gimp_reserved6) (void);
 
115
  void (* _gimp_reserved7) (void);
 
116
  void (* _gimp_reserved8) (void);
 
117
} GimpProgressVtable;
 
118
</pre>
 
119
<p>
 
120
 
 
121
</p>
 
122
</div>
 
123
<hr>
 
124
<div class="refsect2" lang="en">
 
125
<a name="id2609929"></a><h3>
195
126
<a name="gimp-progress-init"></a>gimp_progress_init ()</h3>
196
 
<a class="indexterm" name="id2523280"></a><pre class="programlisting">gboolean    gimp_progress_init              (const gchar *message);</pre>
 
127
<a class="indexterm" name="id2609942"></a><pre class="programlisting">gboolean            gimp_progress_init                  (const gchar *message);</pre>
197
128
<p>
198
129
Initializes the progress bar for the current plug-in.
199
130
</p>
207
138
<col align="left" valign="top">
208
139
<tbody>
209
140
<tr>
210
 
<td>
211
 
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
 
141
<td><span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
212
142
<td> Message to use in the progress dialog.
213
143
</td>
214
144
</tr>
215
145
<tr>
216
 
<td>
217
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
146
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
218
147
<td> TRUE on success.
219
148
</td>
220
149
</tr>
223
152
</div>
224
153
<hr>
225
154
<div class="refsect2" lang="en">
226
 
<a name="id2523345"></a><h3>
 
155
<a name="id2610421"></a><h3>
 
156
<a name="gimp-progress-init-printf"></a>gimp_progress_init_printf ()</h3>
 
157
<a class="indexterm" name="id2610435"></a><pre class="programlisting">gboolean            gimp_progress_init_printf           (const gchar *format,
 
158
                                                         ...);</pre>
 
159
<p>
 
160
Initializes the progress bar for the current plug-in.
 
161
</p>
 
162
<p>
 
163
Initializes the progress bar for the current plug-in. It is only
 
164
valid to call this procedure from a plug-in.</p>
 
165
<p>
 
166
 
 
167
</p>
 
168
<div class="variablelist"><table border="0">
 
169
<col align="left" valign="top">
 
170
<tbody>
 
171
<tr>
 
172
<td><span class="term"><em class="parameter"><code>format</code></em>&#160;:</span></td>
 
173
<td> a standard <code class="function">printf()</code> format string
 
174
</td>
 
175
</tr>
 
176
<tr>
 
177
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
 
178
<td> arguments for <em class="parameter"><code>format</code></em>
 
179
</td>
 
180
</tr>
 
181
<tr>
 
182
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
183
<td> <code class="literal">TRUE</code> on success.
 
184
 
 
185
</td>
 
186
</tr>
 
187
</tbody>
 
188
</table></div>
 
189
<p class="since">Since  GIMP 2.4
 
190
</p>
 
191
</div>
 
192
<hr>
 
193
<div class="refsect2" lang="en">
 
194
<a name="id2610549"></a><h3>
227
195
<a name="gimp-progress-update"></a>gimp_progress_update ()</h3>
228
 
<a class="indexterm" name="id2523356"></a><pre class="programlisting">gboolean    gimp_progress_update            (gdouble percentage);</pre>
229
 
<p>
230
 
Updates the progress bar for the current plug-in.
 
196
<a class="indexterm" name="id2610560"></a><pre class="programlisting">gboolean            gimp_progress_update                (gdouble percentage);</pre>
 
197
<p>
 
198
Updates the progress bar for the current plug-in.</p>
 
199
<p>
 
200
 
 
201
</p>
 
202
<div class="variablelist"><table border="0">
 
203
<col align="left" valign="top">
 
204
<tbody>
 
205
<tr>
 
206
<td><span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
 
207
<td> Percentage of progress completed (in the range from 0.0 to 1.0).
 
208
</td>
 
209
</tr>
 
210
<tr>
 
211
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
212
<td> TRUE on success.
 
213
</td>
 
214
</tr>
 
215
</tbody>
 
216
</table></div>
 
217
</div>
 
218
<hr>
 
219
<div class="refsect2" lang="en">
 
220
<a name="id2610622"></a><h3>
 
221
<a name="gimp-progress-pulse"></a>gimp_progress_pulse ()</h3>
 
222
<a class="indexterm" name="id2610636"></a><pre class="programlisting">gboolean            gimp_progress_pulse                 (void);</pre>
 
223
<p>
 
224
Pulses the progress bar for the current plug-in.
231
225
</p>
232
226
<p>
233
227
Updates the progress bar for the current plug-in. It is only valid
234
 
to call this procedure from a plug-in.</p>
235
 
<p>
236
 
 
237
 
</p>
238
 
<div class="variablelist"><table border="0">
239
 
<col align="left" valign="top">
240
 
<tbody>
241
 
<tr>
242
 
<td>
243
 
<span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
244
 
<td> Percentage of progress completed which must be between 0.0 and 1.0.
245
 
</td>
246
 
</tr>
247
 
<tr>
248
 
<td>
249
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
250
 
<td> TRUE on success.
251
 
</td>
252
 
</tr>
253
 
</tbody>
254
 
</table></div>
255
 
</div>
256
 
<hr>
257
 
<div class="refsect2" lang="en">
258
 
<a name="id2523423"></a><h3>
259
 
<a name="gimp-progress-install"></a>gimp_progress_install ()</h3>
260
 
<a class="indexterm" name="id2523436"></a><pre class="programlisting">const gchar* gimp_progress_install          (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
261
 
                                             <a href="libgimp-gimpprogress.html#GimpProgressEndCallback">GimpProgressEndCallback</a> end_callback,
262
 
                                             <a href="libgimp-gimpprogress.html#GimpProgressTextCallback">GimpProgressTextCallback</a> text_callback,
263
 
                                             <a href="libgimp-gimpprogress.html#GimpProgressValueCallback">GimpProgressValueCallback</a> value_callback,
264
 
                                             gpointer user_data);</pre>
265
 
<p>
266
 
</p>
267
 
<p>
268
 
 
269
 
</p>
270
 
<div class="variablelist"><table border="0">
271
 
<col align="left" valign="top">
272
 
<tbody>
273
 
<tr>
274
 
<td>
275
 
<span class="term"><em class="parameter"><code>start_callback</code></em>&#160;:</span></td>
276
 
<td> the function to call when progress starts
277
 
</td>
278
 
</tr>
279
 
<tr>
280
 
<td>
281
 
<span class="term"><em class="parameter"><code>end_callback</code></em>&#160;:</span></td>
282
 
<td>   the function to call when progress finishes
283
 
</td>
284
 
</tr>
285
 
<tr>
286
 
<td>
287
 
<span class="term"><em class="parameter"><code>text_callback</code></em>&#160;:</span></td>
288
 
<td>  the function to call to change the text
289
 
</td>
290
 
</tr>
291
 
<tr>
292
 
<td>
293
 
<span class="term"><em class="parameter"><code>value_callback</code></em>&#160;:</span></td>
294
 
<td> the function to call to change the value
295
 
</td>
296
 
</tr>
297
 
<tr>
298
 
<td>
299
 
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
300
 
<td>      a pointer that is returned when uninstalling the progress
301
 
</td>
302
 
</tr>
303
 
<tr>
304
 
<td>
305
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
306
 
<td> the name of the temporary procedure that's been installed
307
 
 
308
 
</td>
309
 
</tr>
310
 
</tbody>
311
 
</table></div>
312
 
<p>Since  GIMP 2.2
313
 
</p>
314
 
</div>
315
 
<hr>
316
 
<div class="refsect2" lang="en">
317
 
<a name="id2545274"></a><h3>
 
228
to call this procedure from a plug-in. Use this function instead of
 
229
<a href="libgimp-gimpprogress.html#gimp-progress-update"><code class="function">gimp_progress_update()</code></a> if you cannot tell how much progress has been
 
230
made. This usually causes the the progress bar to enter \"activity
 
231
mode\", where a block bounces back and forth.</p>
 
232
<p>
 
233
 
 
234
</p>
 
235
<div class="variablelist"><table border="0">
 
236
<col align="left" valign="top">
 
237
<tbody><tr>
 
238
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
239
<td> TRUE on success.
 
240
 
 
241
</td>
 
242
</tr></tbody>
 
243
</table></div>
 
244
<p class="since">Since  GIMP 2.4
 
245
</p>
 
246
</div>
 
247
<hr>
 
248
<div class="refsect2" lang="en">
 
249
<a name="id2610702"></a><h3>
 
250
<a name="gimp-progress-set-text"></a>gimp_progress_set_text ()</h3>
 
251
<a class="indexterm" name="id2610715"></a><pre class="programlisting">gboolean            gimp_progress_set_text              (const gchar *message);</pre>
 
252
<p>
 
253
Changes the text in the progress bar for the current plug-in.
 
254
</p>
 
255
<p>
 
256
This function allows to change the text in the progress bar for the
 
257
current plug-in. Unlike <a href="libgimp-gimpprogress.html#gimp-progress-init"><code class="function">gimp_progress_init()</code></a> it does not change the
 
258
displayed value.</p>
 
259
<p>
 
260
 
 
261
</p>
 
262
<div class="variablelist"><table border="0">
 
263
<col align="left" valign="top">
 
264
<tbody>
 
265
<tr>
 
266
<td><span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
 
267
<td> Message to use in the progress dialog.
 
268
</td>
 
269
</tr>
 
270
<tr>
 
271
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
272
<td> TRUE on success.
 
273
 
 
274
</td>
 
275
</tr>
 
276
</tbody>
 
277
</table></div>
 
278
<p class="since">Since  GIMP 2.4
 
279
</p>
 
280
</div>
 
281
<hr>
 
282
<div class="refsect2" lang="en">
 
283
<a name="id2610797"></a><h3>
 
284
<a name="gimp-progress-set-text-printf"></a>gimp_progress_set_text_printf ()</h3>
 
285
<a class="indexterm" name="id2610811"></a><pre class="programlisting">gboolean            gimp_progress_set_text_printf       (const gchar *format,
 
286
                                                         ...);</pre>
 
287
<p>
 
288
Changes the text in the progress bar for the current plug-in.
 
289
</p>
 
290
<p>
 
291
This function allows to change the text in the progress bar for the
 
292
current plug-in. Unlike <a href="libgimp-gimpprogress.html#gimp-progress-init"><code class="function">gimp_progress_init()</code></a> it does not change the
 
293
displayed value.</p>
 
294
<p>
 
295
 
 
296
</p>
 
297
<div class="variablelist"><table border="0">
 
298
<col align="left" valign="top">
 
299
<tbody>
 
300
<tr>
 
301
<td><span class="term"><em class="parameter"><code>format</code></em>&#160;:</span></td>
 
302
<td> a standard <code class="function">printf()</code> format string
 
303
</td>
 
304
</tr>
 
305
<tr>
 
306
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
 
307
<td> arguments for <em class="parameter"><code>format</code></em>
 
308
</td>
 
309
</tr>
 
310
<tr>
 
311
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
312
<td> <code class="literal">TRUE</code> on success.
 
313
 
 
314
</td>
 
315
</tr>
 
316
</tbody>
 
317
</table></div>
 
318
<p class="since">Since  GIMP 2.4
 
319
</p>
 
320
</div>
 
321
<hr>
 
322
<div class="refsect2" lang="en">
 
323
<a name="id2612865"></a><h3>
318
324
<a name="gimp-progress-uninstall"></a>gimp_progress_uninstall ()</h3>
319
 
<a class="indexterm" name="id2545287"></a><pre class="programlisting">gpointer    gimp_progress_uninstall         (const gchar *progress_callback);</pre>
 
325
<a class="indexterm" name="id2612877"></a><pre class="programlisting">gpointer            gimp_progress_uninstall             (const gchar *progress_callback);</pre>
320
326
<p>
321
327
Uninstalls a temporary progress procedure that was installed using
322
328
<a href="libgimp-gimpprogress.html#gimp-progress-install"><code class="function">gimp_progress_install()</code></a>.</p>
327
333
<col align="left" valign="top">
328
334
<tbody>
329
335
<tr>
330
 
<td>
331
 
<span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
 
336
<td><span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
332
337
<td> the name of the temporary procedure to uninstall
333
338
</td>
334
339
</tr>
335
340
<tr>
336
 
<td>
337
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
341
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
338
342
<td> the <em class="parameter"><code>user_data</code></em> that was passed to <a href="libgimp-gimpprogress.html#gimp-progress-install"><code class="function">gimp_progress_install()</code></a>.
339
343
 
340
344
</td>
341
345
</tr>
342
346
</tbody>
343
347
</table></div>
344
 
<p>Since  GIMP 2.2
 
348
<p class="since">Since  GIMP 2.2
345
349
</p>
346
350
</div>
347
351
<hr>
348
352
<div class="refsect2" lang="en">
349
 
<a name="id2545376"></a><h3>
 
353
<a name="id2612961"></a><h3>
350
354
<a name="gimp-progress-cancel"></a>gimp_progress_cancel ()</h3>
351
 
<a class="indexterm" name="id2545390"></a><pre class="programlisting">gboolean    gimp_progress_cancel            (const gchar *progress_callback);</pre>
 
355
<a class="indexterm" name="id2612973"></a><pre class="programlisting">gboolean            gimp_progress_cancel                (const gchar *progress_callback);</pre>
352
356
<p>
353
357
Cancels a running progress.
354
358
</p>
361
365
<col align="left" valign="top">
362
366
<tbody>
363
367
<tr>
364
 
<td>
365
 
<span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
 
368
<td><span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
366
369
<td> The name of the callback registered for this progress.
367
370
</td>
368
371
</tr>
369
372
<tr>
370
 
<td>
371
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
373
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
372
374
<td> TRUE on success.
373
375
 
374
376
</td>
375
377
</tr>
376
378
</tbody>
377
379
</table></div>
378
 
<p>Since  GIMP 2.2
 
380
<p class="since">Since  GIMP 2.2
 
381
</p>
 
382
</div>
 
383
<hr>
 
384
<div class="refsect2" lang="en">
 
385
<a name="id2613038"></a><h3>
 
386
<a name="gimp-progress-get-window-handle"></a>gimp_progress_get_window_handle ()</h3>
 
387
<a class="indexterm" name="id2613051"></a><pre class="programlisting">gint                gimp_progress_get_window_handle     (void);</pre>
 
388
<p>
 
389
Returns the native window ID of the toplevel window this plug-in's
 
390
progress is displayed in.
 
391
</p>
 
392
<p>
 
393
This function returns the native window ID of the toplevel window
 
394
this plug-in\'s progress is displayed in.</p>
 
395
<p>
 
396
 
 
397
</p>
 
398
<div class="variablelist"><table border="0">
 
399
<col align="left" valign="top">
 
400
<tbody><tr>
 
401
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
402
<td> The progress bar's toplevel window.
 
403
 
 
404
</td>
 
405
</tr></tbody>
 
406
</table></div>
 
407
<p class="since">Since  GIMP 2.2
 
408
</p>
 
409
</div>
 
410
<hr>
 
411
<div class="refsect2" lang="en">
 
412
<a name="id2613100"></a><h3>
 
413
<a name="GimpProgressStartCallback"></a>GimpProgressStartCallback ()</h3>
 
414
<a class="indexterm" name="id2613112"></a><pre class="programlisting">void                (*GimpProgressStartCallback)        (const gchar *message,
 
415
                                                         gboolean cancelable,
 
416
                                                         gpointer user_data);</pre>
 
417
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
418
<h3 class="title">Warning</h3>
 
419
<p><code class="literal">GimpProgressStartCallback</code> is deprecated and should not be used in newly-written code.</p>
 
420
</div>
 
421
<p>
 
422
 
 
423
</p>
 
424
<div class="variablelist"><table border="0">
 
425
<col align="left" valign="top">
 
426
<tbody>
 
427
<tr>
 
428
<td><span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
 
429
<td>
 
430
</td>
 
431
</tr>
 
432
<tr>
 
433
<td><span class="term"><em class="parameter"><code>cancelable</code></em>&#160;:</span></td>
 
434
<td>
 
435
</td>
 
436
</tr>
 
437
<tr>
 
438
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
439
<td>
 
440
 
 
441
 
 
442
</td>
 
443
</tr>
 
444
</tbody>
 
445
</table></div>
 
446
</div>
 
447
<hr>
 
448
<div class="refsect2" lang="en">
 
449
<a name="id2613203"></a><h3>
 
450
<a name="GimpProgressEndCallback"></a>GimpProgressEndCallback ()</h3>
 
451
<a class="indexterm" name="id2613215"></a><pre class="programlisting">void                (*GimpProgressEndCallback)          (gpointer user_data);</pre>
 
452
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
453
<h3 class="title">Warning</h3>
 
454
<p><code class="literal">GimpProgressEndCallback</code> is deprecated and should not be used in newly-written code.</p>
 
455
</div>
 
456
<p>
 
457
 
 
458
</p>
 
459
<div class="variablelist"><table border="0">
 
460
<col align="left" valign="top">
 
461
<tbody><tr>
 
462
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
463
<td>
 
464
 
 
465
 
 
466
</td>
 
467
</tr></tbody>
 
468
</table></div>
 
469
</div>
 
470
<hr>
 
471
<div class="refsect2" lang="en">
 
472
<a name="id2613268"></a><h3>
 
473
<a name="GimpProgressTextCallback"></a>GimpProgressTextCallback ()</h3>
 
474
<a class="indexterm" name="id2613280"></a><pre class="programlisting">void                (*GimpProgressTextCallback)         (const gchar *message,
 
475
                                                         gpointer user_data);</pre>
 
476
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
477
<h3 class="title">Warning</h3>
 
478
<p><code class="literal">GimpProgressTextCallback</code> is deprecated and should not be used in newly-written code.</p>
 
479
</div>
 
480
<p>
 
481
 
 
482
</p>
 
483
<div class="variablelist"><table border="0">
 
484
<col align="left" valign="top">
 
485
<tbody>
 
486
<tr>
 
487
<td><span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
 
488
<td>
 
489
</td>
 
490
</tr>
 
491
<tr>
 
492
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
493
<td>
 
494
 
 
495
 
 
496
</td>
 
497
</tr>
 
498
</tbody>
 
499
</table></div>
 
500
</div>
 
501
<hr>
 
502
<div class="refsect2" lang="en">
 
503
<a name="id2613352"></a><h3>
 
504
<a name="GimpProgressValueCallback"></a>GimpProgressValueCallback ()</h3>
 
505
<a class="indexterm" name="id2613364"></a><pre class="programlisting">void                (*GimpProgressValueCallback)        (gdouble percentage,
 
506
                                                         gpointer user_data);</pre>
 
507
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
508
<h3 class="title">Warning</h3>
 
509
<p><code class="literal">GimpProgressValueCallback</code> is deprecated and should not be used in newly-written code.</p>
 
510
</div>
 
511
<p>
 
512
 
 
513
</p>
 
514
<div class="variablelist"><table border="0">
 
515
<col align="left" valign="top">
 
516
<tbody>
 
517
<tr>
 
518
<td><span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
 
519
<td>
 
520
</td>
 
521
</tr>
 
522
<tr>
 
523
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
524
<td>
 
525
 
 
526
 
 
527
</td>
 
528
</tr>
 
529
</tbody>
 
530
</table></div>
 
531
</div>
 
532
<hr>
 
533
<div class="refsect2" lang="en">
 
534
<a name="id2613436"></a><h3>
 
535
<a name="gimp-progress-install-vtable"></a>gimp_progress_install_vtable ()</h3>
 
536
<a class="indexterm" name="id2613448"></a><pre class="programlisting">const gchar*        gimp_progress_install_vtable        (const <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a> *vtable,
 
537
                                                         gpointer user_data);</pre>
 
538
<p>
 
539
</p>
 
540
<p>
 
541
 
 
542
</p>
 
543
<div class="variablelist"><table border="0">
 
544
<col align="left" valign="top">
 
545
<tbody>
 
546
<tr>
 
547
<td><span class="term"><em class="parameter"><code>vtable</code></em>&#160;:</span></td>
 
548
<td>    a pointer to a <em class="parameter"><code>GimpProgressVtable</code></em>.
 
549
</td>
 
550
</tr>
 
551
<tr>
 
552
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
553
<td> a pointer that is passed as user_data to all vtable functions.
 
554
</td>
 
555
</tr>
 
556
<tr>
 
557
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
558
<td> the name of the temporary procedure that's been installed
 
559
 
 
560
</td>
 
561
</tr>
 
562
</tbody>
 
563
</table></div>
 
564
<p class="since">Since  GIMP 2.4
 
565
</p>
 
566
</div>
 
567
<hr>
 
568
<div class="refsect2" lang="en">
 
569
<a name="id2613535"></a><h3>
 
570
<a name="gimp-progress-install"></a>gimp_progress_install ()</h3>
 
571
<a class="indexterm" name="id2613548"></a><a class="indexterm" name="id2613555"></a><pre class="programlisting">const gchar*        gimp_progress_install               (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
 
572
                                                         <a href="libgimp-gimpprogress.html#GimpProgressEndCallback">GimpProgressEndCallback</a> end_callback,
 
573
                                                         <a href="libgimp-gimpprogress.html#GimpProgressTextCallback">GimpProgressTextCallback</a> text_callback,
 
574
                                                         <a href="libgimp-gimpprogress.html#GimpProgressValueCallback">GimpProgressValueCallback</a> value_callback,
 
575
                                                         gpointer user_data);</pre>
 
576
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
577
<h3 class="title">Warning</h3>
 
578
<p><code class="literal">gimp_progress_install</code> is deprecated and should not be used in newly-written code.</p>
 
579
</div>
 
580
<p>
 
581
</p>
 
582
<p>
 
583
 
 
584
</p>
 
585
<div class="variablelist"><table border="0">
 
586
<col align="left" valign="top">
 
587
<tbody>
 
588
<tr>
 
589
<td><span class="term"><em class="parameter"><code>start_callback</code></em>&#160;:</span></td>
 
590
<td> the function to call when progress starts
 
591
</td>
 
592
</tr>
 
593
<tr>
 
594
<td><span class="term"><em class="parameter"><code>end_callback</code></em>&#160;:</span></td>
 
595
<td>   the function to call when progress finishes
 
596
</td>
 
597
</tr>
 
598
<tr>
 
599
<td><span class="term"><em class="parameter"><code>text_callback</code></em>&#160;:</span></td>
 
600
<td>  the function to call to change the text
 
601
</td>
 
602
</tr>
 
603
<tr>
 
604
<td><span class="term"><em class="parameter"><code>value_callback</code></em>&#160;:</span></td>
 
605
<td> the function to call to change the value
 
606
</td>
 
607
</tr>
 
608
<tr>
 
609
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
610
<td>      a pointer that is returned when uninstalling the progress
 
611
</td>
 
612
</tr>
 
613
<tr>
 
614
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
615
<td> the name of the temporary procedure that's been installed
 
616
 
 
617
</td>
 
618
</tr>
 
619
</tbody>
 
620
</table></div>
 
621
<p class="since">Since  GIMP 2.2
 
622
 
 
623
Note that since GIMP 2.4, @value_callback can be called with
 
624
negative values. This is triggered by calls to gimp_progress_pulse().
 
625
The callback should then implement a progress indicating business,
 
626
e.g. by calling gtk_progress_bar_pulse().
379
627
</p>
380
628
</div>
381
629
</div>