← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpundo.xml

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpundo.xml
1
 
<?xml version="1.0" encoding="UTF-8" ?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
 
5
 
<refentry id="libgimp-gimpundo">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="libgimp-gimpundo.top_of_page">gimpundo</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMP Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimpundo</refname>
14
 
<refpurpose>Control of undo/redo.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libgimp-gimpundo.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-undo-group-start">gimp_image_undo_group_start</link>         (<link linkend="gint32">gint32</link> image_ID);
22
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-undo-group-end">gimp_image_undo_group_end</link>           (<link linkend="gint32">gint32</link> image_ID);
23
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-undo-is-enabled">gimp_image_undo_is_enabled</link>          (<link linkend="gint32">gint32</link> image_ID);
24
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-undo-disable">gimp_image_undo_disable</link>             (<link linkend="gint32">gint32</link> image_ID);
25
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-undo-enable">gimp_image_undo_enable</link>              (<link linkend="gint32">gint32</link> image_ID);
26
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-undo-freeze">gimp_image_undo_freeze</link>              (<link linkend="gint32">gint32</link> image_ID);
27
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-undo-thaw">gimp_image_undo_thaw</link>                (<link linkend="gint32">gint32</link> image_ID);
28
 
</synopsis>
29
 
</refsynopsisdiv>
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
<refsect1 id="libgimp-gimpundo.description" role="desc">
40
 
<title role="desc.title">Description</title>
41
 
<para>
42
 
Control of undo/redo.
43
 
</para>
44
 
</refsect1>
45
 
 
46
 
<refsect1 id="libgimp-gimpundo.details" role="details">
47
 
<title role="details.title">Details</title>
48
 
<refsect2 id="gimp-image-undo-group-start" role="function">
49
 
<title>gimp_image_undo_group_start ()</title>
50
 
<indexterm zone="gimp-image-undo-group-start"><primary sortas="gimp_image_undo_group_start">gimp_image_undo_group_start</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_undo_group_start         (<link linkend="gint32">gint32</link> image_ID);</programlisting>
51
 
<para>
52
 
Starts a group undo.
53
 
</para>
54
 
<para>
55
 
This function is used to start a group undo--necessary for logically
56
 
combining two or more undo operations into a single operation. This
57
 
call must be used in conjunction with a <link linkend="gimp-image-undo-group-end"><function>gimp_image_undo_group_end()</function></link>
58
 
call.</para>
59
 
<para>
60
 
</para><variablelist role="params">
61
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
62
 
<listitem><simpara> The ID of the image in which to open an undo group.
63
 
</simpara></listitem></varlistentry>
64
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
65
 
</simpara></listitem></varlistentry>
66
 
</variablelist></refsect2>
67
 
<refsect2 id="gimp-image-undo-group-end" role="function">
68
 
<title>gimp_image_undo_group_end ()</title>
69
 
<indexterm zone="gimp-image-undo-group-end"><primary sortas="gimp_image_undo_group_end">gimp_image_undo_group_end</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_undo_group_end           (<link linkend="gint32">gint32</link> image_ID);</programlisting>
70
 
<para>
71
 
Finish a group undo.
72
 
</para>
73
 
<para>
74
 
This function must be called once for each
75
 
<link linkend="gimp-image-undo-group-start"><function>gimp_image_undo_group_start()</function></link> call that is made.</para>
76
 
<para>
77
 
</para><variablelist role="params">
78
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
79
 
<listitem><simpara> The ID of the image in which to close an undo group.
80
 
</simpara></listitem></varlistentry>
81
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
82
 
</simpara></listitem></varlistentry>
83
 
</variablelist></refsect2>
84
 
<refsect2 id="gimp-image-undo-is-enabled" role="function">
85
 
<title>gimp_image_undo_is_enabled ()</title>
86
 
<indexterm zone="gimp-image-undo-is-enabled"><primary sortas="gimp_image_undo_is_enabled">gimp_image_undo_is_enabled</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_undo_is_enabled          (<link linkend="gint32">gint32</link> image_ID);</programlisting>
87
 
<para>
88
 
Check if the image's undo stack is enabled.
89
 
</para>
90
 
<para>
91
 
This procedure checks if the image's undo stack is currently enabled
92
 
or disabled. This is useful when several plugins or scripts call
93
 
each other and want to check if their caller has already used
94
 
<link linkend="gimp-image-undo-disable"><function>gimp_image_undo_disable()</function></link> or <link linkend="gimp-image-undo-freeze"><function>gimp_image_undo_freeze()</function></link>.</para>
95
 
<para>
96
 
</para><variablelist role="params">
97
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
98
 
<listitem><simpara> The image.
99
 
</simpara></listitem></varlistentry>
100
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if undo is enabled for this image.
101
 
</simpara></listitem></varlistentry>
102
 
</variablelist></refsect2>
103
 
<refsect2 id="gimp-image-undo-disable" role="function">
104
 
<title>gimp_image_undo_disable ()</title>
105
 
<indexterm zone="gimp-image-undo-disable"><primary sortas="gimp_image_undo_disable">gimp_image_undo_disable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_undo_disable             (<link linkend="gint32">gint32</link> image_ID);</programlisting>
106
 
<para>
107
 
Disable the image's undo stack.
108
 
