← 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/gimppaths.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimppaths.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gchar">gchar</link>**     <link linkend="gimp-path-list">gimp_path_list</link>                  (<link linkend="gint32">gint32</link> image_ID,
26
 
                                             <link linkend="gint">gint</link> *num_paths);
27
 
<link linkend="gint">gint</link>        <link linkend="gimp-path-get-points">gimp_path_get_points</link>            (<link linkend="gint32">gint32</link> image_ID,
28
 
                                             const <link linkend="gchar">gchar</link> *name,
29
 
                                             <link linkend="gint">gint</link> *path_closed,
30
 
                                             <link linkend="gint">gint</link> *num_path_point_details,
31
 
                                             <link linkend="gdouble">gdouble</link> **points_pairs);
32
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-path-get-current">gimp_path_get_current</link>           (<link linkend="gint32">gint32</link> image_ID);
33
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-path-set-current">gimp_path_set_current</link>           (<link linkend="gint32">gint32</link> image_ID,
34
 
                                             const <link linkend="gchar">gchar</link> *name);
35
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-path-set-points">gimp_path_set_points</link>            (<link linkend="gint32">gint32</link> image_ID,
36
 
                                             const <link linkend="gchar">gchar</link> *name,
37
 
                                             <link linkend="gint">gint</link> ptype,
38
 
                                             <link linkend="gint">gint</link> num_path_points,
39
 
                                             const <link linkend="gdouble">gdouble</link> *points_pairs);
40
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-path-stroke-current">gimp_path_stroke_current</link>        (<link linkend="gint32">gint32</link> image_ID);
41
 
<link linkend="gint">gint</link>        <link linkend="gimp-path-get-point-at-dist">gimp_path_get_point_at_dist</link>     (<link linkend="gint32">gint32</link> image_ID,
42
 
                                             <link linkend="gdouble">gdouble</link> distance,
43
 
                                             <link linkend="gint">gint</link> *y_point,
44
 
                                             <link linkend="gdouble">gdouble</link> *slope);
45
 
<link linkend="gint">gint</link>        <link linkend="gimp-path-get-tattoo">gimp_path_get_tattoo</link>            (<link linkend="gint32">gint32</link> image_ID,
46
 
                                             const <link linkend="gchar">gchar</link> *name);
47
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-get-path-by-tattoo">gimp_get_path_by_tattoo</link>         (<link linkend="gint32">gint32</link> image_ID,
48
 
                                             <link linkend="gint">gint</link> tattoo);
49
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-path-delete">gimp_path_delete</link>                (<link linkend="gint32">gint32</link> image_ID,
50
 
                                             const <link linkend="gchar">gchar</link> *name);
51
 
<link linkend="gint">gint</link>        <link linkend="gimp-path-get-locked">gimp_path_get_locked</link>            (<link linkend="gint32">gint32</link> image_ID,
52
 
                                             const <link linkend="gchar">gchar</link> *name);
53
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-path-set-locked">gimp_path_set_locked</link>            (<link linkend="gint32">gint32</link> image_ID,
54
 
                                             const <link linkend="gchar">gchar</link> *name,
55
 
                                             <link linkend="gint">gint</link> lockstatus);
56
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-path-set-tattoo">gimp_path_set_tattoo</link>            (<link linkend="gint32">gint32</link> image_ID,
57
 
                                             const <link linkend="gchar">gchar</link> *name,
58
 
                                             <link linkend="gint">gint</link> tattovalue);
59
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-path-to-selection">gimp_path_to_selection</link>          (<link linkend="gint32">gint32</link> image_ID,
60
 
                                             const <link linkend="gchar">gchar</link> *name,
61
 
                                             <link linkend="GimpChannelOps">GimpChannelOps</link> op,
62
 
                                             <link linkend="gboolean">gboolean</link> antialias,
63
 
                                             <link linkend="gboolean">gboolean</link> feather,
64
 
                                             <link linkend="gdouble">gdouble</link> feather_radius_x,
65
 
                                             <link linkend="gdouble">gdouble</link> feather_radius_y);
66
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-path-import">gimp_path_import</link>                (<link linkend="gint32">gint32</link> image_ID,
67
 
                                             const <link linkend="gchar">gchar</link> *filename,
68
 
                                             <link linkend="gboolean">gboolean</link> merge,
69
 
                                             <link linkend="gboolean">gboolean</link> scale);
 
