diff options
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimpfloatingsel.html')
-rw-r--r-- | devel-docs/libgimp/html/libgimp-gimpfloatingsel.html | 306 |
1 files changed, 306 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpfloatingsel.html b/devel-docs/libgimp/html/libgimp-gimpfloatingsel.html new file mode 100644 index 0000000..85ebf70 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpfloatingsel.html @@ -0,0 +1,306 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimpfloatingsel: GIMP Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Library Reference Manual"> +<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties"> +<link rel="prev" href="libgimp-gimpfileops.html" title="gimpfileops"> +<link rel="next" href="libgimp-gimpimage.html" title="gimpimage"> +<meta name="generator" content="GTK-Doc V1.32 (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="5"><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-gimpfloatingsel.description" class="shortcut">Description</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-gimpfileops.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimpimage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<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="libgimp-gimpfloatingsel.top_of_page"></a>gimpfloatingsel</span></h2> +<p>gimpfloatingsel — Functions for removing or attaching floating selections.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimpfloatingsel.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpfloatingsel.html#gimp-floating-sel-remove" title="gimp_floating_sel_remove ()">gimp_floating_sel_remove</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpfloatingsel.html#gimp-floating-sel-anchor" title="gimp_floating_sel_anchor ()">gimp_floating_sel_anchor</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpfloatingsel.html#gimp-floating-sel-to-layer" title="gimp_floating_sel_to_layer ()">gimp_floating_sel_to_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpfloatingsel.html#gimp-floating-sel-attach" title="gimp_floating_sel_attach ()">gimp_floating_sel_attach</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpfloatingsel.html#gimp-floating-sel-rigor" title="gimp_floating_sel_rigor ()">gimp_floating_sel_rigor</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpfloatingsel.html#gimp-floating-sel-relax" title="gimp_floating_sel_relax ()">gimp_floating_sel_relax</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpfloatingsel.description"></a><h2>Description</h2> +<p>Functions for removing or attaching floating selections.</p> +</div> +<div class="refsect1"> +<a name="libgimp-gimpfloatingsel.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-floating-sel-remove"></a><h3>gimp_floating_sel_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_floating_sel_remove (<em class="parameter"><code><span class="type">gint32</span> floating_sel_ID</code></em>);</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> +<div class="refsect3"> +<a name="gimp-floating-sel-remove.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>floating_sel_ID</p></td> +<td class="parameter_description"><p>The floating selection.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-floating-sel-remove.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-floating-sel-anchor"></a><h3>gimp_floating_sel_anchor ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_floating_sel_anchor (<em class="parameter"><code><span class="type">gint32</span> floating_sel_ID</code></em>);</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> +<div class="refsect3"> +<a name="gimp-floating-sel-anchor.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>floating_sel_ID</p></td> +<td class="parameter_description"><p>The floating selection.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-floating-sel-anchor.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-floating-sel-to-layer"></a><h3>gimp_floating_sel_to_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_floating_sel_to_layer (<em class="parameter"><code><span class="type">gint32</span> floating_sel_ID</code></em>);</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 auxiliary channel or a layer mask.</p> +<div class="refsect3"> +<a name="gimp-floating-sel-to-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>floating_sel_ID</p></td> +<td class="parameter_description"><p>The floating selection.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-floating-sel-to-layer.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-floating-sel-attach"></a><h3>gimp_floating_sel_attach ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_floating_sel_attach (<em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>);</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> +<div class="refsect3"> +<a name="gimp-floating-sel-attach.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>layer_ID</p></td> +<td class="parameter_description"><p>The layer (is attached as floating selection).</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>drawable_ID</p></td> +<td class="parameter_description"><p>The drawable (where to attach the floating selection).</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-floating-sel-attach.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-floating-sel-rigor"></a><h3>gimp_floating_sel_rigor ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_floating_sel_rigor (<em class="parameter"><code><span class="type">gint32</span> floating_sel_ID</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> undo</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_floating_sel_rigor</code> is deprecated and should not be used in newly-written code.</p> +<p>There is no replacement for this procedure.</p> +</div> +<div class="refsect3"> +<a name="gimp-floating-sel-rigor.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>floating_sel_ID</p></td> +<td class="parameter_description"><p>The floating selection.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>undo</p></td> +<td class="parameter_description"><p>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-floating-sel-rigor.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-floating-sel-relax"></a><h3>gimp_floating_sel_relax ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_floating_sel_relax (<em class="parameter"><code><span class="type">gint32</span> floating_sel_ID</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> undo</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_floating_sel_relax</code> is deprecated and should not be used in newly-written code.</p> +<p>There is no replacement for this procedure.</p> +</div> +<div class="refsect3"> +<a name="gimp-floating-sel-relax.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" 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>floating_sel_ID</p></td> +<td class="parameter_description"><p>The floating selection.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>undo</p></td> +<td class="parameter_description"><p>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-floating-sel-relax.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |