summaryrefslogtreecommitdiff
path: root/docs/tmpl/main.sgml
blob: ea6c2a7435ff44d4982a1b176db676f1c81271dd (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
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
<!-- ##### 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>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### SECTION Image ##### -->


<!-- ##### STRUCT PangoContext ##### -->
<para>
The #PangoContext structure stores global information
used to control the itemization process. 
</para>


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


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

@shape_engine: the engine for doing rendering-system-dependent processing.
@lang_engine: the engine for doing rendering-system-independent processing.
@font: the font for this segment.
@level: the bidirectional level for this segment.
@gravity: the glyph orientation for this segment (A #PangoGravity).
@flags: boolean flags for this segment (currently only one) (Since: 1.16).
@script: the detected script for this segment (A #PangoScript) (Since: 1.18).
@language: the detected language for this segment.
@extra_attrs: extra attributes for this segment.

<!-- ##### MACRO PANGO_ANALYSIS_FLAG_CENTERED_BASELINE ##### -->
<para>
Whether the segment should be shifted to center around the baseline.
Used in vertical writing directions mostly.

Since: 1.16
</para>



<!-- ##### MACRO PANGO_TYPE_DIRECTION ##### -->
<para>
The #GObject type for #PangoDirection.
</para>



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

</para>

@context: 
@text: 
@start_index: 
@length: 
@attrs: 
@cached_iter: 
@Returns: 


<!-- ##### FUNCTION pango_itemize_with_base_dir ##### -->
<para>

</para>

@context: 
@base_dir: 
@text: 
@start_index: 
@length: 
@attrs: 
@cached_iter: 
@Returns: 


<!-- ##### FUNCTION pango_item_free ##### -->
<para>

</para>

@item: 


<!-- ##### FUNCTION pango_item_copy ##### -->
<para>

</para>

@item: 
@Returns: 


<!-- ##### FUNCTION pango_item_new ##### -->
<para>

</para>

@void: 
@Returns: 


<!-- ##### FUNCTION pango_item_split ##### -->
<para>

</para>

@orig: 
@split_index: 
@split_offset: 
@Returns: 


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

</para>

@logical_items: 
@Returns: 


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

</para>

@void: 
@Returns: 


<!-- ##### FUNCTION pango_context_changed ##### -->
<para>

</para>

@context: 


<!-- ##### FUNCTION pango_context_get_serial ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_set_font_map ##### -->
<para>

</para>

@context: 
@font_map: 


<!-- ##### FUNCTION pango_context_get_font_map ##### -->
<para>

</para>

@context: 
@Returns: 


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

</para>

@context: 
@Returns: 


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

</para>

@context: 
@desc: 


<!-- ##### FUNCTION pango_context_get_language ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_set_language ##### -->
<para>

</para>

@context: 
@language: 


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

</para>

@context: 
@Returns: 


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

</para>

@context: 
@direction: 


<!-- ##### FUNCTION pango_context_get_base_gravity ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_set_base_gravity ##### -->
<para>

</para>

@context: 
@gravity: 


<!-- ##### FUNCTION pango_context_get_gravity ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_get_gravity_hint ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_set_gravity_hint ##### -->
<para>

</para>

@context: 
@hint: 


<!-- ##### FUNCTION pango_context_get_matrix ##### -->
<para>

</para>

@context: 
@Returns: 


<!-- ##### FUNCTION pango_context_set_matrix ##### -->
<para>

</para>

@context: 
@matrix: 


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

</para>

@context: 
@desc: 
@Returns: 


<!-- ##### FUNCTION pango_context_load_fontset ##### -->
<para>

</para>

@context: 
@desc: 
@language: 
@Returns: 


<!-- ##### FUNCTION pango_context_get_metrics ##### -->
<para>

</para>

@context: 
@desc: 
@language: 
@Returns: 


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

</para>

@context: 
@families: 
@n_families: 


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

</para>

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


<!-- ##### FUNCTION pango_get_log_attrs ##### -->
<para>

</para>

@text: 
@length: 
@level: 
@language: 
@log_attrs: 
@attrs_len: 


<!-- ##### FUNCTION pango_find_paragraph_boundary ##### -->
<para>

</para>

@text: 
@length: 
@paragraph_delimiter_index: 
@next_paragraph_start: 


<!-- ##### FUNCTION pango_default_break ##### -->
<para>

</para>

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


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

@is_line_break: if set, can break line in front of character
@is_mandatory_break: if set, must break line in front of character
@is_char_break: if set, can break here when doing character wrapping
@is_white: is whitespace character
@is_cursor_position: if set, cursor can appear in front of character.
	i.e. this is a grapheme boundary, or the first character
        in the text.
	This flag implements Unicode's
	<ulink url="http://www.unicode.org/reports/tr29/">Grapheme
	Cluster Boundaries</ulink> semantics.
@is_word_start: is first character in a word
@is_word_end: is first non-word char after a word
	Note that in degenerate cases, you could have both @is_word_start
	and @is_word_end set for some character.
@is_sentence_boundary: is a sentence boundary.
        There are two ways to divide sentences. The first assigns all
	inter-sentence whitespace/control/format chars to some sentence,
	so all chars are in some sentence; @is_sentence_boundary denotes
	the boundaries there. The second way doesn't assign
	between-sentence spaces, etc. to any sentence, so
	@is_sentence_start/@is_sentence_end mark the boundaries
	of those sentences.
@is_sentence_start: is first character in a sentence
@is_sentence_end: is first char after a sentence.
	Note that in degenerate cases, you could have both @is_sentence_start
	and @is_sentence_end set for some character. (e.g. no space after a
	period, so the next sentence starts right away)
@backspace_deletes_character: if set, backspace deletes one character
                              rather than the entire grapheme cluster. This
                              field is only meaningful on grapheme
                              boundaries (where @is_cursor_position is
                              set).  In some languages, the full grapheme
                              (e.g.  letter + diacritics) is considered a
                              unit, while in others, each decomposed
                              character in the grapheme is a unit. In the
                              default implementation of pango_break(), this
                              bit is set on all grapheme boundaries except
                              those following Latin, Cyrillic or Greek base
                              characters.
@is_expandable_space: is a whitespace character that can possibly be
                      expanded for justification purposes. (Since: 1.18)
@is_word_boundary: is a word boundary.
	More specifically, means that this is not a position in the middle
	of a word.  For example, both sides of a punctuation mark are
	considered word boundaries.  This flag is particularly useful when
	selecting text word-by-word.
	This flag implements Unicode's
	<ulink url="http://www.unicode.org/reports/tr29/">Word
	Boundaries</ulink> semantics.
	(Since: 1.22)

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

</para>

@text: 
@length: 
@analysis: 
@glyphs: 


<!-- ##### FUNCTION pango_shape_full ##### -->
<para>

</para>

@item_text:
@item_length:
@paragraph_text:
@paragraph_length:
@analysis:
@glyphs: