← 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/gimptexttool.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/gimptexttool.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gint32">gint32</link>      <link linkend="gimp-text-fontname">gimp_text_fontname</link>              (<link linkend="gint32">gint32</link> image_ID,
26
 
                                             <link linkend="gint32">gint32</link> drawable_ID,
27
 
                                             <link linkend="gdouble">gdouble</link> x,
28
 
                                             <link linkend="gdouble">gdouble</link> y,
29
 
                                             const <link linkend="gchar">gchar</link> *text,
30
 
                                             <link linkend="gint">gint</link> border,
31
 
                                             <link linkend="gboolean">gboolean</link> antialias,
32
 
                                             <link linkend="gdouble">gdouble</link> size,
33
 
                                             <link linkend="GimpSizeType">GimpSizeType</link> size_type,
34
 
                                             const <link linkend="gchar">gchar</link> *fontname);
35
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-text-get-extents-fontname">gimp_text_get_extents_fontname</link>  (const <link linkend="gchar">gchar</link> *text,
36
 
                                             <link linkend="gdouble">gdouble</link> size,
37
 
                                             <link linkend="GimpSizeType">GimpSizeType</link> size_type,
38
 
                                             const <link linkend="gchar">gchar</link> *fontname,
39
 
                                             <link linkend="gint">gint</link> *width,
40
 
                                             <link linkend="gint">gint</link> *height,
41
 
                                             <link linkend="gint">gint</link> *ascent,
42
 
                                             <link linkend="gint">gint</link> *descent);
43
 
<link linkend="gint32">gint32</link>      <link linkend="gimp-text">gimp_text</link>                       (<link linkend="gint32">gint32</link> image_ID,
44
 
                                             <link linkend="gint32">gint32</link> drawable_ID,
45
 
                                             <link linkend="gdouble">gdouble</link> x,
46
 
                                             <link linkend="gdouble">gdouble</link> y,
47
 
                                             const <link linkend="gchar">gchar</link> *text,
48
 
                                             <link linkend="gint">gint</link> border,
49
 
                                             <link linkend="gboolean">gboolean</link> antialias,
50
 
                                             <link linkend="gdouble">gdouble</link> size,
51
 
                                             <link linkend="GimpSizeType">GimpSizeType</link> size_type,
52
 
                                             const <link linkend="gchar">gchar</link> *foundry,
53
 
                                             const <link linkend="gchar">gchar</link> *family,
54
 
                                             const <link linkend="gchar">gchar</link> *weight,
55
 
                                             const <link linkend="gchar">gchar</link> *slant,
56
 
                                             const <link linkend="gchar">gchar</link> *set_width,
57
 
                                             const <link linkend="gchar">gchar</link> *spacing,
58
 
                                             const <link linkend="gchar">gchar</link> *registry,
59
 
                                             const <link linkend="gchar">gchar</link> *encoding);
60
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-text-get-extents">gimp_text_get_extents</link>           (const <link linkend="gchar">gchar</link> *text,
61
 
                                             <link linkend="gdouble">gdouble</link> size,
62
 
                                             <link linkend="GimpSizeType">GimpSizeType</link> size_type,
63
 
                                             const <link linkend="gchar">gchar</link> *foundry,
64
 
                                             const <link linkend="gchar">gchar</link> *family,
65
 
                                             const <link linkend="gchar">gchar</link> *weight,
66
 
                                             const <link linkend="gchar">gchar</link> *slant,
67
 
                                             const <link linkend="gchar">gchar</link> *set_width,
68
 
                                             const <link linkend="gchar">gchar</link> *spacing,
69
 
                                             const <link linkend="gchar">gchar</link> *registry,
70
 
                                             const <link linkend="gchar">gchar</link> *encoding,
71
 
                                             <link linkend="gint">gint</link> *width,
72
 
                                             <link linkend="gint">gint</link> *height,
73
 
                                             <link linkend="gint">gint</link> *ascent,
74
 
                                             <link linkend="gint">gint</link> *descent);
 
25
<link linkend="gint32">gint32</link>              <link linkend="gimp-text-fontname">gimp_text_fontname</link>                  (<link linkend="gint32">gint32</link> image_ID,
 
26
                                                         <link linkend="gint32">gint32</link> drawable_ID,
 
27
                                                         <link linkend="gdouble">gdouble</link> x,
 
28
                                                         <link linkend="gdouble">gdouble</link> y,
 
29
                                                         const <link linkend="gchar">gchar</link> *text,
 
30
                                                         <link linkend="gint">gint</link> border,
 
31
                                                         <link linkend="gboolean">gboolean</link> antialias,
 
32
                                                         <link linkend="gdouble">gdouble</link> size,
 
33
                                                         <link linkend="GimpSizeType">GimpSizeType</link> size_type,
 
34
                                                         const <link linkend="gchar">gchar</link> *fontname);
 
35
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-text-get-extents-fontname">gimp_text_get_extents_fontname</link>      (const <link linkend="gchar">gchar</link> *text,
 
36
                                                         <link linkend="gdouble">gdouble</link> size,
 
37
                                                         <link linkend="GimpSizeType">GimpSizeType</link> size_type,
 
38
                                                         const <link linkend="gchar">gchar</link> *fontname,
 
39
                                                         <link linkend="gint">gint</link> *width,
 
40
                                                         <link linkend="gint">gint</link> *height,
 
41
                                                         <link linkend="gint">gint</link> *ascent,
 
42
                                                         <link linkend="gint">gint</link> *descent);
 
43
<link linkend="gint32">gint32</link>              <link linkend="gimp-text">gimp_text</link>                           (<link linkend="gint32">gint32</link> image_ID,
 
44
                                                         <link linkend="gint32">gint32</link> drawable_ID,
 
45
                                                         <link linkend="gdouble">gdouble</link> x,
 
46
                                                         <link linkend="gdouble">gdouble</link> y,
 
47
                                                         const <link linkend="gchar">gchar</link> *text,
 
48
                                                         <link linkend="gint">gint</link> border,
 
49
                                                         <link linkend="gboolean">gboolean</link> antialias,
 
50
                                                         <link linkend="gdouble">gdouble</link> size,
 
51
                                                         <link linkend="GimpSizeType">GimpSizeType</link> size_type,
 
52
                                                         const <link linkend="gchar">gchar</link> *foundry,
 
53
                                                         const <link linkend="gchar">gchar</link> *family,
 
54
                                                         const <link linkend="gchar">gchar</link> *weight,
 
55
                                                         const <link linkend="gchar">gchar</link> *slant,
 
56
                                                         const <link linkend="gchar">gchar</link> *set_width,
 
57
                                                         const <link linkend="gchar">gchar</link> *spacing,
 
58
                                                         const <link linkend="gchar">gchar</link> *registry,
 
59
                                                         const <link linkend="gchar">gchar</link> *encoding);
 
60
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-text-get-extents">gimp_text_get_extents</link>               (const <link linkend="gchar">gchar</link> *text,
 
61
                                                         <link linkend="gdouble">gdouble</link> size,
 
62
                                                         <link linkend="GimpSizeType">GimpSizeType</link> size_type,
 
63
                                                         const <link linkend="gchar">gchar</link> *foundry,
 
64
                                                         const <link linkend="gchar">gchar</link> *family,
 
65
                                                         const <link linkend="gchar">gchar</link> *weight,
 
66
                                                         const <link linkend="gchar">gchar</link> *slant,
 
67
                                                         const <link linkend="gchar">gchar</link> *set_width,
 
68
                                                         const <link linkend="gchar">gchar</link> *spacing,
 
69
                                                         const <link linkend="gchar">gchar</link> *registry,
 
70
                                                         const <link linkend="gchar">gchar</link> *encoding,
 
71
                                                         <link linkend="gint">gint</link> *width,
 
72
                                                         <link linkend="gint">gint</link> *height,
 
73
                                                         <link linkend="gint">gint</link> *ascent,
 
74
                                                         <link linkend="gint">gint</link> *descent);
75
75
</synopsis>
76
76
</refsynopsisdiv>
77
77
 
95
95
<title role="details.title">Details</title>
96
96
<refsect2>
97
97
<title><anchor id="gimp-text-fontname" role="function"/>gimp_text_fontname ()</title>
98
 
<indexterm><primary>gimp_text_fontname</primary></indexterm><programlisting><link linkend="gint32">gint32</link>      gimp_text_fontname              (<link linkend="gint32">gint32</link> image_ID,
99
 
                                             <link linkend="gint32">gint32</link> drawable_ID,
100
 
                                             <link linkend="gdouble">gdouble</link> x,
101
 
                                             <link linkend="gdouble">gdouble</link> y,
102
 
                                             const <link linkend="gchar">gchar</link> *text,
103
 
                                             <link linkend="gint">gint</link> border,
104
 
                                             <link linkend="gboolean">gboolean</link> antialias,
105
 
                                             <link linkend="gdouble">gdouble</link> size,
106
 
                                             <link linkend="GimpSizeType">GimpSizeType</link> size_type,
107
 
                                             const <link linkend="gchar">gchar</link> *fontname);</programlisting>
 
98
<indexterm><primary>gimp_text_fontname</primary></indexterm><programlisting><link linkend="gint32">gint32</link>              gimp_text_fontname                  (<link linkend="gint32">gint32</link> image_ID,
 
99
                                                         <link linkend="gint32">gint32</link> drawable_ID,
 
100
                                                         <link linkend="gdouble">gdouble</link> x,
 
101
                                                         <link linkend="gdouble">gdouble</link> y,
 
102
                                                         const <link linkend="gchar">gchar</link> *text,
 
103
                                                         <link linkend="gint">gint</link> border,
 
104
                                                         <link linkend="gboolean">gboolean</link> antialias,
 
105
                                                         <link linkend="gdouble">gdouble</link> size,
 
106
                                                         <link linkend="GimpSizeType">GimpSizeType</link> size_type,
 
107
                                                         const <link linkend="gchar">gchar</link> *fontname);</programlisting>
108
108
<para>
109
109
Add text at the specified location as a floating selection or a new
110
110
layer.
119
119
floating selection attached to the drawable. If the drawable
120
120
parameter is not valid (-1), the text will appear as a new layer.
121
121
Finally, a border can be specified around the final rendered text.
122
 
The border is measured in pixels.</para>
 
122
The border is measured in pixels. Parameter size-type is not used
 
123
and is currently ignored. If you need to display a font in points,
 
124
divide the size in points by 72.0 and multiply it by the image's
 
125
vertical resolution.</para>
123
126
<para>
124
127
 
125
128
</para><variablelist role="params">
158
161
</variablelist></refsect2>
159
162
<refsect2>
160
163
<title><anchor id="gimp-text-get-extents-fontname" role="function"/>gimp_text_get_extents_fontname ()</title>
161
 
<indexterm><primary>gimp_text_get_extents_fontname</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_text_get_extents_fontname  (const <link linkend="gchar">gchar</link> *text,
162
 
                                             <link linkend="gdouble">gdouble</link> size,
163
 
                                             <link linkend="GimpSizeType">GimpSizeType</link> size_type,
164
 
                                             const <link linkend="gchar">gchar</link> *fontname,
165
 
                                             <link linkend="gint">gint</link> *width,
166
 
                                             <link linkend="gint">gint</link> *height,
167
 
                                             <link linkend="gint">gint</link> *ascent,
168
 
                                             <link linkend="gint">gint</link> *descent);</programlisting>
 
164
<indexterm><primary>gimp_text_get_extents_fontname</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_text_get_extents_fontname      (const <link linkend="gchar">gchar</link> *text,
 
165
                                                         <link linkend="gdouble">gdouble</link> size,
 
166
                                                         <link linkend="GimpSizeType">GimpSizeType</link> size_type,
 
167
                                                         const <link linkend="gchar">gchar</link> *fontname,
 
168
                                                         <link linkend="gint">gint</link> *width,
 
169
                                                         <link linkend="gint">gint</link> *height,
 
170
                                                         <link linkend="gint">gint</link> *ascent,
 
171
                                                         <link linkend="gint">gint</link> *descent);</programlisting>
169
172
<para>
170
173
Get extents of the bounding box for the specified text.
171
174
</para>
172
175
<para>
173
176
This tool returns the width and height of a bounding box for the
174
177
specified text string with the specified font information. Ascent
175
 
and descent for the specified font are returned as well.</para>
 
178
and descent for the specified font are returned as well. Parameter
 
179
size-type is not used and is currently ignored. If you need to
 
180
display a font in points, divide the size in points by 72.0 and
 
181
multiply it by the vertical resolution of the image you are taking
 
182
into account.</para>
176
183
<para>
177
184
 
178
185
</para><variablelist role="params">
205
212
</variablelist></refsect2>
206
213
<refsect2>
207
214
<title><anchor id="gimp-text" role="function" condition="deprecated:"/>gimp_text ()</title>
208
 
<indexterm role="deprecated"><primary>gimp_text</primary></indexterm><programlisting><link linkend="gint32">gint32</link>      gimp_text                       (<link linkend="gint32">gint32</link> image_ID,
209
 
                                             <link linkend="gint32">gint32</link> drawable_ID,
210
 
                                             <link linkend="gdouble">gdouble</link> x,
211
 
                                             <link linkend="gdouble">gdouble</link> y,
212
 
                                             const <link linkend="gchar">gchar</link> *text,
213
 
                                             <link linkend="gint">gint</link> border,
214
 
                                             <link linkend="gboolean">gboolean</link> antialias,
215
 
                                             <link linkend="gdouble">gdouble</link> size,
216
 
                                             <link linkend="GimpSizeType">GimpSizeType</link> size_type,
217
 
                                             const <link linkend="gchar">gchar</link> *foundry,
218
 
                                             const <link linkend="gchar">gchar</link> *family,
219
 
                                             const <link linkend="gchar">gchar</link> *weight,
220
 
                                             const <link linkend="gchar">gchar</link> *slant,
221
 
                                             const <link linkend="gchar">gchar</link> *set_width,
222
 
                                             const <link linkend="gchar">gchar</link> *spacing,
223
 
                                             const <link linkend="gchar">gchar</link> *registry,
224
 
                                             const <link linkend="gchar">gchar</link> *encoding);</programlisting>
 
215
<indexterm role="deprecated"><primary>gimp_text</primary></indexterm><programlisting><link linkend="gint32">gint32</link>              gimp_text                           (<link linkend="gint32">gint32</link> image_ID,
 
216
                                                         <link linkend="gint32">gint32</link> drawable_ID,
 
217
                                                         <link linkend="gdouble">gdouble</link> x,
 
218
                                                         <link linkend="gdouble">gdouble</link> y,
 
219
                                                         const <link linkend="gchar">gchar</link> *text,
 
220
                                                         <link linkend="gint">gint</link> border,
 
221
                                                         <link linkend="gboolean">gboolean</link> antialias,
 
222
                                                         <link linkend="gdouble">gdouble</link> size,
 
223
                                                         <link linkend="GimpSizeType">GimpSizeType</link> size_type,
 
224
                                                         const <link linkend="gchar">gchar</link> *foundry,
 
225
                                                         const <link linkend="gchar">gchar</link> *family,
 
226
                                                         const <link linkend="gchar">gchar</link> *weight,
 
227
                                                         const <link linkend="gchar">gchar</link> *slant,
 
228
                                                         const <link linkend="gchar">gchar</link> *set_width,
 
229
                                                         const <link linkend="gchar">gchar</link> *spacing,
 
230
                                                         const <link linkend="gchar">gchar</link> *registry,
 
231
                                                         const <link linkend="gchar">gchar</link> *encoding);</programlisting>
225
232
<warning><para><literal>gimp_text</literal> is deprecated and should not be used in newly-written code.</para></warning>
226
233
<para>
227
234
This procedure is deprecated! Use <link linkend="gimp-text-fontname"><function>gimp_text_fontname()</function></link> instead.</para>
284
291
</variablelist></refsect2>
285
292
<refsect2>
286
293
<title><anchor id="gimp-text-get-extents" role="function" condition="deprecated:"/>gimp_text_get_extents ()</title>
287
 
<indexterm role="deprecated"><primary>gimp_text_get_extents</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_text_get_extents           (const <link linkend="gchar">gchar</link> *text,
288
 
                                             <link linkend="gdouble">gdouble</link> size,
289
 
                                             <link linkend="GimpSizeType">GimpSizeType</link> size_type,
290
 
                                             const <link linkend="gchar">gchar</link> *foundry,
291
 
                                             const <link linkend="gchar">gchar</link> *family,
292
 
                                             const <link linkend="gchar">gchar</link> *weight,
293
 
                                             const <link linkend="gchar">gchar</link> *slant,
294
 
                                             const <link linkend="gchar">gchar</link> *set_width,
295
 
                                             const <link linkend="gchar">gchar</link> *spacing,
296
 
                                             const <link linkend="gchar">gchar</link> *registry,
297
 
                                             const <link linkend="gchar">gchar</link> *encoding,
298
 
                                             <link linkend="gint">gint</link> *width,
299
 
                                             <link linkend="gint">gint</link> *height,
300
 
                                             <link linkend="gint">gint</link> *ascent,
301
 
                                             <link linkend="gint">gint</link> *descent);</programlisting>
 
294
<indexterm role="deprecated"><primary>gimp_text_get_extents</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_text_get_extents               (const <link linkend="gchar">gchar</link> *text,
 
295
                                                         <link linkend="gdouble">gdouble</link> size,
 
296
                                                         <link linkend="GimpSizeType">GimpSizeType</link> size_type,
 
297
                                                         const <link linkend="gchar">gchar</link> *foundry,
 
298
                                                         const <link linkend="gchar">gchar</link> *family,
 
299
                                                         const <link linkend="gchar">gchar</link> *weight,
 
300
                                                         const <link linkend="gchar">gchar</link> *slant,
 
301
                                                         const <link linkend="gchar">gchar</link> *set_width,
 
302
                                                         const <link linkend="gchar">gchar</link> *spacing,
 
303
                                                         const <link linkend="gchar">gchar</link> *registry,
 
304
                                                         const <link linkend="gchar">gchar</link> *encoding,
 
305
                                                         <link linkend="gint">gint</link> *width,
 
306
                                                         <link linkend="gint">gint</link> *height,
 
307
                                                         <link linkend="gint">gint</link> *ascent,
 
308
                                                         <link linkend="gint">gint</link> *descent);</programlisting>
302
309
<warning><para><literal>gimp_text_get_extents</literal> is deprecated and should not be used in newly-written code.</para></warning>
303
310
<para>
304
311
This procedure is deprecated! Use <link linkend="gimp-text-get-extents-fontname"><function>gimp_text_get_extents_fontname()</function></link>