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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpedit</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="prev" href="libgimp-gimpdrawabletransform.html" title="gimpdrawabletransform">
<link rel="next" href="libgimp-gimpfileops.html" title="gimpfileops">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
<link rel="part" href="libgimp.html" title="Part II. 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 all 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 III. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</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">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpdrawabletransform.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpfileops.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="#id2549755" class="shortcut">Top</a>
 | 
<a href="#id2586071" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpedit"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2549755"></a><span class="refentrytitle">gimpedit</span>
</h2>
<p>gimpedit — Edit menu functions (cut, copy, paste, clear, etc.)</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
gboolean <a href="libgimp-gimpedit.html#gimp-edit-cut">gimp_edit_cut</a> (gint32 drawable_ID);
gboolean <a href="libgimp-gimpedit.html#gimp-edit-copy">gimp_edit_copy</a> (gint32 drawable_ID);
gboolean <a href="libgimp-gimpedit.html#gimp-edit-copy-visible">gimp_edit_copy_visible</a> (gint32 image_ID);
gint32 <a href="libgimp-gimpedit.html#gimp-edit-paste">gimp_edit_paste</a> (gint32 drawable_ID,
gboolean paste_into);
gboolean <a href="libgimp-gimpedit.html#gimp-edit-clear">gimp_edit_clear</a> (gint32 drawable_ID);
gboolean <a href="libgimp-gimpedit.html#gimp-edit-fill">gimp_edit_fill</a> (gint32 drawable_ID,
<a href="libgimp-gimpenums.html#GimpFillType">GimpFillType</a> fill_type);
gboolean <a href="libgimp-gimpedit.html#gimp-edit-bucket-fill">gimp_edit_bucket_fill</a> (gint32 drawable_ID,
<a href="libgimp-gimpenums.html#GimpBucketFillMode">GimpBucketFillMode</a> fill_mode,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
gdouble opacity,
gdouble threshold,
gboolean sample_merged,
gdouble x,
gdouble y);
gboolean <a href="libgimp-gimpedit.html#gimp-edit-blend">gimp_edit_blend</a> (gint32 drawable_ID,
<a href="libgimp-gimpenums.html#GimpBlendMode">GimpBlendMode</a> blend_mode,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
<a href="libgimp-gimpenums.html#GimpGradientType">GimpGradientType</a> gradient_type,
gdouble opacity,
gdouble offset,
<a href="libgimp-gimpenums.html#GimpRepeatMode">GimpRepeatMode</a> repeat,
gboolean reverse,
gboolean supersample,
gint max_depth,
gdouble threshold,
gboolean dither,
gdouble x1,
gdouble y1,
gdouble x2,
gdouble y2);
gboolean <a href="libgimp-gimpedit.html#gimp-edit-stroke">gimp_edit_stroke</a> (gint32 drawable_ID);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2586071"></a><h2>Description</h2>
<p>
Edit menu functions (cut, copy, paste, clear, etc.)
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2586087"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2586098"></a><h3>
<a name="gimp-edit-cut"></a>gimp_edit_cut ()</h3>
<a class="indexterm" name="id2586110"></a><pre class="programlisting">gboolean gimp_edit_cut (gint32 drawable_ID);</pre>
<p>
Cut from the specified drawable.
</p>
<p>
If there is a selection in the image, then the area specified by the
selection is cut from the specified drawable and placed in an
internal GIMP edit buffer. It can subsequently be retrieved using
the 'gimp-edit-paste' command. If there is no selection, then the
specified drawable will be removed and its contents stored in the
internal GIMP edit buffer.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
<td> The drawable to cut from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the cut was successful, FALSE if the selection contained only transparent pixels.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2586180"></a><h3>
<a name="gimp-edit-copy"></a>gimp_edit_copy ()</h3>
<a class="indexterm" name="id2586193"></a><pre class="programlisting">gboolean gimp_edit_copy (gint32 drawable_ID);</pre>
<p>
Copy from the specified drawable.
</p>
<p>
If there is a selection in the image, then the area specified by the
selection is copied from the specified drawable and placed in an
internal GIMP edit buffer. It can subsequently be retrieved using
the 'gimp-edit-paste' command. If there is no selection, then the
specified drawable's contents will be stored in the internal GIMP
edit buffer.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
<td> The drawable to copy from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the copy was successful, FALSE if the selection contained only transparent pixels.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581521"></a><h3>
<a name="gimp-edit-copy-visible"></a>gimp_edit_copy_visible ()</h3>
<a class="indexterm" name="id2581534"></a><pre class="programlisting">gboolean gimp_edit_copy_visible (gint32 image_ID);</pre>
<p>
Copy from the projection.
</p>
<p>
If there is a selection in the image, then the area specified by the
selection is copied from the projection and placed in an internal
GIMP edit buffer. It can subsequently be retrieved using the
'gimp-edit-paste' command. If there is no selection, then the
projection's contents will be stored in the internal GIMP edit
buffer.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The image to copy from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the copy was successful, FALSE if the selection contained only transparent pixels.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581608"></a><h3>
<a name="gimp-edit-paste"></a>gimp_edit_paste ()</h3>
<a class="indexterm" name="id2581620"></a><pre class="programlisting">gint32 gimp_edit_paste (gint32 drawable_ID,
gboolean paste_into);</pre>
<p>
Paste buffer to the specified drawable.
</p>
<p>
This procedure pastes a copy of the internal GIMP edit buffer to the
specified drawable. The GIMP edit buffer will be empty unless a call
was previously made to either 'gimp-edit-cut' or 'gimp-edit-copy'.
The \"paste_into\" option specifies whether to clear the current
image selection, or to paste the buffer \"behind\" the selection.
This allows the selection to act as a mask for the pasted buffer.
Anywhere that the selection mask is non-zero, the pasted buffer will
show through. The pasted buffer will be a new layer in the image
which is designated as the image floating selection. If the image
has a floating selection at the time of pasting, the old floating
selection will be anchored to it's drawable before the new floating
selection is added. This procedure returns the new floating layer.
The resulting floating selection will already be attached to the
specified drawable, and a subsequent call to floating_sel_attach is
not needed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
<td> The drawable to paste to.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>paste_into</code></em> :</span></td>
<td> Clear selection, or paste behind it?
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The new floating selection.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581680"></a><h3>
<a name="gimp-edit-clear"></a>gimp_edit_clear ()</h3>
<a class="indexterm" name="id2581692"></a><pre class="programlisting">gboolean gimp_edit_clear (gint32 drawable_ID);</pre>
<p>
Clear selected area of drawable.
</p>
<p>
This procedure clears the specified drawable. If the drawable has an
alpha channel, the cleared pixels will become transparent. If the
drawable does not have an alpha channel, cleared pixels will be set
to the background color. This procedure only affects regions within
a selection if there is a selection active.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
<td> The drawable to clear from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2581760"></a><h3>
<a name="gimp-edit-fill"></a>gimp_edit_fill ()</h3>
<a class="indexterm" name="id2581773"></a><pre class="programlisting">gboolean gimp_edit_fill (gint32 drawable_ID,
<a href="libgimp-gimpenums.html#GimpFillType">GimpFillType</a> fill_type);</pre>
<p>
Fill selected area of drawable.
</p>
<p>
This procedure fills the specified drawable with the fill mode. If
the fill mode is foreground, the current foreground color is used.
If the fill mode is background, the current background color is
used. Other fill modes should not be used. This procedure only
affects regions within a selection if there is a selection active.
If you want to fill the whole drawable, regardless of the selection,
use <a href="libgimp-gimpdrawable.html#gimp-drawable-fill"><code class="function">gimp_drawable_fill()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
<td> The drawable to fill to.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fill_type</code></em> :</span></td>
<td> The type of fill.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2595074"></a><h3>
<a name="gimp-edit-bucket-fill"></a>gimp_edit_bucket_fill ()</h3>
<a class="indexterm" name="id2595086"></a><pre class="programlisting">gboolean gimp_edit_bucket_fill (gint32 drawable_ID,
<a href="libgimp-gimpenums.html#GimpBucketFillMode">GimpBucketFillMode</a> fill_mode,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
gdouble opacity,
gdouble threshold,
gboolean sample_merged,
gdouble x,
gdouble y);</pre>
<p>
Fill the area specified either by the current selection if there is
one, or by a seed fill starting at the specified coordinates.
</p>
<p>
This tool requires information on the paint application mode, and
the fill mode, which can either be in the foreground color, or in
the currently active pattern. If there is no selection, a seed fill
is executed at the specified coordinates and extends outward in
keeping with the threshold parameter. If there is a selection in the
target image, the threshold, sample merged, x, and y arguments are
unused. If the sample_merged parameter is non-zero, the data of the
composite image will be used instead of that for the specified
drawable. This is equivalent to sampling for colors after merging
all visible layers. In the case of merged sampling, the x and y
coordinates are relative to the image's origin; otherwise, they are
relative to the drawable's origin.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
<td> The affected drawable.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fill_mode</code></em> :</span></td>
<td> The type of fill.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
<td> The paint application mode.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
<td> The opacity of the final bucket fill.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>threshold</code></em> :</span></td>
<td> The threshold determines how extensive the seed fill will be. It's value is specified in terms of intensity levels . This parameter is only valid when there is no selection in the specified image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>sample_merged</code></em> :</span></td>
<td> Use the composite image, not the drawable.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> The x coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> The y coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2595320"></a><h3>
<a name="gimp-edit-blend"></a>gimp_edit_blend ()</h3>
<a class="indexterm" name="id2595332"></a><pre class="programlisting">gboolean gimp_edit_blend (gint32 drawable_ID,
<a href="libgimp-gimpenums.html#GimpBlendMode">GimpBlendMode</a> blend_mode,
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
<a href="libgimp-gimpenums.html#GimpGradientType">GimpGradientType</a> gradient_type,
gdouble opacity,
gdouble offset,
<a href="libgimp-gimpenums.html#GimpRepeatMode">GimpRepeatMode</a> repeat,
gboolean reverse,
gboolean supersample,
gint max_depth,
gdouble threshold,
gboolean dither,
gdouble x1,
gdouble y1,
gdouble x2,
gdouble y2);</pre>
<p>
Blend between the starting and ending coordinates with the specified
blend mode and gradient type.
</p>
<p>
This tool requires information on the paint application mode, the
blend mode, and the gradient type. It creates the specified variety
of blend using the starting and ending coordinates as defined for
each gradient type.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
<td> The affected drawable.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>blend_mode</code></em> :</span></td>
<td> The type of blend.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
<td> The paint application mode.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>gradient_type</code></em> :</span></td>
<td> The type of gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
<td> The opacity of the final blend.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
<td> Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>repeat</code></em> :</span></td>
<td> Repeat mode.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>reverse</code></em> :</span></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>supersample</code></em> :</span></td>
<td> Do adaptive supersampling.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>max_depth</code></em> :</span></td>
<td> Maximum recursion levels for supersampling.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>threshold</code></em> :</span></td>
<td> Supersampling threshold.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>dither</code></em> :</span></td>
<td> Use dithering to reduce banding.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x1</code></em> :</span></td>
<td> The x coordinate of this blend's starting point.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y1</code></em> :</span></td>
<td> The y coordinate of this blend's starting point.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x2</code></em> :</span></td>
<td> The x coordinate of this blend's ending point.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y2</code></em> :</span></td>
<td> The y coordinate of this blend's ending point.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588272"></a><h3>
<a name="gimp-edit-stroke"></a>gimp_edit_stroke ()</h3>
<a class="indexterm" name="id2588284"></a><pre class="programlisting">gboolean gimp_edit_stroke (gint32 drawable_ID);</pre>
<p>
Stroke the current selection
</p>
<p>
This procedure strokes the current selection, painting along the
selection boundary with the active brush and foreground color. The
paint is applied to the specified drawable regardless of the active
selection.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
<td> The drawable to stroke to.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
