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

Imported Upstream version 2.4.0~rc2

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions
Download Patch File Download Diff File Expand all files Collapse all files

162
devel-docs/libgimp/html/libgimp-gimpundo.html
View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpundo</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="prev" href="libgimp-gimptools.html" title="gimptools">
@ -31,16 +31,16 @@
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpvectors.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="#id2574387" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2611555" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2665675" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2682629" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpundo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2574387"></a><span class="refentrytitle">gimpundo</span>
<a name="id2611555"></a><span class="refentrytitle">gimpundo</span>
</h2>
<p>gimpundo &#8212; Control of undo/redo.</p>
</td>
@ -52,67 +52,35 @@
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpundo.html#gimp-image-undo-group-start">gimp_image_undo_group_start</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpundo.html#gimp-image-undo-group-end">gimp_image_undo_group_end</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpundo.html#gimp-image-undo-is-enabled">gimp_image_undo_is_enabled</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpundo.html#gimp-image-undo-disable">gimp_image_undo_disable</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpundo.html#gimp-image-undo-enable">gimp_image_undo_enable</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpundo.html#gimp-image-undo-freeze">gimp_image_undo_freeze</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpundo.html#gimp-image-undo-thaw">gimp_image_undo_thaw</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
gboolean <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-start">gimp_image_undo_group_start</a> (gint32 image_ID);
gboolean <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-end">gimp_image_undo_group_end</a> (gint32 image_ID);
gboolean <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-is-enabled">gimp_image_undo_is_enabled</a> (gint32 image_ID);
gboolean <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable">gimp_image_undo_disable</a> (gint32 image_ID);
gboolean <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-enable">gimp_image_undo_enable</a> (gint32 image_ID);
gboolean <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze">gimp_image_undo_freeze</a> (gint32 image_ID);
gboolean <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw">gimp_image_undo_thaw</a> (gint32 image_ID);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2665675"></a><h2>Description</h2>
<a name="id2682629"></a><h2>Description</h2>
<p>
Control of undo/redo.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2661069"></a><h2>Details</h2>
<a name="id2682644"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2661079"></a><h3>
<a name="id2682655"></a><h3>
<a name="gimp-image-undo-group-start"></a>gimp_image_undo_group_start ()</h3>
<a class="indexterm" name="id2661090"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_group_start (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<a class="indexterm" name="id2682666"></a><pre class="programlisting">gboolean gimp_image_undo_group_start (gint32 image_ID);</pre>
<p>
Starts a group undo.
</p>
<p>
This function is used to start a group undo--necessary for logically
combining two or more undo operations into a single operation. This
call must be used in conjunction with a <a href="libgimp-gimpundo.html#gimp-image-undo-group-end"><code class="function">gimp_image_undo_group_end()</code></a>
call must be used in conjunction with a <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-end"><code class="function">gimp_image_undo_group_end()</code></a>
call.</p>
<p>
@ -121,12 +89,12 @@ call.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The ID of the image in which to open an undo group.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
@ -135,19 +103,15 @@ call.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2661165"></a><h3>
<a name="id2684970"></a><h3>
<a name="gimp-image-undo-group-end"></a>gimp_image_undo_group_end ()</h3>
<a class="indexterm" name="id2661177"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_group_end (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<a class="indexterm" name="id2684981"></a><pre class="programlisting">gboolean gimp_image_undo_group_end (gint32 image_ID);</pre>
<p>
Finish a group undo.
</p>
<p>
This function must be called once for each
<a href="libgimp-gimpundo.html#gimp-image-undo-group-start"><code class="function">gimp_image_undo_group_start()</code></a> call that is made.</p>
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-start"><code class="function">gimp_image_undo_group_start()</code></a> call that is made.</p>
<p>
</p>
@ -155,12 +119,12 @@ This function must be called once for each
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The ID of the image in which to close an undo group.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
@ -169,13 +133,9 @@ This function must be called once for each
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2668386"></a><h3>
<a name="id2685054"></a><h3>
<a name="gimp-image-undo-is-enabled"></a>gimp_image_undo_is_enabled ()</h3>
<a class="indexterm" name="id2668398"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_is_enabled (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<a class="indexterm" name="id2685065"></a><pre class="programlisting">gboolean gimp_image_undo_is_enabled (gint32 image_ID);</pre>
<p>
Check if the image's undo stack is enabled.
</p>
@ -183,7 +143,7 @@ Check if the image's undo stack is enabled.
This procedure checks if the image's undo stack is currently enabled
or disabled. This is useful when several plugins or scripts call
each other and want to check if their caller has already used
<a href="libgimp-gimpundo.html#gimp-image-undo-disable"><code class="function">gimp_image_undo_disable()</code></a> or <a href="libgimp-gimpundo.html#gimp-image-undo-freeze"><code class="function">gimp_image_undo_freeze()</code></a>.</p>
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable"><code class="function">gimp_image_undo_disable()</code></a> or <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze"><code class="function">gimp_image_undo_freeze()</code></a>.</p>
<p>
</p>
@ -191,12 +151,12 @@ each other and want to check if their caller has already used
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE if undo is enabled for this image.
</td>
</tr>
@ -205,20 +165,16 @@ each other and want to check if their caller has already used
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2668482"></a><h3>
<a name="id2687892"></a><h3>
<a name="gimp-image-undo-disable"></a>gimp_image_undo_disable ()</h3>
<a class="indexterm" name="id2668493"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_disable (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<a class="indexterm" name="id2687903"></a><pre class="programlisting">gboolean gimp_image_undo_disable (gint32 image_ID);</pre>
<p>
Disable the image's undo stack.
</p>
<p>
This procedure disables the image's undo stack, allowing subsequent
operations to ignore their undo steps. This is generally called in
conjunction with <a href="libgimp-gimpundo.html#gimp-image-undo-enable"><code class="function">gimp_image_undo_enable()</code></a> to temporarily disable an
conjunction with <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-enable"><code class="function">gimp_image_undo_enable()</code></a> to temporarily disable an
image undo stack. This is advantageous because saving undo steps can
be time and memory intensive.</p>
<p>
@ -228,12 +184,12 @@ be time and memory intensive.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE if the image undo has been disabled.
</td>
</tr>
@ -242,20 +198,16 @@ be time and memory intensive.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2675008"></a><h3>
<a name="id2687978"></a><h3>
<a name="gimp-image-undo-enable"></a>gimp_image_undo_enable ()</h3>
<a class="indexterm" name="id2675019"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_enable (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<a class="indexterm" name="id2687990"></a><pre class="programlisting">gboolean gimp_image_undo_enable (gint32 image_ID);</pre>
<p>
Enable the image's undo stack.
</p>
<p>
This procedure enables the image's undo stack, allowing subsequent
operations to store their undo steps. This is generally called in
conjunction with <a href="libgimp-gimpundo.html#gimp-image-undo-disable"><code class="function">gimp_image_undo_disable()</code></a> to temporarily disable an
conjunction with <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable"><code class="function">gimp_image_undo_disable()</code></a> to temporarily disable an
image undo stack.</p>
<p>
@ -264,12 +216,12 @@ image undo stack.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE if the image undo has been enabled.
</td>
</tr>
@ -278,24 +230,20 @@ image undo stack.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2675093"></a><h3>
<a name="id2688064"></a><h3>
<a name="gimp-image-undo-freeze"></a>gimp_image_undo_freeze ()</h3>
<a class="indexterm" name="id2675104"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_freeze (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<a class="indexterm" name="id2688075"></a><pre class="programlisting">gboolean gimp_image_undo_freeze (gint32 image_ID);</pre>
<p>
Freeze the image's undo stack.
</p>
<p>
This procedure freezes the image's undo stack, allowing subsequent
operations to ignore their undo steps. This is generally called in
conjunction with <a href="libgimp-gimpundo.html#gimp-image-undo-thaw"><code class="function">gimp_image_undo_thaw()</code></a> to temporarily disable an
conjunction with <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw"><code class="function">gimp_image_undo_thaw()</code></a> to temporarily disable an
image undo stack. This is advantageous because saving undo steps can
be time and memory intensive. <a href="libgimp-gimpundo.html#gimp-image-undo-freeze"><code class="function">gimp_image_undo_freeze()</code></a> /
<a href="libgimp-gimpundo.html#gimp-image-undo-thaw"><code class="function">gimp_image_undo_thaw()</code></a> and <a href="libgimp-gimpundo.html#gimp-image-undo-disable"><code class="function">gimp_image_undo_disable()</code></a> /
<a href="libgimp-gimpundo.html#gimp-image-undo-enable"><code class="function">gimp_image_undo_enable()</code></a> differ in that the former does not free up
be time and memory intensive. <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze"><code class="function">gimp_image_undo_freeze()</code></a> /
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw"><code class="function">gimp_image_undo_thaw()</code></a> and <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable"><code class="function">gimp_image_undo_disable()</code></a> /
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-enable"><code class="function">gimp_image_undo_enable()</code></a> differ in that the former does not free up
all undo steps when undo is thawed, so is more suited to interactive
in-situ previews. It is important in this case that the image is
back to the same state it was frozen in before thawing, else 'undo'
@ -307,12 +255,12 @@ behaviour is undefined.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE if the image undo has been frozen.
</td>
</tr>
@ -321,22 +269,18 @@ behaviour is undefined.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2667815"></a><h3>
<a name="id2678196"></a><h3>
<a name="gimp-image-undo-thaw"></a>gimp_image_undo_thaw ()</h3>
<a class="indexterm" name="id2667826"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_thaw (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<a class="indexterm" name="id2678207"></a><pre class="programlisting">gboolean gimp_image_undo_thaw (gint32 image_ID);</pre>
<p>
Thaw the image's undo stack.
</p>
<p>
This procedure thaws the image's undo stack, allowing subsequent
operations to store their undo steps. This is generally called in
conjunction with <a href="libgimp-gimpundo.html#gimp-image-undo-freeze"><code class="function">gimp_image_undo_freeze()</code></a> to temporarily freeze an
image undo stack. <a href="libgimp-gimpundo.html#gimp-image-undo-thaw"><code class="function">gimp_image_undo_thaw()</code></a> does NOT free the undo
stack as <a href="libgimp-gimpundo.html#gimp-image-undo-enable"><code class="function">gimp_image_undo_enable()</code></a> does, so is suited for situations
conjunction with <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze"><code class="function">gimp_image_undo_freeze()</code></a> to temporarily freeze an
image undo stack. <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw"><code class="function">gimp_image_undo_thaw()</code></a> does NOT free the undo
stack as <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-enable"><code class="function">gimp_image_undo_enable()</code></a> does, so is suited for situations
where one wishes to leave the undo stack in the same state in which
one found it despite non-destructively playing with the image in the
meantime. An example would be in-situ plugin previews. Balancing
@ -349,12 +293,12 @@ responsibility of the caller.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE if the image undo has been thawed.
</td>
</tr>