← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpfloatingsel.xml

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2009-03-17 03:00:24 UTC
  • mfrom: (1.1.20 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317030024-gnp1dhd0hnt80f4h
Tags: 2.6.6-0ubuntu1
https://launchpad.net/bugs/344052
* New upstream release (LP: #344052)
* debian/patches/04_from_bugzilla_572403.patch:
  - Dropped, the fix is in the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpfloatingsel.xml
12
12
<refnamediv>
13
13
<refname>gimpfloatingsel</refname>
14
14
<refpurpose>Functions for removing or attaching floating selections.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="libgimp-gimpfloatingsel.synopsis" role="synopsis">
43
42
<title role="desc.title">Description</title>
44
43
<para>
45
44
Functions for removing or attaching floating selections.
46
 
 
47
45
</para>
48
46
</refsect1>
49
47
 
51
49
<title role="details.title">Details</title>
52
50
<refsect2 id="gimp-floating-sel-remove" role="function">
53
51
<title>gimp_floating_sel_remove ()</title>
54
 
<indexterm zone="gimp-floating-sel-remove"><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>
 
52
<indexterm zone="gimp-floating-sel-remove"><primary sortas="gimp_floating_sel_remove">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>
55
53
<para>
56
54
Remove the specified floating selection from its associated
57
55
drawable.
60
58
This procedure removes the floating selection completely, without
61
59
any side effects. The associated drawable is then set to active.</para>
62
60
<para>
63
 
 
64
61
</para><variablelist role="params">
65
 
<varlistentry><term><parameter>floating_sel_ID</parameter>&nbsp;:</term>
 
62
<varlistentry><term><parameter>floating_sel_ID</parameter>&#160;:</term>
66
63
<listitem><simpara> The floating selection.
67
64
</simpara></listitem></varlistentry>
68
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
65
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
69
66
</simpara></listitem></varlistentry>
70
67
</variablelist></refsect2>
71
68
<refsect2 id="gimp-floating-sel-anchor" role="function">
72
69
<title>gimp_floating_sel_anchor ()</title>
73
 
<indexterm zone="gimp-floating-sel-anchor"><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>
 
70
<indexterm zone="gimp-floating-sel-anchor"><primary sortas="gimp_floating_sel_anchor">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>
74
71
<para>
75
72
Anchor the specified floating selection to its associated drawable.
76
73
</para>
80
77
ClipToBottomLayer. The floating selection layer is no longer valid
81
78
after this operation.</para>
82
79
<para>
83
 
 
84
80
</para><variablelist role="params">
85
 
<varlistentry><term><parameter>floating_sel_ID</parameter>&nbsp;:</term>
 
81
<varlistentry><term><parameter>floating_sel_ID</parameter>&#160;:</term>
86
82
<listitem><simpara> The floating selection.
87
83
</simpara></listitem></varlistentry>
88
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
84
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
89
85
</simpara></listitem></varlistentry>
90
86
</variablelist></refsect2>
91
87
<refsect2 id="gimp-floating-sel-to-layer" role="function">
92
88
<title>gimp_floating_sel_to_layer ()</title>
93
 
<indexterm zone="gimp-floating-sel-to-layer"><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>
 
89
<indexterm zone="gimp-floating-sel-to-layer"><primary sortas="gimp_floating_sel_to_layer">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>
94
90
<para>
95
91
Transforms the specified floating selection into a layer.
96
92
</para>
104
100
from the underlying image. This might be the case if the floating
105
101
selection is above an auxillary channel or a layer mask.</para>
106
102
<para>
107
 
 
108
103
</para><variablelist role="params">
109
 
<varlistentry><term><parameter>floating_sel_ID</parameter>&nbsp;:</term>
 
104
<varlistentry><term><parameter>floating_sel_ID</parameter>&#160;:</term>
110
105
<listitem><simpara> The floating selection.
111
106
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
107
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
113
108
</simpara></listitem></varlistentry>
114
109
</variablelist></refsect2>
115
110
<refsect2 id="gimp-floating-sel-attach" role="function">
116
111
<title>gimp_floating_sel_attach ()</title>
117
 
<indexterm zone="gimp-floating-sel-attach"><primary>gimp_floating_sel_attach</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_floating_sel_attach            (<link linkend="gint32">gint32</link> layer_ID,
 
112
<indexterm zone="gimp-floating-sel-attach"><primary sortas="gimp_floating_sel_attach">gimp_floating_sel_attach</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_floating_sel_attach            (<link linkend="gint32">gint32</link> layer_ID,
118
113
                                                         <link linkend="gint32">gint32</link> drawable_ID);</programlisting>
119
114
<para>
120
115
Attach the specified layer as floating to the specified drawable.
123
118
This procedure attaches the layer as floating selection to the
124
119
drawable.</para>
125
120
<para>
126
 
 
127
121
</para><variablelist role="params">
128
 
<varlistentry><term><parameter>layer_ID</parameter>&nbsp;:</term>
 
122
<varlistentry><term><parameter>layer_ID</parameter>&#160;:</term>
129
123
<listitem><simpara> The layer (is attached as floating selection).
130
124
</simpara></listitem></varlistentry>
131
 
<varlistentry><term><parameter>drawable_ID</parameter>&nbsp;:</term>
 
125
<varlistentry><term><parameter>drawable_ID</parameter>&#160;:</term>
132
126
<listitem><simpara> The drawable (where to attach the floating selection).
133
127
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
128
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
135
129
</simpara></listitem></varlistentry>
136
130
</variablelist></refsect2>
137
131
<refsect2 id="gimp-floating-sel-rigor" role="function">
138
132
<title>gimp_floating_sel_rigor ()</title>
139
 
<indexterm zone="gimp-floating-sel-rigor"><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,
 
133
<indexterm zone="gimp-floating-sel-rigor"><primary sortas="gimp_floating_sel_rigor">gimp_floating_sel_rigor</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_floating_sel_rigor             (<link linkend="gint32">gint32</link> floating_sel_ID,
140
134
                                                         <link linkend="gboolean">gboolean</link> undo);</programlisting>
141
135
<para>
142
136
Rigor the floating selection.
144
138
<para>
145
139
This procedure rigors the floating selection.</para>
146
140
<para>
147
 
 
148
141
</para><variablelist role="params">
149
 
<varlistentry><term><parameter>floating_sel_ID</parameter>&nbsp;:</term>
 
142
<varlistentry><term><parameter>floating_sel_ID</parameter>&#160;:</term>
150
143
<listitem><simpara> The floating selection.
151
144
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><parameter>undo</parameter>&nbsp;:</term>
 
145
<varlistentry><term><parameter>undo</parameter>&#160;:</term>
153
146
<listitem><simpara> .
154
147
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
148
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
156
149
</simpara></listitem></varlistentry>
157
150
</variablelist></refsect2>
158
151
<refsect2 id="gimp-floating-sel-relax" role="function">
159
152
<title>gimp_floating_sel_relax ()</title>
160
 
<indexterm zone="gimp-floating-sel-relax"><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,
 
153
<indexterm zone="gimp-floating-sel-relax"><primary sortas="gimp_floating_sel_relax">gimp_floating_sel_relax</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_floating_sel_relax             (<link linkend="gint32">gint32</link> floating_sel_ID,
161
154
                                                         <link linkend="gboolean">gboolean</link> undo);</programlisting>
162
155
<para>
163
156
Relax the floating selection.
165
158
<para>
166
159
This procedure relaxes the floating selection.</para>
167
160
<para>
168
 
 
169
161
</para><variablelist role="params">
170
 
<varlistentry><term><parameter>floating_sel_ID</parameter>&nbsp;:</term>
 
162
<varlistentry><term><parameter>floating_sel_ID</parameter>&#160;:</term>
171
163
<listitem><simpara> The floating selection.
172
164
</simpara></listitem></varlistentry>
173
 
<varlistentry><term><parameter>undo</parameter>&nbsp;:</term>
 
165
<varlistentry><term><parameter>undo</parameter>&#160;:</term>
174
166
<listitem><simpara> .
175
167
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
 
168
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
177
169
</simpara></listitem></varlistentry>
178
170
</variablelist></refsect2>
179
171