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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gnomeprintglyphlist">
<refnamediv>
<refname>gnomeprint.Glyphlist</refname>
<refpurpose>Glyphlist object for GnomePrint</refpurpose>
</refnamediv>
<!-- ************************************* -->
<!-- BEGIN OF GNOMEPRINTGLYPHLIST SYNOPSIS -->
<!-- ************************************* -->
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gnomeprint.Glyphlist</classname></ooclass>
<ooclass><classname><link linkend="class-gobjectgboxed">gobject.GBoxed</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gnomeprintglyphlist">gnomeprint.Glyphlist</link></methodname>
<methodparam><parameter role="keyword"></parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--advance">advance</link></methodname>
<methodparam><parameter role="keyword">advance</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--bbox">bbox</link></methodname>
<methodparam><parameter role="keyword">transform</parameter></methodparam>
<methodparam><parameter role="keyword">flags</parameter></methodparam>
<methodparam><parameter role="keyword">bbox</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--color">color</link></methodname>
<methodparam><parameter role="keyword">color</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--duplicate">duplicate</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--font">font</link></methodname>
<methodparam><parameter role="keyword">font</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--glyph">glyph</link></methodname>
<methodparam><parameter role="keyword">glyph</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--glyphs">glyphs</link></methodname>
<methodparam><parameter role="keyword">glyphs</parameter></methodparam>
<methodparam><parameter role="keyword">num_glyps</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--kerning">kerning</link></methodname>
<methodparam><parameter role="keyword">kerning</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--letterspace">letterspace</link></methodname>
<methodparam><parameter role="keyword">letterspace</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--moveto">moveto</link></methodname>
<methodparam><parameter role="keyword">x</parameter></methodparam>
<methodparam><parameter role="keyword">y</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--rmoveto">rmoveto</link></methodname>
<methodparam><parameter role="keyword">x</parameter></methodparam>
<methodparam><parameter role="keyword">y</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gnomeprintglyphlist--text-dumb">text_dumb</link></methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-gnomeprint--glyphlist-from-text-dumb">gnomeprint.glyphlist_from_text_dumb</link></methodname>
<methodparam><parameter role="keyword">font</parameter></methodparam>
<methodparam><parameter role="keyword">color</parameter></methodparam>
<methodparam><parameter role="keyword">kerning</parameter></methodparam>
<methodparam><parameter role="keyword">letterspace</parameter></methodparam>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<!-- ************************************* -->
<!-- BEGIN OF GNOMEPRINTGLYPHLIST ANCESTRY -->
<!-- ************************************* -->
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobjectgboxed">gobject.GBoxed</link>
+-- <link linkend="class-gnomeprintglyphlist">gnomeprint.Glyphlist</link>
</synopsis>
</refsect1>
<!-- **************************************** -->
<!-- BEGIN OF GNOMEPRINTGLYPHLIST DESCRIPTION -->
<!-- **************************************** -->
<refsect1 id="description-gnomeprintglyphlist">
<title>Description</title>
<para>
</para>
</refsect1>
<!-- **************************************** -->
<!-- BEGIN OF GNOMEPRINTGLYPHLIST CONSTRUCTOR -->
<!-- **************************************** -->
<refsect1 id="constructor-gnomeprintglyphlist">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gnomeprint.Glyphlist</methodname>
<methodparam><parameter role="keyword"></parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link linkend="class-gnomeprintglyphlist"><classname>gnomeprint.Glyphlist</classname></link>.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new <link linkend="class-gnomeprintglyphlist"><classname>gnomeprint.Glyphlist</classname></link> object.
</para>
</refsect1>
<!-- ************************************ -->
<!-- BEGIN OF GNOMEPRINTGLYPHLIST METHODS -->
<!-- ************************************ -->
<refsect1>
<title>Methods</title>
<refsect2 id="method-gnomeprintglyphlist--advance">
<title>gnomeprint.Glyphlist.advance</title>
<programlisting><methodsynopsis language="python">
<methodname>advance</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">advance</parameter> :</term>
<listitem><simpara> if <literal>TRUE</literal> move the pen position, <literal>FALSE</literal> otherwise.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>advance</methodname>() method decide whether or not to move the pen position by the font standard advance vector.
Advancing happens immediately after glyph is sent through pipeline.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--bbox">
<title>gnomeprint.Glyphlist.bbox</title>
<programlisting><methodsynopsis language="python">
<methodname>bbox</methodname>
<methodparam><parameter role="keyword">transform</parameter></methodparam>
<methodparam><parameter role="keyword">flags</parameter></methodparam>
<methodparam><parameter role="keyword">bbox</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">transform</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">flags</parameter> :</term>
<listitem><simpara> should be 0 for now.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">bbox</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> bbox or <literal>None</literal> on error.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>bbox</methodname>() method gets ink dimensions of transformed glyphlist Flags are to specify user preferences,
should be 0 for now.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--color">
<title>gnomeprint.Glyphlist.color</title>
<programlisting><methodsynopsis language="python">
<methodname>color</methodname>
<methodparam><parameter role="keyword">color</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">color</parameter> :</term>
<listitem><simpara> the color in the form RRGGBBAA.</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>color</methodname>() method specify the color as RRGGBBAA to be used for the glyphs that follow.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--duplicate">
<title>gnomeprint.Glyphlist.duplicate</title>
<programlisting><methodsynopsis language="python">
<methodname>duplicate</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>duplicate</methodname>() method
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--font">
<title>gnomeprint.Glyphlist.font</title>
<programlisting><methodsynopsis language="python">
<methodname>font</methodname>
<methodparam><parameter role="keyword">font</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">font</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>font</methodname>() method specify the font to be used for the glyphs that follow.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--glyph">
<title>gnomeprint.Glyphlist.glyph</title>
<programlisting><methodsynopsis language="python">
<methodname>glyph</methodname>
<methodparam><parameter role="keyword">glyph</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">glyph</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>glyph</methodname>() method appends a single glyph to the glyphlist.
It will be connected to the previous glyphs by the previously defined rules.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--glyphs">
<title>gnomeprint.Glyphlist.glyphs</title>
<programlisting><methodsynopsis language="python">
<methodname>glyphs</methodname>
<methodparam><parameter role="keyword">glyphs</parameter></methodparam>
<methodparam><parameter role="keyword">num_glyps</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">glyps</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">val</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>gluphs</methodname>() method append a string of glyphs.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--kerning">
<title>gnomeprint.Glyphlist.kerning</title>
<programlisting><methodsynopsis language="python">
<methodname>kerning</methodname>
<methodparam><parameter role="keyword">kerning</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">kerning</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>kerning</methodname>() method sets the amount of kerning to add between glyphs connected by an advance rule.
It is specified as fraction of a full kerning value If a glyph is manually positioned,
the kerning value is ignored Kerning will be added immediately before placing a new glyph.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--letterspace">
<title>gnomeprint.Glyphlist.letterspace</title>
<programlisting><methodsynopsis language="python">
<methodname>letterspace</methodname>
<methodparam><parameter role="keyword">letterspace</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">letterspace</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>letterspace</methodname>() method sets the amount of white space to add between glyphs connected by an advance rule.
It is specified in font units (i.e. 12 for 12pt font is the width of an em square).
If glyph is manually positioned, letterspace value will be ignored.
Letterspace will be added immediately before placing a new glyph
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--moveto">
<title>gnomeprint.Glyphlist.moveto</title>
<programlisting><methodsynopsis language="python">
<methodname>moveto</methodname>
<methodparam><parameter role="keyword">x</parameter></methodparam>
<methodparam><parameter role="keyword">y</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">x</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">y</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>moveto</methodname>() method position manually the glyph following.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--rmoveto">
<title>gnomeprint.Glyphlist.rmoveto</title>
<programlisting><methodsynopsis language="python">
<methodname>rmoveto</methodname>
<methodparam><parameter role="keyword">x</parameter></methodparam>
<methodparam><parameter role="keyword">y</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">x</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">y</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>rmoveto</methodname>() method position the glyph following relative to current pen position.
</para>
</refsect2>
<refsect2 id="method-gnomeprintglyphlist--text-dumb">
<title>gnomeprint.Glyphlist.text_dumb</title>
<programlisting><methodsynopsis language="python">
<methodname>text_dumb</methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>text_dumb</methodname>() method
</para>
</refsect2>
</refsect1>
<!-- ************************************** -->
<!-- BEGIN OF GNOMEPRINTGLYPHLIST FUNCTIONS -->
<!-- ************************************** -->
<refsect1>
<title>Functions</title>
<refsect2 id="function-gnomeprint--glyphlist-from-text-dumb">
<title>gnomeprint.glyphlist_from_text_dumb</title>
<programlisting><methodsynopsis language="python">
<methodname>gnomeprint.glyphlist_from_text_dumb</methodname>
<methodparam><parameter role="keyword">font</parameter></methodparam>
<methodparam><parameter role="keyword">color</parameter></methodparam>
<methodparam><parameter role="keyword">kerning</parameter></methodparam>
<methodparam><parameter role="keyword">letterspace</parameter></methodparam>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">font</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">color</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">kerning</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">letterspace</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> </simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>glyphlist_from_text_dumb</methodname>() function appends utf8 text, converting it to glyphs and
connecting it as specified by rules. You cannot expect anything about language-specific typesetting rules,
so if the given script does not use trivial placement, you should better avoid this.
</para>
</refsect2>
</refsect1>
</refentry>
|
