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

Imported Upstream version 2.2.9

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:15:37 -04:00
parent 0b9c5e2b5d
commit f6af42dd71
596 changed files with 118511 additions and 46407 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,4 +1,43 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpprogress</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" 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 all their Properties"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part<72>I.<2E>GIMP Constants"><link rel="part" href="libgimp.html" title="Part<72>II.<2E>GIMP Library"><link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images"><link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties"><link rel="chapter" href="libgimp-data.html" title="Data Objects"><link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs"><link rel="part" href="libgimpui.html" title="Part<72>III.<2E>GIMP User Interface Library"><link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimp-gimpproceduraldb.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><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></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><span class="refentrytitle">gimpprogress</span></h2><p>gimpprogress &#8212; Functions for embedding the progress bar into a plug-in's GUI.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpprogress</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" 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 all their Properties">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpproceduraldb.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<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></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><span class="refentrytitle">gimpprogress</span></h2>
<p>gimpprogress &#8212; Functions for embedding the progress bar into a plug-in's GUI.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
@ -19,82 +58,323 @@ const gchar* <a href="libgimp-gimpprogress.html#gimp-progress-install">gimp_prog
gpointer user_data);
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);
</pre></div><div class="refsect1" lang="en"><a name="id2586532"></a><h2>Description</h2><p>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2553908"></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="id2586543"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2586548"></a><h3><a name="GimpProgressStartCallback"></a>GimpProgressStartCallback ()</h3><a class="indexterm" name="id2586556"></a><pre class="programlisting">void (*GimpProgressStartCallback) (const gchar *message,
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2553920"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2553926"></a><h3>
<a name="GimpProgressStartCallback"></a>GimpProgressStartCallback ()</h3>
<a class="indexterm" name="id2553935"></a><pre class="programlisting">void (*GimpProgressStartCallback) (const gchar *message,
gboolean cancelable,
gpointer user_data);</pre><p>
gpointer user_data);</pre>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>message</code></em><EFBFBD>:</span></td><td>
</td></tr><tr><td><span class="term"><em class="parameter"><code>cancelable</code></em><EFBFBD>:</span></td><td>
</td></tr><tr><td><span class="term"><em class="parameter"><code>user_data</code></em><EFBFBD>:</span></td><td>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>cancelable</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586625"></a><h3><a name="GimpProgressEndCallback"></a>GimpProgressEndCallback ()</h3><a class="indexterm" name="id2586633"></a><pre class="programlisting">void (*GimpProgressEndCallback) (gpointer user_data);</pre><p>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2554023"></a><h3>
<a name="GimpProgressEndCallback"></a>GimpProgressEndCallback ()</h3>
<a class="indexterm" name="id2554032"></a><pre class="programlisting">void (*GimpProgressEndCallback) (gpointer user_data);</pre>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>user_data</code></em><EFBFBD>:</span></td><td>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2585950"></a><h3><a name="GimpProgressTextCallback"></a>GimpProgressTextCallback ()</h3><a class="indexterm" name="id2585959"></a><pre class="programlisting">void (*GimpProgressTextCallback) (const gchar *message,
gpointer user_data);</pre><p>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567664"></a><h3>
<a name="GimpProgressTextCallback"></a>GimpProgressTextCallback ()</h3>
<a class="indexterm" name="id2567673"></a><pre class="programlisting">void (*GimpProgressTextCallback) (const gchar *message,
gpointer user_data);</pre>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>message</code></em><EFBFBD>:</span></td><td>
</td></tr><tr><td><span class="term"><em class="parameter"><code>user_data</code></em><EFBFBD>:</span></td><td>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586010"></a><h3><a name="GimpProgressValueCallback"></a>GimpProgressValueCallback ()</h3><a class="indexterm" name="id2586019"></a><pre class="programlisting">void (*GimpProgressValueCallback) (gdouble percentage,
gpointer user_data);</pre><p>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567740"></a><h3>
<a name="GimpProgressValueCallback"></a>GimpProgressValueCallback ()</h3>
<a class="indexterm" name="id2567749"></a><pre class="programlisting">void (*GimpProgressValueCallback) (gdouble percentage,
gpointer user_data);</pre>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>percentage</code></em><EFBFBD>:</span></td><td>
</td></tr><tr><td><span class="term"><em class="parameter"><code>user_data</code></em><EFBFBD>:</span></td><td>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586069"></a><h3><a name="gimp-progress-init"></a>gimp_progress_init ()</h3><a class="indexterm" name="id2586078"></a><pre class="programlisting">gboolean gimp_progress_init (const gchar *message);</pre><p>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567815"></a><h3>
<a name="gimp-progress-init"></a>gimp_progress_init ()</h3>
<a class="indexterm" name="id2567825"></a><pre class="programlisting">gboolean gimp_progress_init (const gchar *message);</pre>
<p>
Initializes the progress bar for the current plug-in.
</p><p>
</p>
<p>
Initializes the progress bar for the current plug-in. It is only
valid to call this procedure from a plug-in.</p><p>
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>message</code></em><EFBFBD>:</span></td><td> Message to use in the progress dialog.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2586130"></a><h3><a name="gimp-progress-update"></a>gimp_progress_update ()</h3><a class="indexterm" name="id2586139"></a><pre class="programlisting">gboolean gimp_progress_update (gdouble percentage);</pre><p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
<td> Message to use in the progress dialog.
</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>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2559986"></a><h3>
<a name="gimp-progress-update"></a>gimp_progress_update ()</h3>
<a class="indexterm" name="id2559995"></a><pre class="programlisting">gboolean gimp_progress_update (gdouble percentage);</pre>
<p>
Updates the progress bar for the current plug-in.
</p><p>
</p>
<p>
Updates the progress bar for the current plug-in. It is only valid
to call this procedure from a plug-in.</p><p>
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>percentage</code></em><EFBFBD>:</span></td><td> Percentage of progress completed which must be between 0.0 and 1.0.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2555520"></a><h3><a name="gimp-progress-install"></a>gimp_progress_install ()</h3><a class="indexterm" name="id2555528"></a><pre class="programlisting">const gchar* gimp_progress_install (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
<td> Percentage of progress completed which must be between 0.0 and 1.0.
</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>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560062"></a><h3>
<a name="gimp-progress-install"></a>gimp_progress_install ()</h3>
<a class="indexterm" name="id2560071"></a><pre class="programlisting">const gchar* 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><p>
</p><p>
gpointer user_data);</pre>
<p>
</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>start_callback</code></em><EFBFBD>:</span></td><td> the function to call when progress starts
</td></tr><tr><td><span class="term"><em class="parameter"><code>end_callback</code></em><EFBFBD>:</span></td><td> the function to call when progress finishes
</td></tr><tr><td><span class="term"><em class="parameter"><code>text_callback</code></em><EFBFBD>:</span></td><td> the function to call to change the text
</td></tr><tr><td><span class="term"><em class="parameter"><code>value_callback</code></em><EFBFBD>:</span></td><td> the function to call to change the value
</td></tr><tr><td><span class="term"><em class="parameter"><code>user_data</code></em><EFBFBD>:</span></td><td> a pointer that is returned when uninstalling the progress
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> the name of the temporary procedure that's been installed
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>start_callback</code></em>&#160;:</span></td>
<td> the function to call when progress starts
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>end_callback</code></em>&#160;:</span></td>
<td> the function to call when progress finishes
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>text_callback</code></em>&#160;:</span></td>
<td> the function to call to change the text
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value_callback</code></em>&#160;:</span></td>
<td> the function to call to change the value
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td> a pointer that is returned when uninstalling the progress
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the name of the temporary procedure that's been installed
</td></tr></tbody></table></div><p>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2555652"></a><h3><a name="gimp-progress-uninstall"></a>gimp_progress_uninstall ()</h3><a class="indexterm" name="id2555660"></a><pre class="programlisting">gpointer gimp_progress_uninstall (const gchar *progress_callback);</pre><p>
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2560224"></a><h3>
<a name="gimp-progress-uninstall"></a>gimp_progress_uninstall ()</h3>
<a class="indexterm" name="id2560233"></a><pre class="programlisting">gpointer gimp_progress_uninstall (const gchar *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>
<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><EFBFBD>:</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><EFBFBD>:</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>.
</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>Since GIMP 2.2
</p></div><hr><div class="refsect2" lang="en"><a name="id2555730"></a><h3><a name="gimp-progress-cancel"></a>gimp_progress_cancel ()</h3><a class="indexterm" name="id2555738"></a><pre class="programlisting">gboolean gimp_progress_cancel (const gchar *progress_callback);</pre><p>
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537732"></a><h3>
<a name="gimp-progress-cancel"></a>gimp_progress_cancel ()</h3>
<a class="indexterm" name="id2537741"></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>
<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><EFBFBD>:</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><EFBFBD>:</span></td><td> TRUE on success.
</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>Since GIMP 2.2
</p></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-gimpproceduraldb.html"><b>&lt;&lt;<EFBFBD>gimpproceduraldb</b></a></td><td align="right"><a accesskey="n" href="libgimp-image.html"><b>Manupulating Images and all their Properties<65>&gt;&gt;</b></a></td></tr></table></body></html>
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimp-gimpproceduraldb.html"><b>&lt;&lt;&#160;gimpproceduraldb</b></a></td>
<td align="right"><a accesskey="n" href="libgimp-image.html"><b>Manupulating Images and all their Properties&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>