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

Imported Upstream version 2.6.10

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:28:26 -04:00
parent d302c2222c
commit 04341c96c0
875 changed files with 164198 additions and 146469 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,20 +8,8 @@
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="prev" href="libgimp-gimptools.html" title="gimptools">
<link rel="next" href="libgimp-gimpvectors.html" title="gimpvectors">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part I. 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 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 II. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<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-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
<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">
@ -34,8 +22,8 @@
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimp-gimpundo.synopsis" class="shortcut">Top</a>
 | 
<a href="#libgimp-gimpundo.description" class="shortcut">Description</a>
 | 
<a href="#libgimp-gimpundo.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="gimpundo">
@ -49,42 +37,13 @@
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libgimp-gimpundo.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-start" title="gimp_image_undo_group_start ()">gimp_image_undo_group_start</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-end" title="gimp_image_undo_group_end ()">gimp_image_undo_group_end</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-is-enabled" title="gimp_image_undo_is_enabled ()">gimp_image_undo_is_enabled</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable" title="gimp_image_undo_disable ()">gimp_image_undo_disable</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-enable" title="gimp_image_undo_enable ()">gimp_image_undo_enable</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze" title="gimp_image_undo_freeze ()">gimp_image_undo_freeze</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw" title="gimp_image_undo_thaw ()">gimp_image_undo_thaw</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<pre class="synopsis"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-start" title="gimp_image_undo_group_start ()">gimp_image_undo_group_start</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-end" title="gimp_image_undo_group_end ()">gimp_image_undo_group_end</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-is-enabled" title="gimp_image_undo_is_enabled ()">gimp_image_undo_is_enabled</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable" title="gimp_image_undo_disable ()">gimp_image_undo_disable</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-enable" title="gimp_image_undo_enable ()">gimp_image_undo_enable</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze" title="gimp_image_undo_freeze ()">gimp_image_undo_freeze</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw" title="gimp_image_undo_thaw ()">gimp_image_undo_thaw</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
@ -97,11 +56,7 @@ Control of undo/redo.
<a name="libgimp-gimpundo.details"></a><h2>Details</h2>
<div class="refsect2" title="gimp_image_undo_group_start ()">
<a name="gimp-image-undo-group-start"></a><h3>gimp_image_undo_group_start ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_group_start (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_undo_group_start (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);</pre>
<p>
Starts a group undo.
</p>
@ -109,15 +64,14 @@ Starts a group undo.
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 class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-end" title="gimp_image_undo_group_end ()"><code class="function">gimp_image_undo_group_end()</code></a>
call.</p>
<p>
call.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The ID of the image in which to open an undo group.
<td>The ID of the image in which to open an undo group.
</td>
</tr>
<tr>
@ -131,25 +85,20 @@ call.</p>
<hr>
<div class="refsect2" title="gimp_image_undo_group_end ()">
<a name="gimp-image-undo-group-end"></a><h3>gimp_image_undo_group_end ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_group_end (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_undo_group_end (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);</pre>
<p>
Finish a group undo.
</p>
<p>
This function must be called once for each
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-start" title="gimp_image_undo_group_start ()"><code class="function">gimp_image_undo_group_start()</code></a> call that is made.</p>
<p>
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-start" title="gimp_image_undo_group_start ()"><code class="function">gimp_image_undo_group_start()</code></a> call that is made.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The ID of the image in which to close an undo group.
<td>The ID of the image in which to close an undo group.
</td>
</tr>
<tr>
@ -163,11 +112,7 @@ This function must be called once for each
<hr>
<div class="refsect2" title="gimp_image_undo_is_enabled ()">
<a name="gimp-image-undo-is-enabled"></a><h3>gimp_image_undo_is_enabled ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_is_enabled (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_undo_is_enabled (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);</pre>
<p>
Check if the image's undo stack is enabled.
</p>
@ -175,15 +120,14 @@ 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 class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable" title="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" title="gimp_image_undo_freeze ()"><code class="function">gimp_image_undo_freeze()</code></a>.</p>
<p>
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable" title="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" title="gimp_image_undo_freeze ()"><code class="function">gimp_image_undo_freeze()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<td>The image.
</td>
</tr>
<tr>
@ -197,11 +141,7 @@ each other and want to check if their caller has already used
<hr>
<div class="refsect2" title="gimp_image_undo_disable ()">
<a name="gimp-image-undo-disable"></a><h3>gimp_image_undo_disable ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_disable (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_undo_disable (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);</pre>
<p>
Disable the image's undo stack.
</p>
@ -210,15 +150,14 @@ This procedure disables the image's undo stack, allowing subsequent
operations to ignore their undo steps. This is generally called in
conjunction with <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-enable" title="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>
be time and memory intensive.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<td>The image.
</td>
</tr>
<tr>
@ -232,11 +171,7 @@ be time and memory intensive.</p>
<hr>
<div class="refsect2" title="gimp_image_undo_enable ()">
<a name="gimp-image-undo-enable"></a><h3>gimp_image_undo_enable ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_enable (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_undo_enable (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);</pre>
<p>
Enable the image's undo stack.
</p>
@ -244,15 +179,14 @@ Enable the image's undo stack.
This procedure enables the image's undo stack, allowing subsequent
operations to store their undo steps. This is generally called in
conjunction with <a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable" title="gimp_image_undo_disable ()"><code class="function">gimp_image_undo_disable()</code></a> to temporarily disable an
image undo stack.</p>
<p>
image undo stack.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<td>The image.
</td>
</tr>
<tr>
@ -266,11 +200,7 @@ image undo stack.</p>
<hr>
<div class="refsect2" title="gimp_image_undo_freeze ()">
<a name="gimp-image-undo-freeze"></a><h3>gimp_image_undo_freeze ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_freeze (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_undo_freeze (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);</pre>
<p>
Freeze the image's undo stack.
</p>
@ -285,15 +215,14 @@ be time and memory intensive. <a class="link" href="libgimp-gimpundo.html#gimp-i
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'
behaviour is undefined.</p>
<p>
behaviour is undefined.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<td>The image.
</td>
</tr>
<tr>
@ -307,11 +236,7 @@ behaviour is undefined.</p>
<hr>
<div class="refsect2" title="gimp_image_undo_thaw ()">
<a name="gimp-image-undo-thaw"></a><h3>gimp_image_undo_thaw ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_undo_thaw (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_image_undo_thaw (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> image_ID</code></em>);</pre>
<p>
Thaw the image's undo stack.
</p>
@ -325,15 +250,14 @@ 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
freezes and thaws and ensuring image consistancy is the
responsibility of the caller.</p>
<p>
responsibility of the caller.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
<td> The image.
<td>The image.
</td>
</tr>
<tr>
@ -348,6 +272,6 @@ responsibility of the caller.</p>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
Generated by GTK-Doc V1.15</div>
</body>
</html>
</html>