callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.8.16

Browse Source
This commit is contained in:
Ari Pollak
2015-11-24 14:17:30 -05:00
parent bf2f572083
commit 66d1b776a9
842 changed files with 251623 additions and 240362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

402
devel-docs/libgimp/html/libgimp-gimpprogress.html
View File

@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIMP Library Reference Manual: gimpprogress</title>
<title>gimpprogress: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp-gimpproceduraldb.html" title="gimpproceduraldb">
<link rel="next" href="libgimp-image.html" title="Manupulating Images and their Properties">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -27,7 +27,7 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpprogress.top_of_page"></a>gimpprogress</span></h2>
<p>gimpprogress — Functions for embedding the progress bar into a plug-in's GUI.</p>
<p>gimpprogress</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
@ -41,7 +41,7 @@
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()">gimp_progress_init</a> <span class="c_punctuation">()</span>
@ -49,7 +49,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-init-printf" title="gimp_progress_init_printf ()">gimp_progress_init_printf</a> <span class="c_punctuation">()</span>
@ -57,7 +57,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-update" title="gimp_progress_update ()">gimp_progress_update</a> <span class="c_punctuation">()</span>
@ -65,7 +65,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-pulse" title="gimp_progress_pulse ()">gimp_progress_pulse</a> <span class="c_punctuation">()</span>
@ -73,7 +73,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-set-text" title="gimp_progress_set_text ()">gimp_progress_set_text</a> <span class="c_punctuation">()</span>
@ -81,7 +81,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-set-text-printf" title="gimp_progress_set_text_printf ()">gimp_progress_set_text_printf</a> <span class="c_punctuation">()</span>
@ -89,7 +89,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-end" title="gimp_progress_end ()">gimp_progress_end</a> <span class="c_punctuation">()</span>
@ -97,7 +97,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-get-window-handle" title="gimp_progress_get_window_handle ()">gimp_progress_get_window_handle</a> <span class="c_punctuation">()</span>
@ -136,14 +136,14 @@
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-install-vtable" title="gimp_progress_install_vtable ()">gimp_progress_install_vtable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-install" title="gimp_progress_install ()">gimp_progress_install</a> <span class="c_punctuation">()</span>
@ -151,7 +151,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gpointer</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-uninstall" title="gimp_progress_uninstall ()">gimp_progress_uninstall</a> <span class="c_punctuation">()</span>
@ -159,7 +159,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-cancel" title="gimp_progress_cancel ()">gimp_progress_cancel</a> <span class="c_punctuation">()</span>
@ -183,418 +183,129 @@
</div>
<div class="refsect1">
<a name="libgimp-gimpprogress.description"></a><h2>Description</h2>
<p>Functions for embedding the progress bar into a plug-in's GUI.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpprogress.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-progress-init"></a><h3>gimp_progress_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_init (<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>Initializes the progress bar for the current plug-in.</p>
<p>Initializes the progress bar for the current plug-in. It is only
valid to call this procedure from a plug-in.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>Message to use in the progress dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.2.7"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_progress_init (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-init-printf"></a><h3>gimp_progress_init_printf ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_init_printf (<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_progress_init_printf (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Initializes the progress bar for the current plug-in.</p>
<p>Initializes the progress bar for the current plug-in. It is only
valid to call this procedure from a plug-in.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a standard <code class="function">printf()</code> format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>arguments for <em class="parameter"><code>format</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.3.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-update"></a><h3>gimp_progress_update ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_update (<em class="parameter"><code><span class="type">gdouble</span> percentage</code></em>);</pre>
<p>Updates the progress bar for the current plug-in.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>percentage</p></td>
<td class="parameter_description"><p>Percentage of progress completed (in the range from 0.0 to 1.0).</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.4.6"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_progress_update (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> percentage</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-pulse"></a><h3>gimp_progress_pulse ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_progress_pulse (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Pulses the progress bar for the current plug-in.</p>
<p>Updates the progress bar for the current plug-in. It is only valid
to call this procedure from a plug-in. Use this function instead of
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-update" title="gimp_progress_update ()"><code class="function">gimp_progress_update()</code></a> if you cannot tell how much progress has been
made. This usually causes the the progress bar to enter \"activity
mode\", where a block bounces back and forth.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.5.6"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-set-text"></a><h3>gimp_progress_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_set_text (<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>);</pre>
<p>Changes the text in the progress bar for the current plug-in.</p>
<p>This function allows to change the text in the progress bar for the
current plug-in. Unlike <a class="link" href="libgimp-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()"><code class="function">gimp_progress_init()</code></a> it does not change the
displayed value.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>Message to use in the progress dialog.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.6.7"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_progress_set_text (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-set-text-printf"></a><h3>gimp_progress_set_text_printf ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_set_text_printf (<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_progress_set_text_printf (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Changes the text in the progress bar for the current plug-in.</p>
<p>This function allows to change the text in the progress bar for the
current plug-in. Unlike <a class="link" href="libgimp-gimpprogress.html#gimp-progress-init" title="gimp_progress_init ()"><code class="function">gimp_progress_init()</code></a> it does not change the
displayed value.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>a standard <code class="function">printf()</code> format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>arguments for <em class="parameter"><code>format</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.7.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-end"></a><h3>gimp_progress_end ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_progress_end (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<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>
<div class="refsect3">
<a name="id-1.2.3.11.6.8.6"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-get-window-handle"></a><h3>gimp_progress_get_window_handle ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gimp_progress_get_window_handle (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the native window ID of the toplevel window this plug-in's
progress is displayed in.</p>
<p>This function returns the native window ID of the toplevel window
this plug-in\'s progress is displayed in.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.9.6"></a><h4>Returns</h4>
<p> The progress bar's toplevel window.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressStartCallback"></a><h3>GimpProgressStartCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressStartCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> cancelable</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<span class="c_punctuation">(</span>*GimpProgressStartCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> cancelable</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<div class="warning"><p><code class="literal">GimpProgressStartCallback</code> is deprecated and should not be used in newly-written code.</p></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressEndCallback"></a><h3>GimpProgressEndCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressEndCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<span class="c_punctuation">(</span>*GimpProgressEndCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<div class="warning"><p><code class="literal">GimpProgressEndCallback</code> is deprecated and should not be used in newly-written code.</p></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressTextCallback"></a><h3>GimpProgressTextCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressTextCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<span class="c_punctuation">(</span>*GimpProgressTextCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<div class="warning"><p><code class="literal">GimpProgressTextCallback</code> is deprecated and should not be used in newly-written code.</p></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpProgressValueCallback"></a><h3>GimpProgressValueCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GimpProgressValueCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gdouble</span> percentage</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<span class="c_punctuation">(</span>*GimpProgressValueCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> percentage</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<div class="warning"><p><code class="literal">GimpProgressValueCallback</code> is deprecated and should not be used in newly-written code.</p></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-install-vtable"></a><h3>gimp_progress_install_vtable ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_progress_install_vtable (<em class="parameter"><code>const <a class="link" href="libgimp-gimpprogress.html#GimpProgressVtable" title="struct GimpProgressVtable"><span class="type">GimpProgressVtable</span></a> *vtable</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.3.11.6.14.4"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>vtable</p></td>
<td class="parameter_description"><p>a pointer to a <em class="parameter"><code>GimpProgressVtable</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>a pointer that is passed as user_data to all vtable functions.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.14.5"></a><h4>Returns</h4>
<p> the name of the temporary procedure that's been installed</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-install"></a><h3>gimp_progress_install ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_progress_install (<em class="parameter"><code><a class="link" href="libgimp-gimpprogress.html#GimpProgressStartCallback" title="GimpProgressStartCallback ()"><span class="type">GimpProgressStartCallback</span></a> start_callback</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpprogress.html#GimpProgressEndCallback" title="GimpProgressEndCallback ()"><span class="type">GimpProgressEndCallback</span></a> end_callback</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpprogress.html#GimpProgressTextCallback" title="GimpProgressTextCallback ()"><span class="type">GimpProgressTextCallback</span></a> text_callback</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpprogress.html#GimpProgressValueCallback" title="GimpProgressValueCallback ()"><span class="type">GimpProgressValueCallback</span></a> value_callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<div class="warning"><p><code class="literal">gimp_progress_install</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Note that since GIMP 2.4, <em class="parameter"><code>value_callback</code></em>
can be called with
negative values. This is triggered by calls to <a class="link" href="libgimp-gimpprogress.html#gimp-progress-pulse" title="gimp_progress_pulse ()"><code class="function">gimp_progress_pulse()</code></a>.
The callback should then implement a progress indicating business,
e.g. by calling <code class="function">gtk_progress_bar_pulse()</code>.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.15.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>start_callback</p></td>
<td class="parameter_description"><p>the function to call when progress starts</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_callback</p></td>
<td class="parameter_description"><p>the function to call when progress finishes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text_callback</p></td>
<td class="parameter_description"><p>the function to call to change the text</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value_callback</p></td>
<td class="parameter_description"><p>the function to call to change the value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>a pointer that is returned when uninstalling the progress</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.15.8"></a><h4>Returns</h4>
<p> the name of the temporary procedure that's been installed</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-uninstall"></a><h3>gimp_progress_uninstall ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span>
gimp_progress_uninstall (<em class="parameter"><code>const <span class="type">gchar</span> *progress_callback</code></em>);</pre>
<p>Uninstalls a temporary progress procedure that was installed using
<a class="link" href="libgimp-gimpprogress.html#gimp-progress-install" title="gimp_progress_install ()"><code class="function">gimp_progress_install()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.16.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>progress_callback</p></td>
<td class="parameter_description"><p>the name of the temporary procedure to uninstall</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.16.6"></a><h4>Returns</h4>
<p> the <em class="parameter"><code>user_data</code></em>
that was passed to <a class="link" href="libgimp-gimpprogress.html#gimp-progress-install" title="gimp_progress_install ()"><code class="function">gimp_progress_install()</code></a>.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
gimp_progress_uninstall (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *progress_callback</code></em>);</pre>
<p class="since">Since: GIMP 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-progress-cancel"></a><h3>gimp_progress_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_progress_cancel (<em class="parameter"><code>const <span class="type">gchar</span> *progress_callback</code></em>);</pre>
<p>Cancels a running progress.</p>
<p>This function cancels the currently running progress.</p>
<div class="refsect3">
<a name="id-1.2.3.11.6.17.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>progress_callback</p></td>
<td class="parameter_description"><p>The name of the callback registered for this progress.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.11.6.17.7"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.2</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_progress_cancel (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *progress_callback</code></em>);</pre>
<p class="since">Since: GIMP 2.2</p>
</div>
</div>
<div class="refsect1">
@ -625,13 +336,10 @@ gimp_progress_cancel (<em class="parameter"><code>const <span class="type">gchar
void (* _gimp_reserved8) (void);
};
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>