25
<link linkend="gchar">gchar</link>**             <link linkend="gimp-path-list">gimp_path_list</link>                      (<link linkend="gint32">gint32</link> image_ID,
 
26
                                                         <link linkend="gint">gint</link> *num_paths);
 
27
<link linkend="gint">gint</link>                <link linkend="gimp-path-get-points">gimp_path_get_points</link>                (<link linkend="gint32">gint32</link> image_ID,
 
28
                                                         const <link linkend="gchar">gchar</link> *name,
 
29
                                                         <link linkend="gint">gint</link> *path_closed,
 
30
                                                         <link linkend="gint">gint</link> *num_path_point_details,
 
31
                                                         <link linkend="gdouble">gdouble</link> **points_pairs);
 
32
<link linkend="gchar">gchar</link>*              <link linkend="gimp-path-get-current">gimp_path_get_current</link>               (<link linkend="gint32">gint32</link> image_ID);
 
33
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-set-current">gimp_path_set_current</link>               (<link linkend="gint32">gint32</link> image_ID,
 
34
                                                         const <link linkend="gchar">gchar</link> *name);
 
35
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-set-points">gimp_path_set_points</link>                (<link linkend="gint32">gint32</link> image_ID,
 
36
                                                         const <link linkend="gchar">gchar</link> *name,
 
37
                                                         <link linkend="gint">gint</link> ptype,
 
38
                                                         <link linkend="gint">gint</link> num_path_points,
 
39
                                                         const <link linkend="gdouble">gdouble</link> *points_pairs);
 
40
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-stroke-current">gimp_path_stroke_current</link>            (<link linkend="gint32">gint32</link> image_ID);
 
41
<link linkend="gint">gint</link>                <link linkend="gimp-path-get-point-at-dist">gimp_path_get_point_at_dist</link>         (<link linkend="gint32">gint32</link> image_ID,
 
42
                                                         <link linkend="gdouble">gdouble</link> distance,
 
43
                                                         <link linkend="gint">gint</link> *y_point,
 
44
                                                         <link linkend="gdouble">gdouble</link> *slope);
 
45
<link linkend="gint">gint</link>                <link linkend="gimp-path-get-tattoo">gimp_path_get_tattoo</link>                (<link linkend="gint32">gint32</link> image_ID,
 
46
                                                         const <link linkend="gchar">gchar</link> *name);
 
47
<link linkend="gchar">gchar</link>*              <link linkend="gimp-get-path-by-tattoo">gimp_get_path_by_tattoo</link>             (<link linkend="gint32">gint32</link> image_ID,
 
48
                                                         <link linkend="gint">gint</link> tattoo);
 
49
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-delete">gimp_path_delete</link>                    (<link linkend="gint32">gint32</link> image_ID,
 
50
                                                         const <link linkend="gchar">gchar</link> *name);
 
51
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-get-locked">gimp_path_get_locked</link>                (<link linkend="gint32">gint32</link> image_ID,
 
52
                                                         const <link linkend="gchar">gchar</link> *name);
 
53
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-set-locked">gimp_path_set_locked</link>                (<link linkend="gint32">gint32</link> image_ID,
 
54
                                                         const <link linkend="gchar">gchar</link> *name,
 
55
                                                         <link linkend="gboolean">gboolean</link> locked);
 
56
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-set-tattoo">gimp_path_set_tattoo</link>                (<link linkend="gint32">gint32</link> image_ID,
 
57
                                                         const <link linkend="gchar">gchar</link> *name,
 
58
                                                         <link linkend="gint">gint</link> tattovalue);
 
59
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-to-selection">gimp_path_to_selection</link>              (<link linkend="gint32">gint32</link> image_ID,
 
60
                                                         const <link linkend="gchar">gchar</link> *name,
 
61
                                                         <link linkend="GimpChannelOps">GimpChannelOps</link> op,
 
62
                                                         <link linkend="gboolean">gboolean</link> antialias,
 
63
                                                         <link linkend="gboolean">gboolean</link> feather,
 
64
                                                         <link linkend="gdouble">gdouble</link> feather_radius_x,
 
65
                                                         <link linkend="gdouble">gdouble</link> feather_radius_y);
 
66
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-path-import">gimp_path_import</link>                    (<link linkend="gint32">gint32</link> image_ID,
 
67
                                                         const <link linkend="gchar">gchar</link> *filename,
 
68
                                                         <link linkend="gboolean">gboolean</link> merge,
 
69
                                                         <link linkend="gboolean">gboolean</link> scale);
70
70
</synopsis>
71
71
</refsynopsisdiv>
72
72
 
88
88
<refsect1 role="details">
89
89
<title role="details.title">Details</title>
90
90
<refsect2>
91
 
<title><anchor id="gimp-path-list" role="function"/>gimp_path_list ()</title>
92
 
<indexterm><primary>gimp_path_list</primary></indexterm><programlisting><link linkend="gchar">gchar</link>**     gimp_path_list                  (<link linkend="gint32">gint32</link> image_ID,
93
 
                                             <link linkend="gint">gint</link> *num_paths);</programlisting>
94
 
<para>
95
 
List the paths associated with the passed image.
96
 
</para>
97
 
<para>
98
 
List the paths associated with the passed image.</para>
 
91
<title><anchor id="gimp-path-list" role="function" condition="deprecated:"/>gimp_path_list ()</title>
 
92
<indexterm role="deprecated"><primary>gimp_path_list</primary></indexterm><programlisting><link linkend="gchar">gchar</link>**             gimp_path_list                      (<link linkend="gint32">gint32</link> image_ID,
 
93
                                                         <link linkend="gint">gint</link> *num_paths);</programlisting>
 
94
<warning><para><literal>gimp_path_list</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
95
<para>
 
96
This procedure is deprecated! Use <link linkend="gimp-image-get-vectors"><function>gimp_image_get_vectors()</function></link> instead.</para>
99
97
<para>
100
98
 
101
99
</para><variablelist role="params">
102
100
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
103
 
<listitem><simpara> The ID of the image to list the paths from.
 
101
<listitem><simpara> The image to list the paths from.
104
102
</simpara></listitem></varlistentry>
105
103
<varlistentry><term><parameter>num_paths</parameter>&nbsp;:</term>
106
104
<listitem><simpara> The number of paths returned.
109
107
</simpara></listitem></varlistentry>
110
108
</variablelist></refsect2>
111
109
<refsect2>
112
 
<title><anchor id="gimp-path-get-points" role="function"/>gimp_path_get_points ()</title>
113
 
<indexterm><primary>gimp_path_get_points</primary></indexterm><programlisting><link linkend="gint">gint</link>        gimp_path_get_points            (<link linkend="gint32">gint32</link> image_ID,
114
 
                                             const <link linkend="gchar">gchar</link> *name,
115
 
                                             <link linkend="gint">gint</link> *path_closed,
116
 
                                             <link linkend="gint">gint</link> *num_path_point_details,
117
 
                                             <link linkend="gdouble">gdouble</link> **points_pairs);</programlisting>
118
 
<para>
119
 
List the points associated with the named path.
120
 
</para>
121
 
<para>
122
 
List the points associated with the named path.</para>
 
110
<title><anchor id="gimp-path-get-points" role="function" condition="deprecated:"/>gimp_path_get_points ()</title>
 
111
<indexterm role="deprecated"><primary>gimp_path_get_points</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_path_get_points                (<link linkend="gint32">gint32</link> image_ID,
 
112
                                                         const <link linkend="gchar">gchar</link> *name,
 
113
                                                         <link linkend="gint">gint</link> *path_closed,
 
114
                                                         <link linkend="gint">gint</link> *num_path_point_details,
 
115
                                                         <link linkend="gdouble">gdouble</link> **points_pairs);</programlisting>
 
116
<warning><para><literal>gimp_path_get_points</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
117
<para>
 
118
This procedure is deprecated! Use <link linkend="gimp-vectors-stroke-get-points"><function>gimp_vectors_stroke_get_points()</function></link>
 
119
instead.</para>
123
120
<para>
124
121
 
125
122
</para><variablelist role="params">
126
123
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
127
 
<listitem><simpara> The ID of the image to list the paths from.
 
124
<listitem><simpara> The image to list the paths from.
128
125
</simpara></listitem></varlistentry>
129
126
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
130
127
<listitem><simpara> The name of the path whose points should be listed.
142
139
</simpara></listitem></varlistentry>
143
140
</variablelist></refsect2>
144
141
<refsect2>
145
 
<title><anchor id="gimp-path-get-current" role="function"/>gimp_path_get_current ()</title>
146
 
<indexterm><primary>gimp_path_get_current</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_path_get_current           (<link linkend="gint32">gint32</link> image_ID);</programlisting>
147
 
<para>
148
 
The name of the current path. Error if no paths.
149
 
</para>
150
 
<para>
151
 
The name of the current path. Error if no paths.</para>
 
