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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpfloatingsel">
<refmeta>
<refentrytitle role="top_of_page">gimpfloatingsel</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpfloatingsel</refname>
<refpurpose>Functions for removing or attaching floating selections.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gboolean">gboolean</link> <link linkend="gimp-floating-sel-remove">gimp_floating_sel_remove</link> (<link linkend="gint32">gint32</link> floating_sel_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-floating-sel-anchor">gimp_floating_sel_anchor</link> (<link linkend="gint32">gint32</link> floating_sel_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-floating-sel-to-layer">gimp_floating_sel_to_layer</link> (<link linkend="gint32">gint32</link> floating_sel_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-floating-sel-attach">gimp_floating_sel_attach</link> (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint32">gint32</link> drawable_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-floating-sel-rigor">gimp_floating_sel_rigor</link> (<link linkend="gint32">gint32</link> floating_sel_ID,
<link linkend="gboolean">gboolean</link> undo);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-floating-sel-relax">gimp_floating_sel_relax</link> (<link linkend="gint32">gint32</link> floating_sel_ID,
<link linkend="gboolean">gboolean</link> undo);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions for removing or attaching floating selections.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-floating-sel-remove" role="function"/>gimp_floating_sel_remove ()</title>
<indexterm><primary>gimp_floating_sel_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_floating_sel_remove (<link linkend="gint32">gint32</link> floating_sel_ID);</programlisting>
<para>
Remove the specified floating selection from its associated
drawable.
</para>
<para>
This procedure removes the floating selection completely, without
any side effects. The associated drawable is then set to active.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>floating_sel_ID</parameter> :</term>
<listitem><simpara> The floating selection.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-floating-sel-anchor" role="function"/>gimp_floating_sel_anchor ()</title>
<indexterm><primary>gimp_floating_sel_anchor</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_floating_sel_anchor (<link linkend="gint32">gint32</link> floating_sel_ID);</programlisting>
<para>
Anchor the specified floating selection to its associated drawable.
</para>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>floating_sel_ID</parameter> :</term>
<listitem><simpara> The floating selection.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-floating-sel-to-layer" role="function"/>gimp_floating_sel_to_layer ()</title>
<indexterm><primary>gimp_floating_sel_to_layer</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_floating_sel_to_layer (<link linkend="gint32">gint32</link> floating_sel_ID);</programlisting>
<para>
Transforms the specified floating selection into a layer.
</para>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>floating_sel_ID</parameter> :</term>
<listitem><simpara> The floating selection.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-floating-sel-attach" role="function"/>gimp_floating_sel_attach ()</title>
<indexterm><primary>gimp_floating_sel_attach</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_floating_sel_attach (<link linkend="gint32">gint32</link> layer_ID,
<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
<para>
Attach the specified layer as floating to the specified drawable.
</para>
<para>
This procedure attaches the layer as floating selection to the
drawable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layer_ID</parameter> :</term>
<listitem><simpara> The layer (is attached as floating selection).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
<listitem><simpara> The drawable (where to attach the floating selection).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-floating-sel-rigor" role="function"/>gimp_floating_sel_rigor ()</title>
<indexterm><primary>gimp_floating_sel_rigor</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_floating_sel_rigor (<link linkend="gint32">gint32</link> floating_sel_ID,
<link linkend="gboolean">gboolean</link> undo);</programlisting>
<para>
Rigor the floating selection.
</para>
<para>
This procedure rigors the floating selection.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>floating_sel_ID</parameter> :</term>
<listitem><simpara> The floating selection.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>undo</parameter> :</term>
<listitem><simpara> %<link linkend="desc"><literal>desc</literal></link>%%.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-floating-sel-relax" role="function"/>gimp_floating_sel_relax ()</title>
<indexterm><primary>gimp_floating_sel_relax</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_floating_sel_relax (<link linkend="gint32">gint32</link> floating_sel_ID,
<link linkend="gboolean">gboolean</link> undo);</programlisting>
<para>
Relax the floating selection.
</para>
<para>
This procedure relaxes the floating selection.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>floating_sel_ID</parameter> :</term>
<listitem><simpara> The floating selection.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>undo</parameter> :</term>
<listitem><simpara> %<link linkend="desc"><literal>desc</literal></link>%%.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
