libgimp2.0-doc 2.8.10-0ubuntu1.2 / usr / share / gtk-doc / html / libgimp / libgimp-gimpundo.html

This file is indexed.

/usr/share/gtk-doc/html/libgimp/libgimp-gimpundo.html is in libgimp2.0-doc 2.8.10-0ubuntu1.2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIMP Library Reference Manual: gimpundo</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" 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-gimptransformtools.html" title="gimptransformtools">
<link rel="next" href="libgimp-gimpvectors.html" title="gimpvectors">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#libgimp-gimpundo.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#libgimp-gimpundo.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-gimptransformtools.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp-gimpvectors.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimpundo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpundo.top_of_page"></a>gimpundo</span></h2>
<p>gimpundo — Control of undo/redo.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimpundo.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-start" title="gimp_image_undo_group_start ()">gimp_image_undo_group_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-group-end" title="gimp_image_undo_group_end ()">gimp_image_undo_group_end</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-is-enabled" title="gimp_image_undo_is_enabled ()">gimp_image_undo_is_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-disable" title="gimp_image_undo_disable ()">gimp_image_undo_disable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-enable" title="gimp_image_undo_enable ()">gimp_image_undo_enable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze" title="gimp_image_undo_freeze ()">gimp_image_undo_freeze</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw" title="gimp_image_undo_thaw ()">gimp_image_undo_thaw</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimpundo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="libgimp-gimpundo.description"></a><h2>Description</h2>
<p>Control of undo/redo.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpundo.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-image-undo-group-start"></a><h3>gimp_image_undo_group_start ()</h3>
<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><span class="type">gint32</span> image_ID</code></em>);</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 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>
<div class="refsect3">
<a name="id-1.2.4.30.6.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The ID of the image in which to open an undo group.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.30.6.2.7"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-undo-group-end"></a><h3>gimp_image_undo_group_end ()</h3>
<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><span class="type">gint32</span> 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>
<div class="refsect3">
<a name="id-1.2.4.30.6.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The ID of the image in which to close an undo group.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.30.6.3.7"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-undo-is-enabled"></a><h3>gimp_image_undo_is_enabled ()</h3>
<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><span class="type">gint32</span> image_ID</code></em>);</pre>
<p>Check if the image's undo stack is enabled.</p>
<p>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>
<div class="refsect3">
<a name="id-1.2.4.30.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.30.6.4.7"></a><h4>Returns</h4>
<p> TRUE if undo is enabled for this image.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-undo-disable"></a><h3>gimp_image_undo_disable ()</h3>
<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><span class="type">gint32</span> image_ID</code></em>);</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 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>
<div class="refsect3">
<a name="id-1.2.4.30.6.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.30.6.5.7"></a><h4>Returns</h4>
<p> TRUE if the image undo has been disabled.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-undo-enable"></a><h3>gimp_image_undo_enable ()</h3>
<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><span class="type">gint32</span> image_ID</code></em>);</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 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>
<div class="refsect3">
<a name="id-1.2.4.30.6.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.30.6.6.7"></a><h4>Returns</h4>
<p> TRUE if the image undo has been enabled.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-undo-freeze"></a><h3>gimp_image_undo_freeze ()</h3>
<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><span class="type">gint32</span> image_ID</code></em>);</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 class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw" title="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 class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze" title="gimp_image_undo_freeze ()"><code class="function">gimp_image_undo_freeze()</code></a> /
<a class="link" href="libgimp-gimpundo.html#gimp-image-undo-thaw" title="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" title="gimp_image_undo_disable ()"><code class="function">gimp_image_undo_disable()</code></a> /
<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> 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'
behaviour is undefined.</p>
<div class="refsect3">
<a name="id-1.2.4.30.6.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.30.6.7.7"></a><h4>Returns</h4>
<p> TRUE if the image undo has been frozen.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-undo-thaw"></a><h3>gimp_image_undo_thaw ()</h3>
<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><span class="type">gint32</span> image_ID</code></em>);</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 class="link" href="libgimp-gimpundo.html#gimp-image-undo-freeze" title="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" title="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" title="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
freezes and thaws and ensuring image consistancy is the
responsibility of the caller.</p>
<div class="refsect3">
<a name="id-1.2.4.30.6.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.30.6.8.7"></a><h4>Returns</h4>
<p> TRUE if the image undo has been thawed.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libgimp-gimpundo.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.