142
<title><anchor id="gimp-path-get-current" role="function" condition="deprecated:"/>gimp_path_get_current ()</title>
 
143
<indexterm role="deprecated"><primary>gimp_path_get_current</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_path_get_current               (<link linkend="gint32">gint32</link> image_ID);</programlisting>
 
144
<warning><para><literal>gimp_path_get_current</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
145
<para>
 
146
This procedure is deprecated! Use <link linkend="gimp-image-get-active-vectors"><function>gimp_image_get_active_vectors()</function></link>
 
147
instead.</para>
152
148
<para>
153
149
 
154
150
</para><variablelist role="params">
155
151
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
156
 
<listitem><simpara> The ID of the image to get the current path from.
 
152
<listitem><simpara> The image to get the current path from.
157
153
</simpara></listitem></varlistentry>
158
154
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The name of the current path.
159
155
</simpara></listitem></varlistentry>
160
156
</variablelist></refsect2>
161
157
<refsect2>
162
 
<title><anchor id="gimp-path-set-current" role="function"/>gimp_path_set_current ()</title>
163
 
<indexterm><primary>gimp_path_set_current</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_set_current           (<link linkend="gint32">gint32</link> image_ID,
164
 
                                             const <link linkend="gchar">gchar</link> *name);</programlisting>
165
 
<para>
166
 
Sets the current path associated with the passed image.
167
 
</para>
168
 
<para>
169
 
Sets a named path as the current path.</para>
 
158
<title><anchor id="gimp-path-set-current" role="function" condition="deprecated:"/>gimp_path_set_current ()</title>
 
159
<indexterm role="deprecated"><primary>gimp_path_set_current</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_set_current               (<link linkend="gint32">gint32</link> image_ID,
 
160
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
 
161
<warning><para><literal>gimp_path_set_current</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
162
<para>
 
163
This procedure is deprecated! Use <link linkend="gimp-image-set-active-vectors"><function>gimp_image_set_active_vectors()</function></link>
 
164
instead.</para>
170
165
<para>
171
166
 
172
167
</para><variablelist role="params">
173
168
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
174
 
<listitem><simpara> The ID of the image in which a path will become current.
 
169
<listitem><simpara> The image in which a path will become current.
175
170
</simpara></listitem></varlistentry>
176
171
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
177
172
<listitem><simpara> The name of the path to make current.
180
175
</simpara></listitem></varlistentry>
181
176
</variablelist></refsect2>
182
177
<refsect2>
183
 
<title><anchor id="gimp-path-set-points" role="function"/>gimp_path_set_points ()</title>
184
 
<indexterm><primary>gimp_path_set_points</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_set_points            (<link linkend="gint32">gint32</link> image_ID,
185
 
                                             const <link linkend="gchar">gchar</link> *name,
186
 
                                             <link linkend="gint">gint</link> ptype,
187
 
                                             <link linkend="gint">gint</link> num_path_points,
188
 
                                             const <link linkend="gdouble">gdouble</link> *points_pairs);</programlisting>
189
 
<para>
190
 
Set the points associated with the named path.
191
 
</para>
192
 
<para>
193
 
Set the points associated with the named path.</para>
 
178
<title><anchor id="gimp-path-set-points" role="function" condition="deprecated:"/>gimp_path_set_points ()</title>
 
179
<indexterm role="deprecated"><primary>gimp_path_set_points</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_set_points                (<link linkend="gint32">gint32</link> image_ID,
 
180
                                                         const <link linkend="gchar">gchar</link> *name,
 
181
                                                         <link linkend="gint">gint</link> ptype,
 
182
                                                         <link linkend="gint">gint</link> num_path_points,
 
183
                                                         const <link linkend="gdouble">gdouble</link> *points_pairs);</programlisting>
 
184
<warning><para><literal>gimp_path_set_points</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
185
<para>
 
186
This procedure is deprecated! Use <link linkend="vectors-stroke-new-from-points"><function>vectors_stroke_new_from_points()</function></link>
 
187
instead.</para>
194
188
<para>
195
189
 
196
190
</para><variablelist role="params">
197
191
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
198
 
<listitem><simpara> The ID of the image to set the paths in.
 
192
<listitem><simpara> The image to set the paths in.
199
193
</simpara></listitem></varlistentry>
200
194
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
201
195
<listitem><simpara> The name of the path to create. If it exists then a unique name will be created - query the list of paths if you want to make sure that the name of the path you create is unique. This will be set as the current path.
213
207
</simpara></listitem></varlistentry>
214
208
</variablelist></refsect2>
215
209
<refsect2>
216
 
<title><anchor id="gimp-path-stroke-current" role="function"/>gimp_path_stroke_current ()</title>
217
 
<indexterm><primary>gimp_path_stroke_current</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_stroke_current        (<link linkend="gint32">gint32</link> image_ID);</programlisting>
218
 
<para>
219
 
Stroke the current path in the passed image.
220
 
</para>
221
 
<para>
222
 
Stroke the current path in the passed image.</para>
 
210
<title><anchor id="gimp-path-stroke-current" role="function" condition="deprecated:"/>gimp_path_stroke_current ()</title>
 
211
<indexterm role="deprecated"><primary>gimp_path_stroke_current</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_stroke_current            (<link linkend="gint32">gint32</link> image_ID);</programlisting>
 
212
<warning><para><literal>gimp_path_stroke_current</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
213
<para>
 
214
This procedure is deprecated! Use <link linkend="gimp-edit-stroke-vectors"><function>gimp_edit_stroke_vectors()</function></link>
 
215
instead.</para>
223
216
<para>
224
217
 
225
218
</para><variablelist role="params">
226
219
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
227
 
<listitem><simpara> The ID of the image which contains the path to stroke.
 
220
<listitem><simpara> The image which contains the path to stroke.
228
221
</simpara></listitem></varlistentry>
229
222
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
230
223
</simpara></listitem></varlistentry>
231
224
</variablelist></refsect2>
232
225
<refsect2>
233
 
<title><anchor id="gimp-path-get-point-at-dist" role="function"/>gimp_path_get_point_at_dist ()</title>
234
 
<indexterm><primary>gimp_path_get_point_at_dist</primary></indexterm><programlisting><link linkend="gint">gint</link>        gimp_path_get_point_at_dist     (<link linkend="gint32">gint32</link> image_ID,
235
 
                                             <link linkend="gdouble">gdouble</link> distance,
236
 
                                             <link linkend="gint">gint</link> *y_point,
237
 
                                             <link linkend="gdouble">gdouble</link> *slope);</programlisting>
238
 
<para>
239
 
Get point on a path at a specified distance along the path.
240
 
</para>
241
 
<para>
242
 
This will return the x,y position of a point at a given distance
243
 
along the bezier curve. The distance will be obtained by first
244
 
digitizing the curve internally and then walking along the curve.
245
 
For a closed curve the start of the path is the first point on the
246
 
path that was created. This might not be obvious. Note the current
247
 
path is used.</para>
 
226
<title><anchor id="gimp-path-get-point-at-dist" role="function" condition="deprecated:"/>gimp_path_get_point_at_dist ()</title>
 
227
<indexterm role="deprecated"><primary>gimp_path_get_point_at_dist</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_path_get_point_at_dist         (<link linkend="gint32">gint32</link> image_ID,
 
228
                                                         <link linkend="gdouble">gdouble</link> distance,
 
229
                                                         <link linkend="gint">gint</link> *y_point,
 
230
                                                         <link linkend="gdouble">gdouble</link> *slope);</programlisting>
 
231
<warning><para><literal>gimp_path_get_point_at_dist</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
232
<para>
 
233
This procedure is deprecated! Use
 
234
<link linkend="gimp-vectors-stroke-get-point-at-dist"><function>gimp_vectors_stroke_get_point_at_dist()</function></link> instead.</para>
248
235
<para>
249
236
 
250
237
</para><variablelist role="params">
251
238
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
252
 
<listitem><simpara> The ID of the image the paths belongs to.
 
239
<listitem><simpara> The image the paths belongs to.
253
240
</simpara></listitem></varlistentry>
254
241
<varlistentry><term><parameter>distance</parameter>&nbsp;:</term>
255
242
<listitem><simpara> The distance along the path.
264
251
</simpara></listitem></varlistentry>
265
252
</variablelist></refsect2>
266
253
<refsect2>
267
 
<title><anchor id="gimp-path-get-tattoo" role="function"/>gimp_path_get_tattoo ()</title>
268
 
<indexterm><primary>gimp_path_get_tattoo</primary></indexterm><programlisting><link linkend="gint">gint</link>        gimp_path_get_tattoo            (<link linkend="gint32">gint32</link> image_ID,
269
 
                                             const <link linkend="gchar">gchar</link> *name);</programlisting>
270
 
<para>
271
 
Returns the tattoo associated with the name path.
272
 
</para>
273
 
<para>
274
 
This procedure returns the tattoo associated with the specified
275
 
path. A tattoo is a unique and permanent identifier attached to a
276
 
path that can be used to uniquely identify a path within an image
277
 
even between sessions.</para>
 
254
<title><anchor id="gimp-path-get-tattoo" role="function" condition="deprecated:"/>gimp_path_get_tattoo ()</title>
 
255
<indexterm role="deprecated"><primary>gimp_path_get_tattoo</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_path_get_tattoo                (<link linkend="gint32">gint32</link> image_ID,
 
256
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
 
257
<warning><para><literal>gimp_path_get_tattoo</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
258
<para>
 
259
This procedure is deprecated! Use <link linkend="gimp-vectors-get-tattoo"><function>gimp_vectors_get_tattoo()</function></link> instead.</para>
278
260
<para>
279
261
 
280
262
</para><variablelist role="params">
288
270
</simpara></listitem></varlistentry>
289
271
</variablelist></refsect2>
290
272
<refsect2>
291
 
<title><anchor id="gimp-get-path-by-tattoo" role="function"/>gimp_get_path_by_tattoo ()</title>
292
 
<indexterm><primary>gimp_get_path_by_tattoo</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_get_path_by_tattoo         (<link linkend="gint32">gint32</link> image_ID,
293
 
                                             <link linkend="gint">gint</link> tattoo);</programlisting>
294
 
<para>
295
 
Return the name of the path with the given tattoo.
296
 
</para>
297
 
<para>
298
 
The procedure returns the name of the path in the specified image
299
 
which has the passed tattoo. The tattoos are unique within the image
300
 
and will be preserved across sessions and through renaming of the
301
 
path. An error is returned if no path with the specified tattoo can
302
 
be found.</para>
 
273
<title><anchor id="gimp-get-path-by-tattoo" role="function" condition="deprecated:"/>gimp_get_path_by_tattoo ()</title>
 
274
<indexterm role="deprecated"><primary>gimp_get_path_by_tattoo</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_get_path_by_tattoo             (<link linkend="gint32">gint32</link> image_ID,
 
275
                                                         <link linkend="gint">gint</link> tattoo);</programlisting>
 
276
<warning><para><literal>gimp_get_path_by_tattoo</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
277
<para>
 
278
This procedure is deprecated! Use <link linkend="gimp-image-get-vectors-by-tattoo"><function>gimp_image_get_vectors_by_tattoo()</function></link>
 
279
instead.</para>
303
280
<para>
304
281
 
305
282
</para><variablelist role="params">
313
290
</simpara></listitem></varlistentry>
314
291
</variablelist></refsect2>
315
292
<refsect2>
316
 
<title><anchor id="gimp-path-delete" role="function"/>gimp_path_delete ()</title>
317
 
<indexterm><primary>gimp_path_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_delete                (<link linkend="gint32">gint32</link> image_ID,
318
 
                                             const <link linkend="gchar">gchar</link> *name);</programlisting>
319
 
<para>
320
 
Delete the named path associated with the passed image.
321
 
</para>
322
 
<para>
323
 
Delete the named path.</para>
 
293
<title><anchor id="gimp-path-delete" role="function" condition="deprecated:"/>gimp_path_delete ()</title>
 
294
<indexterm role="deprecated"><primary>gimp_path_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_delete                    (<link linkend="gint32">gint32</link> image_ID,
 
295
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
 
296
<warning><para><literal>gimp_path_delete</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
297
<para>
 
298
This procedure is deprecated! Use <link linkend="gimp-image-remove-vectors"><function>gimp_image_remove_vectors()</function></link>
 
299
instead.</para>
324
300
<para>
325
301
 
326
302
</para><variablelist role="params">
327
303
<varlistentry><term><parameter>image_ID</parameter>&nbsp;:</term>
328
 
<listitem><simpara> The ID of the image to delete the path from.
 
304
<listitem><simpara> The image to delete the path from.
329
305
</simpara></listitem></varlistentry>
330
306
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
331
307
<listitem><simpara> The name of the path to delete.
334
310
</simpara></listitem></varlistentry>
335
311
</variablelist></refsect2>
336
312
<refsect2>
337
 
<title><anchor id="gimp-path-get-locked" role="function"/>gimp_path_get_locked ()</title>
338
 
<indexterm><primary>gimp_path_get_locked</primary></indexterm><programlisting><link linkend="gint">gint</link>        gimp_path_get_locked            (<link linkend="gint32">gint32</link> image_ID,
339
 
                                             const <link linkend="gchar">gchar</link> *name);</programlisting>
340
 
<para>
341
 
Returns the locked status associated with the named path.
342
 
</para>
343
 
<para>
344
 
This procedure returns the lock status associated with the specified
345
 
path. A path can be \"locked\" which means that the transformation
346
 
tool operations will also apply to the path.</para>
 
313
<title><anchor id="gimp-path-get-locked" role="function" condition="deprecated:"/>gimp_path_get_locked ()</title>
 
314
<indexterm role="deprecated"><primary>gimp_path_get_locked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_get_locked                (<link linkend="gint32">gint32</link> image_ID,
 
315
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
 
316
<warning><para><literal>gimp_path_get_locked</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
317
<para>
 
318
This procedure is deprecated! Use <link linkend="gimp-vectors-get-linked"><function>gimp_vectors_get_linked()</function></link> instead.</para>
347
319
<para>
348
320
 
349
321
</para><variablelist role="params">
353
325
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
354
326
<listitem><simpara> The name of the path whose locked status should be obtained.
355
327
</simpara></listitem></varlistentry>
356
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The lock status associated with the name path. 0 is returned if the path is not locked. 1 is returned if the path is locked.
 
328
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the path is locked, FALSE otherwise.
357
329
</simpara></listitem></varlistentry>
358
330
</variablelist></refsect2>
359
331
<refsect2>
360
 
<title><anchor id="gimp-path-set-locked" role="function"/>gimp_path_set_locked ()</title>
361
 
<indexterm><primary>gimp_path_set_locked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_set_locked            (<link linkend="gint32">gint32</link> image_ID,
362
 
                                             const <link linkend="gchar">gchar</link> *name,
363
 
                                             <link linkend="gint">gint</link> lockstatus);</programlisting>
364
 
<para>
365
 
Set the locked status associated with the named path.
366
 
</para>
367
 
<para>
368
 
This procedure sets the lock status associated with the specified
369
 
path. A path can be \"locked\" which means that the transformation
370
 
tool operations will also apply to the path.</para>
 
332
<title><anchor id="gimp-path-set-locked" role="function" condition="deprecated:"/>gimp_path_set_locked ()</title>
 
333
<indexterm role="deprecated"><primary>gimp_path_set_locked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_set_locked                (<link linkend="gint32">gint32</link> image_ID,
 
334
                                                         const <link linkend="gchar">gchar</link> *name,
 
335
                                                         <link linkend="gboolean">gboolean</link> locked);</programlisting>
 
336
<warning><para><literal>gimp_path_set_locked</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
337
<para>
 
338
This procedure is deprecated! Use <link linkend="gimp-vectors-set-linked"><function>gimp_vectors_set_linked()</function></link> instead.</para>
371
339
<para>
372
340
 
373
341
</para><variablelist role="params">
377
345
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
378
346
<listitem><simpara> the name of the path whose locked status should be set.
379
347
</simpara></listitem></varlistentry>
380
 
<varlistentry><term><parameter>lockstatus</parameter>&nbsp;:</term>
381
 
<listitem><simpara> The lock status associated with the name path. 0 if the path is not locked. 1 if the path is to be locked.
 
348
<varlistentry><term><parameter>locked</parameter>&nbsp;:</term>
 
349
<listitem><simpara> Whether the path is locked.
382
350
</simpara></listitem></varlistentry>
383
351
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
384
352
</simpara></listitem></varlistentry>
385
353
</variablelist></refsect2>
386
354
<refsect2>
387
 
<title><anchor id="gimp-path-set-tattoo" role="function"/>gimp_path_set_tattoo ()</title>
388
 
<indexterm><primary>gimp_path_set_tattoo</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_set_tattoo            (<link linkend="gint32">gint32</link> image_ID,
389
 
                                             const <link linkend="gchar">gchar</link> *name,
390
 
                                             <link linkend="gint">gint</link> tattovalue);</programlisting>
391
 
<para>
392
 
Sets the tattoo associated with the named path.
393
 
</para>
394
 
<para>
395
 
This procedure sets the tattoo associated with the specified path. A
396
 
tattoo is a unique and permenant identifier attached to a path that
397
 
can be used to uniquely identify a path within an image even between
398
 
sessions. Note that the value passed to this function must have been
399
 
obtained from a previous call to path_get_tattoo.</para>
 
355
<title><anchor id="gimp-path-set-tattoo" role="function" condition="deprecated:"/>gimp_path_set_tattoo ()</title>
 
356
<indexterm role="deprecated"><primary>gimp_path_set_tattoo</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_set_tattoo                (<link linkend="gint32">gint32</link> image_ID,
 
357
                                                         const <link linkend="gchar">gchar</link> *name,
 
358
                                                         <link linkend="gint">gint</link> tattovalue);</programlisting>
 
359
<warning><para><literal>gimp_path_set_tattoo</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
360
<para>
 
361
This procedure is deprecated! Use <link linkend="gimp-vectors-set-tattoo"><function>gimp_vectors_set_tattoo()</function></link> instead.</para>
400
362
<para>
401
363
 
402
364
</para><variablelist role="params">
413
375
</simpara></listitem></varlistentry>
414
376
</variablelist></refsect2>
415
377
<refsect2>
416
 
<title><anchor id="gimp-path-to-selection" role="function"/>gimp_path_to_selection ()</title>
417
 
<indexterm><primary>gimp_path_to_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_to_selection          (<link linkend="gint32">gint32</link> image_ID,
418
 
                                             const <link linkend="gchar">gchar</link> *name,
419
 
                                             <link linkend="GimpChannelOps">GimpChannelOps</link> op,
420
 
                                             <link linkend="gboolean">gboolean</link> antialias,
421
 
                                             <link linkend="gboolean">gboolean</link> feather,
422
 
                                             <link linkend="gdouble">gdouble</link> feather_radius_x,
423
 
                                             <link linkend="gdouble">gdouble</link> feather_radius_y);</programlisting>
424
 
<para>
425
 
Transforms the active path into a selection
426
 
</para>
427
 
<para>
428
 
This procedure renders the desired path into the current selection.</para>
 
378
<title><anchor id="gimp-path-to-selection" role="function" condition="deprecated:"/>gimp_path_to_selection ()</title>
 
379
<indexterm role="deprecated"><primary>gimp_path_to_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_to_selection              (<link linkend="gint32">gint32</link> image_ID,
 
380
                                                         const <link linkend="gchar">gchar</link> *name,
 
381
                                                         <link linkend="GimpChannelOps">GimpChannelOps</link> op,
 
382
                                                         <link linkend="gboolean">gboolean</link> antialias,
 
383
                                                         <link linkend="gboolean">gboolean</link> feather,
 
384
                                                         <link linkend="gdouble">gdouble</link> feather_radius_x,
 
385
                                                         <link linkend="gdouble">gdouble</link> feather_radius_y);</programlisting>
 
386
<warning><para><literal>gimp_path_to_selection</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
387
<para>
 
388
This procedure is deprecated! Use <link linkend="gimp-vectors-to-selection"><function>gimp_vectors_to_selection()</function></link>
 
389
instead.</para>
429
390
<para>
430
391
 
431
392
</para><variablelist role="params">
454
415
</simpara></listitem></varlistentry>
455
416
</variablelist></refsect2>
456
417
<refsect2>
457
 
<title><anchor id="gimp-path-import" role="function"/>gimp_path_import ()</title>
458
 
<indexterm><primary>gimp_path_import</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_path_import                (<link linkend="gint32">gint32</link> image_ID,
459
 
                                             const <link linkend="gchar">gchar</link> *filename,
460
 
                                             <link linkend="gboolean">gboolean</link> merge,
461
 
                                             <link linkend="gboolean">gboolean</link> scale);</programlisting>
462
 
<para>
463
 
Import paths from an SVG file.
464
 
</para>
465
 
<para>
466
 
This procedure imports paths from an SVG file. This is a temporary
467
 
solution until the new vectors PDB API is in place. Don't rely on
468
 
this function being available in future GIMP releases.</para>
 
418
<title><anchor id="gimp-path-import" role="function" condition="deprecated:"/>gimp_path_import ()</title>
 
419
<indexterm role="deprecated"><primary>gimp_path_import</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_path_import                    (<link linkend="gint32">gint32</link> image_ID,
 
420
                                                         const <link linkend="gchar">gchar</link> *filename,
 
421
                                                         <link linkend="gboolean">gboolean</link> merge,
 
422
                                                         <link linkend="gboolean">gboolean</link> scale);</programlisting>
 
423
<warning><para><literal>gimp_path_import</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
424
<para>
 
425
This procedure is deprecated! Use <link linkend="vectors-import-from-file"><function>vectors_import_from_file()</function></link>
 
426
instead.</para>
469
427
<para>
470
428
 
471
429
</para><variablelist role="params">