Files
gimp/devel-docs/libgimp/html/libgimp-gimpfloatingsel.html
2010-08-11 01:19:49 -04:00

297 lines
10 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpfloatingsel</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-gimpfileops.html" title="gimpfileops">
<link rel="next" href="libgimp-gimpgrid.html" title="gimpgrid">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;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&#160;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.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">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpfileops.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-gimpgrid.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="#top_of_page" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpfloatingsel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>gimpfloatingsel</span></h2>
<p>gimpfloatingsel &#8212; Functions for removing or attaching floating selections.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
gboolean <a href="libgimp-gimpfloatingsel.html#gimp-floating-sel-remove">gimp_floating_sel_remove</a> (gint32 floating_sel_ID);
gboolean <a href="libgimp-gimpfloatingsel.html#gimp-floating-sel-anchor">gimp_floating_sel_anchor</a> (gint32 floating_sel_ID);
gboolean <a href="libgimp-gimpfloatingsel.html#gimp-floating-sel-to-layer">gimp_floating_sel_to_layer</a> (gint32 floating_sel_ID);
gboolean <a href="libgimp-gimpfloatingsel.html#gimp-floating-sel-attach">gimp_floating_sel_attach</a> (gint32 layer_ID,
gint32 drawable_ID);
gboolean <a href="libgimp-gimpfloatingsel.html#gimp-floating-sel-rigor">gimp_floating_sel_rigor</a> (gint32 floating_sel_ID,
gboolean undo);
gboolean <a href="libgimp-gimpfloatingsel.html#gimp-floating-sel-relax">gimp_floating_sel_relax</a> (gint32 floating_sel_ID,
gboolean undo);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
Functions for removing or attaching floating selections.
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2582099"></a><h3>
<a name="gimp-floating-sel-remove"></a>gimp_floating_sel_remove ()</h3>
<a class="indexterm" name="id2582111"></a><pre class="programlisting">gboolean gimp_floating_sel_remove (gint32 floating_sel_ID);</pre>
<p>
Remove the specified floating selection from its associated
drawable.
</p>
<p>
This procedure removes the floating selection completely, without
any side effects. The associated drawable is then set to 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>floating_sel_ID</code></em>&#160;:</span></td>
<td> The floating selection.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2582176"></a><h3>
<a name="gimp-floating-sel-anchor"></a>gimp_floating_sel_anchor ()</h3>
<a class="indexterm" name="id2582187"></a><pre class="programlisting">gboolean gimp_floating_sel_anchor (gint32 floating_sel_ID);</pre>
<p>
Anchor the specified floating selection to its associated drawable.
</p>
<p>
This procedure anchors the floating selection to its associated
drawable. This is similar to merging with a merge type of
ClipToBottomLayer. The floating selection layer is no longer valid
after this operation.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>floating_sel_ID</code></em>&#160;:</span></td>
<td> The floating selection.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531267"></a><h3>
<a name="gimp-floating-sel-to-layer"></a>gimp_floating_sel_to_layer ()</h3>
<a class="indexterm" name="id2531278"></a><pre class="programlisting">gboolean gimp_floating_sel_to_layer (gint32 floating_sel_ID);</pre>
<p>
Transforms the specified floating selection into a layer.
</p>
<p>
This procedure transforms the specified floating selection into a
layer with the same offsets and extents. The composited image will
look precisely the same, but the floating selection layer will no
longer be clipped to the extents of the drawable it was attached to.
The floating selection will become the active layer. This procedure
will not work if the floating selection has a different base type
from the underlying image. This might be the case if the floating
selection is above an auxillary channel or a layer mask.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>floating_sel_ID</code></em>&#160;:</span></td>
<td> The floating selection.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531350"></a><h3>
<a name="gimp-floating-sel-attach"></a>gimp_floating_sel_attach ()</h3>
<a class="indexterm" name="id2531361"></a><pre class="programlisting">gboolean gimp_floating_sel_attach (gint32 layer_ID,
gint32 drawable_ID);</pre>
<p>
Attach the specified layer as floating to the specified drawable.
</p>
<p>
This procedure attaches the layer as floating selection to the
drawable.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
<td> The layer (is attached as floating selection).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
<td> The drawable (where to attach the floating selection).
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603085"></a><h3>
<a name="gimp-floating-sel-rigor"></a>gimp_floating_sel_rigor ()</h3>
<a class="indexterm" name="id2603096"></a><pre class="programlisting">gboolean gimp_floating_sel_rigor (gint32 floating_sel_ID,
gboolean undo);</pre>
<p>
Rigor the floating selection.
</p>
<p>
This procedure rigors the floating 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>floating_sel_ID</code></em>&#160;:</span></td>
<td> The floating selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>undo</code></em>&#160;:</span></td>
<td> .
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603180"></a><h3>
<a name="gimp-floating-sel-relax"></a>gimp_floating_sel_relax ()</h3>
<a class="indexterm" name="id2603191"></a><pre class="programlisting">gboolean gimp_floating_sel_relax (gint32 floating_sel_ID,
gboolean undo);</pre>
<p>
Relax the floating selection.
</p>
<p>
This procedure relaxes the floating 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>floating_sel_ID</code></em>&#160;:</span></td>
<td> The floating selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>undo</code></em>&#160;:</span></td>
<td> .
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>