Imported Upstream version 2.4.0~rc1

This commit is contained in:
Ari Pollak
2010-08-11 01:22:21 -04:00
parent 5516c26b4b
commit d884b2912c
672 changed files with 122964 additions and 82169 deletions

View File

@ -31,16 +31,16 @@
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-image.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2597737" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2599592" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2608514" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2562247" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpprogress"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2597737"></a><span class="refentrytitle">gimpprogress</span>
<a name="id2599592"></a><span class="refentrytitle">gimpprogress</span>
</h2>
<p>gimpprogress &#8212; Functions for embedding the progress bar into a plug-in's GUI.</p>
</td>
@ -53,46 +53,105 @@
<a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a>;
gboolean <a href="libgimp-gimpprogress.html#gimp-progress-init">gimp_progress_init</a> (const gchar *message);
gboolean <a href="libgimp-gimpprogress.html#gimp-progress-init-printf">gimp_progress_init_printf</a> (const gchar *format,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpprogress.html#gimp-progress-init">gimp_progress_init</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *message);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpprogress.html#gimp-progress-init-printf">gimp_progress_init_printf</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *format,
...);
gboolean <a href="libgimp-gimpprogress.html#gimp-progress-update">gimp_progress_update</a> (gdouble percentage);
gboolean <a href="libgimp-gimpprogress.html#gimp-progress-pulse">gimp_progress_pulse</a> (void);
gboolean <a href="libgimp-gimpprogress.html#gimp-progress-set-text">gimp_progress_set_text</a> (const gchar *message);
gboolean <a href="libgimp-gimpprogress.html#gimp-progress-set-text-printf">gimp_progress_set_text_printf</a> (const gchar *format,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpprogress.html#gimp-progress-update">gimp_progress_update</a> (<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> percentage);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpprogress.html#gimp-progress-pulse">gimp_progress_pulse</a> (void);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpprogress.html#gimp-progress-set-text">gimp_progress_set_text</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *message);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpprogress.html#gimp-progress-set-text-printf">gimp_progress_set_text_printf</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *format,
...);
gpointer <a href="libgimp-gimpprogress.html#gimp-progress-uninstall">gimp_progress_uninstall</a> (const gchar *progress_callback);
gboolean <a href="libgimp-gimpprogress.html#gimp-progress-cancel">gimp_progress_cancel</a> (const gchar *progress_callback);
gint <a href="libgimp-gimpprogress.html#gimp-progress-get-window-handle">gimp_progress_get_window_handle</a> (void);
void (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">*GimpProgressStartCallback</a>) (const gchar *message,
gboolean cancelable,
gpointer user_data);
void (<a href="libgimp-gimpprogress.html#GimpProgressEndCallback">*GimpProgressEndCallback</a>) (gpointer user_data);
void (<a href="libgimp-gimpprogress.html#GimpProgressTextCallback">*GimpProgressTextCallback</a>) (const gchar *message,
gpointer user_data);
void (<a href="libgimp-gimpprogress.html#GimpProgressValueCallback">*GimpProgressValueCallback</a>) (gdouble percentage,
gpointer user_data);
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,
gpointer user_data);
const gchar* <a href="libgimp-gimpprogress.html#gimp-progress-install">gimp_progress_install</a> (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpprogress.html#gimp-progress-end">gimp_progress_end</a> (void);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="libgimp-gimpprogress.html#gimp-progress-get-window-handle">gimp_progress_get_window_handle</a> (void);
void (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">*GimpProgressStartCallback</a>) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *message,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> cancelable,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
void (<a href="libgimp-gimpprogress.html#GimpProgressEndCallback">*GimpProgressEndCallback</a>) (<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
void (<a href="libgimp-gimpprogress.html#GimpProgressTextCallback">*GimpProgressTextCallback</a>) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *message,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
void (<a href="libgimp-gimpprogress.html#GimpProgressValueCallback">*GimpProgressValueCallback</a>) (<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> percentage,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimp-gimpprogress.html#gimp-progress-install-vtable">gimp_progress_install_vtable</a> (const <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a> *vtable,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimp-gimpprogress.html#gimp-progress-install">gimp_progress_install</a> (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
<a href="libgimp-gimpprogress.html#GimpProgressEndCallback">GimpProgressEndCallback</a> end_callback,
<a href="libgimp-gimpprogress.html#GimpProgressTextCallback">GimpProgressTextCallback</a> text_callback,
<a href="libgimp-gimpprogress.html#GimpProgressValueCallback">GimpProgressValueCallback</a> value_callback,
gpointer user_data);
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> <a href="libgimp-gimpprogress.html#gimp-progress-uninstall">gimp_progress_uninstall</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *progress_callback);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpprogress.html#gimp-progress-cancel">gimp_progress_cancel</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *progress_callback);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2608514"></a><h2>Description</h2>
<a name="id2562247"></a><h2>Description</h2>
<p>
Functions for embedding the progress bar into a plug-in's GUI.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2608531"></a><h2>Details</h2>
<a name="id2562264"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2608542"></a><h3>
<a name="id2562274"></a><h3>
<a name="GimpProgressVtable"></a>GimpProgressVtable</h3>
<a class="indexterm" name="id2608554"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2562287"></a><pre class="programlisting">typedef struct {
void (* start) (const gchar *message,
gboolean cancelable,
gpointer user_data);
@ -122,9 +181,13 @@ Functions for embedding the progress bar into a plug-in's GUI.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608585"></a><h3>
<a name="id2562318"></a><h3>
<a name="gimp-progress-init"></a>gimp_progress_init ()</h3>
<a class="indexterm" name="id2608597"></a><pre class="programlisting">gboolean gimp_progress_init (const gchar *message);</pre>
<a class="indexterm" name="id2562330"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_progress_init (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *message);</pre>
<p>
Initializes the progress bar for the current plug-in.
</p>
@ -152,9 +215,13 @@ valid to call this procedure from a plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610457"></a><h3>
<a name="id2562396"></a><h3>
<a name="gimp-progress-init-printf"></a>gimp_progress_init_printf ()</h3>
<a class="indexterm" name="id2610470"></a><pre class="programlisting">gboolean gimp_progress_init_printf (const gchar *format,
<a class="indexterm" name="id2610623"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_progress_init_printf (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *format,
...);</pre>
<p>
Initializes the progress bar for the current plug-in.
@ -180,7 +247,9 @@ valid to call this procedure from a plug-in.</p>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> on success.
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success.
</td>
</tr>
@ -191,9 +260,13 @@ valid to call this procedure from a plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610584"></a><h3>
<a name="id2610737"></a><h3>
<a name="gimp-progress-update"></a>gimp_progress_update ()</h3>
<a class="indexterm" name="id2610596"></a><pre class="programlisting">gboolean gimp_progress_update (gdouble percentage);</pre>
<a class="indexterm" name="id2610749"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_progress_update (<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> percentage);</pre>
<p>
Updates the progress bar for the current plug-in.</p>
<p>
@ -217,9 +290,11 @@ Updates the progress bar for the current plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610658"></a><h3>
<a name="id2610810"></a><h3>
<a name="gimp-progress-pulse"></a>gimp_progress_pulse ()</h3>
<a class="indexterm" name="id2610672"></a><pre class="programlisting">gboolean gimp_progress_pulse (void);</pre>
<a class="indexterm" name="id2610825"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_progress_pulse (void);</pre>
<p>
Pulses the progress bar for the current plug-in.
</p>
@ -246,9 +321,13 @@ mode\", where a block bounces back and forth.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610737"></a><h3>
<a name="id2610890"></a><h3>
<a name="gimp-progress-set-text"></a>gimp_progress_set_text ()</h3>
<a class="indexterm" name="id2610751"></a><pre class="programlisting">gboolean gimp_progress_set_text (const gchar *message);</pre>
<a class="indexterm" name="id2610904"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_progress_set_text (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *message);</pre>
<p>
Changes the text in the progress bar for the current plug-in.
</p>
@ -280,9 +359,13 @@ displayed value.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610833"></a><h3>
<a name="id2610986"></a><h3>
<a name="gimp-progress-set-text-printf"></a>gimp_progress_set_text_printf ()</h3>
<a class="indexterm" name="id2610847"></a><pre class="programlisting">gboolean gimp_progress_set_text_printf (const gchar *format,
<a class="indexterm" name="id2611000"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_progress_set_text_printf (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *format,
...);</pre>
<p>
Changes the text in the progress bar for the current plug-in.
@ -309,7 +392,9 @@ displayed value.</p>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> on success.
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> on success.
</td>
</tr>
@ -320,71 +405,40 @@ displayed value.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2612906"></a><h3>
<a name="gimp-progress-uninstall"></a>gimp_progress_uninstall ()</h3>
<a class="indexterm" name="id2612918"></a><pre class="programlisting">gpointer gimp_progress_uninstall (const gchar *progress_callback);</pre>
<a name="id2613157"></a><h3>
<a name="gimp-progress-end"></a>gimp_progress_end ()</h3>
<a class="indexterm" name="id2613170"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_progress_end (void);</pre>
<p>
Uninstalls a temporary progress procedure that was installed using
<a href="libgimp-gimpprogress.html#gimp-progress-install"><code class="function">gimp_progress_install()</code></a>.</p>
Ends the progress bar for the current plug-in.
</p>
<p>
Ends the progress display for the current plug-in. Most plug-ins
don't need to call this, they just exit when the work is done. It is
only valid to call this procedure from a plug-in.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
<td> the name of the temporary procedure to uninstall
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<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>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613002"></a><h3>
<a name="gimp-progress-cancel"></a>gimp_progress_cancel ()</h3>
<a class="indexterm" name="id2613014"></a><pre class="programlisting">gboolean gimp_progress_cancel (const gchar *progress_callback);</pre>
<p>
Cancels a running progress.
</p>
<p>
This function cancels the currently running progress.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
<td> The name of the callback registered for this progress.
</td>
</tr>
<tr>
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</tr></tbody>
</table></div>
<p class="since">Since GIMP 2.2
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613079"></a><h3>
<a name="id2613219"></a><h3>
<a name="gimp-progress-get-window-handle"></a>gimp_progress_get_window_handle ()</h3>
<a class="indexterm" name="id2613092"></a><pre class="programlisting">gint gimp_progress_get_window_handle (void);</pre>
<a class="indexterm" name="id2613231"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_progress_get_window_handle (void);</pre>
<p>
Returns the native window ID of the toplevel window this plug-in's
progress is displayed in.
@ -409,11 +463,17 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613140"></a><h3>
<a name="id2613280"></a><h3>
<a name="GimpProgressStartCallback"></a>GimpProgressStartCallback ()</h3>
<a class="indexterm" name="id2613153"></a><pre class="programlisting">void (*GimpProgressStartCallback) (const gchar *message,
gboolean cancelable,
gpointer user_data);</pre>
<a class="indexterm" name="id2613293"></a><pre class="programlisting">void (*GimpProgressStartCallback) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *message,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> cancelable,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GimpProgressStartCallback</code> is deprecated and should not be used in newly-written code.</p>
@ -446,9 +506,11 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613244"></a><h3>
<a name="id2613384"></a><h3>
<a name="GimpProgressEndCallback"></a>GimpProgressEndCallback ()</h3>
<a class="indexterm" name="id2613256"></a><pre class="programlisting">void (*GimpProgressEndCallback) (gpointer user_data);</pre>
<a class="indexterm" name="id2613396"></a><pre class="programlisting">void (*GimpProgressEndCallback) (<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GimpProgressEndCallback</code> is deprecated and should not be used in newly-written code.</p>
@ -469,10 +531,14 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613308"></a><h3>
<a name="id2613449"></a><h3>
<a name="GimpProgressTextCallback"></a>GimpProgressTextCallback ()</h3>
<a class="indexterm" name="id2613321"></a><pre class="programlisting">void (*GimpProgressTextCallback) (const gchar *message,
gpointer user_data);</pre>
<a class="indexterm" name="id2613461"></a><pre class="programlisting">void (*GimpProgressTextCallback) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *message,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GimpProgressTextCallback</code> is deprecated and should not be used in newly-written code.</p>
@ -500,10 +566,14 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613392"></a><h3>
<a name="id2613533"></a><h3>
<a name="GimpProgressValueCallback"></a>GimpProgressValueCallback ()</h3>
<a class="indexterm" name="id2613405"></a><pre class="programlisting">void (*GimpProgressValueCallback) (gdouble percentage,
gpointer user_data);</pre>
<a class="indexterm" name="id2613546"></a><pre class="programlisting">void (*GimpProgressValueCallback) (<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> percentage,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GimpProgressValueCallback</code> is deprecated and should not be used in newly-written code.</p>
@ -531,10 +601,14 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613476"></a><h3>
<a name="id2613618"></a><h3>
<a name="gimp-progress-install-vtable"></a>gimp_progress_install_vtable ()</h3>
<a class="indexterm" name="id2613489"></a><pre class="programlisting">const gchar* gimp_progress_install_vtable (const <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a> *vtable,
gpointer user_data);</pre>
<a class="indexterm" name="id2613632"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_progress_install_vtable (const <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a> *vtable,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
</p>
<p>
@ -566,13 +640,17 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613578"></a><h3>
<a name="id2613720"></a><h3>
<a name="gimp-progress-install"></a>gimp_progress_install ()</h3>
<a class="indexterm" name="id2613590"></a><a class="indexterm" name="id2613597"></a><pre class="programlisting">const gchar* gimp_progress_install (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
<a class="indexterm" name="id2613732"></a><a class="indexterm" name="id2613740"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_progress_install (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
<a href="libgimp-gimpprogress.html#GimpProgressEndCallback">GimpProgressEndCallback</a> end_callback,
<a href="libgimp-gimpprogress.html#GimpProgressTextCallback">GimpProgressTextCallback</a> text_callback,
<a href="libgimp-gimpprogress.html#GimpProgressValueCallback">GimpProgressValueCallback</a> value_callback,
gpointer user_data);</pre>
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_progress_install</code> is deprecated and should not be used in newly-written code.</p>
@ -626,6 +704,76 @@ The callback should then implement a progress indicating business,
e.g. by calling gtk_progress_bar_pulse().
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613901"></a><h3>
<a name="gimp-progress-uninstall"></a>gimp_progress_uninstall ()</h3>
<a class="indexterm" name="id2613914"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> gimp_progress_uninstall (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *progress_callback);</pre>
<p>
Uninstalls a temporary progress procedure that was installed using
<a href="libgimp-gimpprogress.html#gimp-progress-install"><code class="function">gimp_progress_install()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
<td> the name of the temporary procedure to uninstall
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<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>.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613997"></a><h3>
<a name="gimp-progress-cancel"></a>gimp_progress_cancel ()</h3>
<a class="indexterm" name="id2614010"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_progress_cancel (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *progress_callback);</pre>
<p>
Cancels a running progress.
</p>
<p>
This function cancels the currently running progress.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
<td> The name of the callback registered for this progress.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
</div>
</div>
</body>