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

Imported Upstream version 2.3.13

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:20:31 -04:00
parent a028e0b309
commit bbd6d9844c
1225 changed files with 162390 additions and 93699 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,10 +18,10 @@
<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">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</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="2">
@ -32,16 +32,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="#id2561782" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2591848" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2594003" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2601824" 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="id2561782"></a><span class="refentrytitle">gimpprogress</span>
<a name="id2591848"></a><span class="refentrytitle">gimpprogress</span>
</h2>
<p>gimpprogress &#8212; Functions for embedding the progress bar into a plug-in's GUI.</p>
</td>
@ -83,17 +83,17 @@ const gchar* <a href="libgimp-gimpprogress.html#gimp-progress-install">gimp_prog
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2594003"></a><h2>Description</h2>
<a name="id2601824"></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="id2594020"></a><h2>Details</h2>
<a name="id2601841"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2594031"></a><h3>
<a name="id2601852"></a><h3>
<a name="GimpProgressVtable"></a>GimpProgressVtable</h3>
<a class="indexterm" name="id2594043"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2601864"></a><pre class="programlisting">typedef struct {
void (* start) (const gchar *message,
gboolean cancelable,
gpointer user_data);
@ -123,9 +123,9 @@ Functions for embedding the progress bar into a plug-in's GUI.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602162"></a><h3>
<a name="id2601895"></a><h3>
<a name="gimp-progress-init"></a>gimp_progress_init ()</h3>
<a class="indexterm" name="id2602175"></a><pre class="programlisting">gboolean gimp_progress_init (const gchar *message);</pre>
<a class="indexterm" name="id2601907"></a><pre class="programlisting">gboolean gimp_progress_init (const gchar *message);</pre>
<p>
Initializes the progress bar for the current plug-in.
</p>
@ -139,14 +139,12 @@ valid to call this procedure from a plug-in.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
<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><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -155,9 +153,9 @@ valid to call this procedure from a plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602240"></a><h3>
<a name="id2601973"></a><h3>
<a name="gimp-progress-init-printf"></a>gimp_progress_init_printf ()</h3>
<a class="indexterm" name="id2602254"></a><pre class="programlisting">gboolean gimp_progress_init_printf (const gchar *format,
<a class="indexterm" name="id2599814"></a><pre class="programlisting">gboolean gimp_progress_init_printf (const gchar *format,
...);</pre>
<p>
Initializes the progress bar for the current plug-in.
@ -172,20 +170,17 @@ valid to call this procedure from a plug-in.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>format</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>format</code></em>&#160;:</span></td>
<td> a standard <code class="function">printf()</code> format string
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td> arguments for <em class="parameter"><code>format</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> on success.
</td>
@ -197,9 +192,9 @@ valid to call this procedure from a plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602364"></a><h3>
<a name="id2599924"></a><h3>
<a name="gimp-progress-update"></a>gimp_progress_update ()</h3>
<a class="indexterm" name="id2602375"></a><pre class="programlisting">gboolean gimp_progress_update (gdouble percentage);</pre>
<a class="indexterm" name="id2599936"></a><pre class="programlisting">gboolean gimp_progress_update (gdouble percentage);</pre>
<p>
Updates the progress bar for the current plug-in.</p>
<p>
@ -209,14 +204,12 @@ Updates the progress bar for the current plug-in.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
<td> Percentage of progress completed (in the range from 0.0 to 1.0).
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -225,9 +218,9 @@ Updates the progress bar for the current plug-in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594093"></a><h3>
<a name="id2599996"></a><h3>
<a name="gimp-progress-pulse"></a>gimp_progress_pulse ()</h3>
<a class="indexterm" name="id2594108"></a><pre class="programlisting">gboolean gimp_progress_pulse (void);</pre>
<a class="indexterm" name="id2600011"></a><pre class="programlisting">gboolean gimp_progress_pulse (void);</pre>
<p>
Pulses the progress bar for the current plug-in.
</p>
@ -243,8 +236,7 @@ mode\", where a block bounces back and forth.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
@ -255,9 +247,9 @@ mode\", where a block bounces back and forth.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594170"></a><h3>
<a name="id2600073"></a><h3>
<a name="gimp-progress-set-text"></a>gimp_progress_set_text ()</h3>
<a class="indexterm" name="id2594183"></a><pre class="programlisting">gboolean gimp_progress_set_text (const gchar *message);</pre>
<a class="indexterm" name="id2600086"></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>
@ -272,14 +264,12 @@ displayed value.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
<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><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
@ -291,9 +281,9 @@ displayed value.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594262"></a><h3>
<a name="id2600165"></a><h3>
<a name="gimp-progress-set-text-printf"></a>gimp_progress_set_text_printf ()</h3>
<a class="indexterm" name="id2594276"></a><pre class="programlisting">gboolean gimp_progress_set_text_printf (const gchar *format,
<a class="indexterm" name="id2600179"></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.
@ -309,20 +299,17 @@ displayed value.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>format</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>format</code></em>&#160;:</span></td>
<td> a standard <code class="function">printf()</code> format string
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
<td> arguments for <em class="parameter"><code>format</code></em>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> on success.
</td>
@ -334,9 +321,9 @@ displayed value.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605033"></a><h3>
<a name="id2604425"></a><h3>
<a name="gimp-progress-uninstall"></a>gimp_progress_uninstall ()</h3>
<a class="indexterm" name="id2605046"></a><pre class="programlisting">gpointer gimp_progress_uninstall (const gchar *progress_callback);</pre>
<a class="indexterm" name="id2604438"></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>
@ -347,14 +334,12 @@ Uninstalls a temporary progress procedure that was installed using
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
<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><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>
@ -366,9 +351,9 @@ Uninstalls a temporary progress procedure that was installed using
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605126"></a><h3>
<a name="id2604518"></a><h3>
<a name="gimp-progress-cancel"></a>gimp_progress_cancel ()</h3>
<a class="indexterm" name="id2605139"></a><pre class="programlisting">gboolean gimp_progress_cancel (const gchar *progress_callback);</pre>
<a class="indexterm" name="id2604531"></a><pre class="programlisting">gboolean gimp_progress_cancel (const gchar *progress_callback);</pre>
<p>
Cancels a running progress.
</p>
@ -381,14 +366,12 @@ This function cancels the currently running progress.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>progress_callback</code></em>&#160;:</span></td>
<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><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
@ -400,9 +383,9 @@ This function cancels the currently running progress.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605201"></a><h3>
<a name="id2604593"></a><h3>
<a name="gimp-progress-get-window-handle"></a>gimp_progress_get_window_handle ()</h3>
<a class="indexterm" name="id2605214"></a><pre class="programlisting">gint gimp_progress_get_window_handle (void);</pre>
<a class="indexterm" name="id2604605"></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.
@ -416,8 +399,7 @@ this plug-in\'s progress is displayed in.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The progress bar's toplevel window.
</td>
@ -428,9 +410,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605262"></a><h3>
<a name="id2604652"></a><h3>
<a name="GimpProgressStartCallback"></a>GimpProgressStartCallback ()</h3>
<a class="indexterm" name="id2605275"></a><pre class="programlisting">void (*GimpProgressStartCallback) (const gchar *message,
<a class="indexterm" name="id2604666"></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;">
@ -444,20 +426,17 @@ this plug-in\'s progress is displayed in.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
<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><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><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
@ -468,9 +447,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605365"></a><h3>
<a name="id2604756"></a><h3>
<a name="GimpProgressEndCallback"></a>GimpProgressEndCallback ()</h3>
<a class="indexterm" name="id2605377"></a><pre class="programlisting">void (*GimpProgressEndCallback) (gpointer user_data);</pre>
<a class="indexterm" name="id2604768"></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>
@ -481,8 +460,7 @@ this plug-in\'s progress is displayed in.</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><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
@ -492,9 +470,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605430"></a><h3>
<a name="id2604820"></a><h3>
<a name="GimpProgressTextCallback"></a>GimpProgressTextCallback ()</h3>
<a class="indexterm" name="id2605442"></a><pre class="programlisting">void (*GimpProgressTextCallback) (const gchar *message,
<a class="indexterm" name="id2604833"></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>
@ -507,14 +485,12 @@ this plug-in\'s progress is displayed in.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></td>
<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><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
@ -525,9 +501,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605513"></a><h3>
<a name="id2604904"></a><h3>
<a name="GimpProgressValueCallback"></a>GimpProgressValueCallback ()</h3>
<a class="indexterm" name="id2605526"></a><pre class="programlisting">void (*GimpProgressValueCallback) (gdouble percentage,
<a class="indexterm" name="id2604917"></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>
@ -540,14 +516,12 @@ this plug-in\'s progress is displayed in.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>percentage</code></em>&#160;:</span></td>
<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><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>
@ -558,9 +532,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605597"></a><h3>
<a name="id2604988"></a><h3>
<a name="gimp-progress-install-vtable"></a>gimp_progress_install_vtable ()</h3>
<a class="indexterm" name="id2605612"></a><pre class="programlisting">const gchar* gimp_progress_install_vtable (const <a href="libgimp-gimpprogress.html#GimpProgressVtable">GimpProgressVtable</a> *vtable,
<a class="indexterm" name="id2605002"></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>
@ -571,20 +545,17 @@ this plug-in\'s progress is displayed in.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>vtable</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>vtable</code></em>&#160;:</span></td>
<td> a pointer to a <em class="parameter"><code>GimpProgressVtable</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td> a pointer that is passed as user_data to all vtable functions.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<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>
@ -596,9 +567,9 @@ this plug-in\'s progress is displayed in.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605697"></a><h3>
<a name="id2605088"></a><h3>
<a name="gimp-progress-install"></a>gimp_progress_install ()</h3>
<a class="indexterm" name="id2605710"></a><a class="indexterm" name="id2605717"></a><pre class="programlisting">const gchar* gimp_progress_install (<a href="libgimp-gimpprogress.html#GimpProgressStartCallback">GimpProgressStartCallback</a> start_callback,
<a class="indexterm" name="id2605100"></a><a class="indexterm" name="id2605108"></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,
@ -616,38 +587,32 @@ this plug-in\'s progress is displayed in.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>start_callback</code></em>&#160;:</span></td>
<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><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><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><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><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><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>