</para>
109
 
<para>
110
 
This procedure disables the image's undo stack, allowing subsequent
111
 
operations to ignore their undo steps. This is generally called in
112
 
conjunction with <link linkend="gimp-image-undo-enable"><function>gimp_image_undo_enable()</function></link> to temporarily disable an
113
 
image undo stack. This is advantageous because saving undo steps can
114
 
be time and memory intensive.</para>
115
 
<para>
116
 
</para><variablelist role="params">
117
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
118
 
<listitem><simpara> The image.
119
 
</simpara></listitem></varlistentry>
120
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the image undo has been disabled.
121
 
</simpara></listitem></varlistentry>
122
 
</variablelist></refsect2>
123
 
<refsect2 id="gimp-image-undo-enable" role="function">
124
 
<title>gimp_image_undo_enable ()</title>
125
 
<indexterm zone="gimp-image-undo-enable"><primary sortas="gimp_image_undo_enable">gimp_image_undo_enable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_undo_enable              (<link linkend="gint32">gint32</link> image_ID);</programlisting>
126
 
<para>
127
 
Enable the image's undo stack.
128
 
</para>
129
 
<para>
130
 
This procedure enables the image's undo stack, allowing subsequent
131
 
operations to store their undo steps. This is generally called in
132
 
conjunction with <link linkend="gimp-image-undo-disable"><function>gimp_image_undo_disable()</function></link> to temporarily disable an
133
 
image undo stack.</para>
134
 
<para>
135
 
</para><variablelist role="params">
136
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
137
 
<listitem><simpara> The image.
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the image undo has been enabled.
140
 
</simpara></listitem></varlistentry>
141
 
</variablelist></refsect2>
142
 
<refsect2 id="gimp-image-undo-freeze" role="function">
143
 
<title>gimp_image_undo_freeze ()</title>
144
 
<indexterm zone="gimp-image-undo-freeze"><primary sortas="gimp_image_undo_freeze">gimp_image_undo_freeze</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_undo_freeze              (<link linkend="gint32">gint32</link> image_ID);</programlisting>
145
 
<para>
146
 
Freeze the image's undo stack.
147
 
</para>
148
 
<para>
149
 
This procedure freezes the image's undo stack, allowing subsequent
150
 
operations to ignore their undo steps. This is generally called in
151
 
conjunction with <link linkend="gimp-image-undo-thaw"><function>gimp_image_undo_thaw()</function></link> to temporarily disable an
152
 
image undo stack. This is advantageous because saving undo steps can
153
 
be time and memory intensive. <link linkend="gimp-image-undo-freeze"><function>gimp_image_undo_freeze()</function></link> /
154
 
<link linkend="gimp-image-undo-thaw"><function>gimp_image_undo_thaw()</function></link> and <link linkend="gimp-image-undo-disable"><function>gimp_image_undo_disable()</function></link> /
155
 
<link linkend="gimp-image-undo-enable"><function>gimp_image_undo_enable()</function></link> differ in that the former does not free up
156
 
all undo steps when undo is thawed, so is more suited to interactive
157
 
in-situ previews. It is important in this case that the image is
158
 
back to the same state it was frozen in before thawing, else 'undo'
159
 
behaviour is undefined.</para>
160
 
<para>
161
 
</para><variablelist role="params">
162
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
163
 
<listitem><simpara> The image.
164
 
</simpara></listitem></varlistentry>
165
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the image undo has been frozen.
166
 
</simpara></listitem></varlistentry>
167
 
</variablelist></refsect2>
168
 
<refsect2 id="gimp-image-undo-thaw" role="function">
169
 
<title>gimp_image_undo_thaw ()</title>
170
 
<indexterm zone="gimp-image-undo-thaw"><primary sortas="gimp_image_undo_thaw">gimp_image_undo_thaw</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_undo_thaw                (<link linkend="gint32">gint32</link> image_ID);</programlisting>
171
 
<para>
172
 
Thaw the image's undo stack.
173
 
</para>
174
 
<para>
175
 
This procedure thaws the image's undo stack, allowing subsequent
176
 
operations to store their undo steps. This is generally called in
177
 
conjunction with <link linkend="gimp-image-undo-freeze"><function>gimp_image_undo_freeze()</function></link> to temporarily freeze an
178
 
image undo stack. <link linkend="gimp-image-undo-thaw"><function>gimp_image_undo_thaw()</function></link> does NOT free the undo
179
 
stack as <link linkend="gimp-image-undo-enable"><function>gimp_image_undo_enable()</function></link> does, so is suited for situations
180
 
where one wishes to leave the undo stack in the same state in which
181
 
one found it despite non-destructively playing with the image in the
182
 
meantime. An example would be in-situ plugin previews. Balancing
183
 
freezes and thaws and ensuring image consistancy is the
184
 
responsibility of the caller.</para>
185
 
<para>
186
 
</para><variablelist role="params">
187
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
188
 
<listitem><simpara> The image.
189
 
</simpara></listitem></varlistentry>
190
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the image undo has been thawed.
191
 
</simpara></listitem></varlistentry>
192
 
</variablelist></refsect2>
193
 
 
194
 
</refsect1>
195
 
 
196
 
 
197
 
 
198
 
 
199
 
</refentry>