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

Imported Upstream version 2.2.4

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:13:56 -04:00
parent 3154facabf
commit c5acc8ae10
5446 changed files with 2386086 additions and 390981 deletions
Download Patch File Download Diff File Expand all files Collapse all files

212
devel-docs/libgimp/html/libgimp-gimpedit.html Normal file
View File

@ -0,0 +1,212 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpedit</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part<72>I.<2E>GIMP Constants"><link rel="part" href="libgimp.html" title="Part<72>II.<2E>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<72>III.<2E>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" 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></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><span class="refentrytitle">gimpedit</span></h2><p>gimpedit &#8212; 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="id2600382"></a><h2>Description</h2><p>
Edit menu functions (cut, copy, paste, clear, etc.)
</p></div><div class="refsect1" lang="en"><a name="id2601083"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2601088"></a><h3><a name="gimp-edit-cut"></a>gimp_edit_cut ()</h3><a class="indexterm" name="id2601096"></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"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The drawable to cut from.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</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="id2601154"></a><h3><a name="gimp-edit-copy"></a>gimp_edit_copy ()</h3><a class="indexterm" name="id2601162"></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"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The drawable to copy from.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</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="id2601220"></a><h3><a name="gimp-edit-copy-visible"></a>gimp_edit_copy_visible ()</h3><a class="indexterm" name="id2601228"></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"><i class="parameter"><tt>image_ID</tt></i><EFBFBD>:</span></td><td> The image to copy from.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</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="id2601289"></a><h3><a name="gimp-edit-paste"></a>gimp_edit_paste ()</h3><a class="indexterm" name="id2601298"></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"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The drawable to paste to.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>paste_into</tt></i><EFBFBD>:</span></td><td> Clear selection, or paste behind it?
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The new floating selection.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2544187"></a><h3><a name="gimp-edit-clear"></a>gimp_edit_clear ()</h3><a class="indexterm" name="id2529708"></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"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The drawable to clear from.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2596448"></a><h3><a name="gimp-edit-fill"></a>gimp_edit_fill ()</h3><a class="indexterm" name="id2596456"></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"><tt class="function">gimp_drawable_fill()</tt></a>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The drawable to fill to.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>fill_type</tt></i><EFBFBD>:</span></td><td> The type of fill.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2596531"></a><h3><a name="gimp-edit-bucket-fill"></a>gimp_edit_bucket_fill ()</h3><a class="indexterm" name="id2596538"></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"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The affected drawable.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>fill_mode</tt></i><EFBFBD>:</span></td><td> The type of fill.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>paint_mode</tt></i><EFBFBD>:</span></td><td> The paint application mode.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i><EFBFBD>:</span></td><td> The opacity of the final bucket fill.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>threshold</tt></i><EFBFBD>:</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"><i class="parameter"><tt>sample_merged</tt></i><EFBFBD>:</span></td><td> Use the composite image, not the drawable.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>x</tt></i><EFBFBD>:</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"><i class="parameter"><tt>y</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2596720"></a><h3><a name="gimp-edit-blend"></a>gimp_edit_blend ()</h3><a class="indexterm" name="id2596727"></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"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The affected drawable.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>blend_mode</tt></i><EFBFBD>:</span></td><td> The type of blend.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>paint_mode</tt></i><EFBFBD>:</span></td><td> The paint application mode.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>gradient_type</tt></i><EFBFBD>:</span></td><td> The type of gradient.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i><EFBFBD>:</span></td><td> The opacity of the final blend.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>offset</tt></i><EFBFBD>:</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"><i class="parameter"><tt>repeat</tt></i><EFBFBD>:</span></td><td> Repeat mode.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>reverse</tt></i><EFBFBD>:</span></td><td> Use the reverse gradient.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>supersample</tt></i><EFBFBD>:</span></td><td> Do adaptive supersampling.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>max_depth</tt></i><EFBFBD>:</span></td><td> Maximum recursion levels for supersampling.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>threshold</tt></i><EFBFBD>:</span></td><td> Supersampling threshold.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>dither</tt></i><EFBFBD>:</span></td><td> Use dithering to reduce banding.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>x1</tt></i><EFBFBD>:</span></td><td> The x coordinate of this blend's starting point.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>y1</tt></i><EFBFBD>:</span></td><td> The y coordinate of this blend's starting point.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>x2</tt></i><EFBFBD>:</span></td><td> The x coordinate of this blend's ending point.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>y2</tt></i><EFBFBD>:</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><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2609633"></a><h3><a name="gimp-edit-stroke"></a>gimp_edit_stroke ()</h3><a class="indexterm" name="id2609641"></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"><i class="parameter"><tt>drawable_ID</tt></i><EFBFBD>:</span></td><td> The drawable to stroke to.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-gimpdrawabletransform.html"><b>&lt;&lt;<EFBFBD>gimpdrawabletransform</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpfileops.html"><b>gimpfileops<EFBFBD>&gt;&gt;</b></a></td></tr></table></body></html>