Imported Upstream version 2.3.15

This commit is contained in:
Ari Pollak
2010-08-11 01:21:06 -04:00
parent aca02f7697
commit d694295a3e
819 changed files with 63117 additions and 44484 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="#id2559491" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2563774" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2553146" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2553545" 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="id2559491"></a><span class="refentrytitle">gimpprogress</span>
<a name="id2563774"></a><span class="refentrytitle">gimpprogress</span>
</h2>
<p>gimpprogress &#8212; Functions for embedding the progress bar into a plug-in's GUI.</p>
</td>
@ -82,17 +82,17 @@ const gchar* <a href="libgimp-gimpprogress.html#gimp-progress-install">gimp_prog
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2553146"></a><h2>Description</h2>
<a name="id2553545"></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="id2553163"></a><h2>Details</h2>
<a name="id2553561"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2553174"></a><h3>
<a name="id2553572"></a><h3>
<a name="GimpProgressVtable"></a>GimpProgressVtable</h3>
<a class="indexterm" name="id2553186"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2601690"></a><pre class="programlisting">typedef struct {
void (* start) (const gchar *message,
gboolean cancelable,
gpointer user_data);
@ -122,9 +122,9 @@ Functions for embedding the progress bar into a plug-in's GUI.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601776"></a><h3>
<a name="id2601720"></a><h3>
<a name="gimp-progress-init"></a>gimp_progress_init ()</h3>
<a class="indexterm" name="id2601788"></a><pre class="programlisting">gboolean gimp_progress_init (const gchar *message);</pre>
<a class="indexterm" name="id2601733"></a><pre class="programlisting">gboolean gimp_progress_init (const gchar *message);</pre>
<p>
Initializes the progress bar for the current plug-in.
</p>
@ -152,9 +152,9 @@ valid to call this procedure from a plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601853"></a><h3>
<a name="id2601798"></a><h3>
<a name="gimp-progress-init-printf"></a>gimp_progress_init_printf ()</h3>
<a class="indexterm" name="id2601867"></a><pre class="programlisting">gboolean gimp_progress_init_printf (const gchar *format,
<a class="indexterm" name="id2601811"></a><pre class="programlisting">gboolean gimp_progress_init_printf (const gchar *format,
...);</pre>
<p>
Initializes the progress bar for the current plug-in.
@ -191,9 +191,9 @@ valid to call this procedure from a plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2601977"></a><h3>
<a name="id2601922"></a><h3>
<a name="gimp-progress-update"></a>gimp_progress_update ()</h3>
<a class="indexterm" name="id2601988"></a><pre class="programlisting">gboolean gimp_progress_update (gdouble percentage);</pre>
<a class="indexterm" name="id2601933"></a><pre class="programlisting">gboolean gimp_progress_update (gdouble percentage);</pre>
<p>
Updates the progress bar for the current plug-in.</p>
<p>
@ -217,9 +217,9 @@ Updates the progress bar for the current plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553587"></a><h3>
<a name="id2599389"></a><h3>
<a name="gimp-progress-pulse"></a>gimp_progress_pulse ()</h3>
<a class="indexterm" name="id2553601"></a><pre class="programlisting">gboolean gimp_progress_pulse (void);</pre>
<a class="indexterm" name="id2599404"></a><pre class="programlisting">gboolean gimp_progress_pulse (void);</pre>
<p>
Pulses the progress bar for the current plug-in.
</p>
@ -246,9 +246,9 @@ mode\", where a block bounces back and forth.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553663"></a><h3>
<a name="id2599466"></a><h3>
<a name="gimp-progress-set-text"></a>gimp_progress_set_text ()</h3>
<a class="indexterm" name="id2553677"></a><pre class="programlisting">gboolean gimp_progress_set_text (const gchar *message);</pre>
<a class="indexterm" name="id2599479"></a><pre class="programlisting">gboolean gimp_progress_set_text (const gchar *message);</pre>
<p>
Changes the text in the progress bar for the current plug-in.
</p>
@ -280,9 +280,9 @@ displayed value.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2553756"></a><h3>
<a name="id2599558"></a><h3>
<a name="gimp-progress-set-text-printf"></a>gimp_progress_set_text_printf ()</h3>
<a class="indexterm" name="id2553769"></a><pre class="programlisting">gboolean gimp_progress_set_text_printf (const gchar *format,
<a class="indexterm" name="id2599572"></a><pre class="programlisting">gboolean gimp_progress_set_text_printf (const gchar *format,
...);</pre>
<p>
Changes the text in the progress bar for the current plug-in.
@ -320,9 +320,9 @@ displayed value.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604347"></a><h3>
<a name="id2604358"></a><h3>
<a name="gimp-progress-uninstall"></a>gimp_progress_uninstall ()</h3>
<a class="indexterm" name="id2604360"></a><pre class="programlisting">gpointer gimp_progress_uninstall (const gchar *progress_callback);</pre>
<a class="indexterm" name="id2604371"></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>
@ -350,9 +350,9 @@ Uninstalls a temporary progress procedure that was installed using
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604441"></a><h3>
<a name="id2604452"></a><h3>
<a name="gimp-progress-cancel"></a>gimp_progress_cancel ()</h3>
<a class="indexterm" name="id2604454"></a><pre class="programlisting">gboolean gimp_progress_cancel (const gchar *progress_callback);</pre>
<a class="indexterm" name="id2604464"></a><pre class="programlisting">gboolean gimp_progress_cancel (const gchar *progress_callback);</pre>
<p>
Cancels a running progress.
</p>
@ -382,9 +382,9 @@ This function cancels the currently running progress.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604516"></a><h3>
<a name="id2604527"></a><h3>
<a name="gimp-progress-get-window-handle"></a>gimp_progress_get_window_handle ()</h3>
<a class="indexterm" name="id2604529"></a><pre class="programlisting">gint gimp_progress_get_window_handle (void);</pre>
<a class="indexterm" name="id2604540"></a><pre class="programlisting">gint 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,9 +409,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604576"></a><h3>
<a name="id2604588"></a><h3>
<a name="GimpProgressStartCallback"></a>GimpProgressStartCallback ()</h3>
<a class="indexterm" name="id2604589"></a><pre class="programlisting">void (*GimpProgressStartCallback) (const gchar *message,
<a class="indexterm" name="id2604601"></a><pre class="programlisting">void (*GimpProgressStartCallback) (const gchar *message,
gboolean cancelable,
gpointer user_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
@ -446,9 +446,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604679"></a><h3>
<a name="id2604691"></a><h3>
<a name="GimpProgressEndCallback"></a>GimpProgressEndCallback ()</h3>
<a class="indexterm" name="id2604691"></a><pre class="programlisting">void (*GimpProgressEndCallback) (gpointer user_data);</pre>
<a class="indexterm" name="id2604703"></a><pre class="programlisting">void (*GimpProgressEndCallback) (gpointer 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,9 +469,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604743"></a><h3>
<a name="id2604756"></a><h3>
<a name="GimpProgressTextCallback"></a>GimpProgressTextCallback ()</h3>
<a class="indexterm" name="id2604756"></a><pre class="programlisting">void (*GimpProgressTextCallback) (const gchar *message,
<a class="indexterm" name="id2604768"></a><pre class="programlisting">void (*GimpProgressTextCallback) (const gchar *message,
gpointer user_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
@ -500,9 +500,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604827"></a><h3>
<a name="id2604839"></a><h3>
<a name="GimpProgressValueCallback"></a>GimpProgressValueCallback ()</h3>
<a class="indexterm" name="id2604840"></a><pre class="programlisting">void (*GimpProgressValueCallback) (gdouble percentage,
<a class="indexterm" name="id2604852"></a><pre class="programlisting">void (*GimpProgressValueCallback) (gdouble percentage,
gpointer user_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
@ -531,9 +531,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604911"></a><h3>
<a name="id2604923"></a><h3>
<a name="gimp-progress-install-vtable"></a>gimp_progress_install_vtable ()</h3>
<a class="indexterm" name="id2604925"></a><pre class="programlisting">const gchar* gimp_progress_install_vtable (const <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a> *vtable,
<a class="indexterm" name="id2604938"></a><pre class="programlisting">const gchar* gimp_progress_install_vtable (const <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a> *vtable,
gpointer user_data);</pre>
<p>
</p>
@ -566,9 +566,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605011"></a><h3>
<a name="id2605023"></a><h3>
<a name="gimp-progress-install"></a>gimp_progress_install ()</h3>
<a class="indexterm" name="id2605024"></a><a class="indexterm" name="id2605031"></a><pre class="programlisting">const gchar* gimp_progress_install (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
<a class="indexterm" name="id2605036"></a><a class="indexterm" name="id2605043"></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,