diff options
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimpprogress.html')
| -rw-r--r-- | devel-docs/libgimp/html/libgimp-gimpprogress.html | 614 |
1 files changed, 614 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpprogress.html b/devel-docs/libgimp/html/libgimp-gimpprogress.html new file mode 100644 index 0000000..f41cfad --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpprogress.html @@ -0,0 +1,614 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimpprogress: GIMP Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<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-gimpdebug.html" title="gimpdebug"> +<meta name="generator" content="GTK-Doc V1.32 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#libgimp-gimpprogress.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimp-gimpproceduraldb.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimpdebug.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimp-gimpprogress"></a><div class="titlepage"></div> +<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> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimpprogress.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpprogress.html#GimpProgressStartCallback" title="GimpProgressStartCallback ()">*GimpProgressStartCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpprogress.html#GimpProgressEndCallback" title="GimpProgressEndCallback ()">*GimpProgressEndCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpprogress.html#GimpProgressTextCallback" title="GimpProgressTextCallback ()">*GimpProgressTextCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="libgimp-gimpprogress.html#GimpProgressValueCallback" title="GimpProgressValueCallback ()">*GimpProgressValueCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">gchar</span> * +</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> +<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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gpointer</span> +</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> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</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> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpprogress.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="libgimp-gimpprogress.html#GimpProgressVtable" title="struct GimpProgressVtable">GimpProgressVtable</a></td> +</tr></tbody> +</table></div> +</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="gimp-progress-init.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-init.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</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>, + <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="gimp-progress-init-printf.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-init-printf.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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="gimp-progress-update.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-update.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-progress-pulse"></a><h3>gimp_progress_pulse ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +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="gimp-progress-pulse.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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 changes 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="gimp-progress-set-text.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-set-text.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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>, + <em class="parameter"><code>...</code></em>);</pre> +<p>Changes the text in the progress bar for the current plug-in.</p> +<p>This function changes 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="gimp-progress-set-text-printf.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-set-text-printf.returns"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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> +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="gimp-progress-end.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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> +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="gimp-progress-get-window-handle.returns"></a><h4>Returns</h4> +<p> The progress bar's toplevel window.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></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> +<div class="warning"><p><code class="literal">GimpProgressStartCallback</code> is deprecated and should not be used in newly-written code.</p></div> +</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> +<div class="warning"><p><code class="literal">GimpProgressEndCallback</code> is deprecated and should not be used in newly-written code.</p></div> +</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> +<div class="warning"><p><code class="literal">GimpProgressTextCallback</code> is deprecated and should not be used in newly-written code.</p></div> +</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> +<div class="warning"><p><code class="literal">GimpProgressValueCallback</code> is deprecated and should not be used in newly-written code.</p></div> +</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> * +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="gimp-progress-install-vtable.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-install-vtable.returns"></a><h4>Returns</h4> +<p> the name of the temporary procedure that's been installed</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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> * +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> +<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 <a href="https://developer.gnome.org/gtk3/GtkProgressBar.html#gtk-progress-bar-pulse"><code class="function">gtk_progress_bar_pulse()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-progress-install.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-install.returns"></a><h4>Returns</h4> +<p> the name of the temporary procedure that's been installed</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></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="gimp-progress-uninstall.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-uninstall.returns"></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> +</div> +<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></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="gimp-progress-cancel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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="gimp-progress-cancel.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-2.html#api-index-2.2">2.2</a></p> +</div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpprogress.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GimpProgressVtable"></a><h3>struct GimpProgressVtable</h3> +<pre class="programlisting">struct GimpProgressVtable { + void (* start) (const gchar *message, + gboolean cancelable, + gpointer user_data); + void (* end) (gpointer user_data); + void (* set_text) (const gchar *message, + gpointer user_data); + void (* set_value) (gdouble percentage, + gpointer user_data); + void (* pulse) (gpointer user_data); + + guint32 (* get_window) (gpointer user_data); + + /* Padding for future expansion. Must be initialized with NULL! */ + void (* _gimp_reserved1) (void); + void (* _gimp_reserved2) (void); + void (* _gimp_reserved3) (void); + void (* _gimp_reserved4) (void); + void (* _gimp_reserved5) (void); + void (* _gimp_reserved6) (void); + void (* _gimp_reserved7) (void); + void (* _gimp_reserved8) (void); +}; +</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |