File: libgimp-gimptexttool.html

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (576 lines) | stat: -rw-r--r-- 20,855 bytes parent folder | download | duplicates (2)
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimptexttool</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="prev" href="libgimp-gimpselection.html" title="gimpselection">
<link rel="next" href="libgimp-gimptile.html" title="gimptile">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpselection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimptile.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2533779" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2619181" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimptexttool"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2533779"></a><span class="refentrytitle">gimptexttool</span>
</h2>
<p>gimptexttool &#8212; Functions for controlling the text tool.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">



gint32      <a href="libgimp-gimptexttool.html#gimp-text-fontname">gimp_text_fontname</a>              (gint32 image_ID,
                                             gint32 drawable_ID,
                                             gdouble x,
                                             gdouble y,
                                             const gchar *text,
                                             gint border,
                                             gboolean antialias,
                                             gdouble size,
                                             <a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
                                             const gchar *fontname);
gboolean    <a href="libgimp-gimptexttool.html#gimp-text-get-extents-fontname">gimp_text_get_extents_fontname</a>  (const gchar *text,
                                             gdouble size,
                                             <a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
                                             const gchar *fontname,
                                             gint *width,
                                             gint *height,
                                             gint *ascent,
                                             gint *descent);
gint32      <a href="libgimp-gimptexttool.html#gimp-text">gimp_text</a>                       (gint32 image_ID,
                                             gint32 drawable_ID,
                                             gdouble x,
                                             gdouble y,
                                             const gchar *text,
                                             gint border,
                                             gboolean antialias,
                                             gdouble size,
                                             <a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
                                             const gchar *foundry,
                                             const gchar *family,
                                             const gchar *weight,
                                             const gchar *slant,
                                             const gchar *set_width,
                                             const gchar *spacing,
                                             const gchar *registry,
                                             const gchar *encoding);
gboolean    <a href="libgimp-gimptexttool.html#gimp-text-get-extents">gimp_text_get_extents</a>           (const gchar *text,
                                             gdouble size,
                                             <a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
                                             const gchar *foundry,
                                             const gchar *family,
                                             const gchar *weight,
                                             const gchar *slant,
                                             const gchar *set_width,
                                             const gchar *spacing,
                                             const gchar *registry,
                                             const gchar *encoding,
                                             gint *width,
                                             gint *height,
                                             gint *ascent,
                                             gint *descent);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2619181"></a><h2>Description</h2>
<p>
Functions for controlling the text tool.

</p>
</div>
<div class="refsect1" lang="en">
<a name="id2619196"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2619207"></a><h3>
<a name="gimp-text-fontname"></a>gimp_text_fontname ()</h3>
<a class="indexterm" name="id2619219"></a><pre class="programlisting">gint32      gimp_text_fontname              (gint32 image_ID,
                                             gint32 drawable_ID,
                                             gdouble x,
                                             gdouble y,
                                             const gchar *text,
                                             gint border,
                                             gboolean antialias,
                                             gdouble size,
                                             <a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
                                             const gchar *fontname);</pre>
<p>
Add text at the specified location as a floating selection or a new
layer.
</p>
<p>
This tool requires a fontname matching an installed PangoFT2 font.
You can specify the fontsize in units of pixels or points, and the
appropriate metric is specified using the size_type argument. The x
and y parameters together control the placement of the new text by
specifying the upper left corner of the text bounding box. If the
specified drawable parameter is valid, the text will be created as a
floating selection attached to the drawable. If the drawable
parameter is not valid (-1), the text will appear as a new layer.
Finally, a border can be specified around the final rendered text.
The border is measured in pixels.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
<td> The affected drawable: (-1 for a new text layer).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td> The x coordinate for the left of the text bounding box.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td> The y coordinate for the top of the text bounding box.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>text</code></em>&#160;:</span></td>
<td> The text to generate (in UTF-8 encoding).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>border</code></em>&#160;:</span></td>
<td> The size of the border.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>antialias</code></em>&#160;:</span></td>
<td> Antialiasing.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> The size of text in either pixels or points.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size_type</code></em>&#160;:</span></td>
<td> The units of specified size.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fontname</code></em>&#160;:</span></td>
<td> The name of the font.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The new text layer or -1 if no layer was created.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604246"></a><h3>
<a name="gimp-text-get-extents-fontname"></a>gimp_text_get_extents_fontname ()</h3>
<a class="indexterm" name="id2604257"></a><pre class="programlisting">gboolean    gimp_text_get_extents_fontname  (const gchar *text,
                                             gdouble size,
                                             <a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
                                             const gchar *fontname,
                                             gint *width,
                                             gint *height,
                                             gint *ascent,
                                             gint *descent);</pre>
<p>
Get extents of the bounding box for the specified text.
</p>
<p>
This tool returns the width and height of a bounding box for the
specified text string with the specified font information. Ascent
and descent for the specified font are returned as well.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>text</code></em>&#160;:</span></td>
<td> The text to generate (in UTF-8 encoding).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> The size of text in either pixels or points.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size_type</code></em>&#160;:</span></td>
<td> The units of specified size.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>fontname</code></em>&#160;:</span></td>
<td> The name of the font.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The width of the specified font.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The height of the specified font.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ascent</code></em>&#160;:</span></td>
<td> The ascent of the specified font.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>descent</code></em>&#160;:</span></td>
<td> The descent of the specified font.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604470"></a><h3>
<a name="gimp-text"></a>gimp_text ()</h3>
<a class="indexterm" name="id2604485"></a><pre class="programlisting">gint32      gimp_text                       (gint32 image_ID,
                                             gint32 drawable_ID,
                                             gdouble x,
                                             gdouble y,
                                             const gchar *text,
                                             gint border,
                                             gboolean antialias,
                                             gdouble size,
                                             <a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
                                             const gchar *foundry,
                                             const gchar *family,
                                             const gchar *weight,
                                             const gchar *slant,
                                             const gchar *set_width,
                                             const gchar *spacing,
                                             const gchar *registry,
                                             const gchar *encoding);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_text</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimptexttool.html#gimp-text-fontname"><code class="function">gimp_text_fontname()</code></a> instead.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
<td> The affected drawable: (-1 for a new text layer).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td> The x coordinate for the left of the text bounding box.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td> The y coordinate for the top of the text bounding box.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>text</code></em>&#160;:</span></td>
<td> The text to generate (in UTF-8 encoding).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>border</code></em>&#160;:</span></td>
<td> The size of the border.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>antialias</code></em>&#160;:</span></td>
<td> Antialiasing.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> The size of text in either pixels or points.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size_type</code></em>&#160;:</span></td>
<td> The units of specified size.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>foundry</code></em>&#160;:</span></td>
<td> The font foundry.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>family</code></em>&#160;:</span></td>
<td> The font family.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>weight</code></em>&#160;:</span></td>
<td> The font weight.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>slant</code></em>&#160;:</span></td>
<td> The font slant.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>set_width</code></em>&#160;:</span></td>
<td> The font set-width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The font spacing.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>registry</code></em>&#160;:</span></td>
<td> The font registry.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>encoding</code></em>&#160;:</span></td>
<td> The font encoding.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The new text layer or -1 if no layer was created.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2626352"></a><h3>
<a name="gimp-text-get-extents"></a>gimp_text_get_extents ()</h3>
<a class="indexterm" name="id2626364"></a><pre class="programlisting">gboolean    gimp_text_get_extents           (const gchar *text,
                                             gdouble size,
                                             <a href="libgimp-gimpenums.html#GimpSizeType">GimpSizeType</a> size_type,
                                             const gchar *foundry,
                                             const gchar *family,
                                             const gchar *weight,
                                             const gchar *slant,
                                             const gchar *set_width,
                                             const gchar *spacing,
                                             const gchar *registry,
                                             const gchar *encoding,
                                             gint *width,
                                             gint *height,
                                             gint *ascent,
                                             gint *descent);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_text_get_extents</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimptexttool.html#gimp-text-get-extents-fontname"><code class="function">gimp_text_get_extents_fontname()</code></a>
instead.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>text</code></em>&#160;:</span></td>
<td> The text to generate (in UTF-8 encoding).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> The size of text in either pixels or points.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size_type</code></em>&#160;:</span></td>
<td> The units of specified size.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>foundry</code></em>&#160;:</span></td>
<td> The font foundry.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>family</code></em>&#160;:</span></td>
<td> The font family.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>weight</code></em>&#160;:</span></td>
<td> The font weight.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>slant</code></em>&#160;:</span></td>
<td> The font slant.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>set_width</code></em>&#160;:</span></td>
<td> The font set-width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The font spacing.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>registry</code></em>&#160;:</span></td>
<td> The font registry.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>encoding</code></em>&#160;:</span></td>
<td> The font encoding.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The width of the specified font.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The height of the specified font.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ascent</code></em>&#160;:</span></td>
<td> The ascent of the specified font.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>descent</code></em>&#160;:</span></td>
<td> The descent of the specified font.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>