summaryrefslogtreecommitdiff
path: root/docs/tmpl/main.sgml
blob: 748419c4650b70ad0bc189dfd1efa4f84dd4b081 (plain)
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
<!-- ##### SECTION Title ##### -->
Rendering

<!-- ##### SECTION Short_Description ##### -->
Functions to run the rendering pipeline.

<!-- ##### SECTION Long_Description ##### -->
<para>
The Pango rendering pipeline takes a string of
Unicode characters and converts it into glyphs.
The functions described in this section accomplish
various steps of this process.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION pango_itemize ##### -->
<para>

</para>

@context: 
@text: 
@length: 
@attrs: 
@Returns: 
<!-- # Unused Parameters # -->
@lang_info: 
@n_langs: 


<!-- ##### STRUCT PangoContext ##### -->
<para>
The #PangoContext structure stores global information
used to control the itemization process. It contains
the following fields:

<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>

<row>
<entry>gchar *lang;</entry>
<entry>the global default language in the standard form
       "fr" or "fr_FR". (This may be overriden
       with the @lang_info parameter to pango_itemize().)</entry>
</row>

<row>
<entry>gchar *render_type;</entry>
<entry>a string identifier for the rendering system to use,
       for instance %PANGO_RENDER_TYPE_X</entry>
</row>

</tbody></tgroup></informaltable>
</para>


<!-- ##### STRUCT PangoItem ##### -->
<para>
The #PangoItem structure stores information about
a segment of text. It contains the following fields:

<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>

<row>
<entry>gint offset;</entry>
<entry>the offset of the segment from the beginning of the
       string in bytes.</entry>
</row>

<row>
<entry>gint length;</entry>
<entry>the length of the segment in bytes.</entry>
</row>

<row>
<entry>gint num_chars;</entry>
<entry>the length of the segment in characters.</entry>
</row>

<row>
<entry>gint analysis;</entry>
<entry>the properties of the segment.</entry>
</row>

</tbody></tgroup></informaltable>
</para>

@offset: 
@length: 
@num_chars: 
@analysis: 

<!-- ##### STRUCT PangoAnalysis ##### -->
<para>
The #PangoAnalysis structure stores information about
the properties of a segment of text. It has the following
fields:

<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>

<row>
<entry>#PangoEngineShape *shape_engine;</entry>
<entry>the engine for doing rendering-system-dependent processing</entry>
</row>

<row>
<entry>#PangoEngineLang *lang_engine;</entry>
<entry>the engine for doing rendering-system-independent processing</entry>
</row>

<row>
<entry>guint8 level;</entry>
<entry>the bidrectional level for this segment.</entry>
</row>

</tbody></tgroup></informaltable>
</para>

@shape_engine: 
@lang_engine: 
@font: 
@level: 

<!-- ##### STRUCT PangoLangRange ##### -->
<para>
The #PangoLangRange structure stores language tagging
information for a range of character positions of text. 
It contains the following fields:

<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>

<row>
<entry>gint start;</entry>
<entry>the start position of this tagged range in bytes.</entry>
</row>

<row>
<entry>gint length;</entry>
<entry>the length of this tagged range in bytes.</entry>
</row>

<row>
<entry>gchar *lang;</entry> 
<entry>the language for this range, in the standard form 
       "fr" or "fr_FR".</entry>
</row>

</tbody></tgroup></informaltable>
</para>

@start: 
@length: 
@lang: 

<!-- ##### ENUM PangoDirection ##### -->
<para>

</para>

@PANGO_DIRECTION_LTR: 
@PANGO_DIRECTION_RTL: 
@PANGO_DIRECTION_TTB: 

<!-- ##### FUNCTION pango_reorder_items ##### -->
<para>

</para>

@logical_items: 
@Returns: 


<!-- ##### FUNCTION pango_context_new ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION pango_context_ref ##### -->
<para>

</para>

@context: 


<!-- ##### FUNCTION pango_context_unref ##### -->
<para>

</para>

@context: 


<!-- ##### FUNCTION pango_context_add_font_map ##### -->
<para>

</para>

@context: 
@font_map: 


<!-- ##### FUNCTION pango_context_get_font_description ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_set_font_description ##### -->
<para>

</para>

@context: 
@desc: 


<!-- ##### FUNCTION pango_context_get_base_dir ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_set_base_dir ##### -->
<para>

</para>

@context: 
@direction: 


<!-- ##### FUNCTION pango_context_get_lang ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_set_lang ##### -->
<para>

</para>

@context: 
@lang: 


<!-- ##### FUNCTION pango_context_load_font ##### -->
<para>

</para>

@context: 
@desc: 
@Returns: 
<!-- # Unused Parameters # -->
@size: 


<!-- ##### FUNCTION pango_context_list_families ##### -->
<para>

</para>

@context: 
@families: 
@n_families: 


<!-- ##### FUNCTION pango_context_list_fonts ##### -->
<para>

</para>

@context: 
@family: 
@descs: 
@n_descs: 


<!-- ##### FUNCTION pango_break ##### -->
<para>

</para>

@text: 
@length: 
@analysis: 
@attrs: 


<!-- ##### STRUCT PangoLogAttr ##### -->
<para>
The #PangoLogAttr structure stores information
about the attributes of a single character.
</para>

@is_break: 
@is_white: 
@is_char_stop: 
@is_word_stop: 

<!-- ##### FUNCTION pango_shape ##### -->
<para>

</para>

@text: 
@length: 
@analysis: 
@glyphs: 
<!-- # Unused Parameters # -->
@font: 


<!-- ##### FUNCTION pango_justify ##### -->
<para>

</para>

@glyphs: 
@new_line_width: 
@min_kashida_width: 


<!-- ##### FUNCTION pango_cp_to_x ##### -->
<para>

</para>

@text: 
@length: 
@analysis: 
@glyphs: 
@char_pos: 
@trailing: 
@x_pos: 


<!-- ##### FUNCTION pango_x_to_cp ##### -->
<para>

</para>

@text: 
@length: 
@analysis: 
@glyphs: 
@x_pos: 
@char_pos: 
@trailing: