« back to all changes in this revision
Viewing changes to pango/Pango-1.0.gir
- browse files at revision 84
- compare with another revision
- download diff
- download tarball
- view history from revision 84
- Committer: Bazaar Package Importer
- Author(s): Josselin Mouette
- Date: 2010-10-19 23:37:45 UTC
- mfrom: (1.5.12 upstream)
- Revision ID: james.westby@ubuntu.com-20101019233745-xey8xlf91rpkth51
Tags: 1.28.3-1
* New upstream stable release.
+ Fixes SIGFPE in opentype renderer. Closes: #598166.
+ Fixes SIGFPE in opentype renderer. Closes: #598166.
- files added:
- docs/html/pango-pango-renderer.html
- files removed:
- docs/html/PangoRenderer.html
- files modified:
- ChangeLog
added
removed
pango/Pango-1.0.gir
2
2
<!-- This file was automatically generated from C sources - DO NOT EDIT!
3
3
To affect the contents of this file, edit the original C definitions,
4
4
and/or use gtk-doc annotations. -->
5
<repository version="1.0"
5
<repository version="1.2"
6
6
xmlns="http://www.gtk.org/introspection/core/1.0"
7
7
xmlns:c="http://www.gtk.org/introspection/c/1.0"
8
8
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
15
15
<namespace name="Pango"
16
16
version="1.0"
17
17
shared-library="libpango-1.0.so.0"
18
c:prefix="Pango">
19
<alias name="Glyph" target="uint32" c:type="PangoGlyph"/>
20
<alias name="GlyphUnit" target="int32" c:type="PangoGlyphUnit"/>
21
<alias name="LayoutRun" target="GlyphItem" c:type="PangoLayoutRun"/>
18
c:identifier-prefixes="Pango"
19
c:symbol-prefixes="pango">
20
<alias name="Glyph" c:type="PangoGlyph">
21
<type name="guint32" c:type="guint32"/>
22
</alias>
23
<alias name="GlyphUnit" c:type="PangoGlyphUnit">
24
<type name="gint32" c:type="gint32"/>
25
</alias>
26
<alias name="LayoutRun" c:type="PangoLayoutRun">
27
<type name="GlyphItem" c:type="PangoGlyphItem"/>
28
</alias>
22
29
<constant name="ANALYSIS_FLAG_CENTERED_BASELINE" value="1">
23
<type name="int"/>
30
<type name="gint" c:type="gint"/>
24
31
</constant>
25
32
<constant name="ATTR_INDEX_FROM_TEXT_BEGINNING" value="0">
26
<type name="int"/>
33
<type name="gint" c:type="gint"/>
27
34
</constant>
28
35
<enumeration name="Alignment"
29
36
glib:type-name="PangoAlignment"
53
60
<type name="Font" c:type="PangoFont*"/>
54
61
</field>
55
62
<field name="level" writable="1">
56
<type name="uint8" c:type="guint8"/>
63
<type name="guint8" c:type="guint8"/>
57
64
</field>
58
65
<field name="gravity" writable="1">
59
<type name="uint8" c:type="guint8"/>
66
<type name="guint8" c:type="guint8"/>
60
67
</field>
61
68
<field name="flags" writable="1">
62
<type name="uint8" c:type="guint8"/>
69
<type name="guint8" c:type="guint8"/>
63
70
</field>
64
71
<field name="script" writable="1">
65
<type name="uint8" c:type="guint8"/>
72
<type name="guint8" c:type="guint8"/>
66
73
</field>
67
74
<field name="language" writable="1">
68
75
<type name="Language" c:type="PangoLanguage*"/>
69
76
</field>
70
77
<field name="extra_attrs" writable="1">
71
<type name="GLib.SList" c:type="GSList*"/>
78
<type name="GLib.SList" c:type="GSList*">
79
<type name="gpointer" c:type="gpointer"/>
80
</type>
72
81
</field>
73
82
</record>
74
83
<record name="AttrClass" c:type="PangoAttrClass">
75
84
<field name="type" writable="1">
76
85
<type name="AttrType" c:type="PangoAttrType"/>
77
86
</field>
78
<field name="copy">
79
<type name="any" c:type="pointer"/>
87
<field name="copy" introspectable="0">
88
<callback name="copy" introspectable="0">
89
<return-value>
90
<type name="Attribute" c:type="PangoAttribute*"/>
91
</return-value>
92
<parameters>
93
<parameter name="attr" transfer-ownership="none">
94
<type name="Attribute" c:type="PangoAttribute*"/>
95
</parameter>
96
</parameters>
97
</callback>
80
98
</field>
81
99
<field name="destroy">
82
<type name="any" c:type="pointer"/>
100
<callback name="destroy">
101
<return-value transfer-ownership="none">
102
<type name="none" c:type="void"/>
103
</return-value>
104
<parameters>
105
<parameter name="attr" transfer-ownership="none">
106
<type name="Attribute" c:type="PangoAttribute*"/>
107
</parameter>
108
</parameters>
109
</callback>
83
110
</field>
84
111
<field name="equal">
85
<type name="any" c:type="pointer"/>
112
<callback name="equal">
113
<return-value transfer-ownership="none">
114
<type name="gboolean" c:type="gboolean"/>
115
</return-value>
116
<parameters>
117
<parameter name="attr1" transfer-ownership="none">
118
<type name="Attribute" c:type="PangoAttribute*"/>
119
</parameter>
120
<parameter name="attr2" transfer-ownership="none">
121
<type name="Attribute" c:type="PangoAttribute*"/>
122
</parameter>
123
</parameters>
124
</callback>
86
125
</field>
87
126
</record>
88
127
<record name="AttrColor" c:type="PangoAttrColor">
93
132
<type name="Color" c:type="PangoColor"/>
94
133
</field>
95
134
</record>
96
<callback name="AttrDataCopyFunc" c:type="PangoAttrDataCopyFunc">
97
<return-value transfer-ownership="none">
98
<type name="any" c:type="gpointer"/>
135
<callback name="AttrDataCopyFunc"
136
c:type="PangoAttrDataCopyFunc"
137
introspectable="0">
138
<return-value>
139
<type name="gpointer" c:type="gpointer"/>
99
140
</return-value>
100
141
<parameters>
101
142
<parameter name="data" transfer-ownership="none">
102
<type name="any" c:type="gconstpointer"/>
143
<type name="gpointer" c:type="gconstpointer"/>
103
144
</parameter>
104
145
</parameters>
105
146
</callback>
106
147
<callback name="AttrFilterFunc" c:type="PangoAttrFilterFunc">
107
148
<return-value transfer-ownership="none">
108
<type name="boolean" c:type="gboolean"/>
149
<type name="gboolean" c:type="gboolean"/>
109
150
</return-value>
110
151
<parameters>
111
152
<parameter name="attribute" transfer-ownership="none">
112
153
<type name="Attribute" c:type="PangoAttribute*"/>
113
154
</parameter>
114
155
<parameter name="data" transfer-ownership="none">
115
<type name="any" c:type="gpointer"/>
156
<type name="gpointer" c:type="gpointer"/>
116
157
</parameter>
117
158
</parameters>
118
159
</callback>
121
162
<type name="Attribute" c:type="PangoAttribute"/>
122
163
</field>
123
164
<field name="value" writable="1">
124
<type name="double" c:type="double"/>
165
<type name="gdouble" c:type="double"/>
125
166
</field>
126
167
</record>
127
168
<record name="AttrFontDesc" c:type="PangoAttrFontDesc">
131
172
<field name="desc" writable="1">
132
173
<type name="FontDescription" c:type="PangoFontDescription*"/>
133
174
</field>
134
<constructor name="new"
135
c:identifier="pango_attr_font_desc_new"
136
doc="Create a new font description attribute. This attribute
137
allows setting family, style, weight, variant, stretch,
138
and size simultaneously.
139
freed with pango_attribute_destroy().">
140
<return-value transfer-ownership="full">
141
<type name="AttrFontDesc" c:type="PangoAttribute*"/>
142
</return-value>
143
<parameters>
144
<parameter name="desc" transfer-ownership="none">
145
<type name="FontDescription" c:type="PangoFontDescription*"/>
146
</parameter>
147
</parameters>
148
</constructor>
149
175
</record>
150
176
<record name="AttrInt" c:type="PangoAttrInt">
151
177
<field name="attr" writable="1">
152
178
<type name="Attribute" c:type="PangoAttribute"/>
153
179
</field>
154
180
<field name="value" writable="1">
155
<type name="int" c:type="int"/>
181
<type name="gint" c:type="int"/>
156
182
</field>
157
183
</record>
158
<record name="AttrIterator" c:type="PangoAttrIterator">
159
<method name="range"
160
c:identifier="pango_attr_iterator_range"
161
doc="Get the range of the current segment. Note that the
162
stored return values are signed, not unsigned like
163
the values in #PangoAttribute. To deal with this API
164
oversight, stored return values that wouldn't fit into
165
a signed integer are clamped to %G_MAXINT.">
166
<return-value transfer-ownership="none">
167
<type name="none" c:type="void"/>
168
</return-value>
169
<parameters>
170
<parameter name="start" direction="out" transfer-ownership="full">
171
<type name="int" c:type="gint*"/>
172
</parameter>
173
<parameter name="end" direction="out" transfer-ownership="full">
174
<type name="int" c:type="gint*"/>
175
</parameter>
176
</parameters>
177
</method>
178
<method name="next"
179
c:identifier="pango_attr_iterator_next"
180
doc="Advance the iterator until the next change of style.">
181
<return-value transfer-ownership="none">
182
<type name="boolean" c:type="gboolean"/>
183
</return-value>
184
</method>
184
<record name="AttrIterator" c:type="PangoAttrIterator" disguised="1">
185
185
<method name="copy"
186
186
c:identifier="pango_attr_iterator_copy"
187
doc="Copy a #PangoAttrIterator
188
be freed with pango_attr_iterator_destroy().">
189
<return-value transfer-ownership="full">
187
introspectable="0">
188
<doc xml:whitespace="preserve">Copy a #PangoAttrIterator
189
be freed with pango_attr_iterator_destroy().</doc>
190
<return-value>
191
<doc xml:whitespace="preserve">the newly allocated #PangoAttrIterator, which should</doc>
190
192
<type name="AttrIterator" c:type="PangoAttrIterator*"/>
191
193
</return-value>
192
194
</method>
193
<method name="destroy"
194
c:identifier="pango_attr_iterator_destroy"
195
doc="Destroy a #PangoAttrIterator and free all associated memory.">
195
<method name="destroy" c:identifier="pango_attr_iterator_destroy">
196
<doc xml:whitespace="preserve">Destroy a #PangoAttrIterator and free all associated memory.</doc>
196
197
<return-value transfer-ownership="none">
197
198
<type name="none" c:type="void"/>
198
199
</return-value>
199
200
</method>
200
201
<method name="get"
201
202
c:identifier="pango_attr_iterator_get"
202
doc="Find the current attribute of a particular type at the iterator
203
introspectable="0">
204
<doc xml:whitespace="preserve">Find the current attribute of a particular type at the iterator
203
205
location. When multiple attributes of the same type overlap,
204
206
the attribute whose range starts closest to the current location
205
207
is used.
206
208
if no attribute of that type applies to the current
207
location.">
208
<return-value transfer-ownership="full">
209
location.</doc>
210
<return-value>
211
<doc xml:whitespace="preserve">the current attribute of the given type, or %NULL</doc>
209
212
<type name="Attribute" c:type="PangoAttribute*"/>
210
213
</return-value>
211
214
<parameters>
212
215
<parameter name="type" transfer-ownership="none">
216
<doc xml:whitespace="preserve">the type of attribute to find.</doc>
213
217
<type name="AttrType" c:type="PangoAttrType"/>
214
218
</parameter>
215
219
</parameters>
216
220
</method>
217
<method name="get_font"
218
c:identifier="pango_attr_iterator_get_font"
219
doc="The family name in this structure will be set using
220
pango_font_description_set_family_static() using values from
221
an attribute in the #PangoAttrList associated with the iterator,
222
so if you plan to keep it around, you must call:
223
<literal>pango_font_description_set_family (desc, pango_font_description_get_family (desc))</literal>.
224
if none is found.
225
location in which to store a list of non-font
226
attributes at the the current position; only the highest priority
227
value of each attribute will be added to this list. In order
228
to free this value, you must call pango_attribute_destroy() on
229
each member.
230
Get the font and other attributes at the current iterator position.">
231
<return-value transfer-ownership="none">
232
<type name="none" c:type="void"/>
233
</return-value>
234
<parameters>
235
<parameter name="desc" transfer-ownership="none">
236
<type name="FontDescription" c:type="PangoFontDescription*"/>
237
</parameter>
238
<parameter name="language" transfer-ownership="none">
239
<type name="Language" c:type="PangoLanguage**"/>
240
</parameter>
241
<parameter name="extra_attrs"
242
transfer-ownership="full"
243
doc="if non-%NULL,">
244
<type name="GLib.SList" c:type="GSList**"/>
245
</parameter>
246
</parameters>
247
</method>
248
221
<method name="get_attrs"
249
222
c:identifier="pango_attr_iterator_get_attrs"
250
doc="Gets a list of all attributes at the current position of the
223
version="1.2"
224
introspectable="0">
225
<doc xml:whitespace="preserve">Gets a list of all attributes at the current position of the
251
226
iterator.
252
227
all attributes for the current range.
253
228
To free this value, call pango_attribute_destroy() on
254
each value and g_slist_free() on the list."
255
version="1.2">
256
<return-value transfer-ownership="full" doc="a list of">
229
each value and g_slist_free() on the list.</doc>
230
<return-value>
231
<doc xml:whitespace="preserve">(transfer full): a list of</doc>
257
232
<type name="GLib.SList" c:type="GSList*">
258
<type name="Pango.Attribute"/>
233
<type name="Attribute"/>
259
234
</type>
260
235
</return-value>
261
236
</method>
237
<method name="get_font" c:identifier="pango_attr_iterator_get_font">
238
<doc xml:whitespace="preserve">Get the font and other attributes at the current iterator position.</doc>
239
<return-value transfer-ownership="none">
240
<type name="none" c:type="void"/>
241
</return-value>
242
<parameters>
243
<parameter name="desc" transfer-ownership="none">
244
<doc xml:whitespace="preserve">a #PangoFontDescription to fill in with the current values. The family name in this structure will be set using pango_font_description_set_family_static() using values from an attribute in the #PangoAttrList associated with the iterator, so if you plan to keep it around, you must call: <literal>pango_font_description_set_family (desc, pango_font_description_get_family (desc))</literal>.</doc>
245
<type name="FontDescription" c:type="PangoFontDescription*"/>
246
</parameter>
247
<parameter name="language" transfer-ownership="none">
248
<doc xml:whitespace="preserve">if non-%NULL, location to store language tag for item, or %NULL if none is found.</doc>
249
<type name="Language" c:type="PangoLanguage**"/>
250
</parameter>
251
<parameter name="extra_attrs" transfer-ownership="none">
252
<doc xml:whitespace="preserve">(transfer full): if non-%NULL, location in which to store a list of non-font attributes at the the current position; only the highest priority value of each attribute will be added to this list. In order to free this value, you must call pango_attribute_destroy() on each member.</doc>
253
<type name="GLib.SList" c:type="GSList**">
254
<type name="gpointer" c:type="gpointer"/>
255
</type>
256
</parameter>
257
</parameters>
258
</method>
259
<method name="next" c:identifier="pango_attr_iterator_next">
260
<doc xml:whitespace="preserve">Advance the iterator until the next change of style.</doc>
261
<return-value transfer-ownership="none">
262
<doc xml:whitespace="preserve">%FALSE if the iterator is at the end of the list, otherwise %TRUE</doc>
263
<type name="gboolean" c:type="gboolean"/>
264
</return-value>
265
</method>
266
<method name="range" c:identifier="pango_attr_iterator_range">
267
<doc xml:whitespace="preserve">Get the range of the current segment. Note that the
268
stored return values are signed, not unsigned like
269
the values in #PangoAttribute. To deal with this API
270
oversight, stored return values that wouldn't fit into
271
a signed integer are clamped to %G_MAXINT.</doc>
272
<return-value transfer-ownership="none">
273
<type name="none" c:type="void"/>
274
</return-value>
275
<parameters>
276
<parameter name="start" transfer-ownership="none">
277
<doc xml:whitespace="preserve">location to store the start of the range</doc>
278
<type name="gint" c:type="gint*"/>
279
</parameter>
280
<parameter name="end" transfer-ownership="none">
281
<doc xml:whitespace="preserve">location to store the end of the range</doc>
282
<type name="gint" c:type="gint*"/>
283
</parameter>
284
</parameters>
285
</method>
262
286
</record>
263
287
<record name="AttrLanguage" c:type="PangoAttrLanguage">
264
288
<field name="attr" writable="1">
267
291
<field name="value" writable="1">
268
292
<type name="Language" c:type="PangoLanguage*"/>
269
293
</field>
270
<constructor name="new"
271
c:identifier="pango_attr_language_new"
272
doc="Create a new language tag attribute.
273
freed with pango_attribute_destroy().">
274
<return-value transfer-ownership="full">
275
<type name="AttrLanguage" c:type="PangoAttribute*"/>
276
</return-value>
277
<parameters>
278
<parameter name="language" transfer-ownership="none">
279
<type name="Language" c:type="PangoLanguage*"/>
280
</parameter>
281
</parameters>
282
</constructor>
283
294
</record>
284
295
<record name="AttrList"
285
296
c:type="PangoAttrList"
286
297
glib:type-name="PangoAttrList"
287
glib:get-type="pango_attr_list_get_type">
288
<constructor name="new"
289
c:identifier="pango_attr_list_new"
290
doc="Create a new empty attribute list with a reference count of one.
291
be freed with pango_attr_list_unref().">
298
glib:get-type="pango_attr_list_get_type"
299
c:symbol-prefix="attr_list">
300
<constructor name="new" c:identifier="pango_attr_list_new">
301
<doc xml:whitespace="preserve">Create a new empty attribute list with a reference count of one.
302
be freed with pango_attr_list_unref().</doc>
292
303
<return-value transfer-ownership="full">
304
<doc xml:whitespace="preserve">the newly allocated #PangoAttrList, which should</doc>
293
305
<type name="AttrList" c:type="PangoAttrList*"/>
294
306
</return-value>
295
307
</constructor>
296
<method name="ref"
297
c:identifier="pango_attr_list_ref"
298
doc="Increase the reference count of the given attribute list by one."
299
version="1.10">
300
<return-value transfer-ownership="full">
301
<type name="AttrList" c:type="PangoAttrList*"/>
302
</return-value>
303
</method>
304
<method name="unref"
305
c:identifier="pango_attr_list_unref"
306
doc="Decrease the reference count of the given attribute list by one.
307
If the result is zero, free the attribute list and the attributes
308
it contains.">
309
<return-value transfer-ownership="none">
310
<type name="none" c:type="void"/>
311
</return-value>
312
</method>
313
<method name="copy"
314
c:identifier="pango_attr_list_copy"
315
doc="Copy @list and return an identical new list.
316
reference count of one, which should
317
be freed with pango_attr_list_unref().
318
Returns %NULL if @list was %NULL.">
319
<return-value transfer-ownership="full">
320
<type name="AttrList" c:type="PangoAttrList*"/>
321
</return-value>
322
</method>
323
<method name="insert"
324
c:identifier="pango_attr_list_insert"
325
doc="assumed by the list.
326
Insert the given attribute into the #PangoAttrList. It will
327
be inserted after all other attributes with a matching">
328
<return-value transfer-ownership="none">
329
<type name="none" c:type="void"/>
330
</return-value>
331
<parameters>
332
<parameter name="attr" transfer-ownership="none">
333
<type name="Attribute" c:type="PangoAttribute*"/>
334
</parameter>
335
</parameters>
336
</method>
337
<method name="insert_before"
338
c:identifier="pango_attr_list_insert_before"
339
doc="assumed by the list.
340
Insert the given attribute into the #PangoAttrList. It will
341
be inserted before all other attributes with a matching">
342
<return-value transfer-ownership="none">
343
<type name="none" c:type="void"/>
344
</return-value>
345
<parameters>
346
<parameter name="attr" transfer-ownership="none">
347
<type name="Attribute" c:type="PangoAttribute*"/>
348
</parameter>
349
</parameters>
350
</method>
351
<method name="change"
352
c:identifier="pango_attr_list_change"
353
doc="assumed by the list.
354
Insert the given attribute into the #PangoAttrList. It will
308
<method name="change" c:identifier="pango_attr_list_change">
309
<doc xml:whitespace="preserve">Insert the given attribute into the #PangoAttrList. It will
355
310
replace any attributes of the same type on that segment
356
311
and be merged with any adjoining attributes that are identical.
357
312
This function is slower than pango_attr_list_insert() for
358
313
creating a attribute list in order (potentially much slower
359
314
for large lists). However, pango_attr_list_insert() is not
360
315
suitable for continually changing a set of attributes
361
since it never removes or combines existing attributes.">
362
<return-value transfer-ownership="none">
363
<type name="none" c:type="void"/>
364
</return-value>
365
<parameters>
366
<parameter name="attr" transfer-ownership="none">
367
<type name="Attribute" c:type="PangoAttribute*"/>
368
</parameter>
369
</parameters>
370
</method>
371
<method name="splice"
372
c:identifier="pango_attr_list_splice"
373
doc="must be specified since the attributes in @other
374
may only be present at some subsection of this range)
375
This function opens up a hole in @list, fills it in with attributes from
316
since it never removes or combines existing attributes.</doc>
317
<return-value transfer-ownership="none">
318
<type name="none" c:type="void"/>
319
</return-value>
320
<parameters>
321
<parameter name="attr" transfer-ownership="none">
322
<doc xml:whitespace="preserve">the attribute to insert. Ownership of this value is assumed by the list.</doc>
323
<type name="Attribute" c:type="PangoAttribute*"/>
324
</parameter>
325
</parameters>
326
</method>
327
<method name="copy" c:identifier="pango_attr_list_copy">
328
<doc xml:whitespace="preserve">Copy @list and return an identical new list.
329
reference count of one, which should
330
be freed with pango_attr_list_unref().
331
Returns %NULL if @list was %NULL.</doc>
332
<return-value transfer-ownership="full">
333
<doc xml:whitespace="preserve">the newly allocated #PangoAttrList, with a</doc>
334
<type name="AttrList" c:type="PangoAttrList*"/>
335
</return-value>
336
</method>
337
<method name="filter"
338
c:identifier="pango_attr_list_filter"
339
version="1.2"
340
introspectable="0">
341
<doc xml:whitespace="preserve">Given a #PangoAttrList and callback function, removes any elements
342
of @list for which @func returns %TRUE and inserts them into
343
a new list.
344
no attributes of the given types were found.</doc>
345
<return-value transfer-ownership="full">
346
<doc xml:whitespace="preserve">the new #PangoAttrList or %NULL if</doc>
347
<type name="AttrList" c:type="PangoAttrList*"/>
348
</return-value>
349
<parameters>
350
<parameter name="func" transfer-ownership="none" closure="1">
351
<doc xml:whitespace="preserve">callback function; returns %TRUE if an attribute should be filtered out.</doc>
352
<type name="AttrFilterFunc" c:type="PangoAttrFilterFunc"/>
353
</parameter>
354
<parameter name="data" transfer-ownership="none">
355
<doc xml:whitespace="preserve">Data to be passed to @func</doc>
356
<type name="gpointer" c:type="gpointer"/>
357
</parameter>
358
</parameters>
359
</method>
360
<method name="get_iterator"
361
c:identifier="pango_attr_list_get_iterator"
362
introspectable="0">
363
<doc xml:whitespace="preserve">Create a iterator initialized to the beginning of the list.
364
be freed with pango_attr_iterator_destroy().</doc>
365
<return-value>
366
<doc xml:whitespace="preserve">the newly allocated #PangoAttrIterator, which should</doc>
367
<type name="AttrIterator" c:type="PangoAttrIterator*"/>
368
</return-value>
369
</method>
370
<method name="insert" c:identifier="pango_attr_list_insert">
371
<doc xml:whitespace="preserve">Insert the given attribute into the #PangoAttrList. It will
372
be inserted after all other attributes with a matching</doc>
373
<return-value transfer-ownership="none">
374
<type name="none" c:type="void"/>
375
</return-value>
376
<parameters>
377
<parameter name="attr" transfer-ownership="none">
378
<doc xml:whitespace="preserve">the attribute to insert. Ownership of this value is assumed by the list.</doc>
379
<type name="Attribute" c:type="PangoAttribute*"/>
380
</parameter>
381
</parameters>
382
</method>
383
<method name="insert_before"
384
c:identifier="pango_attr_list_insert_before">
385
<doc xml:whitespace="preserve">Insert the given attribute into the #PangoAttrList. It will
386
be inserted before all other attributes with a matching</doc>
387
<return-value transfer-ownership="none">
388
<type name="none" c:type="void"/>
389
</return-value>
390
<parameters>
391
<parameter name="attr" transfer-ownership="none">
392
<doc xml:whitespace="preserve">the attribute to insert. Ownership of this value is assumed by the list.</doc>
393
<type name="Attribute" c:type="PangoAttribute*"/>
394
</parameter>
395
</parameters>
396
</method>
397
<method name="ref" c:identifier="pango_attr_list_ref" version="1.10">
398
<doc xml:whitespace="preserve">Increase the reference count of the given attribute list by one.</doc>
399
<return-value transfer-ownership="full">
400
<doc xml:whitespace="preserve">The attribute list passed in</doc>
401
<type name="AttrList" c:type="PangoAttrList*"/>
402
</return-value>
403
</method>
404
<method name="splice" c:identifier="pango_attr_list_splice">
405
<doc xml:whitespace="preserve">This function opens up a hole in @list, fills it in with attributes from
376
406
the left, and then merges @other on top of the hole.
377
407
This operation is equivalent to stretching every attribute
378
408
that applies at position @pos in @list by an amount @len,
379
409
and then calling pango_attr_list_change() with a copy
380
410
of each attribute in @other in sequence (offset in position by @pos).
381
411
This operation proves useful for, for instance, inserting
382
a pre-edit string in the middle of an edit buffer.">
412
a pre-edit string in the middle of an edit buffer.</doc>
383
413
<return-value transfer-ownership="none">
384
414
<type name="none" c:type="void"/>
385
415
</return-value>
386
416
<parameters>
387
417
<parameter name="other" transfer-ownership="none">
418
<doc xml:whitespace="preserve">another #PangoAttrList</doc>
388
419
<type name="AttrList" c:type="PangoAttrList*"/>
389
420
</parameter>
390
421
<parameter name="pos" transfer-ownership="none">
391
<type name="int" c:type="gint"/>
422
<doc xml:whitespace="preserve">the position in @list at which to insert @other</doc>
423
<type name="gint" c:type="gint"/>
392
424
</parameter>
393
425
<parameter name="len" transfer-ownership="none">
394
<type name="int" c:type="gint"/>
395
</parameter>
396
</parameters>
397
</method>
398
<method name="filter"
399
c:identifier="pango_attr_list_filter"
400
doc="should be filtered out.
401
Given a #PangoAttrList and callback function, removes any elements
402
of @list for which @func returns %TRUE and inserts them into
403
a new list.
404
no attributes of the given types were found."
405
version="1.2">
406
<return-value transfer-ownership="full">
407
<type name="AttrList" c:type="PangoAttrList*"/>
408
</return-value>
409
<parameters>
410
<parameter name="func"
411
transfer-ownership="none"
412
scope="call"
413
closure="2">
414
<type name="AttrFilterFunc" c:type="PangoAttrFilterFunc"/>
415
</parameter>
416
<parameter name="data" transfer-ownership="none">
417
<type name="any" c:type="gpointer"/>
418
</parameter>
419
</parameters>
420
</method>
421
<method name="get_iterator"
422
c:identifier="pango_attr_list_get_iterator"
423
doc="Create a iterator initialized to the beginning of the list.
424
be freed with pango_attr_iterator_destroy().">
425
<return-value transfer-ownership="full">
426
<type name="AttrIterator" c:type="PangoAttrIterator*"/>
426
<doc xml:whitespace="preserve">the length of the spliced segment. (Note that this must be specified since the attributes in @other may only be present at some subsection of this range)</doc>
427
<type name="gint" c:type="gint"/>
428
</parameter>
429
</parameters>
430
</method>
431
<method name="unref" c:identifier="pango_attr_list_unref">
432
<doc xml:whitespace="preserve">Decrease the reference count of the given attribute list by one.
433
If the result is zero, free the attribute list and the attributes
434
it contains.</doc>
435
<return-value transfer-ownership="none">
436
<type name="none" c:type="void"/>
427
437
</return-value>
428
438
</method>
429
439
</record>
438
448
<type name="Rectangle" c:type="PangoRectangle"/>
439
449
</field>
440
450
<field name="data" writable="1">
441
<type name="any" c:type="gpointer"/>
451
<type name="gpointer" c:type="gpointer"/>
442
452
</field>
443
<field name="copy_func" writable="1">
453
<field name="copy_func" introspectable="0" writable="1">
444
454
<type name="AttrDataCopyFunc" c:type="PangoAttrDataCopyFunc"/>
445
455
</field>
446
456
<field name="destroy_func" writable="1">
447
457
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
448
458
</field>
449
<constructor name="new"
450
c:identifier="pango_attr_shape_new"
451
doc="Create a new shape attribute. A shape is used to impose a
452
particular ink and logical rectangle on the result of shaping a
453
particular glyph. This might be used, for instance, for
454
embedding a picture or a widget inside a #PangoLayout.
455
freed with pango_attribute_destroy().">
456
<return-value transfer-ownership="full">
457
<type name="AttrShape" c:type="PangoAttribute*"/>
458
</return-value>
459
<parameters>
460
<parameter name="ink_rect" transfer-ownership="none">
461
<type name="Rectangle" c:type="PangoRectangle*"/>
462
</parameter>
463
<parameter name="logical_rect" transfer-ownership="none">
464
<type name="Rectangle" c:type="PangoRectangle*"/>
465
</parameter>
466
</parameters>
467
</constructor>
468
<constructor name="new_with_data"
469
c:identifier="pango_attr_shape_new_with_data"
470
doc="is copied. If %NULL, @data is simply copied
471
as a pointer.
472
is freed, or %NULL
473
Like pango_attr_shape_new(), but a user data pointer is also
474
provided; this pointer can be accessed when later
475
rendering the glyph.
476
freed with pango_attribute_destroy()."
477
version="1.8">
478
<return-value transfer-ownership="full">
479
<type name="AttrShape" c:type="PangoAttribute*"/>
480
</return-value>
481
<parameters>
482
<parameter name="ink_rect" transfer-ownership="none">
483
<type name="Rectangle" c:type="PangoRectangle*"/>
484
</parameter>
485
<parameter name="logical_rect" transfer-ownership="none">
486
<type name="Rectangle" c:type="PangoRectangle*"/>
487
</parameter>
488
<parameter name="data" transfer-ownership="none">
489
<type name="any" c:type="gpointer"/>
490
</parameter>
491
<parameter name="copy_func"
492
transfer-ownership="none"
493
scope="call"
494
destroy="4">
495
<type name="AttrDataCopyFunc" c:type="PangoAttrDataCopyFunc"/>
496
</parameter>
497
<parameter name="destroy_func"
498
transfer-ownership="none"
499
scope="call">
500
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
501
</parameter>
502
</parameters>
503
</constructor>
504
459
</record>
505
460
<record name="AttrSize" c:type="PangoAttrSize">
506
461
<field name="attr" writable="1">
507
462
<type name="Attribute" c:type="PangoAttribute"/>
508
463
</field>
509
464
<field name="size" writable="1">
510
<type name="int" c:type="int"/>
465
<type name="gint" c:type="int"/>
511
466
</field>
512
467
<field name="absolute" writable="1" bits="1">
513
<type name="uint" c:type="guint"/>
468
<type name="guint" c:type="guint"/>
514
469
</field>
515
<constructor name="new"
516
c:identifier="pango_attr_size_new"
517
doc="Create a new font-size attribute in fractional points.
518
freed with pango_attribute_destroy().">
519
<return-value transfer-ownership="full">
520
<type name="AttrSize" c:type="PangoAttribute*"/>
521
</return-value>
522
<parameters>
523
<parameter name="size" transfer-ownership="none">
524
<type name="int" c:type="int"/>
525
</parameter>
526
</parameters>
527
</constructor>
528
<constructor name="new_absolute"
529
c:identifier="pango_attr_size_new_absolute"
530
doc="Create a new font-size attribute in device units.
531
freed with pango_attribute_destroy()."
532
version="1.8">
533
<return-value transfer-ownership="full">
534
<type name="AttrSize" c:type="PangoAttribute*"/>
535
</return-value>
536
<parameters>
537
<parameter name="size" transfer-ownership="none">
538
<type name="int" c:type="int"/>
539
</parameter>
540
</parameters>
541
</constructor>
542
470
</record>
543
471
<record name="AttrString" c:type="PangoAttrString">
544
472
<field name="attr" writable="1">
650
578
<type name="AttrClass" c:type="PangoAttrClass*"/>
651
579
</field>
652
580
<field name="start_index" writable="1">
653
<type name="uint" c:type="guint"/>
581
<type name="guint" c:type="guint"/>
654
582
</field>
655
583
<field name="end_index" writable="1">
656
<type name="uint" c:type="guint"/>
584
<type name="guint" c:type="guint"/>
657
585
</field>
658
<method name="init"
659
c:identifier="pango_attribute_init"
660
doc="Initializes @attr's klass to @klass,
661
it's start_index to %PANGO_ATTR_INDEX_FROM_TEXT_BEGINNING
586
<method name="copy"
587
c:identifier="pango_attribute_copy"
588
introspectable="0">
589
<doc xml:whitespace="preserve">Make a copy of an attribute.
590
freed with pango_attribute_destroy().</doc>
591
<return-value>
592
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
593
<type name="Attribute" c:type="PangoAttribute*"/>
594
</return-value>
595
</method>
596
<method name="destroy" c:identifier="pango_attribute_destroy">
597
<doc xml:whitespace="preserve">Destroy a #PangoAttribute and free all associated memory.</doc>
598
<return-value transfer-ownership="none">
599
<type name="none" c:type="void"/>
600
</return-value>
601
</method>
602
<method name="equal" c:identifier="pango_attribute_equal">
603
<doc xml:whitespace="preserve">Compare two attributes for equality. This compares only the
604
actual value of the two attributes and not the ranges that the
605
attributes apply to.</doc>
606
<return-value transfer-ownership="none">
607
<doc xml:whitespace="preserve">%TRUE if the two attributes have the same value.</doc>
608
<type name="gboolean" c:type="gboolean"/>
609
</return-value>
610
<parameters>
611
<parameter name="attr2" transfer-ownership="none">
612
<doc xml:whitespace="preserve">another #PangoAttribute</doc>
613
<type name="Attribute" c:type="PangoAttribute*"/>
614
</parameter>
615
</parameters>
616
</method>
617
<method name="init" c:identifier="pango_attribute_init" version="1.20">
618
<doc xml:whitespace="preserve">Initializes @attr's klass to @klass,
619
it's start_index to %PANGO_ATTR_INDEX_FROM_TEXT_BEGINNING
662
620
and end_index to %PANGO_ATTR_INDEX_TO_TEXT_END
663
621
such that the attribute applies
664
to the entire text by default."
665
version="1.20">
622
to the entire text by default.</doc>
666
623
<return-value transfer-ownership="none">
667
624
<type name="none" c:type="void"/>
668
625
</return-value>
669
626
<parameters>
670
627
<parameter name="klass" transfer-ownership="none">
628
<doc xml:whitespace="preserve">a #PangoAttributeClass</doc>
671
629
<type name="AttrClass" c:type="PangoAttrClass*"/>
672
630
</parameter>
673
631
</parameters>
674
632
</method>
675
<method name="copy"
676
c:identifier="pango_attribute_copy"
677
doc="Make a copy of an attribute.
678
freed with pango_attribute_destroy().">
679
<return-value transfer-ownership="full">
680
<type name="Attribute" c:type="PangoAttribute*"/>
681
</return-value>
682
</method>
683
<method name="destroy"
684
c:identifier="pango_attribute_destroy"
685
doc="Destroy a #PangoAttribute and free all associated memory.">
686
<return-value transfer-ownership="none">
687
<type name="none" c:type="void"/>
688
</return-value>
689
</method>
690
<method name="equal"
691
c:identifier="pango_attribute_equal"
692
doc="Compare two attributes for equality. This compares only the
693
actual value of the two attributes and not the ranges that the
694
attributes apply to.">
695
<return-value transfer-ownership="none">
696
<type name="boolean" c:type="gboolean"/>
697
</return-value>
698
<parameters>
699
<parameter name="attr2" transfer-ownership="none">
700
<type name="Attribute" c:type="PangoAttribute*"/>
701
</parameter>
702
</parameters>
703
</method>
704
633
</record>
705
634
<enumeration name="BidiType"
706
doc="The #PangoBidiType type represents the bidirectional character
707
type of a Unicode character as specified by the
708
<ulink url="http://www.unicode.org/reports/tr9/">Unicode bidirectional algorithm</ulink>."
709
635
version="1.22"
710
636
glib:type-name="PangoBidiType"
711
637
glib:get-type="pango_bidi_type_get_type"
712
638
c:type="PangoBidiType">
639
<doc xml:whitespace="preserve">The #PangoBidiType type represents the bidirectional character
640
type of a Unicode character as specified by the
641
<ulink url="http://www.unicode.org/reports/tr9/">Unicode bidirectional algorithm</ulink>.</doc>
713
642
<member name="l"
714
643
value="0"
715
644
c:identifier="PANGO_BIDI_TYPE_L"
790
719
<record name="Color"
791
720
c:type="PangoColor"
792
721
glib:type-name="PangoColor"
793
glib:get-type="pango_color_get_type">
722
glib:get-type="pango_color_get_type"
723
c:symbol-prefix="color">
794
724
<field name="red" writable="1">
795
<type name="uint16" c:type="guint16"/>
725
<type name="guint16" c:type="guint16"/>
796
726
</field>
797
727
<field name="green" writable="1">
798
<type name="uint16" c:type="guint16"/>
728
<type name="guint16" c:type="guint16"/>
799
729
</field>
800
730
<field name="blue" writable="1">
801
<type name="uint16" c:type="guint16"/>
731
<type name="guint16" c:type="guint16"/>
802
732
</field>
803
<method name="copy"
804
c:identifier="pango_color_copy"
805
doc="Creates a copy of @src, which should be freed with
733
<method name="copy" c:identifier="pango_color_copy">
734
<doc xml:whitespace="preserve">Creates a copy of @src, which should be freed with
806
735
pango_color_free(). Primarily used by language bindings,
807
736
not that useful otherwise (since colors can just be copied
808
737
by assignment in C).
809
738
be freed with pango_color_free(), or %NULL
810
if @src was %NULL.">
739
if @src was %NULL.</doc>
811
740
<return-value transfer-ownership="full">
741
<doc xml:whitespace="preserve">the newly allocated #PangoColor, which should</doc>
812
742
<type name="Color" c:type="PangoColor*"/>
813
743
</return-value>
814
744
</method>
815
<method name="free"
816
c:identifier="pango_color_free"
817
doc="Frees a color allocated by pango_color_copy().">
745
<method name="free" c:identifier="pango_color_free">
746
<doc xml:whitespace="preserve">Frees a color allocated by pango_color_copy().</doc>
818
747
<return-value transfer-ownership="none">
819
748
<type name="none" c:type="void"/>
820
749
</return-value>
821
750
</method>
822
<method name="parse"
823
c:identifier="pango_color_parse"
824
doc="Fill in the fields of a color from a string specification. The
751
<method name="parse" c:identifier="pango_color_parse">
752
<doc xml:whitespace="preserve">Fill in the fields of a color from a string specification. The
825
753
string can either one of a large set of standard names. (Taken
826
754
from the X11 <filename>rgb.txt</filename> file), or it can be a hex value in the
827
form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where
828
'r', 'g' and 'b' are hex digits of the red, green, and blue
755
form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where
756
'r', 'g' and 'b' are hex digits of the red, green, and blue
829
757
components of the color, respectively. (White in the four
830
forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and '&num;ffffffffffff')
831
otherwise false.">
758
forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and '&num;ffffffffffff')
759
otherwise false.</doc>
832
760
<return-value transfer-ownership="none">
833
<type name="boolean" c:type="gboolean"/>
761
<doc xml:whitespace="preserve">%TRUE if parsing of the specifier succeeded,</doc>
762
<type name="gboolean" c:type="gboolean"/>
834
763
</return-value>
835
764
<parameters>
836
765
<parameter name="spec" transfer-ownership="none">
766
<doc xml:whitespace="preserve">a string specifying the new color</doc>
837
767
<type name="utf8" c:type="char*"/>
838
768
</parameter>
839
769
</parameters>
840
770
</method>
841
771
<method name="to_string"
842
772
c:identifier="pango_color_to_string"
843
doc="Returns a textual specification of @color in the hexadecimal form
773
version="1.16">
774
<doc xml:whitespace="preserve">Returns a textual specification of @color in the hexadecimal form
844
775
<literal>&num;rrrrggggbbbb</literal>, where <literal>r</literal>,
845
776
<literal>g</literal> and <literal>b</literal> are hex digits representing
846
the red, green, and blue components respectively."
847
version="1.16">
777
the red, green, and blue components respectively.</doc>
848
778
<return-value transfer-ownership="full">
779
<doc xml:whitespace="preserve">a newly-allocated text string that must be freed with g_free().</doc>
849
780
<type name="utf8" c:type="gchar*"/>
850
781
</return-value>
851
782
</method>
852
783
</record>
853
784
<class name="Context"
785
c:symbol-prefix="context"
854
786
c:type="PangoContext"
855
787
parent="GObject.Object"
856
788
glib:type-name="PangoContext"
857
789
glib:get-type="pango_context_get_type"
858
790
glib:type-struct="ContextClass">
859
<constructor name="new"
860
c:identifier="pango_context_new"
861
doc="Creates a new #PangoContext initialized to default values.
791
<constructor name="new" c:identifier="pango_context_new">
792
<doc xml:whitespace="preserve">Creates a new #PangoContext initialized to default values.
862
793
This function is not particularly useful as it should always
863
794
be followed by a pango_context_set_font_map() call, and the
864
795
function pango_font_map_create_context() does these two steps
865
796
together and hence users are recommended to use that.
866
797
If you are using Pango as part of a higher-level system,
867
that system may have it's own way of create a #PangoContext.
798
that system may have it's own way of create a #PangoContext.
868
799
For instance, the GTK+ toolkit has, among others,
869
800
gdk_pango_context_get_for_screen(), and
870
801
gtk_widget_get_pango_context(). Use those instead.
871
be freed with g_object_unref().">
802
be freed with g_object_unref().</doc>
872
803
<return-value transfer-ownership="full">
804
<doc xml:whitespace="preserve">the newly allocated #PangoContext, which should</doc>
873
805
<type name="Context" c:type="PangoContext*"/>
874
806
</return-value>
875
807
</constructor>
876
<method name="set_font_map"
877
c:identifier="pango_context_set_font_map"
878
doc="Sets the font map to be searched when fonts are looked-up in this context.
879
This is only for internal use by Pango backends, a #PangoContext obtained
880
via one of the recommended methods should already have a suitable font map.">
881
<return-value transfer-ownership="none">
882
<type name="none" c:type="void"/>
883
</return-value>
884
<parameters>
885
<parameter name="font_map" transfer-ownership="none">
886
<type name="FontMap" c:type="PangoFontMap*"/>
887
</parameter>
888
</parameters>
808
<method name="get_base_dir" c:identifier="pango_context_get_base_dir">
809
<doc xml:whitespace="preserve">Retrieves the base direction for the context. See
810
pango_context_set_base_dir().</doc>
811
<return-value transfer-ownership="none">
812
<doc xml:whitespace="preserve">the base direction for the context.</doc>
813
<type name="Direction" c:type="PangoDirection"/>
814
</return-value>
815
</method>
816
<method name="get_base_gravity"
817
c:identifier="pango_context_get_base_gravity"
818
version="1.16">
819
<doc xml:whitespace="preserve">Retrieves the base gravity for the context. See
820
pango_context_set_base_gravity().</doc>
821
<return-value transfer-ownership="none">
822
<doc xml:whitespace="preserve">the base gravity for the context.</doc>
823
<type name="Gravity" c:type="PangoGravity"/>
824
</return-value>
825
</method>
826
<method name="get_font_description"
827
c:identifier="pango_context_get_font_description">
828
<doc xml:whitespace="preserve">Retrieve the default font description for the context.
829
This value must not be modified or freed.</doc>
830
<return-value transfer-ownership="full">
831
<doc xml:whitespace="preserve">a pointer to the context's default font description.</doc>
832
<type name="FontDescription" c:type="PangoFontDescription*"/>
833
</return-value>
889
834
</method>
890
835
<method name="get_font_map"
891
836
c:identifier="pango_context_get_font_map"
892
doc="Gets the #PangoFontmap used to look up fonts for this context.
893
is owned by Pango and should not be unreferenced."
837
version="1.6"
838
introspectable="0">
839
<doc xml:whitespace="preserve">Gets the #PangoFontmap used to look up fonts for this context.
840
is owned by Pango and should not be unreferenced.</doc>
841
<return-value>
842
<doc xml:whitespace="preserve">the font map for the #PangoContext. This value</doc>
843
<type name="FontMap" c:type="PangoFontMap*"/>
844
</return-value>
845
</method>
846
<method name="get_gravity"
847
c:identifier="pango_context_get_gravity"
848
version="1.16">
849
<doc xml:whitespace="preserve">Retrieves the gravity for the context. This is similar to
850
pango_context_get_base_gravity(), except for when the base gravity
851
is %PANGO_GRAVITY_AUTO for which pango_gravity_get_for_matrix() is used
852
to return the gravity from the current context matrix.</doc>
853
<return-value transfer-ownership="none">
854
<doc xml:whitespace="preserve">the resolved gravity for the context.</doc>
855
<type name="Gravity" c:type="PangoGravity"/>
856
</return-value>
857
</method>
858
<method name="get_gravity_hint"
859
c:identifier="pango_context_get_gravity_hint"
860
version="1.16">
861
<doc xml:whitespace="preserve">Retrieves the gravity hint for the context. See
862
pango_context_set_gravity_hint() for details.</doc>
863
<return-value transfer-ownership="none">
864
<doc xml:whitespace="preserve">the gravity hint for the context.</doc>
865
<type name="GravityHint" c:type="PangoGravityHint"/>
866
</return-value>
867
</method>
868
<method name="get_language" c:identifier="pango_context_get_language">
869
<doc xml:whitespace="preserve">Retrieves the global language tag for the context.</doc>
870
<return-value transfer-ownership="full">
871
<doc xml:whitespace="preserve">the global language tag.</doc>
872
<type name="Language" c:type="PangoLanguage*"/>
873
</return-value>
874
</method>
875
<method name="get_matrix"
876
c:identifier="pango_context_get_matrix"
894
877
version="1.6">
895
<return-value transfer-ownership="full">
896
<type name="FontMap" c:type="PangoFontMap*"/>
897
</return-value>
898
</method>
899
<method name="list_families"
900
c:identifier="pango_context_list_families"
901
doc="This array should be freed with g_free().
902
List all families for a context.">
878
<doc xml:whitespace="preserve">Gets the transformation matrix that will be applied when
879
rendering with this context. See pango_context_set_matrix().
880
(which is the same as the identity matrix). The returned
881
matrix is owned by Pango and must not be modified or
882
freed.</doc>
903
883
<return-value transfer-ownership="none">
904
<type name="none" c:type="void"/>
905
</return-value>
906
<parameters>
907
<parameter name="families" transfer-ownership="none">
908
<type name="FontFamily" c:type="PangoFontFamily***"/>
909
</parameter>
910
<parameter name="n_families"
911
direction="out"
912
transfer-ownership="full">
913
<type name="int" c:type="int*"/>
914
</parameter>
915
</parameters>
916
</method>
917
<method name="load_font"
918
c:identifier="pango_context_load_font"
919
doc="Loads the font in one of the fontmaps in the context
920
that is the closest match for @desc.">
921
<return-value transfer-ownership="full">
922
<type name="Font" c:type="PangoFont*"/>
923
</return-value>
924
<parameters>
925
<parameter name="desc" transfer-ownership="none">
926
<type name="FontDescription" c:type="PangoFontDescription*"/>
927
</parameter>
928
</parameters>
929
</method>
930
<method name="load_fontset"
931
c:identifier="pango_context_load_fontset"
932
doc="Load a set of fonts in the context that can be used to render
933
a font matching @desc.">
934
<return-value transfer-ownership="full">
935
<type name="Fontset" c:type="PangoFontset*"/>
936
</return-value>
937
<parameters>
938
<parameter name="desc" transfer-ownership="none">
939
<type name="FontDescription" c:type="PangoFontDescription*"/>
940
</parameter>
941
<parameter name="language" transfer-ownership="none">
942
<type name="Language" c:type="PangoLanguage*"/>
943
</parameter>
944
</parameters>
945
</method>
946
<method name="get_metrics"
947
c:identifier="pango_context_get_metrics"
948
doc="description from the context will be used.
949
for. %NULL means that the language tag from the context will
950
be used. If no language tag is set on the context, metrics
951
for the default language (as determined by
952
pango_language_get_default()) will be returned.
953
Get overall metric information for a particular font
884
<doc xml:whitespace="preserve">the matrix, or %NULL if no matrix has been set</doc>
885
<type name="Matrix" c:type="PangoMatrix*"/>
886
</return-value>
887
</method>
888
<method name="get_metrics" c:identifier="pango_context_get_metrics">
889
<doc xml:whitespace="preserve">Get overall metric information for a particular font
954
890
description. Since the metrics may be substantially different for
955
891
different scripts, a language tag can be provided to indicate that
956
892
the metrics should be retrieved that correspond to the script(s)
961
897
would be used to render the string, then the returned fonts would
962
898
be a composite of the metrics for the fonts loaded for the
963
899
individual families.
964
when finished using the object.">
900
when finished using the object.</doc>
965
901
<return-value transfer-ownership="full">
902
<doc xml:whitespace="preserve">a #PangoFontMetrics object. The caller must call pango_font_metrics_unref()</doc>
966
903
<type name="FontMetrics" c:type="PangoFontMetrics*"/>
967
904
</return-value>
968
905
<parameters>
969
906
<parameter name="desc" transfer-ownership="none">
970
<type name="FontDescription" c:type="PangoFontDescription*"/>
971
</parameter>
972
<parameter name="language" transfer-ownership="none">
973
<type name="Language" c:type="PangoLanguage*"/>
974
</parameter>
975
</parameters>
976
</method>
977
<method name="set_font_description"
978
c:identifier="pango_context_set_font_description"
979
doc="Set the default font description for the context">
980
<return-value transfer-ownership="none">
981
<type name="none" c:type="void"/>
982
</return-value>
983
<parameters>
984
<parameter name="desc" transfer-ownership="none">
985
<type name="FontDescription" c:type="PangoFontDescription*"/>
986
</parameter>
987
</parameters>
988
</method>
989
<method name="get_font_description"
990
c:identifier="pango_context_get_font_description"
991
doc="Retrieve the default font description for the context.
992
This value must not be modified or freed.">
993
<return-value transfer-ownership="full">
994
<type name="FontDescription" c:type="PangoFontDescription*"/>
995
</return-value>
996
</method>
997
<method name="get_language"
998
c:identifier="pango_context_get_language"
999
doc="Retrieves the global language tag for the context.">
1000
<return-value transfer-ownership="full">
1001
<type name="Language" c:type="PangoLanguage*"/>
1002
</return-value>
1003
</method>
1004
<method name="set_language"
1005
c:identifier="pango_context_set_language"
1006
doc="Sets the global language tag for the context. The default language
1007
for the locale of the running process can be found using
1008
pango_language_get_default().">
1009
<return-value transfer-ownership="none">
1010
<type name="none" c:type="void"/>
1011
</return-value>
1012
<parameters>
1013
<parameter name="language" transfer-ownership="none">
1014
<type name="Language" c:type="PangoLanguage*"/>
1015
</parameter>
1016
</parameters>
1017
</method>
1018
<method name="set_base_dir"
1019
c:identifier="pango_context_set_base_dir"
1020
doc="Sets the base direction for the context.
907
<doc xml:whitespace="preserve">a #PangoFontDescription structure. %NULL means that the font description from the context will be used.</doc>
908
<type name="FontDescription" c:type="PangoFontDescription*"/>
909
</parameter>
910
<parameter name="language" transfer-ownership="none">
911
<doc xml:whitespace="preserve">language tag used to determine which script to get the metrics for. %NULL means that the language tag from the context will be used. If no language tag is set on the context, metrics for the default language (as determined by pango_language_get_default()) will be returned.</doc>
912
<type name="Language" c:type="PangoLanguage*"/>
913
</parameter>
914
</parameters>
915
</method>
916
<method name="list_families" c:identifier="pango_context_list_families">
917
<doc xml:whitespace="preserve">List all families for a context.</doc>
918
<return-value transfer-ownership="none">
919
<type name="none" c:type="void"/>
920
</return-value>
921
<parameters>
922
<parameter name="families" transfer-ownership="none">
923
<doc xml:whitespace="preserve">location to store a pointer to an array of #PangoFontFamily *. This array should be freed with g_free().</doc>
924
<type name="FontFamily" c:type="PangoFontFamily***"/>
925
</parameter>
926
<parameter name="n_families" transfer-ownership="none">
927
<doc xml:whitespace="preserve">location to store the number of elements in @descs</doc>
928
<type name="gint" c:type="int*"/>
929
</parameter>
930
</parameters>
931
</method>
932
<method name="load_font"
933
c:identifier="pango_context_load_font"
934
introspectable="0">
935
<doc xml:whitespace="preserve">Loads the font in one of the fontmaps in the context
936
that is the closest match for @desc.</doc>
937
<return-value>
938
<doc xml:whitespace="preserve">the font loaded, or %NULL if no font matched.</doc>
939
<type name="Font" c:type="PangoFont*"/>
940
</return-value>
941
<parameters>
942
<parameter name="desc" transfer-ownership="none">
943
<doc xml:whitespace="preserve">a #PangoFontDescription describing the font to load</doc>
944
<type name="FontDescription" c:type="PangoFontDescription*"/>
945
</parameter>
946
</parameters>
947
</method>
948
<method name="load_fontset"
949
c:identifier="pango_context_load_fontset"
950
introspectable="0">
951
<doc xml:whitespace="preserve">Load a set of fonts in the context that can be used to render
952
a font matching @desc.</doc>
953
<return-value>
954
<doc xml:whitespace="preserve">the fontset, or %NULL if no font matched.</doc>
955
<type name="Fontset" c:type="PangoFontset*"/>
956
</return-value>
957
<parameters>
958
<parameter name="desc" transfer-ownership="none">
959
<doc xml:whitespace="preserve">a #PangoFontDescription describing the fonts to load</doc>
960
<type name="FontDescription" c:type="PangoFontDescription*"/>
961
</parameter>
962
<parameter name="language" transfer-ownership="none">
963
<doc xml:whitespace="preserve">a #PangoLanguage the fonts will be used for</doc>
964
<type name="Language" c:type="PangoLanguage*"/>
965
</parameter>
966
</parameters>
967
</method>
968
<method name="set_base_dir" c:identifier="pango_context_set_base_dir">
969
<doc xml:whitespace="preserve">Sets the base direction for the context.
1021
970
The base direction is used in applying the Unicode bidirectional
1022
971
algorithm; if the @direction is %PANGO_DIRECTION_LTR or
1023
972
%PANGO_DIRECTION_RTL, then the value will be used as the paragraph
1024
973
direction in the Unicode bidirectional algorithm. A value of
1025
974
%PANGO_DIRECTION_WEAK_LTR or %PANGO_DIRECTION_WEAK_RTL is used only
1026
for paragraphs that do not contain any strong characters themselves.">
975
for paragraphs that do not contain any strong characters themselves.</doc>
1027
976
<return-value transfer-ownership="none">
1028
977
<type name="none" c:type="void"/>
1029
978
</return-value>
1030
979
<parameters>
1031
980
<parameter name="direction" transfer-ownership="none">
981
<doc xml:whitespace="preserve">the new base direction</doc>
1032
982
<type name="Direction" c:type="PangoDirection"/>
1033
983
</parameter>
1034
984
</parameters>
1035
985
</method>
1036
<method name="get_base_dir"
1037
c:identifier="pango_context_get_base_dir"
1038
doc="Retrieves the base direction for the context. See
1039
pango_context_set_base_dir().">
1040
<return-value transfer-ownership="full">
1041
<type name="Direction" c:type="PangoDirection"/>
1042
</return-value>
1043
</method>
1044
986
<method name="set_base_gravity"
1045
987
c:identifier="pango_context_set_base_gravity"
1046
doc="Sets the base gravity for the context.
1047
The base gravity is used in laying vertical text out."
1048
988
version="1.16">
989
<doc xml:whitespace="preserve">Sets the base gravity for the context.
990
The base gravity is used in laying vertical text out.</doc>
1049
991
<return-value transfer-ownership="none">
1050
992
<type name="none" c:type="void"/>
1051
993
</return-value>
1052
994
<parameters>
1053
995
<parameter name="gravity" transfer-ownership="none">
996
<doc xml:whitespace="preserve">the new base gravity</doc>
1054
997
<type name="Gravity" c:type="PangoGravity"/>
1055
998
</parameter>
1056
999
</parameters>
1057
1000
</method>
1058
<method name="get_base_gravity"
1059
c:identifier="pango_context_get_base_gravity"
1060
doc="Retrieves the base gravity for the context. See
1061
pango_context_set_base_gravity()."
1062
version="1.16">
1063
<return-value transfer-ownership="full">
1064
<type name="Gravity" c:type="PangoGravity"/>
1001
<method name="set_font_description"
1002
c:identifier="pango_context_set_font_description">
1003
<doc xml:whitespace="preserve">Set the default font description for the context</doc>
1004
<return-value transfer-ownership="none">
1005
<type name="none" c:type="void"/>
1065
1006
</return-value>
1007
<parameters>
1008
<parameter name="desc" transfer-ownership="none">
1009
<doc xml:whitespace="preserve">the new pango font description</doc>
1010
<type name="FontDescription" c:type="PangoFontDescription*"/>
1011
</parameter>
1012
</parameters>
1066
1013
</method>
1067
<method name="get_gravity"
1068
c:identifier="pango_context_get_gravity"
1069
doc="Retrieves the gravity for the context. This is similar to
1070
pango_context_get_base_gravity(), except for when the base gravity
1071
is %PANGO_GRAVITY_AUTO for which pango_gravity_get_for_matrix() is used
1072
to return the gravity from the current context matrix."
1073
version="1.16">
1074
<return-value transfer-ownership="full">
1075
<type name="Gravity" c:type="PangoGravity"/>
1014
<method name="set_font_map" c:identifier="pango_context_set_font_map">
1015
<doc xml:whitespace="preserve">Sets the font map to be searched when fonts are looked-up in this context.
1016
This is only for internal use by Pango backends, a #PangoContext obtained
1017
via one of the recommended methods should already have a suitable font map.</doc>
1018
<return-value transfer-ownership="none">
1019
<type name="none" c:type="void"/>
1076
1020
</return-value>
1021
<parameters>
1022
<parameter name="font_map" transfer-ownership="none">
1023
<doc xml:whitespace="preserve">the #PangoFontMap to set.</doc>
1024
<type name="FontMap" c:type="PangoFontMap*"/>
1025
</parameter>
1026
</parameters>
1077
1027
</method>
1078
1028
<method name="set_gravity_hint"
1079
1029
c:identifier="pango_context_set_gravity_hint"
1080
doc="Sets the gravity hint for the context.
1030
version="1.16">
1031
<doc xml:whitespace="preserve">Sets the gravity hint for the context.
1081
1032
The gravity hint is used in laying vertical text out, and is only relevant
1082
1033
if gravity of the context as returned by pango_context_get_gravity()
1083
is set %PANGO_GRAVITY_EAST or %PANGO_GRAVITY_WEST."
1084
version="1.16">
1034
is set %PANGO_GRAVITY_EAST or %PANGO_GRAVITY_WEST.</doc>
1085
1035
<return-value transfer-ownership="none">
1086
1036
<type name="none" c:type="void"/>
1087
1037
</return-value>
1088
1038
<parameters>
1089
1039
<parameter name="hint" transfer-ownership="none">
1040
<doc xml:whitespace="preserve">the new gravity hint</doc>
1090
1041
<type name="GravityHint" c:type="PangoGravityHint"/>
1091
1042
</parameter>
1092
1043
</parameters>
1093
1044
</method>
1094
<method name="get_gravity_hint"
1095
c:identifier="pango_context_get_gravity_hint"
1096
doc="Retrieves the gravity hint for the context. See
1097
pango_context_set_gravity_hint() for details."
1098
version="1.16">
1099
<return-value transfer-ownership="full">
1100
<type name="GravityHint" c:type="PangoGravityHint"/>
1045
<method name="set_language" c:identifier="pango_context_set_language">
1046
<doc xml:whitespace="preserve">Sets the global language tag for the context. The default language
1047
for the locale of the running process can be found using
1048
pango_language_get_default().</doc>
1049
<return-value transfer-ownership="none">
1050
<type name="none" c:type="void"/>
1101
1051
</return-value>
1052
<parameters>
1053
<parameter name="language" transfer-ownership="none">
1054
<doc xml:whitespace="preserve">the new language tag.</doc>
1055
<type name="Language" c:type="PangoLanguage*"/>
1056
</parameter>
1057
</parameters>
1102
1058
</method>
1103
1059
<method name="set_matrix"
1104
1060
c:identifier="pango_context_set_matrix"
1105
doc="(No matrix set is the same as setting the identity matrix.)
1106
Sets the transformation matrix that will be applied when rendering
1061
version="1.6">
1062
<doc xml:whitespace="preserve">Sets the transformation matrix that will be applied when rendering
1107
1063
with this context. Note that reported metrics are in the user space
1108
1064
coordinates before the application of the matrix, not device-space
1109
coordinates after the application of the matrix. So, they don't scale
1065
coordinates after the application of the matrix. So, they don't scale
1110
1066
with the matrix, though they may change slightly for different
1111
matrices, depending on how the text is fit to the pixel grid."
1112
version="1.6">
1067
matrices, depending on how the text is fit to the pixel grid.</doc>
1113
1068
<return-value transfer-ownership="none">
1114
1069
<type name="none" c:type="void"/>
1115
1070
</return-value>
1116
1071
<parameters>
1117
1072
<parameter name="matrix" transfer-ownership="none">
1073
<doc xml:whitespace="preserve">a #PangoMatrix, or %NULL to unset any existing matrix. (No matrix set is the same as setting the identity matrix.)</doc>
1118
1074
<type name="Matrix" c:type="PangoMatrix*"/>
1119
1075
</parameter>
1120
1076
</parameters>
1121
1077
</method>
1122
<method name="get_matrix"
1123
c:identifier="pango_context_get_matrix"
1124
doc="Gets the transformation matrix that will be applied when
1125
rendering with this context. See pango_context_set_matrix().
1126
(which is the same as the identity matrix). The returned
1127
matrix is owned by Pango and must not be modified or
1128
freed."
1129
version="1.6">
1130
<return-value transfer-ownership="none">
1131
<type name="Matrix" c:type="PangoMatrix*"/>
1132
</return-value>
1133
</method>
1134
1078
</class>
1135
1079
<record name="ContextClass"
1136
1080
c:type="PangoContextClass"
1081
disguised="1"
1137
1082
glib:is-gtype-struct-for="Context">
1138
1083
</record>
1139
<record name="Coverage" c:type="PangoCoverage">
1140
<constructor name="new"
1141
c:identifier="pango_coverage_new"
1142
doc="Create a new #PangoCoverage
1143
initialized to %PANGO_COVERAGE_NONE
1144
with a reference count of one, which
1145
should be freed with pango_coverage_unref().">
1146
<return-value transfer-ownership="full">
1147
<type name="Coverage" c:type="PangoCoverage*"/>
1148
</return-value>
1149
</constructor>
1150
<method name="ref"
1151
c:identifier="pango_coverage_ref"
1152
doc="Increase the reference count on the #PangoCoverage by one">
1153
<return-value transfer-ownership="full">
1154
<type name="Coverage" c:type="PangoCoverage*"/>
1155
</return-value>
1156
</method>
1157
<method name="unref"
1158
c:identifier="pango_coverage_unref"
1159
doc="Decrease the reference count on the #PangoCoverage by one.
1160
If the result is zero, free the coverage and all associated memory.">
1161
<return-value transfer-ownership="none">
1162
<type name="none" c:type="void"/>
1163
</return-value>
1164
</method>
1084
<record name="Coverage" c:type="PangoCoverage" disguised="1">
1165
1085
<method name="copy"
1166
1086
c:identifier="pango_coverage_copy"
1167
doc="Copy an existing #PangoCoverage. (This function may now be unnecessary
1087
introspectable="0">
1088
<doc xml:whitespace="preserve">Copy an existing #PangoCoverage. (This function may now be unnecessary
1168
1089
since we refcount the structure. File a bug if you use it.)
1169
1090
with a reference count of one, which
1170
should be freed with pango_coverage_unref().">
1171
<return-value transfer-ownership="full">
1091
should be freed with pango_coverage_unref().</doc>
1092
<return-value>
1093
<doc xml:whitespace="preserve">the newly allocated #PangoCoverage,</doc>
1172
1094
<type name="Coverage" c:type="PangoCoverage*"/>
1173
1095
</return-value>
1174
1096
</method>
1175
<method name="get"
1176
c:identifier="pango_coverage_get"
1177
doc="Determine whether a particular index is covered by @coverage">
1178
<return-value transfer-ownership="full">
1097
<method name="get" c:identifier="pango_coverage_get">
1098
<doc xml:whitespace="preserve">Determine whether a particular index is covered by @coverage</doc>
1099
<return-value transfer-ownership="none">
1100
<doc xml:whitespace="preserve">the coverage level of @coverage for character @index_.</doc>
1179
1101
<type name="CoverageLevel" c:type="PangoCoverageLevel"/>
1180
1102
</return-value>
1181
1103
<parameters>
1182
1104
<parameter name="index_" transfer-ownership="none">
1183
<type name="int" c:type="int"/>
1184
</parameter>
1185
</parameters>
1186
</method>
1187
<method name="set"
1188
c:identifier="pango_coverage_set"
1189
doc="Modify a particular index within @coverage">
1105
<doc xml:whitespace="preserve">the index to check</doc>
1106
<type name="gint" c:type="int"/>
1107
</parameter>
1108
</parameters>
1109
</method>
1110
<method name="max" c:identifier="pango_coverage_max">
1111
<doc xml:whitespace="preserve">Set the coverage for each index in @coverage to be the max (better)
1112
value of the current coverage for the index and the coverage for
1113
the corresponding index in @other.</doc>
1114
<return-value transfer-ownership="none">
1115
<type name="none" c:type="void"/>
1116
</return-value>
1117
<parameters>
1118
<parameter name="other" transfer-ownership="none">
1119
<doc xml:whitespace="preserve">another #PangoCoverage</doc>
1120
<type name="Coverage" c:type="PangoCoverage*"/>
1121
</parameter>
1122
</parameters>
1123
</method>
1124
<method name="ref" c:identifier="pango_coverage_ref" introspectable="0">
1125
<doc xml:whitespace="preserve">Increase the reference count on the #PangoCoverage by one</doc>
1126
<return-value>
1127
<doc xml:whitespace="preserve">@coverage</doc>
1128
<type name="Coverage" c:type="PangoCoverage*"/>
1129
</return-value>
1130
</method>
1131
<method name="set" c:identifier="pango_coverage_set">
1132
<doc xml:whitespace="preserve">Modify a particular index within @coverage</doc>
1190
1133
<return-value transfer-ownership="none">
1191
1134
<type name="none" c:type="void"/>
1192
1135
</return-value>
1193
1136
<parameters>
1194
1137
<parameter name="index_" transfer-ownership="none">
1195
<type name="int" c:type="int"/>
1138
<doc xml:whitespace="preserve">the index to modify</doc>
1139
<type name="gint" c:type="int"/>
1196
1140
</parameter>
1197
1141
<parameter name="level" transfer-ownership="none">
1142
<doc xml:whitespace="preserve">the new level for @index_</doc>
1198
1143
<type name="CoverageLevel" c:type="PangoCoverageLevel"/>
1199
1144
</parameter>
1200
1145
</parameters>
1201
1146
</method>
1202
<method name="max"
1203
c:identifier="pango_coverage_max"
1204
doc="Set the coverage for each index in @coverage to be the max (better)
1205
value of the current coverage for the index and the coverage for
1206
the corresponding index in @other.">
1147
<method name="to_bytes" c:identifier="pango_coverage_to_bytes">
1148
<doc xml:whitespace="preserve">Convert a #PangoCoverage structure into a flat binary format</doc>
1207
1149
<return-value transfer-ownership="none">
1208
1150
<type name="none" c:type="void"/>
1209
1151
</return-value>
1210
1152
<parameters>
1211
<parameter name="other" transfer-ownership="none">
1212
<type name="Coverage" c:type="PangoCoverage*"/>
1153
<parameter name="bytes" transfer-ownership="none">
1154
<doc xml:whitespace="preserve">location to store result (must be freed with g_free())</doc>
1155
<type name="guint8" c:type="guchar**"/>
1156
</parameter>
1157
<parameter name="n_bytes" transfer-ownership="none">
1158
<doc xml:whitespace="preserve">location to store size of result</doc>
1159
<type name="gint" c:type="int*"/>
1213
1160
</parameter>
1214
1161
</parameters>
1215
1162
</method>
1216
<method name="to_bytes"
1217
c:identifier="pango_coverage_to_bytes"
1218
doc="Convert a #PangoCoverage structure into a flat binary format">
1163
<method name="unref" c:identifier="pango_coverage_unref">
1164
<doc xml:whitespace="preserve">Decrease the reference count on the #PangoCoverage by one.
1165
If the result is zero, free the coverage and all associated memory.</doc>
1219
1166
<return-value transfer-ownership="none">
1220
1167
<type name="none" c:type="void"/>
1221
1168
</return-value>
1222
<parameters>
1223
<parameter name="bytes" direction="out" transfer-ownership="full">
1224
<type name="uint8" c:type="guchar**"/>
1225
</parameter>
1226
<parameter name="n_bytes" direction="out" transfer-ownership="full">
1227
<type name="int" c:type="int*"/>
1228
</parameter>
1229
</parameters>
1230
1169
</method>
1231
1170
</record>
1232
1171
<enumeration name="CoverageLevel"
1251
1190
glib:nick="exact"/>
1252
1191
</enumeration>
1253
1192
<enumeration name="Direction"
1254
doc="same as %PANGO_DIRECTION_RTL.
1255
same as %PANGO_DIRECTION_LTR
1256
The #PangoDirection type represents a direction in the
1193
glib:type-name="PangoDirection"
1194
glib:get-type="pango_direction_get_type"
1195
c:type="PangoDirection">
1196
<doc xml:whitespace="preserve">The #PangoDirection type represents a direction in the
1257
1197
Unicode bidirectional algorithm; not every value in this
1258
1198
enumeration makes sense for every usage of #PangoDirection;
1259
1199
for example, the return value of pango_unichar_direction()
1260
1200
and pango_find_base_dir() cannot be %PANGO_DIRECTION_WEAK_LTR
1261
1201
or %PANGO_DIRECTION_WEAK_RTL, since every character is either
1262
1202
neutral or has a strong direction; on the other hand
1263
%PANGO_DIRECTION_NEUTRAL doesn't make sense to pass
1203
%PANGO_DIRECTION_NEUTRAL doesn't make sense to pass
1264
1204
to pango_itemize_with_base_dir().
1265
1205
The %PANGO_DIRECTION_TTB_LTR, %PANGO_DIRECTION_TTB_RTL
1266
1206
values come from an earlier interpretation of this
1267
1207
enumeration as the writing direction of a block of
1268
1208
text and are no longer used; See #PangoGravity for how
1269
vertical text is handled in Pango."
1270
glib:type-name="PangoDirection"
1271
glib:get-type="pango_direction_get_type"
1272
c:type="PangoDirection">
1209
vertical text is handled in Pango.</doc>
1273
1210
<member name="ltr"
1274
1211
value="0"
1275
1212
c:identifier="PANGO_DIRECTION_LTR"
1300
1237
glib:nick="neutral"/>
1301
1238
</enumeration>
1302
1239
<constant name="ENGINE_TYPE_LANG" value="PangoEngineLang">
1303
<type name="utf8"/>
1240
<type name="utf8" c:type="gchar*"/>
1304
1241
</constant>
1305
1242
<constant name="ENGINE_TYPE_SHAPE" value="PangoEngineShape">
1306
<type name="utf8"/>
1243
<type name="utf8" c:type="gchar*"/>
1307
1244
</constant>
1308
1245
<enumeration name="EllipsizeMode"
1309
1246
glib:type-name="PangoEllipsizeMode"
1326
1263
c:identifier="PANGO_ELLIPSIZE_END"
1327
1264
glib:nick="end"/>
1328
1265
</enumeration>
1329
<record name="EngineLang" c:type="PangoEngineLang">
1266
<record name="EngineLang" c:type="PangoEngineLang" disguised="1">
1330
1267
</record>
1331
<record name="EngineShape" c:type="PangoEngineShape">
1268
<record name="EngineShape" c:type="PangoEngineShape" disguised="1">
1332
1269
</record>
1333
1270
<class name="Font"
1271
c:symbol-prefix="font"
1334
1272
c:type="PangoFont"
1335
1273
parent="GObject.Object"
1336
1274
abstract="1"
1337
1275
glib:type-name="PangoFont"
1338
1276
glib:get-type="pango_font_get_type">
1339
<function name="description_from_string"
1340
c:identifier="pango_font_description_from_string"
1341
doc="Creates a new font description from a string representation in the
1342
form "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]", where FAMILY-LIST is a
1343
comma separated list of families optionally terminated by a comma,
1344
STYLE_OPTIONS is a whitespace separated list of words where each WORD
1345
describes one of style, variant, weight, stretch, or gravity, and SIZE
1346
is a decimal number (size in points) or optionally followed by the
1347
unit modifier "px" for absolute size. Any one of the options may
1348
be absent. If FAMILY-LIST is absent, then the family_name field of
1349
the resulting font description will be initialized to %NULL. If
1350
STYLE-OPTIONS is missing, then all style options will be set to the
1351
default values. If SIZE is missing, the size in the resulting font
1352
description will be set to 0.">
1353
<return-value transfer-ownership="full">
1354
<type name="FontDescription" c:type="PangoFontDescription*"/>
1277
<function name="descriptions_free"
1278
c:identifier="pango_font_descriptions_free">
1279
<doc xml:whitespace="preserve">Frees an array of font descriptions.</doc>
1280
<return-value transfer-ownership="none">
1281
<type name="none" c:type="void"/>
1355
1282
</return-value>
1356
1283
<parameters>
1357
<parameter name="str" transfer-ownership="none">
1358
<type name="utf8" c:type="char*"/>
1284
<parameter name="descs" transfer-ownership="none">
1285
<doc xml:whitespace="preserve">a pointer to an array of #PangoFontDescription, may be %NULL</doc>
1286
<type name="FontDescription" c:type="PangoFontDescription**"/>
1287
</parameter>
1288
<parameter name="n_descs" transfer-ownership="none">
1289
<doc xml:whitespace="preserve">number of font descriptions in @descs</doc>
1290
<type name="gint" c:type="int"/>
1359
1291
</parameter>
1360
1292
</parameters>
1361
1293
</function>
1362
<method name="describe"
1363
c:identifier="pango_font_describe"
1364
doc="Returns a description of the font, with font size set in points.
1294
<method name="describe" c:identifier="pango_font_describe">
1295
<doc xml:whitespace="preserve">Returns a description of the font, with font size set in points.
1365
1296
Use pango_font_describe_with_absolute_size() if you want the font
1366
size in device units.">
1297
size in device units.</doc>
1367
1298
<return-value transfer-ownership="full">
1299
<doc xml:whitespace="preserve">a newly-allocated #PangoFontDescription object.</doc>
1368
1300
<type name="FontDescription" c:type="PangoFontDescription*"/>
1369
1301
</return-value>
1370
1302
</method>
1371
1303
<method name="describe_with_absolute_size"
1372
1304
c:identifier="pango_font_describe_with_absolute_size"
1373
doc="Returns a description of the font, with absolute font size set
1305
version="1.14">
1306
<doc xml:whitespace="preserve">Returns a description of the font, with absolute font size set
1374
1307
(in device units). Use pango_font_describe() if you want the font
1375
size in points."
1376
version="1.14">
1308
size in points.</doc>
1377
1309
<return-value transfer-ownership="full">
1310
<doc xml:whitespace="preserve">a newly-allocated #PangoFontDescription object.</doc>
1378
1311
<type name="FontDescription" c:type="PangoFontDescription*"/>
1379
1312
</return-value>
1380
1313
</method>
1381
<method name="get_coverage"
1382
c:identifier="pango_font_get_coverage"
1383
doc="Computes the coverage map for a given font and language tag.">
1384
<return-value transfer-ownership="full">
1385
<type name="Coverage" c:type="PangoCoverage*"/>
1386
</return-value>
1387
<parameters>
1388
<parameter name="language" transfer-ownership="none">
1389
<type name="Language" c:type="PangoLanguage*"/>
1390
</parameter>
1391
</parameters>
1392
</method>
1393
1314
<method name="find_shaper"
1394
1315
c:identifier="pango_font_find_shaper"
1395
doc="Finds the best matching shaper for a font for a particular
1396
language tag and character point.">
1397
<return-value transfer-ownership="full">
1316
introspectable="0">
1317
<doc xml:whitespace="preserve">Finds the best matching shaper for a font for a particular
1318
language tag and character point.</doc>
1319
<return-value>
1320
<doc xml:whitespace="preserve">the best matching shaper.</doc>
1398
1321
<type name="EngineShape" c:type="PangoEngineShape*"/>
1399
1322
</return-value>
1400
1323
<parameters>
1401
1324
<parameter name="language" transfer-ownership="none">
1325
<doc xml:whitespace="preserve">the language tag</doc>
1402
1326
<type name="Language" c:type="PangoLanguage*"/>
1403
1327
</parameter>
1404
1328
<parameter name="ch" transfer-ownership="none">
1405
<type name="uint32" c:type="guint32"/>
1329
<doc xml:whitespace="preserve">a Unicode character.</doc>
1330
<type name="guint32" c:type="guint32"/>
1406
1331
</parameter>
1407
1332
</parameters>
1408
1333
</method>
1409
<method name="get_metrics"
1410
c:identifier="pango_font_get_metrics"
1411
doc="for, or %NULL to indicate to get the metrics for the entire
1412
font.
1413
Gets overall metric information for a font. Since the metrics may be
1414
substantially different for different scripts, a language tag can
1415
be provided to indicate that the metrics should be retrieved that
1416
correspond to the script(s) used by that language.
1417
If @font is %NULL, this function gracefully sets some sane values in the
1418
output variables and returns.
1419
when finished using the object.">
1420
<return-value transfer-ownership="full">
1421
<type name="FontMetrics" c:type="PangoFontMetrics*"/>
1334
<method name="get_coverage"
1335
c:identifier="pango_font_get_coverage"
1336
introspectable="0">
1337
<doc xml:whitespace="preserve">Computes the coverage map for a given font and language tag.</doc>
1338
<return-value>
1339
<doc xml:whitespace="preserve">a newly-allocated #PangoCoverage object.</doc>
1340
<type name="Coverage" c:type="PangoCoverage*"/>
1422
1341
</return-value>
1423
1342
<parameters>
1424
1343
<parameter name="language" transfer-ownership="none">
1344
<doc xml:whitespace="preserve">the language tag</doc>
1425
1345
<type name="Language" c:type="PangoLanguage*"/>
1426
1346
</parameter>
1427
1347
</parameters>
1428
1348
</method>
1349
<method name="get_font_map"
1350
c:identifier="pango_font_get_font_map"
1351
version="1.10"
1352
introspectable="0">
1353
<doc xml:whitespace="preserve">Gets the font map for which the font was created.
1354
Note that the font maintains a <firstterm>weak</firstterm> reference
1355
to the font map, so if all references to font map are dropped, the font
1356
map will be finalized even if there are fonts created with the font
1357
map that are still alive. In that case this function will return %NULL.
1358
It is the responsibility of the user to ensure that the font map is kept
1359
alive. In most uses this is not an issue as a #PangoContext holds
1360
a reference to the font map.</doc>
1361
<return-value>
1362
<doc xml:whitespace="preserve">the #PangoFontMap for the font, or %NULL if @font is %NULL.</doc>
1363
<type name="FontMap" c:type="PangoFontMap*"/>
1364
</return-value>
1365
</method>
1429
1366
<method name="get_glyph_extents"
1430
c:identifier="pango_font_get_glyph_extents"
1431
doc="or %NULL to indicate that the result is not needed.
1432
or %NULL to indicate that the result is not needed.
1433
Gets the logical and ink extents of a glyph within a font. The
1367
c:identifier="pango_font_get_glyph_extents">
1368
<doc xml:whitespace="preserve">Gets the logical and ink extents of a glyph within a font. The
1434
1369
coordinate system for each rectangle has its origin at the
1435
1370
base line and horizontal origin of the character with increasing
1436
1371
coordinates extending to the right and down. The macros PANGO_ASCENT(),
1438
1373
from the extents rectangle to more traditional font metrics. The units
1439
1374
of the rectangles are in 1/PANGO_SCALE of a device unit.
1440
1375
If @font is %NULL, this function gracefully sets some sane values in the
1441
output variables and returns.">
1376
output variables and returns.</doc>
1442
1377
<return-value transfer-ownership="none">
1443
1378
<type name="none" c:type="void"/>
1444
1379
</return-value>
1445
1380
<parameters>
1446
1381
<parameter name="glyph" transfer-ownership="none">
1382
<doc xml:whitespace="preserve">the glyph index</doc>
1447
1383
<type name="Glyph" c:type="PangoGlyph"/>
1448
1384
</parameter>
1449
1385
<parameter name="ink_rect" transfer-ownership="none">
1386
<doc xml:whitespace="preserve">rectangle used to store the extents of the glyph as drawn or %NULL to indicate that the result is not needed.</doc>
1450
1387
<type name="Rectangle" c:type="PangoRectangle*"/>
1451
1388
</parameter>
1452
1389
<parameter name="logical_rect" transfer-ownership="none">
1390
<doc xml:whitespace="preserve">rectangle used to store the logical extents of the glyph or %NULL to indicate that the result is not needed.</doc>
1453
1391
<type name="Rectangle" c:type="PangoRectangle*"/>
1454
1392
</parameter>
1455
1393
</parameters>
1456
1394
</method>
1457
<method name="get_font_map"
1458
c:identifier="pango_font_get_font_map"
1459
doc="Gets the font map for which the font was created.
1460
Note that the font maintains a <firstterm>weak</firstterm> reference
1461
to the font map, so if all references to font map are dropped, the font
1462
map will be finalized even if there are fonts created with the font
1463
map that are still alive. In that case this function will return %NULL.
1464
It is the responsibility of the user to ensure that the font map is kept
1465
alive. In most uses this is not an issue as a #PangoContext holds
1466
a reference to the font map."
1467
version="1.10">
1395
<method name="get_metrics" c:identifier="pango_font_get_metrics">
1396
<doc xml:whitespace="preserve">Gets overall metric information for a font. Since the metrics may be
1397
substantially different for different scripts, a language tag can
1398
be provided to indicate that the metrics should be retrieved that
1399
correspond to the script(s) used by that language.
1400
If @font is %NULL, this function gracefully sets some sane values in the
1401
output variables and returns.
1402
when finished using the object.</doc>
1468
1403
<return-value transfer-ownership="full">
1469
<type name="FontMap" c:type="PangoFontMap*"/>
1404
<doc xml:whitespace="preserve">a #PangoFontMetrics object. The caller must call pango_font_metrics_unref()</doc>
1405
<type name="FontMetrics" c:type="PangoFontMetrics*"/>
1470
1406
</return-value>
1407
<parameters>
1408
<parameter name="language" transfer-ownership="none">
1409
<doc xml:whitespace="preserve">language tag used to determine which script to get the metrics for, or %NULL to indicate to get the metrics for the entire font.</doc>
1410
<type name="Language" c:type="PangoLanguage*"/>
1411
</parameter>
1412
</parameters>
1471
1413
</method>
1472
1414
</class>
1473
1415
<record name="FontDescription"
1474
1416
c:type="PangoFontDescription"
1475
1417
glib:type-name="PangoFontDescription"
1476
glib:get-type="pango_font_description_get_type">
1477
<constructor name="new"
1478
c:identifier="pango_font_description_new"
1479
doc="Creates a new font description structure with all fields unset.
1480
should be freed using pango_font_description_free().">
1418
glib:get-type="pango_font_description_get_type"
1419
c:symbol-prefix="font_description">
1420
<constructor name="new" c:identifier="pango_font_description_new">
1421
<doc xml:whitespace="preserve">Creates a new font description structure with all fields unset.
1422
should be freed using pango_font_description_free().</doc>
1481
1423
<return-value transfer-ownership="full">
1424
<doc xml:whitespace="preserve">the newly allocated #PangoFontDescription, which</doc>
1482
1425
<type name="FontDescription" c:type="PangoFontDescription*"/>
1483
1426
</return-value>
1484
1427
</constructor>
1485
<method name="copy"
1486
c:identifier="pango_font_description_copy"
1487
doc="Make a copy of a #PangoFontDescription.
1428
<method name="better_match"
1429
c:identifier="pango_font_description_better_match">
1430
<doc xml:whitespace="preserve">Determines if the style attributes of @new_match are a closer match
1431
for @desc than those of @old_match are, or if @old_match is %NULL,
1432
determines if @new_match is a match at all.
1433
Approximate matching is done for
1434
weight and style; other style attributes must match exactly.
1435
Style attributes are all attributes other than family and size-related
1436
attributes. Approximate matching for style considers PANGO_STYLE_OBLIQUE
1437
and PANGO_STYLE_ITALIC as matches, but not as good a match as when the
1438
styles are equal.
1439
Note that @old_match must match @desc.</doc>
1440
<return-value transfer-ownership="none">
1441
<doc xml:whitespace="preserve">%TRUE if @new_match is a better match</doc>
1442
<type name="gboolean" c:type="gboolean"/>
1443
</return-value>
1444
<parameters>
1445
<parameter name="old_match" transfer-ownership="none">
1446
<doc xml:whitespace="preserve">a #PangoFontDescription, or %NULL</doc>
1447
<type name="FontDescription" c:type="PangoFontDescription*"/>
1448
</parameter>
1449
<parameter name="new_match" transfer-ownership="none">
1450
<doc xml:whitespace="preserve">a #PangoFontDescription</doc>
1451
<type name="FontDescription" c:type="PangoFontDescription*"/>
1452
</parameter>
1453
</parameters>
1454
</method>
1455
<method name="copy" c:identifier="pango_font_description_copy">
1456
<doc xml:whitespace="preserve">Make a copy of a #PangoFontDescription.
1488
1457
be freed with pango_font_description_free(), or %NULL
1489
if @desc was %NULL.">
1458
if @desc was %NULL.</doc>
1490
1459
<return-value transfer-ownership="full">
1460
<doc xml:whitespace="preserve">the newly allocated #PangoFontDescription, which should</doc>
1491
1461
<type name="FontDescription" c:type="PangoFontDescription*"/>
1492
1462
</return-value>
1493
1463
</method>
1494
1464
<method name="copy_static"
1495
c:identifier="pango_font_description_copy_static"
1496
doc="Like pango_font_description_copy(), but only a shallow copy is made
1465
c:identifier="pango_font_description_copy_static">
1466
<doc xml:whitespace="preserve">Like pango_font_description_copy(), but only a shallow copy is made
1497
1467
of the family name and other allocated fields. The result can only
1498
1468
be used until @desc is modified or freed. This is meant to be used
1499
1469
when the copy is only needed temporarily.
1500
1470
be freed with pango_font_description_free(), or %NULL
1501
if @desc was %NULL.">
1471
if @desc was %NULL.</doc>
1502
1472
<return-value transfer-ownership="full">
1473
<doc xml:whitespace="preserve">the newly allocated #PangoFontDescription, which should</doc>
1503
1474
<type name="FontDescription" c:type="PangoFontDescription*"/>
1504
1475
</return-value>
1505
1476
</method>
1506
<method name="hash"
1507
c:identifier="pango_font_description_hash"
1508
doc="Computes a hash of a #PangoFontDescription structure suitable
1509
to be used, for example, as an argument to g_hash_table_new().
1510
The hash value is independent of @desc->mask.">
1511
<return-value transfer-ownership="none">
1512
<type name="uint" c:type="guint"/>
1513
</return-value>
1514
</method>
1515
<method name="equal"
1516
c:identifier="pango_font_description_equal"
1517
doc="Compares two font descriptions for equality. Two font descriptions
1477
<method name="equal" c:identifier="pango_font_description_equal">
1478
<doc xml:whitespace="preserve">Compares two font descriptions for equality. Two font descriptions
1518
1479
are considered equal if the fonts they describe are provably identical.
1519
1480
This means that their masks do not have to match, as long as other fields
1520
1481
are all the same. (Two font descriptions may result in identical fonts
1521
1482
being loaded, but still compare %FALSE.)
1522
%FALSE otherwise.">
1483
%FALSE otherwise.</doc>
1523
1484
<return-value transfer-ownership="none">
1524
<type name="boolean" c:type="gboolean"/>
1485
<doc xml:whitespace="preserve">%TRUE if the two font descriptions are identical,</doc>
1486
<type name="gboolean" c:type="gboolean"/>
1525
1487
</return-value>
1526
1488
<parameters>
1527
1489
<parameter name="desc2" transfer-ownership="none">
1528
<type name="FontDescription" c:type="PangoFontDescription*"/>
1529
</parameter>
1530
</parameters>
1531
</method>
1532
<method name="free"
1533
c:identifier="pango_font_description_free"
1534
doc="Frees a font description.">
1535
<return-value transfer-ownership="none">
1536
<type name="none" c:type="void"/>
1537
</return-value>
1538
</method>
1539
<method name="_free"
1540
c:identifier="pango_font_descriptions_free"
1541
doc="Frees an array of font descriptions.">
1542
<return-value transfer-ownership="none">
1543
<type name="none" c:type="void"/>
1544
</return-value>
1545
<parameters>
1546
<parameter name="n_descs" transfer-ownership="none">
1547
<type name="int" c:type="int"/>
1490
<doc xml:whitespace="preserve">another #PangoFontDescription</doc>
1491
<type name="FontDescription" c:type="PangoFontDescription*"/>
1492
</parameter>
1493
</parameters>
1494
</method>
1495
<method name="free" c:identifier="pango_font_description_free">
1496
<doc xml:whitespace="preserve">Frees a font description.</doc>
1497
<return-value transfer-ownership="none">
1498
<type name="none" c:type="void"/>
1499
</return-value>
1500
</method>
1501
<method name="get_family"
1502
c:identifier="pango_font_description_get_family">
1503
<doc xml:whitespace="preserve">Gets the family name field of a font description. See
1504
pango_font_description_set_family().
1505
%NULL if not previously set. This has the same life-time
1506
as the font description itself and should not be freed.</doc>
1507
<return-value transfer-ownership="none">
1508
<doc xml:whitespace="preserve">the family name field for the font description, or</doc>
1509
<type name="utf8" c:type="char*"/>
1510
</return-value>
1511
</method>
1512
<method name="get_gravity"
1513
c:identifier="pango_font_description_get_gravity"
1514
version="1.16">
1515
<doc xml:whitespace="preserve">Gets the gravity field of a font description. See
1516
pango_font_description_set_gravity().
1517
pango_font_description_get_set_fields() to find out if
1518
the field was explicitly set or not.</doc>
1519
<return-value transfer-ownership="none">
1520
<doc xml:whitespace="preserve">the gravity field for the font description. Use</doc>
1521
<type name="Gravity" c:type="PangoGravity"/>
1522
</return-value>
1523
</method>
1524
<method name="get_set_fields"
1525
c:identifier="pango_font_description_get_set_fields">
1526
<doc xml:whitespace="preserve">Determines which fields in a font description have been set.
1527
fields in @desc that have been set.</doc>
1528
<return-value transfer-ownership="none">
1529
<doc xml:whitespace="preserve">a bitmask with bits set corresponding to the</doc>
1530
<type name="FontMask" c:type="PangoFontMask"/>
1531
</return-value>
1532
</method>
1533
<method name="get_size" c:identifier="pango_font_description_get_size">
1534
<doc xml:whitespace="preserve">Gets the size field of a font description.
1535
See pango_font_description_set_size().
1536
You must call pango_font_description_get_size_is_absolute()
1537
to find out which is the case. Returns 0 if the size field has not
1538
previously been set or it has been set to 0 explicitly.
1539
Use pango_font_description_get_set_fields() to
1540
find out if the field was explicitly set or not.</doc>
1541
<return-value transfer-ownership="none">
1542
<doc xml:whitespace="preserve">the size field for the font description in points or device units.</doc>
1543
<type name="gint" c:type="gint"/>
1544
</return-value>
1545
</method>
1546
<method name="get_size_is_absolute"
1547
c:identifier="pango_font_description_get_size_is_absolute"
1548
version="1.8">
1549
<doc xml:whitespace="preserve">Determines whether the size of the font is in points (not absolute) or device units (absolute).
1550
See pango_font_description_set_size() and pango_font_description_set_absolute_size().
1551
points or device units. Use pango_font_description_get_set_fields() to
1552
find out if the size field of the font description was explicitly set or not.</doc>
1553
<return-value transfer-ownership="none">
1554
<doc xml:whitespace="preserve">whether the size for the font description is in</doc>
1555
<type name="gboolean" c:type="gboolean"/>
1556
</return-value>
1557
</method>
1558
<method name="get_stretch"
1559
c:identifier="pango_font_description_get_stretch">
1560
<doc xml:whitespace="preserve">Gets the stretch field of a font description.
1561
See pango_font_description_set_stretch().
1562
pango_font_description_get_set_fields() to find out if
1563
the field was explicitly set or not.</doc>
1564
<return-value transfer-ownership="none">
1565
<doc xml:whitespace="preserve">the stretch field for the font description. Use</doc>
1566
<type name="Stretch" c:type="PangoStretch"/>
1567
</return-value>
1568
</method>
1569
<method name="get_style" c:identifier="pango_font_description_get_style">
1570
<doc xml:whitespace="preserve">Gets the style field of a #PangoFontDescription. See
1571
pango_font_description_set_style().
1572
Use pango_font_description_get_set_fields() to find out if
1573
the field was explicitly set or not.</doc>
1574
<return-value transfer-ownership="none">
1575
<doc xml:whitespace="preserve">the style field for the font description.</doc>
1576
<type name="Style" c:type="PangoStyle"/>
1577
</return-value>
1578
</method>
1579
<method name="get_variant"
1580
c:identifier="pango_font_description_get_variant">
1581
<doc xml:whitespace="preserve">Gets the variant field of a #PangoFontDescription. See
1582
pango_font_description_set_variant().
1583
pango_font_description_get_set_fields() to find out if
1584
the field was explicitly set or not.</doc>
1585
<return-value transfer-ownership="none">
1586
<doc xml:whitespace="preserve">the variant field for the font description. Use</doc>
1587
<type name="Variant" c:type="PangoVariant"/>
1588
</return-value>
1589
</method>
1590
<method name="get_weight"
1591
c:identifier="pango_font_description_get_weight">
1592
<doc xml:whitespace="preserve">Gets the weight field of a font description. See
1593
pango_font_description_set_weight().
1594
pango_font_description_get_set_fields() to find out if
1595
the field was explicitly set or not.</doc>
1596
<return-value transfer-ownership="none">
1597
<doc xml:whitespace="preserve">the weight field for the font description. Use</doc>
1598
<type name="Weight" c:type="PangoWeight"/>
1599
</return-value>
1600
</method>
1601
<method name="hash" c:identifier="pango_font_description_hash">
1602
<doc xml:whitespace="preserve">Computes a hash of a #PangoFontDescription structure suitable
1603
to be used, for example, as an argument to g_hash_table_new().
1604
The hash value is independent of @desc->mask.</doc>
1605
<return-value transfer-ownership="none">
1606
<doc xml:whitespace="preserve">the hash value.</doc>
1607
<type name="guint" c:type="guint"/>
1608
</return-value>
1609
</method>
1610
<method name="merge" c:identifier="pango_font_description_merge">
1611
<doc xml:whitespace="preserve">Merges the fields that are set in @desc_to_merge into the fields in
1612
are not already set are affected. If %TRUE, then fields that are
1613
already set will be replaced as well.
1614
If @desc_to_merge is %NULL, this function performs nothing.</doc>
1615
<return-value transfer-ownership="none">
1616
<type name="none" c:type="void"/>
1617
</return-value>
1618
<parameters>
1619
<parameter name="desc_to_merge" transfer-ownership="none">
1620
<doc xml:whitespace="preserve">the #PangoFontDescription to merge from, or %NULL</doc>
1621
<type name="FontDescription" c:type="PangoFontDescription*"/>
1622
</parameter>
1623
<parameter name="replace_existing" transfer-ownership="none">
1624
<doc xml:whitespace="preserve">if %TRUE, replace fields in @desc with the corresponding values from @desc_to_merge, even if they are already exist.</doc>
1625
<type name="gboolean" c:type="gboolean"/>
1626
</parameter>
1627
</parameters>
1628
</method>
1629
<method name="merge_static"
1630
c:identifier="pango_font_description_merge_static">
1631
<doc xml:whitespace="preserve">Like pango_font_description_merge(), but only a shallow copy is made
1632
of the family name and other allocated fields. @desc can only be
1633
used until @desc_to_merge is modified or freed. This is meant
1634
to be used when the merged font description is only needed temporarily.</doc>
1635
<return-value transfer-ownership="none">
1636
<type name="none" c:type="void"/>
1637
</return-value>
1638
<parameters>
1639
<parameter name="desc_to_merge" transfer-ownership="none">
1640
<doc xml:whitespace="preserve">the #PangoFontDescription to merge from</doc>
1641
<type name="FontDescription" c:type="PangoFontDescription*"/>
1642
</parameter>
1643
<parameter name="replace_existing" transfer-ownership="none">
1644
<doc xml:whitespace="preserve">if %TRUE, replace fields in @desc with the corresponding values from @desc_to_merge, even if they are already exist.</doc>
1645
<type name="gboolean" c:type="gboolean"/>
1646
</parameter>
1647
</parameters>
1648
</method>
1649
<method name="set_absolute_size"
1650
c:identifier="pango_font_description_set_absolute_size"
1651
version="1.8">
1652
<doc xml:whitespace="preserve">Sets the size field of a font description, in device units. This is mutually
1653
exclusive with pango_font_description_set_size() which sets the font size
1654
in points.</doc>
1655
<return-value transfer-ownership="none">
1656
<type name="none" c:type="void"/>
1657
</return-value>
1658
<parameters>
1659
<parameter name="size" transfer-ownership="none">
1660
<doc xml:whitespace="preserve">the new size, in Pango units. There are %PANGO_SCALE Pango units in one device unit. For an output backend where a device unit is a pixel, a @size value of 10 * PANGO_SCALE gives a 10 pixel font.</doc>
1661
<type name="gdouble" c:type="double"/>
1548
1662
</parameter>
1549
1663
</parameters>
1550
1664
</method>
1551
1665
<method name="set_family"
1552
c:identifier="pango_font_description_set_family"
1553
doc="Sets the family name field of a font description. The family
1666
c:identifier="pango_font_description_set_family">
1667
<doc xml:whitespace="preserve">Sets the family name field of a font description. The family
1554
1668
name represents a family of related font styles, and will
1555
1669
resolve to a particular #PangoFontFamily. In some uses of
1556
1670
#PangoFontDescription, it is also possible to use a comma
1557
separated list of family names for this field.">
1671
separated list of family names for this field.</doc>
1558
1672
<return-value transfer-ownership="none">
1559
1673
<type name="none" c:type="void"/>
1560
1674
</return-value>
1561
1675
<parameters>
1562
1676
<parameter name="family" transfer-ownership="none">
1677
<doc xml:whitespace="preserve">a string representing the family name.</doc>
1563
1678
<type name="utf8" c:type="char*"/>
1564
1679
</parameter>
1565
1680
</parameters>
1566
1681
</method>
1567
1682
<method name="set_family_static"
1568
c:identifier="pango_font_description_set_family_static"
1569
doc="Like pango_font_description_set_family(), except that no
1683
c:identifier="pango_font_description_set_family_static">
1684
<doc xml:whitespace="preserve">Like pango_font_description_set_family(), except that no
1570
1685
copy of @family is made. The caller must make sure that the
1571
1686
string passed in stays around until @desc has been freed
1572
1687
or the name is set again. This function can be used if
1573
if @desc is only needed temporarily.">
1688
if @desc is only needed temporarily.</doc>
1574
1689
<return-value transfer-ownership="none">
1575
1690
<type name="none" c:type="void"/>
1576
1691
</return-value>
1577
1692
<parameters>
1578
1693
<parameter name="family" transfer-ownership="none">
1694
<doc xml:whitespace="preserve">a string representing the family name.</doc>
1579
1695
<type name="utf8" c:type="char*"/>
1580
1696
</parameter>
1581
1697
</parameters>
1582
1698
</method>
1583
<method name="get_family"
1584
c:identifier="pango_font_description_get_family"
1585
doc="Gets the family name field of a font description. See
1586
pango_font_description_set_family().
1587
%NULL if not previously set. This has the same life-time
1588
as the font description itself and should not be freed.">
1589
<return-value transfer-ownership="none">
1590
<type name="utf8" c:type="char*"/>
1591
</return-value>
1592
</method>
1593
<method name="set_style"
1594
c:identifier="pango_font_description_set_style"
1595
doc="Sets the style field of a #PangoFontDescription. The
1699
<method name="set_gravity"
1700
c:identifier="pango_font_description_set_gravity"
1701
version="1.16">
1702
<doc xml:whitespace="preserve">Sets the gravity field of a font description. The gravity field
1703
specifies how the glyphs should be rotated. If @gravity is
1704
%PANGO_GRAVITY_AUTO, this actually unsets the gravity mask on
1705
the font description.
1706
This function is seldom useful to the user. Gravity should normally
1707
be set on a #PangoContext.</doc>
1708
<return-value transfer-ownership="none">
1709
<type name="none" c:type="void"/>
1710
</return-value>
1711
<parameters>
1712
<parameter name="gravity" transfer-ownership="none">
1713
<doc xml:whitespace="preserve">the gravity for the font description.</doc>
1714
<type name="Gravity" c:type="PangoGravity"/>
1715
</parameter>
1716
</parameters>
1717
</method>
1718
<method name="set_size" c:identifier="pango_font_description_set_size">
1719
<doc xml:whitespace="preserve">Sets the size field of a font description in fractional points. This is mutually
1720
exclusive with pango_font_description_set_absolute_size().</doc>
1721
<return-value transfer-ownership="none">
1722
<type name="none" c:type="void"/>
1723
</return-value>
1724
<parameters>
1725
<parameter name="size" transfer-ownership="none">
1726
<doc xml:whitespace="preserve">the size of the font in points, scaled by PANGO_SCALE. (That is, a @size value of 10 * PANGO_SCALE is a 10 point font. The conversion factor between points and device units depends on system configuration and the output device. For screen display, a logical DPI of 96 is common, in which case a 10 point font corresponds to a 10 * (96 / 72) = 13.3 pixel font. Use pango_font_description_set_absolute_size() if you need a particular size in device units.</doc>
1727
<type name="gint" c:type="gint"/>
1728
</parameter>
1729
</parameters>
1730
</method>
1731
<method name="set_stretch"
1732
c:identifier="pango_font_description_set_stretch">
1733
<doc xml:whitespace="preserve">Sets the stretch field of a font description. The stretch field
1734
specifies how narrow or wide the font should be.</doc>
1735
<return-value transfer-ownership="none">
1736
<type name="none" c:type="void"/>
1737
</return-value>
1738
<parameters>
1739
<parameter name="stretch" transfer-ownership="none">
1740
<doc xml:whitespace="preserve">the stretch for the font description</doc>
1741
<type name="Stretch" c:type="PangoStretch"/>
1742
</parameter>
1743
</parameters>
1744
</method>
1745
<method name="set_style" c:identifier="pango_font_description_set_style">
1746
<doc xml:whitespace="preserve">Sets the style field of a #PangoFontDescription. The
1596
1747
#PangoStyle enumeration describes whether the font is slanted and
1597
1748
the manner in which it is slanted; it can be either
1598
1749
#PANGO_STYLE_NORMAL, #PANGO_STYLE_ITALIC, or #PANGO_STYLE_OBLIQUE.
1599
1750
Most fonts will either have a italic style or an oblique
1600
1751
style, but not both, and font matching in Pango will
1601
1752
match italic specifications with oblique fonts and vice-versa
1602
if an exact match is not found.">
1753
if an exact match is not found.</doc>
1603
1754
<return-value transfer-ownership="none">
1604
1755
<type name="none" c:type="void"/>
1605
1756
</return-value>
1606
1757
<parameters>
1607
1758
<parameter name="style" transfer-ownership="none">
1759
<doc xml:whitespace="preserve">the style for the font description</doc>
1608
1760
<type name="Style" c:type="PangoStyle"/>
1609
1761
</parameter>
1610
1762
</parameters>
1611
1763
</method>
1612
<method name="get_style"
1613
c:identifier="pango_font_description_get_style"
1614
doc="Gets the style field of a #PangoFontDescription. See
1615
pango_font_description_set_style().
1616
Use pango_font_description_get_set_fields() to find out if
1617
the field was explicitly set or not.">
1618
<return-value transfer-ownership="full">
1619
<type name="Style" c:type="PangoStyle"/>
1620
</return-value>
1621
</method>
1622
1764
<method name="set_variant"
1623
c:identifier="pango_font_description_set_variant"
1624
doc="Sets the variant field of a font description. The #PangoVariant
1625
can either be %PANGO_VARIANT_NORMAL or %PANGO_VARIANT_SMALL_CAPS.">
1765
c:identifier="pango_font_description_set_variant">
1766
<doc xml:whitespace="preserve">Sets the variant field of a font description. The #PangoVariant
1767
can either be %PANGO_VARIANT_NORMAL or %PANGO_VARIANT_SMALL_CAPS.</doc>
1626
1768
<return-value transfer-ownership="none">
1627
1769
<type name="none" c:type="void"/>
1628
1770
</return-value>
1629
1771
<parameters>
1630
1772
<parameter name="variant" transfer-ownership="none">
1773
<doc xml:whitespace="preserve">the variant type for the font description.</doc>
1631
1774
<type name="Variant" c:type="PangoVariant"/>
1632
1775
</parameter>
1633
1776
</parameters>
1634
1777
</method>
1635
<method name="get_variant"
1636
c:identifier="pango_font_description_get_variant"
1637
doc="Gets the variant field of a #PangoFontDescription. See
1638
pango_font_description_set_variant().
1639
pango_font_description_get_set_fields() to find out if
1640
the field was explicitly set or not.">
1641
<return-value transfer-ownership="full">
1642
<type name="Variant" c:type="PangoVariant"/>
1643
</return-value>
1644
</method>
1645
1778
<method name="set_weight"
1646
c:identifier="pango_font_description_set_weight"
1647
doc="Sets the weight field of a font description. The weight field
1779
c:identifier="pango_font_description_set_weight">
1780
<doc xml:whitespace="preserve">Sets the weight field of a font description. The weight field
1648
1781
specifies how bold or light the font should be. In addition
1649
1782
to the values of the #PangoWeight enumeration, other intermediate
1650
numeric values are possible.">
1783
numeric values are possible.</doc>
1651
1784
<return-value transfer-ownership="none">
1652
1785
<type name="none" c:type="void"/>
1653
1786
</return-value>
1654
1787
<parameters>
1655
1788
<parameter name="weight" transfer-ownership="none">
1789
<doc xml:whitespace="preserve">the weight for the font description.</doc>
1656
1790
<type name="Weight" c:type="PangoWeight"/>
1657
1791
</parameter>
1658
1792
</parameters>
1659
1793
</method>
1660
<method name="get_weight"
1661
c:identifier="pango_font_description_get_weight"
1662
doc="Gets the weight field of a font description. See
1663
pango_font_description_set_weight().
1664
pango_font_description_get_set_fields() to find out if
1665
the field was explicitly set or not.">
1666
<return-value transfer-ownership="full">
1667
<type name="Weight" c:type="PangoWeight"/>
1668
</return-value>
1669
</method>
1670
<method name="set_stretch"
1671
c:identifier="pango_font_description_set_stretch"
1672
doc="Sets the stretch field of a font description. The stretch field
1673
specifies how narrow or wide the font should be.">
1674
<return-value transfer-ownership="none">
1675
<type name="none" c:type="void"/>
1676
</return-value>
1677
<parameters>
1678
<parameter name="stretch" transfer-ownership="none">
1679
<type name="Stretch" c:type="PangoStretch"/>
1680
</parameter>
1681
</parameters>
1682
</method>
1683
<method name="get_stretch"
1684
c:identifier="pango_font_description_get_stretch"
1685
doc="Gets the stretch field of a font description.
1686
See pango_font_description_set_stretch().
1687
pango_font_description_get_set_fields() to find out if
1688
the field was explicitly set or not.">
1689
<return-value transfer-ownership="full">
1690
<type name="Stretch" c:type="PangoStretch"/>
1691
</return-value>
1692
</method>
1693
<method name="set_size"
1694
c:identifier="pango_font_description_set_size"
1695
doc="a @size value of 10 * PANGO_SCALE is a 10 point font. The conversion
1696
factor between points and device units depends on system configuration
1697
and the output device. For screen display, a logical DPI of 96 is
1698
common, in which case a 10 point font corresponds to a 10 * (96 / 72) = 13.3
1699
pixel font. Use pango_font_description_set_absolute_size() if you need
1700
a particular size in device units.
1701
Sets the size field of a font description in fractional points. This is mutually
1702
exclusive with pango_font_description_set_absolute_size().">
1703
<return-value transfer-ownership="none">
1704
<type name="none" c:type="void"/>
1705
</return-value>
1706
<parameters>
1707
<parameter name="size" transfer-ownership="none">
1708
<type name="int" c:type="gint"/>
1709
</parameter>
1710
</parameters>
1711
</method>
1712
<method name="get_size"
1713
c:identifier="pango_font_description_get_size"
1714
doc="Gets the size field of a font description.
1715
See pango_font_description_set_size().
1716
You must call pango_font_description_get_size_is_absolute()
1717
to find out which is the case. Returns 0 if the size field has not
1718
previously been set or it has been set to 0 explicitly.
1719
Use pango_font_description_get_set_fields() to
1720
find out if the field was explicitly set or not.">
1721
<return-value transfer-ownership="none">
1722
<type name="int" c:type="gint"/>
1723
</return-value>
1724
</method>
1725
<method name="set_absolute_size"
1726
c:identifier="pango_font_description_set_absolute_size"
1727
doc="device unit. For an output backend where a device unit is a pixel, a @size
1728
value of 10 * PANGO_SCALE gives a 10 pixel font.
1729
Sets the size field of a font description, in device units. This is mutually
1730
exclusive with pango_font_description_set_size() which sets the font size
1731
in points."
1732
version="1.8">
1733
<return-value transfer-ownership="none">
1734
<type name="none" c:type="void"/>
1735
</return-value>
1736
<parameters>
1737
<parameter name="size" transfer-ownership="none">
1738
<type name="double" c:type="double"/>
1739
</parameter>
1740
</parameters>
1741
</method>
1742
<method name="get_size_is_absolute"
1743
c:identifier="pango_font_description_get_size_is_absolute"
1744
doc="Determines whether the size of the font is in points (not absolute) or device units (absolute).
1745
See pango_font_description_set_size() and pango_font_description_set_absolute_size().
1746
points or device units. Use pango_font_description_get_set_fields() to
1747
find out if the size field of the font description was explicitly set or not."
1748
version="1.8">
1749
<return-value transfer-ownership="none">
1750
<type name="boolean" c:type="gboolean"/>
1751
</return-value>
1752
</method>
1753
<method name="set_gravity"
1754
c:identifier="pango_font_description_set_gravity"
1755
doc="Sets the gravity field of a font description. The gravity field
1756
specifies how the glyphs should be rotated. If @gravity is
1757
%PANGO_GRAVITY_AUTO, this actually unsets the gravity mask on
1758
the font description.
1759
This function is seldom useful to the user. Gravity should normally
1760
be set on a #PangoContext."
1761
version="1.16">
1762
<return-value transfer-ownership="none">
1763
<type name="none" c:type="void"/>
1764
</return-value>
1765
<parameters>
1766
<parameter name="gravity" transfer-ownership="none">
1767
<type name="Gravity" c:type="PangoGravity"/>
1768
</parameter>
1769
</parameters>
1770
</method>
1771
<method name="get_gravity"
1772
c:identifier="pango_font_description_get_gravity"
1773
doc="Gets the gravity field of a font description. See
1774
pango_font_description_set_gravity().
1775
pango_font_description_get_set_fields() to find out if
1776
the field was explicitly set or not."
1777
version="1.16">
1778
<return-value transfer-ownership="full">
1779
<type name="Gravity" c:type="PangoGravity"/>
1780
</return-value>
1781
</method>
1782
<method name="get_set_fields"
1783
c:identifier="pango_font_description_get_set_fields"
1784
doc="Determines which fields in a font description have been set.
1785
fields in @desc that have been set.">
1786
<return-value transfer-ownership="full">
1787
<type name="FontMask" c:type="PangoFontMask"/>
1794
<method name="to_filename"
1795
c:identifier="pango_font_description_to_filename">
1796
<doc xml:whitespace="preserve">Creates a filename representation of a font description. The
1797
filename is identical to the result from calling
1798
pango_font_description_to_string(), but with underscores instead of
1799
characters that are untypical in filenames, and in lower case only.</doc>
1800
<return-value transfer-ownership="full">
1801
<doc xml:whitespace="preserve">a new string that must be freed with g_free().</doc>
1802
<type name="utf8" c:type="char*"/>
1803
</return-value>
1804
</method>
1805
<method name="to_string" c:identifier="pango_font_description_to_string">
1806
<doc xml:whitespace="preserve">Creates a string representation of a font description. See
1807
pango_font_description_from_string() for a description of the
1808
format of the string representation. The family list in the
1809
string description will only have a terminating comma if the
1810
last word of the list is a valid style option.</doc>
1811
<return-value transfer-ownership="full">
1812
<doc xml:whitespace="preserve">a new string that must be freed with g_free().</doc>
1813
<type name="utf8" c:type="char*"/>
1788
1814
</return-value>
1789
1815
</method>
1790
1816
<method name="unset_fields"
1791
c:identifier="pango_font_description_unset_fields"
1792
doc="Unsets some of the fields in a #PangoFontDescription. The unset
1793
fields will get back to their default values.">
1817
c:identifier="pango_font_description_unset_fields">
1818
<doc xml:whitespace="preserve">Unsets some of the fields in a #PangoFontDescription. The unset
1819
fields will get back to their default values.</doc>
1794
1820
<return-value transfer-ownership="none">
1795
1821
<type name="none" c:type="void"/>
1796
1822
</return-value>
1797
1823
<parameters>
1798
1824
<parameter name="to_unset" transfer-ownership="none">
1825
<doc xml:whitespace="preserve">bitmask of fields in the @desc to unset.</doc>
1799
1826
<type name="FontMask" c:type="PangoFontMask"/>
1800
1827
</parameter>
1801
1828
</parameters>
1802
1829
</method>
1803
<method name="merge"
1804
c:identifier="pango_font_description_merge"
1805
doc="corresponding values from @desc_to_merge, even if they
1806
are already exist.
1807
Merges the fields that are set in @desc_to_merge into the fields in
1808
are not already set are affected. If %TRUE, then fields that are
1809
already set will be replaced as well.
1810
If @desc_to_merge is %NULL, this function performs nothing.">
1811
<return-value transfer-ownership="none">
1812
<type name="none" c:type="void"/>
1813
</return-value>
1814
<parameters>
1815
<parameter name="desc_to_merge" transfer-ownership="none">
1816
<type name="FontDescription" c:type="PangoFontDescription*"/>
1817
</parameter>
1818
<parameter name="replace_existing" transfer-ownership="none">
1819
<type name="boolean" c:type="gboolean"/>
1820
</parameter>
1821
</parameters>
1822
</method>
1823
<method name="merge_static"
1824
c:identifier="pango_font_description_merge_static"
1825
doc="corresponding values from @desc_to_merge, even if they
1826
are already exist.
1827
Like pango_font_description_merge(), but only a shallow copy is made
1828
of the family name and other allocated fields. @desc can only be
1829
used until @desc_to_merge is modified or freed. This is meant
1830
to be used when the merged font description is only needed temporarily.">
1831
<return-value transfer-ownership="none">
1832
<type name="none" c:type="void"/>
1833
</return-value>
1834
<parameters>
1835
<parameter name="desc_to_merge" transfer-ownership="none">
1836
<type name="FontDescription" c:type="PangoFontDescription*"/>
1837
</parameter>
1838
<parameter name="replace_existing" transfer-ownership="none">
1839
<type name="boolean" c:type="gboolean"/>
1840
</parameter>
1841
</parameters>
1842
</method>
1843
<method name="better_match"
1844
c:identifier="pango_font_description_better_match"
1845
doc="Determines if the style attributes of @new_match are a closer match
1846
for @desc than those of @old_match are, or if @old_match is %NULL,
1847
determines if @new_match is a match at all.
1848
Approximate matching is done for
1849
weight and style; other style attributes must match exactly.
1850
Style attributes are all attributes other than family and size-related
1851
attributes. Approximate matching for style considers PANGO_STYLE_OBLIQUE
1852
and PANGO_STYLE_ITALIC as matches, but not as good a match as when the
1853
styles are equal.
1854
Note that @old_match must match @desc.">
1855
<return-value transfer-ownership="none">
1856
<type name="boolean" c:type="gboolean"/>
1857
</return-value>
1858
<parameters>
1859
<parameter name="old_match" transfer-ownership="none">
1860
<type name="FontDescription" c:type="PangoFontDescription*"/>
1861
</parameter>
1862
<parameter name="new_match" transfer-ownership="none">
1863
<type name="FontDescription" c:type="PangoFontDescription*"/>
1864
</parameter>
1865
</parameters>
1866
</method>
1867
<method name="to_string"
1868
c:identifier="pango_font_description_to_string"
1869
doc="Creates a string representation of a font description. See
1870
pango_font_description_from_string() for a description of the
1871
format of the string representation. The family list in the
1872
string description will only have a terminating comma if the
1873
last word of the list is a valid style option.">
1874
<return-value transfer-ownership="full">
1875
<type name="utf8" c:type="char*"/>
1876
</return-value>
1877
</method>
1878
<method name="to_filename"
1879
c:identifier="pango_font_description_to_filename"
1880
doc="Creates a filename representation of a font description. The
1881
filename is identical to the result from calling
1882
pango_font_description_to_string(), but with underscores instead of
1883
characters that are untypical in filenames, and in lower case only.">
1884
<return-value transfer-ownership="full">
1885
<type name="utf8" c:type="char*"/>
1886
</return-value>
1887
</method>
1888
1830
</record>
1889
1831
<class name="FontFace"
1832
c:symbol-prefix="font_face"
1890
1833
c:type="PangoFontFace"
1891
1834
parent="GObject.Object"
1892
1835
abstract="1"
1893
1836
glib:type-name="PangoFontFace"
1894
1837
glib:get-type="pango_font_face_get_type">
1895
<method name="describe"
1896
c:identifier="pango_font_face_describe"
1897
doc="Returns the family, style, variant, weight and stretch of
1838
<method name="describe" c:identifier="pango_font_face_describe">
1839
<doc xml:whitespace="preserve">Returns the family, style, variant, weight and stretch of
1898
1840
a #PangoFontFace. The size field of the resulting font description
1899
1841
will be unset.
1900
1842
holding the description of the face. Use pango_font_description_free()
1901
to free the result.">
1843
to free the result.</doc>
1902
1844
<return-value transfer-ownership="full">
1845
<doc xml:whitespace="preserve">a newly-created #PangoFontDescription structure</doc>
1903
1846
<type name="FontDescription" c:type="PangoFontDescription*"/>
1904
1847
</return-value>
1905
1848
</method>
1906
1849
<method name="get_face_name"
1907
c:identifier="pango_font_face_get_face_name"
1908
doc="Gets a name representing the style of this face among the
1850
c:identifier="pango_font_face_get_face_name">
1851
<doc xml:whitespace="preserve">Gets a name representing the style of this face among the
1909
1852
different faces in the #PangoFontFamily for the face. This
1910
1853
name is unique among all faces in the family and is suitable
1911
1854
for displaying to users.
1912
owned by the face object and must not be modified or freed.">
1855
owned by the face object and must not be modified or freed.</doc>
1913
1856
<return-value transfer-ownership="none">
1857
<doc xml:whitespace="preserve">the face name for the face. This string is</doc>
1914
1858
<type name="utf8" c:type="char*"/>
1915
1859
</return-value>
1916
1860
</method>
1861
<method name="is_synthesized"
1862
c:identifier="pango_font_face_is_synthesized"
1863
version="1.18">
1864
<doc xml:whitespace="preserve">Returns whether a #PangoFontFace is synthesized by the underlying
1865
font rendering engine from another face, perhaps by shearing, emboldening,
1866
or lightening it.</doc>
1867
<return-value transfer-ownership="none">
1868
<doc xml:whitespace="preserve">whether @face is synthesized.</doc>
1869
<type name="gboolean" c:type="gboolean"/>
1870
</return-value>
1871
</method>
1917
1872
<method name="list_sizes"
1918
1873
c:identifier="pango_font_face_list_sizes"
1919
doc="should be freed with g_free().
1920
List the available sizes for a font. This is only applicable to bitmap
1874
version="1.4">
1875
<doc xml:whitespace="preserve">List the available sizes for a font. This is only applicable to bitmap
1921
1876
fonts. For scalable fonts, stores %NULL at the location pointed to by
1922
are in Pango units and are sorted in ascending order."
1923
version="1.4">
1877
are in Pango units and are sorted in ascending order.</doc>
1924
1878
<return-value transfer-ownership="none">
1925
1879
<type name="none" c:type="void"/>
1926
1880
</return-value>
1927
1881
<parameters>
1928
<parameter name="sizes" direction="out" transfer-ownership="full">
1929
<type name="int" c:type="int**"/>
1882
<parameter name="sizes" transfer-ownership="none">
1883
<doc xml:whitespace="preserve">location to store a pointer to an array of int. This array should be freed with g_free().</doc>
1884
<type name="gint" c:type="int**"/>
1930
1885
</parameter>
1931
<parameter name="n_sizes" direction="out" transfer-ownership="full">
1932
<type name="int" c:type="int*"/>
1886
<parameter name="n_sizes" transfer-ownership="none">
1887
<doc xml:whitespace="preserve">location to store the number of elements in @sizes</doc>
1888
<type name="gint" c:type="int*"/>
1933
1889
</parameter>
1934
1890
</parameters>
1935
1891
</method>
1936
<method name="is_synthesized"
1937
c:identifier="pango_font_face_is_synthesized"
1938
doc="Returns whether a #PangoFontFace is synthesized by the underlying
1939
font rendering engine from another face, perhaps by shearing, emboldening,
1940
or lightening it."
1941
version="1.18">
1942
<return-value transfer-ownership="none">
1943
<type name="boolean" c:type="gboolean"/>
1944
</return-value>
1945
</method>
1946
1892
</class>
1947
1893
<class name="FontFamily"
1894
c:symbol-prefix="font_family"
1948
1895
c:type="PangoFontFamily"
1949
1896
parent="GObject.Object"
1950
1897
abstract="1"
1951
1898
glib:type-name="PangoFontFamily"
1952
1899
glib:get-type="pango_font_family_get_type">
1953
<method name="list_faces"
1954
c:identifier="pango_font_family_list_faces"
1955
doc="objects, or %NULL. This array should be freed with g_free()
1956
when it is no longer needed.
1957
Lists the different font faces that make up @family. The faces
1958
in a family share a common design, but differ in slant, weight,
1959
width and other aspects.">
1960
<return-value transfer-ownership="none">
1961
<type name="none" c:type="void"/>
1962
</return-value>
1963
<parameters>
1964
<parameter name="faces" transfer-ownership="none">
1965
<type name="FontFace" c:type="PangoFontFace***"/>
1966
</parameter>
1967
<parameter name="n_faces" direction="out" transfer-ownership="full">
1968
<type name="int" c:type="int*"/>
1969
</parameter>
1970
</parameters>
1971
</method>
1972
<method name="get_name"
1973
c:identifier="pango_font_family_get_name"
1974
doc="Gets the name of the family. The name is unique among all
1900
<method name="get_name" c:identifier="pango_font_family_get_name">
1901
<doc xml:whitespace="preserve">Gets the name of the family. The name is unique among all
1975
1902
fonts for the font backend and can be used in a #PangoFontDescription
1976
1903
to specify that a face from this family is desired.
1977
by the family object and must not be modified or freed.">
1904
by the family object and must not be modified or freed.</doc>
1978
1905
<return-value transfer-ownership="none">
1906
<doc xml:whitespace="preserve">the name of the family. This string is owned</doc>
1979
1907
<type name="utf8" c:type="char*"/>
1980
1908
</return-value>
1981
1909
</method>
1982
1910
<method name="is_monospace"
1983
1911
c:identifier="pango_font_family_is_monospace"
1984
doc="A monospace font is a font designed for text display where the the
1912
version="1.4">
1913
<doc xml:whitespace="preserve">A monospace font is a font designed for text display where the the
1985
1914
characters form a regular grid. For Western languages this would
1986
1915
mean that the advance width of all characters are the same, but
1987
1916
this categorization also includes Asian fonts which include
1990
1919
The best way to find out the grid-cell size is to call
1991
1920
pango_font_metrics_get_approximate_digit_width(), since the results
1992
1921
of pango_font_metrics_get_approximate_char_width() may be affected
1993
by double-width characters."
1994
version="1.4">
1995
<return-value transfer-ownership="none">
1996
<type name="boolean" c:type="gboolean"/>
1997
</return-value>
1922
by double-width characters.</doc>
1923
<return-value transfer-ownership="none">
1924
<doc xml:whitespace="preserve">%TRUE if the family is monospace.</doc>
1925
<type name="gboolean" c:type="gboolean"/>
1926
</return-value>
1927
</method>
1928
<method name="list_faces" c:identifier="pango_font_family_list_faces">
1929
<doc xml:whitespace="preserve">Lists the different font faces that make up @family. The faces
1930
in a family share a common design, but differ in slant, weight,
1931
width and other aspects.</doc>
1932
<return-value transfer-ownership="none">
1933
<type name="none" c:type="void"/>
1934
</return-value>
1935
<parameters>
1936
<parameter name="faces" transfer-ownership="none">
1937
<doc xml:whitespace="preserve">location to store an array of pointers to #PangoFontFace objects, or %NULL. This array should be freed with g_free() when it is no longer needed.</doc>
1938
<type name="FontFace" c:type="PangoFontFace***"/>
1939
</parameter>
1940
<parameter name="n_faces" transfer-ownership="none">
1941
<doc xml:whitespace="preserve">location to store number of elements in @faces.</doc>
1942
<type name="gint" c:type="int*"/>
1943
</parameter>
1944
</parameters>
1998
1945
</method>
1999
1946
</class>
2000
1947
<class name="FontMap"
1948
c:symbol-prefix="font_map"
2001
1949
c:type="PangoFontMap"
2002
1950
parent="GObject.Object"
2003
1951
abstract="1"
2005
1953
glib:get-type="pango_font_map_get_type">
2006
1954
<method name="create_context"
2007
1955
c:identifier="pango_font_map_create_context"
2008
doc="Creates a #PangoContext connected to @fontmap. This is equivalent
1956
version="1.22"
1957
introspectable="0">
1958
<doc xml:whitespace="preserve">Creates a #PangoContext connected to @fontmap. This is equivalent
2009
1959
to pango_context_new() followed by pango_context_set_font_map().
2010
1960
If you are using Pango as part of a higher-level system,
2011
that system may have it's own way of create a #PangoContext.
1961
that system may have it's own way of create a #PangoContext.
2012
1962
For instance, the GTK+ toolkit has, among others,
2013
1963
gdk_pango_context_get_for_screen(), and
2014
1964
gtk_widget_get_pango_context(). Use those instead.
2015
be freed with g_object_unref()."
2016
version="1.22">
2017
<return-value transfer-ownership="full">
1965
be freed with g_object_unref().</doc>
1966
<return-value>
1967
<doc xml:whitespace="preserve">the newly allocated #PangoContext, which should</doc>
2018
1968
<type name="Context" c:type="PangoContext*"/>
2019
1969
</return-value>
2020
1970
</method>
1971
<method name="list_families" c:identifier="pango_font_map_list_families">
1972
<doc xml:whitespace="preserve">List all families for a fontmap.</doc>
1973
<return-value transfer-ownership="none">
1974
<type name="none" c:type="void"/>
1975
</return-value>
1976
<parameters>
1977
<parameter name="families" transfer-ownership="none">
1978
<doc xml:whitespace="preserve">location to store a pointer to an array of #PangoFontFamily *. This array should be freed with g_free().</doc>
1979
<type name="FontFamily" c:type="PangoFontFamily***"/>
1980
</parameter>
1981
<parameter name="n_families" transfer-ownership="none">
1982
<doc xml:whitespace="preserve">location to store the number of elements in @families</doc>
1983
<type name="gint" c:type="int*"/>
1984
</parameter>
1985
</parameters>
1986
</method>
2021
1987
<method name="load_font"
2022
1988
c:identifier="pango_font_map_load_font"
2023
doc="Load the font in the fontmap that is the closest match for @desc.">
2024
<return-value transfer-ownership="full">
1989
introspectable="0">
1990
<doc xml:whitespace="preserve">Load the font in the fontmap that is the closest match for @desc.</doc>
1991
<return-value>
1992
<doc xml:whitespace="preserve">the font loaded, or %NULL if no font matched.</doc>
2025
1993
<type name="Font" c:type="PangoFont*"/>
2026
1994
</return-value>
2027
1995
<parameters>
2028
1996
<parameter name="context" transfer-ownership="none">
1997
<doc xml:whitespace="preserve">the #PangoContext the font will be used with</doc>
2029
1998
<type name="Context" c:type="PangoContext*"/>
2030
1999
</parameter>
2031
2000
<parameter name="desc" transfer-ownership="none">
2001
<doc xml:whitespace="preserve">a #PangoFontDescription describing the font to load</doc>
2032
2002
<type name="FontDescription" c:type="PangoFontDescription*"/>
2033
2003
</parameter>
2034
2004
</parameters>
2035
2005
</method>
2036
2006
<method name="load_fontset"
2037
2007
c:identifier="pango_font_map_load_fontset"
2038
doc="Load a set of fonts in the fontmap that can be used to render
2039
a font matching @desc.">
2040
<return-value transfer-ownership="full">
2008
introspectable="0">
2009
<doc xml:whitespace="preserve">Load a set of fonts in the fontmap that can be used to render
2010
a font matching @desc.</doc>
2011
<return-value>
2012
<doc xml:whitespace="preserve">the fontset, or %NULL if no font matched.</doc>
2041
2013
<type name="Fontset" c:type="PangoFontset*"/>
2042
2014
</return-value>
2043
2015
<parameters>
2044
2016
<parameter name="context" transfer-ownership="none">
2017
<doc xml:whitespace="preserve">the #PangoContext the font will be used with</doc>
2045
2018
<type name="Context" c:type="PangoContext*"/>
2046
2019
</parameter>
2047
2020
<parameter name="desc" transfer-ownership="none">
2021
<doc xml:whitespace="preserve">a #PangoFontDescription describing the font to load</doc>
2048
2022
<type name="FontDescription" c:type="PangoFontDescription*"/>
2049
2023
</parameter>
2050
2024
<parameter name="language" transfer-ownership="none">
2025
<doc xml:whitespace="preserve">a #PangoLanguage the fonts will be used for</doc>
2051
2026
<type name="Language" c:type="PangoLanguage*"/>
2052
2027
</parameter>
2053
2028
</parameters>
2054
2029
</method>
2055
<method name="list_families"
2056
c:identifier="pango_font_map_list_families"
2057
doc="This array should be freed with g_free().
2058
List all families for a fontmap.">
2059
<return-value transfer-ownership="none">
2060
<type name="none" c:type="void"/>
2061
</return-value>
2062
<parameters>
2063
<parameter name="families" transfer-ownership="none">
2064
<type name="FontFamily" c:type="PangoFontFamily***"/>
2065
</parameter>
2066
<parameter name="n_families"
2067
direction="out"
2068
transfer-ownership="full">
2069
<type name="int" c:type="int*"/>
2070
</parameter>
2071
</parameters>
2072
</method>
2073
2030
</class>
2074
2031
<bitfield name="FontMask"
2075
2032
glib:type-name="PangoFontMask"
2107
2064
<record name="FontMetrics"
2108
2065
c:type="PangoFontMetrics"
2109
2066
glib:type-name="PangoFontMetrics"
2110
glib:get-type="pango_font_metrics_get_type">
2111
<method name="ref"
2112
c:identifier="pango_font_metrics_ref"
2113
doc="Increase the reference count of a font metrics structure by one.">
2114
<return-value transfer-ownership="full">
2115
<type name="FontMetrics" c:type="PangoFontMetrics*"/>
2116
</return-value>
2117
</method>
2118
<method name="unref"
2119
c:identifier="pango_font_metrics_unref"
2120
doc="Decrease the reference count of a font metrics structure by one. If
2121
the result is zero, frees the structure and any associated
2122
memory.">
2123
<return-value transfer-ownership="none">
2124
<type name="none" c:type="void"/>
2125
</return-value>
2126
</method>
2127
<method name="get_ascent"
2128
c:identifier="pango_font_metrics_get_ascent"
2129
doc="Gets the ascent from a font metrics structure. The ascent is
2130
the distance from the baseline to the logical top of a line
2131
of text. (The logical top may be above or below the top of the
2132
actual drawn ink. It is necessary to lay out the text to figure
2133
where the ink will be.)">
2134
<return-value transfer-ownership="none">
2135
<type name="int" c:type="int"/>
2136
</return-value>
2137
</method>
2138
<method name="get_descent"
2139
c:identifier="pango_font_metrics_get_descent"
2140
doc="Gets the descent from a font metrics structure. The descent is
2141
the distance from the baseline to the logical bottom of a line
2142
of text. (The logical bottom may be above or below the bottom of the
2143
actual drawn ink. It is necessary to lay out the text to figure
2144
where the ink will be.)">
2145
<return-value transfer-ownership="none">
2146
<type name="int" c:type="int"/>
2147
</return-value>
2148
</method>
2067
glib:get-type="pango_font_metrics_get_type"
2068
c:symbol-prefix="font_metrics">
2149
2069
<method name="get_approximate_char_width"
2150
c:identifier="pango_font_metrics_get_approximate_char_width"
2151
doc="Gets the approximate character width for a font metrics structure.
2070
c:identifier="pango_font_metrics_get_approximate_char_width">
2071
<doc xml:whitespace="preserve">Gets the approximate character width for a font metrics structure.
2152
2072
This is merely a representative value useful, for example, for
2153
2073
determining the initial size for a window. Actual characters in
2154
text will be wider and narrower than this.">
2074
text will be wider and narrower than this.</doc>
2155
2075
<return-value transfer-ownership="none">
2156
<type name="int" c:type="int"/>
2076
<doc xml:whitespace="preserve">the character width, in Pango units.</doc>
2077
<type name="gint" c:type="int"/>
2157
2078
</return-value>
2158
2079
</method>
2159
2080
<method name="get_approximate_digit_width"
2160
c:identifier="pango_font_metrics_get_approximate_digit_width"
2161
doc="Gets the approximate digit width for a font metrics structure.
2081
c:identifier="pango_font_metrics_get_approximate_digit_width">
2082
<doc xml:whitespace="preserve">Gets the approximate digit width for a font metrics structure.
2162
2083
This is merely a representative value useful, for example, for
2163
2084
determining the initial size for a window. Actual digits in
2164
2085
text can be wider or narrower than this, though this value
2165
2086
is generally somewhat more accurate than the result of
2166
pango_font_metrics_get_approximate_char_width() for digits.">
2167
<return-value transfer-ownership="none">
2168
<type name="int" c:type="int"/>
2087
pango_font_metrics_get_approximate_char_width() for digits.</doc>
2088
<return-value transfer-ownership="none">
2089
<doc xml:whitespace="preserve">the digit width, in Pango units.</doc>
2090
<type name="gint" c:type="int"/>
2091
</return-value>
2092
</method>
2093
<method name="get_ascent" c:identifier="pango_font_metrics_get_ascent">
2094
<doc xml:whitespace="preserve">Gets the ascent from a font metrics structure. The ascent is
2095
the distance from the baseline to the logical top of a line
2096
of text. (The logical top may be above or below the top of the
2097
actual drawn ink. It is necessary to lay out the text to figure
2098
where the ink will be.)</doc>
2099
<return-value transfer-ownership="none">
2100
<doc xml:whitespace="preserve">the ascent, in Pango units.</doc>
2101
<type name="gint" c:type="int"/>
2102
</return-value>
2103
</method>
2104
<method name="get_descent" c:identifier="pango_font_metrics_get_descent">
2105
<doc xml:whitespace="preserve">Gets the descent from a font metrics structure. The descent is
2106
the distance from the baseline to the logical bottom of a line
2107
of text. (The logical bottom may be above or below the bottom of the
2108
actual drawn ink. It is necessary to lay out the text to figure
2109
where the ink will be.)</doc>
2110
<return-value transfer-ownership="none">
2111
<doc xml:whitespace="preserve">the descent, in Pango units.</doc>
2112
<type name="gint" c:type="int"/>
2113
</return-value>
2114
</method>
2115
<method name="get_strikethrough_position"
2116
c:identifier="pango_font_metrics_get_strikethrough_position"
2117
version="1.6">
2118
<doc xml:whitespace="preserve">Gets the suggested position to draw the strikethrough.
2119
The value returned is the distance <emphasis>above</emphasis> the
2120
baseline of the top of the strikethrough.</doc>
2121
<return-value transfer-ownership="none">
2122
<doc xml:whitespace="preserve">the suggested strikethrough position, in Pango units.</doc>
2123
<type name="gint" c:type="int"/>
2124
</return-value>
2125
</method>
2126
<method name="get_strikethrough_thickness"
2127
c:identifier="pango_font_metrics_get_strikethrough_thickness"
2128
version="1.6">
2129
<doc xml:whitespace="preserve">Gets the suggested thickness to draw for the strikethrough.</doc>
2130
<return-value transfer-ownership="none">
2131
<doc xml:whitespace="preserve">the suggested strikethrough thickness, in Pango units.</doc>
2132
<type name="gint" c:type="int"/>
2169
2133
</return-value>
2170
2134
</method>
2171
2135
<method name="get_underline_position"
2172
2136
c:identifier="pango_font_metrics_get_underline_position"
2173
doc="Gets the suggested position to draw the underline.
2137
version="1.6">
2138
<doc xml:whitespace="preserve">Gets the suggested position to draw the underline.
2174
2139
The value returned is the distance <emphasis>above</emphasis> the
2175
2140
baseline of the top of the underline. Since most fonts have
2176
2141
underline positions beneath the baseline, this value is typically
2177
negative."
2178
version="1.6">
2142
negative.</doc>
2179
2143
<return-value transfer-ownership="none">
2180
<type name="int" c:type="int"/>
2144
<doc xml:whitespace="preserve">the suggested underline position, in Pango units.</doc>
2145
<type name="gint" c:type="int"/>
2181
2146
</return-value>
2182
2147
</method>
2183
2148
<method name="get_underline_thickness"
2184
2149
c:identifier="pango_font_metrics_get_underline_thickness"
2185
doc="Gets the suggested thickness to draw for the underline."
2186
version="1.6">
2187
<return-value transfer-ownership="none">
2188
<type name="int" c:type="int"/>
2189
</return-value>
2190
</method>
2191
<method name="get_strikethrough_position"
2192
c:identifier="pango_font_metrics_get_strikethrough_position"
2193
doc="Gets the suggested position to draw the strikethrough.
2194
The value returned is the distance <emphasis>above</emphasis> the
2195
baseline of the top of the strikethrough."
2196
version="1.6">
2197
<return-value transfer-ownership="none">
2198
<type name="int" c:type="int"/>
2199
</return-value>
2200
</method>
2201
<method name="get_strikethrough_thickness"
2202
c:identifier="pango_font_metrics_get_strikethrough_thickness"
2203
doc="Gets the suggested thickness to draw for the strikethrough."
2204
version="1.6">
2205
<return-value transfer-ownership="none">
2206
<type name="int" c:type="int"/>
2150
version="1.6">
2151
<doc xml:whitespace="preserve">Gets the suggested thickness to draw for the underline.</doc>
2152
<return-value transfer-ownership="none">
2153
<doc xml:whitespace="preserve">the suggested underline thickness, in Pango units.</doc>
2154
<type name="gint" c:type="int"/>
2155
</return-value>
2156
</method>
2157
<method name="ref" c:identifier="pango_font_metrics_ref">
2158
<doc xml:whitespace="preserve">Increase the reference count of a font metrics structure by one.</doc>
2159
<return-value transfer-ownership="full">
2160
<doc xml:whitespace="preserve">@metrics</doc>
2161
<type name="FontMetrics" c:type="PangoFontMetrics*"/>
2162
</return-value>
2163
</method>
2164
<method name="unref" c:identifier="pango_font_metrics_unref">
2165
<doc xml:whitespace="preserve">Decrease the reference count of a font metrics structure by one. If
2166
the result is zero, frees the structure and any associated
2167
memory.</doc>
2168
<return-value transfer-ownership="none">
2169
<type name="none" c:type="void"/>
2207
2170
</return-value>
2208
2171
</method>
2209
2172
</record>
2210
2173
<class name="Fontset"
2174
c:symbol-prefix="fontset"
2211
2175
c:type="PangoFontset"
2212
2176
parent="GObject.Object"
2213
2177
abstract="1"
2214
2178
glib:type-name="PangoFontset"
2215
2179
glib:get-type="pango_fontset_get_type">
2180
<method name="foreach"
2181
c:identifier="pango_fontset_foreach"
2182
version="1.4"
2183
introspectable="0">
2184
<doc xml:whitespace="preserve">Iterates through all the fonts in a fontset, calling @func for
2185
each one. If @func returns %TRUE, that stops the iteration.</doc>
2186
<return-value transfer-ownership="none">
2187
<type name="none" c:type="void"/>
2188
</return-value>
2189
<parameters>
2190
<parameter name="func" transfer-ownership="none" closure="1">
2191
<doc xml:whitespace="preserve">Callback function</doc>
2192
<type name="FontsetForeachFunc" c:type="PangoFontsetForeachFunc"/>
2193
</parameter>
2194
<parameter name="data" transfer-ownership="none">
2195
<doc xml:whitespace="preserve">data to pass to the callback function</doc>
2196
<type name="gpointer" c:type="gpointer"/>
2197
</parameter>
2198
</parameters>
2199
</method>
2216
2200
<method name="get_font"
2217
2201
c:identifier="pango_fontset_get_font"
2218
doc="Returns the font in the fontset that contains the best glyph for the
2202
introspectable="0">
2203
<doc xml:whitespace="preserve">Returns the font in the fontset that contains the best glyph for the
2219
2204
Unicode character @wc.
2220
with the font.">
2221
<return-value transfer-ownership="full">
2205
with the font.</doc>
2206
<return-value>
2207
<doc xml:whitespace="preserve">a #PangoFont. The caller must call g_object_unref when finished</doc>
2222
2208
<type name="Font" c:type="PangoFont*"/>
2223
2209
</return-value>
2224
2210
<parameters>
2225
2211
<parameter name="wc" transfer-ownership="none">
2226
<type name="uint" c:type="guint"/>
2212
<doc xml:whitespace="preserve">a Unicode character</doc>
2213
<type name="guint" c:type="guint"/>
2227
2214
</parameter>
2228
2215
</parameters>
2229
2216
</method>
2230
<method name="get_metrics"
2231
c:identifier="pango_fontset_get_metrics"
2232
doc="Get overall metric information for the fonts in the fontset.
2233
when finished using the object.">
2217
<method name="get_metrics" c:identifier="pango_fontset_get_metrics">
2218
<doc xml:whitespace="preserve">Get overall metric information for the fonts in the fontset.
2219
when finished using the object.</doc>
2234
2220
<return-value transfer-ownership="full">
2221
<doc xml:whitespace="preserve">a #PangoFontMetrics object. The caller must call pango_font_metrics_unref()</doc>
2235
2222
<type name="FontMetrics" c:type="PangoFontMetrics*"/>
2236
2223
</return-value>
2237
2224
</method>
2238
<method name="foreach"
2239
c:identifier="pango_fontset_foreach"
2240
doc="Iterates through all the fonts in a fontset, calling @func for
2241
each one. If @func returns %TRUE, that stops the iteration."
2242
version="1.4">
2243
<return-value transfer-ownership="none">
2244
<type name="none" c:type="void"/>
2245
</return-value>
2246
<parameters>
2247
<parameter name="func"
2248
transfer-ownership="none"
2249
scope="call"
2250
closure="2">
2251
<type name="FontsetForeachFunc" c:type="PangoFontsetForeachFunc"/>
2252
</parameter>
2253
<parameter name="data" transfer-ownership="none">
2254
<type name="any" c:type="gpointer"/>
2255
</parameter>
2256
</parameters>
2257
</method>
2258
2225
</class>
2259
2226
<callback name="FontsetForeachFunc" c:type="PangoFontsetForeachFunc">
2260
2227
<return-value transfer-ownership="none">
2261
<type name="boolean" c:type="gboolean"/>
2228
<type name="gboolean" c:type="gboolean"/>
2262
2229
</return-value>
2263
2230
<parameters>
2264
2231
<parameter name="fontset" transfer-ownership="none">
2268
2235
<type name="Font" c:type="PangoFont*"/>
2269
2236
</parameter>
2270
2237
<parameter name="data" transfer-ownership="none">
2271
<type name="any" c:type="gpointer"/>
2238
<type name="gpointer" c:type="gpointer"/>
2272
2239
</parameter>
2273
2240
</parameters>
2274
2241
</callback>
2297
2264
<record name="GlyphItem"
2298
2265
c:type="PangoGlyphItem"
2299
2266
glib:type-name="PangoGlyphItem"
2300
glib:get-type="pango_glyph_item_get_type">
2267
glib:get-type="pango_glyph_item_get_type"
2268
c:symbol-prefix="glyph_item">
2301
2269
<field name="item" writable="1">
2302
2270
<type name="Item" c:type="PangoItem*"/>
2303
2271
</field>
2304
2272
<field name="glyphs" writable="1">
2305
2273
<type name="GlyphString" c:type="PangoGlyphString*"/>
2306
2274
</field>
2307
<method name="split"
2308
c:identifier="pango_glyph_item_split"
2309
doc="Modifies @orig to cover only the text after @split_index, and
2310
returns a new item that covers the text before @split_index that
2311
used to be in @orig. You can think of @split_index as the length of
2312
the returned item. @split_index may not be 0, and it may not be
2313
greater than or equal to the length of @orig (that is, there must
2314
be at least one byte assigned to each item, you can't create a
2315
zero-length item).
2316
This function is similar in function to pango_item_split() (and uses
2317
it internally.)
2318
with pango_glyph_item_free()."
2319
version="1.2">
2320
<return-value transfer-ownership="full">
2321
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2322
</return-value>
2323
<parameters>
2324
<parameter name="text" transfer-ownership="none">
2325
<type name="utf8" c:type="char*"/>
2326
</parameter>
2327
<parameter name="split_index" transfer-ownership="none">
2328
<type name="int" c:type="int"/>
2329
</parameter>
2330
</parameters>
2331
</method>
2332
<method name="copy"
2333
c:identifier="pango_glyph_item_copy"
2334
doc="Make a deep copy of an existing #PangoGlyphItem structure.
2335
be freed with pango_glyph_item_free(), or %NULL
2336
if @orig was %NULL."
2337
version="1.20">
2338
<return-value transfer-ownership="full">
2339
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2340
</return-value>
2341
</method>
2342
<method name="free"
2343
c:identifier="pango_glyph_item_free"
2344
doc="Frees a #PangoGlyphItem and resources to which it points."
2345
version="1.6">
2346
<return-value transfer-ownership="none">
2347
<type name="none" c:type="void"/>
2348
</return-value>
2349
</method>
2350
2275
<method name="apply_attrs"
2351
2276
c:identifier="pango_glyph_item_apply_attrs"
2352
doc="Splits a shaped item (PangoGlyphItem) into multiple items based
2277
version="1.2"
2278
introspectable="0">
2279
<doc xml:whitespace="preserve">Splits a shaped item (PangoGlyphItem) into multiple items based
2353
2280
on an attribute list. The idea is that if you have attributes
2354
that don't affect shaping, such as color or underline, to avoid
2281
that don't affect shaping, such as color or underline, to avoid
2355
2282
affecting shaping, you filter them out (pango_attr_list_filter()),
2356
2283
apply the shaping process and then reapply them to the result using
2357
2284
this function.
2363
2290
result items can have multiple attributes of the same type.
2364
2291
This function takes ownership of @glyph_item; it will be reused
2365
2292
as one of the elements in the list.
2366
the list using g_slist_free()."
2367
version="1.2">
2368
<return-value transfer-ownership="full">
2369
<type name="GLib.SList" c:type="GSList*"/>
2293
the list using g_slist_free().</doc>
2294
<return-value>
2295
<doc xml:whitespace="preserve">a list of glyph items resulting from splitting</doc>
2296
<type name="GLib.SList" c:type="GSList*">
2297
<type name="gpointer" c:type="gpointer"/>
2298
</type>
2370
2299
</return-value>
2371
2300
<parameters>
2372
2301
<parameter name="text" transfer-ownership="none">
2302
<doc xml:whitespace="preserve">text that @list applies to</doc>
2373
2303
<type name="utf8" c:type="char*"/>
2374
2304
</parameter>
2375
2305
<parameter name="list" transfer-ownership="none">
2306
<doc xml:whitespace="preserve">a #PangoAttrList</doc>
2376
2307
<type name="AttrList" c:type="PangoAttrList*"/>
2377
2308
</parameter>
2378
2309
</parameters>
2379
2310
</method>
2311
<method name="copy" c:identifier="pango_glyph_item_copy" version="1.20">
2312
<doc xml:whitespace="preserve">Make a deep copy of an existing #PangoGlyphItem structure.
2313
be freed with pango_glyph_item_free(), or %NULL
2314
if @orig was %NULL.</doc>
2315
<return-value transfer-ownership="full">
2316
<doc xml:whitespace="preserve">the newly allocated #PangoGlyphItem, which should</doc>
2317
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2318
</return-value>
2319
</method>
2320
<method name="free" c:identifier="pango_glyph_item_free" version="1.6">
2321
<doc xml:whitespace="preserve">Frees a #PangoGlyphItem and resources to which it points.</doc>
2322
<return-value transfer-ownership="none">
2323
<type name="none" c:type="void"/>
2324
</return-value>
2325
</method>
2326
<method name="get_logical_widths"
2327
c:identifier="pango_glyph_item_get_logical_widths"
2328
version="1.26">
2329
<doc xml:whitespace="preserve">Given a #PangoGlyphItem and the corresponding
2330
text, determine the screen width corresponding to each character. When
2331
multiple characters compose a single cluster, the width of the entire
2332
cluster is divided equally among the characters.
2333
See also pango_glyph_string_get_logical_widths().</doc>
2334
<return-value transfer-ownership="none">
2335
<type name="none" c:type="void"/>
2336
</return-value>
2337
<parameters>
2338
<parameter name="text" transfer-ownership="none">
2339
<doc xml:whitespace="preserve">text that @glyph_item corresponds to (glyph_item->item->offset is an offset from the start of @text)</doc>
2340
<type name="utf8" c:type="char*"/>
2341
</parameter>
2342
<parameter name="logical_widths" transfer-ownership="none">
2343
<doc xml:whitespace="preserve">an array whose length is the number of characters in glyph_item (equal to glyph_item->item->num_chars) to be filled in with the resulting character widths.</doc>
2344
<type name="gint" c:type="int*"/>
2345
</parameter>
2346
</parameters>
2347
</method>
2380
2348
<method name="letter_space"
2381
2349
c:identifier="pango_glyph_item_letter_space"
2382
doc="(glyph_item->item->offset is an offset from the
2383
start of @text)
2384
first logical attribute refers to the position
2385
before the first character in the item)
2386
in Pango units. May be negative, though too large
2387
negative values will give ugly results.
2388
Adds spacing between the graphemes of @glyph_item to
2389
give the effect of typographic letter spacing."
2390
2350
version="1.6">
2351
<doc xml:whitespace="preserve">Adds spacing between the graphemes of @glyph_item to
2352
give the effect of typographic letter spacing.</doc>
2391
2353
<return-value transfer-ownership="none">
2392
2354
<type name="none" c:type="void"/>
2393
2355
</return-value>
2394
2356
<parameters>
2395
2357
<parameter name="text" transfer-ownership="none">
2358
<doc xml:whitespace="preserve">text that @glyph_item corresponds to (glyph_item->item->offset is an offset from the start of @text)</doc>
2396
2359
<type name="utf8" c:type="char*"/>
2397
2360
</parameter>
2398
2361
<parameter name="log_attrs" transfer-ownership="none">
2362
<doc xml:whitespace="preserve">logical attributes for the item (the first logical attribute refers to the position before the first character in the item)</doc>
2399
2363
<type name="LogAttr" c:type="PangoLogAttr*"/>
2400
2364
</parameter>
2401
2365
<parameter name="letter_spacing" transfer-ownership="none">
2402
<type name="int" c:type="int"/>
2366
<doc xml:whitespace="preserve">amount of letter spacing to add in Pango units. May be negative, though too large negative values will give ugly results.</doc>
2367
<type name="gint" c:type="int"/>
2403
2368
</parameter>
2404
2369
</parameters>
2405
2370
</method>
2406
<method name="get_logical_widths"
2407
c:identifier="pango_glyph_item_get_logical_widths"
2408
doc="(glyph_item->item->offset is an offset from the
2409
start of @text)
2410
glyph_item (equal to glyph_item->item->num_chars)
2411
to be filled in with the resulting character widths.
2412
Given a #PangoGlyphItem and the corresponding
2413
text, determine the screen width corresponding to each character. When
2414
multiple characters compose a single cluster, the width of the entire
2415
cluster is divided equally among the characters.
2416
See also pango_glyph_string_get_logical_widths()."
2417
version="1.26">
2418
<return-value transfer-ownership="none">
2419
<type name="none" c:type="void"/>
2371
<method name="split" c:identifier="pango_glyph_item_split" version="1.2">
2372
<doc xml:whitespace="preserve">Modifies @orig to cover only the text after @split_index, and
2373
returns a new item that covers the text before @split_index that
2374
used to be in @orig. You can think of @split_index as the length of
2375
the returned item. @split_index may not be 0, and it may not be
2376
greater than or equal to the length of @orig (that is, there must
2377
be at least one byte assigned to each item, you can't create a
2378
zero-length item).
2379
This function is similar in function to pango_item_split() (and uses
2380
it internally.)
2381
with pango_glyph_item_free().</doc>
2382
<return-value transfer-ownership="full">
2383
<doc xml:whitespace="preserve">the newly allocated item representing text before</doc>
2384
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2420
2385
</return-value>
2421
2386
<parameters>
2422
2387
<parameter name="text" transfer-ownership="none">
2388
<doc xml:whitespace="preserve">text to which positions in @orig apply</doc>
2423
2389
<type name="utf8" c:type="char*"/>
2424
2390
</parameter>
2425
<parameter name="logical_widths"
2426
direction="out"
2427
transfer-ownership="full">
2428
<type name="int" c:type="int*"/>
2391
<parameter name="split_index" transfer-ownership="none">
2392
<doc xml:whitespace="preserve">byte index of position to split item, relative to the start of the item</doc>
2393
<type name="gint" c:type="int"/>
2429
2394
</parameter>
2430
2395
</parameters>
2431
2396
</method>
2433
2398
<record name="GlyphItemIter"
2434
2399
c:type="PangoGlyphItemIter"
2435
2400
glib:type-name="PangoGlyphItemIter"
2436
glib:get-type="pango_glyph_item_iter_get_type">
2401
glib:get-type="pango_glyph_item_iter_get_type"
2402
c:symbol-prefix="glyph_item_iter">
2437
2403
<field name="glyph_item" writable="1">
2438
2404
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2439
2405
</field>
2441
2407
<type name="utf8" c:type="gchar*"/>
2442
2408
</field>
2443
2409
<field name="start_glyph" writable="1">
2444
<type name="int" c:type="int"/>
2410
<type name="gint" c:type="int"/>
2445
2411
</field>
2446
2412
<field name="start_index" writable="1">
2447
<type name="int" c:type="int"/>
2413
<type name="gint" c:type="int"/>
2448
2414
</field>
2449
2415
<field name="start_char" writable="1">
2450
<type name="int" c:type="int"/>
2416
<type name="gint" c:type="int"/>
2451
2417
</field>
2452
2418
<field name="end_glyph" writable="1">
2453
<type name="int" c:type="int"/>
2419
<type name="gint" c:type="int"/>
2454
2420
</field>
2455
2421
<field name="end_index" writable="1">
2456
<type name="int" c:type="int"/>
2422
<type name="gint" c:type="int"/>
2457
2423
</field>
2458
2424
<field name="end_char" writable="1">
2459
<type name="int" c:type="int"/>
2425
<type name="gint" c:type="int"/>
2460
2426
</field>
2461
2427
<method name="copy"
2462
2428
c:identifier="pango_glyph_item_iter_copy"
2463
doc="Make a shallow copy of an existing #PangoGlyphItemIter structure.
2429
version="1.22">
2430
<doc xml:whitespace="preserve">Make a shallow copy of an existing #PangoGlyphItemIter structure.
2464
2431
be freed with pango_glyph_item_iter_free(), or %NULL
2465
if @orig was %NULL."
2466
version="1.22">
2432
if @orig was %NULL.</doc>
2467
2433
<return-value transfer-ownership="full">
2434
<doc xml:whitespace="preserve">the newly allocated #PangoGlyphItemIter, which should</doc>
2468
2435
<type name="GlyphItemIter" c:type="PangoGlyphItemIter*"/>
2469
2436
</return-value>
2470
2437
</method>
2471
2438
<method name="free"
2472
2439
c:identifier="pango_glyph_item_iter_free"
2473
doc="Frees a #PangoGlyphItemIter created by pango_glyph_item_iter_copy()."
2474
2440
version="1.22">
2441
<doc xml:whitespace="preserve">Frees a #PangoGlyphItemIter created by pango_glyph_item_iter_copy().</doc>
2475
2442
<return-value transfer-ownership="none">
2476
2443
<type name="none" c:type="void"/>
2477
2444
</return-value>
2478
2445
</method>
2446
<method name="init_end"
2447
c:identifier="pango_glyph_item_iter_init_end"
2448
version="1.22">
2449
<doc xml:whitespace="preserve">Initializes a #PangoGlyphItemIter structure to point to the
2450
last cluster in a glyph item.
2451
See #PangoGlyphItemIter for details of cluster orders.</doc>
2452
<return-value transfer-ownership="none">
2453
<doc xml:whitespace="preserve">%FALSE if there are no clusters in the glyph item</doc>
2454
<type name="gboolean" c:type="gboolean"/>
2455
</return-value>
2456
<parameters>
2457
<parameter name="glyph_item" transfer-ownership="none">
2458
<doc xml:whitespace="preserve">the glyph item to iterate over</doc>
2459
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2460
</parameter>
2461
<parameter name="text" transfer-ownership="none">
2462
<doc xml:whitespace="preserve">text corresponding to the glyph item</doc>
2463
<type name="utf8" c:type="char*"/>
2464
</parameter>
2465
</parameters>
2466
</method>
2479
2467
<method name="init_start"
2480
2468
c:identifier="pango_glyph_item_iter_init_start"
2481
doc="Initializes a #PangoGlyphItemIter structure to point to the
2469
version="1.22">
2470
<doc xml:whitespace="preserve">Initializes a #PangoGlyphItemIter structure to point to the
2482
2471
first cluster in a glyph item.
2483
See #PangoGlyphItemIter for details of cluster orders."
2484
version="1.22">
2485
<return-value transfer-ownership="none">
2486
<type name="boolean" c:type="gboolean"/>
2487
</return-value>
2488
<parameters>
2489
<parameter name="glyph_item" transfer-ownership="none">
2490
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2491
</parameter>
2492
<parameter name="text" transfer-ownership="none">
2493
<type name="utf8" c:type="char*"/>
2494
</parameter>
2495
</parameters>
2496
</method>
2497
<method name="init_end"
2498
c:identifier="pango_glyph_item_iter_init_end"
2499
doc="Initializes a #PangoGlyphItemIter structure to point to the
2500
last cluster in a glyph item.
2501
See #PangoGlyphItemIter for details of cluster orders."
2502
version="1.22">
2503
<return-value transfer-ownership="none">
2504
<type name="boolean" c:type="gboolean"/>
2505
</return-value>
2506
<parameters>
2507
<parameter name="glyph_item" transfer-ownership="none">
2508
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2509
</parameter>
2510
<parameter name="text" transfer-ownership="none">
2472
See #PangoGlyphItemIter for details of cluster orders.</doc>
2473
<return-value transfer-ownership="none">
2474
<doc xml:whitespace="preserve">%FALSE if there are no clusters in the glyph item</doc>
2475
<type name="gboolean" c:type="gboolean"/>
2476
</return-value>
2477
<parameters>
2478
<parameter name="glyph_item" transfer-ownership="none">
2479
<doc xml:whitespace="preserve">the glyph item to iterate over</doc>
2480
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
2481
</parameter>
2482
<parameter name="text" transfer-ownership="none">
2483
<doc xml:whitespace="preserve">text corresponding to the glyph item</doc>
2511
2484
<type name="utf8" c:type="char*"/>
2512
2485
</parameter>
2513
2486
</parameters>
2514
2487
</method>
2515
2488
<method name="next_cluster"
2516
2489
c:identifier="pango_glyph_item_iter_next_cluster"
2517
doc="Advances the iterator to the next cluster in the glyph item.
2490
version="1.22">
2491
<doc xml:whitespace="preserve">Advances the iterator to the next cluster in the glyph item.
2518
2492
See #PangoGlyphItemIter for details of cluster orders.
2519
last cluster."
2520
version="1.22">
2493
last cluster.</doc>
2521
2494
<return-value transfer-ownership="none">
2522
<type name="boolean" c:type="gboolean"/>
2495
<doc xml:whitespace="preserve">%TRUE if the iterator was advanced, %FALSE if we were already on the</doc>
2496
<type name="gboolean" c:type="gboolean"/>
2523
2497
</return-value>
2524
2498
</method>
2525
2499
<method name="prev_cluster"
2526
2500
c:identifier="pango_glyph_item_iter_prev_cluster"
2527
doc="Moves the iterator to the preceding cluster in the glyph item.
2501
version="1.22">
2502
<doc xml:whitespace="preserve">Moves the iterator to the preceding cluster in the glyph item.
2528
2503
See #PangoGlyphItemIter for details of cluster orders.
2529
first cluster."
2530
version="1.22">
2504
first cluster.</doc>
2531
2505
<return-value transfer-ownership="none">
2532
<type name="boolean" c:type="gboolean"/>
2506
<doc xml:whitespace="preserve">%TRUE if the iterator was moved, %FALSE if we were already on the</doc>
2507
<type name="gboolean" c:type="gboolean"/>
2533
2508
</return-value>
2534
2509
</method>
2535
2510
</record>
2536
2511
<record name="GlyphString"
2537
2512
c:type="PangoGlyphString"
2538
2513
glib:type-name="PangoGlyphString"
2539
glib:get-type="pango_glyph_string_get_type">
2514
glib:get-type="pango_glyph_string_get_type"
2515
c:symbol-prefix="glyph_string">
2540
2516
<field name="num_glyphs" writable="1">
2541
<type name="int" c:type="gint"/>
2517
<type name="gint" c:type="gint"/>
2542
2518
</field>
2543
2519
<field name="glyphs" writable="1">
2544
2520
<type name="GlyphInfo" c:type="PangoGlyphInfo*"/>
2545
2521
</field>
2546
2522
<field name="log_clusters" writable="1">
2547
<type name="any" c:type="gint*"/>
2523
<type name="gint" c:type="gint*"/>
2548
2524
</field>
2549
2525
<field name="space" writable="1">
2550
<type name="int" c:type="gint"/>
2526
<type name="gint" c:type="gint"/>
2551
2527
</field>
2552
<constructor name="new"
2553
c:identifier="pango_glyph_string_new"
2554
doc="Create a new #PangoGlyphString.
2555
should be freed with pango_glyph_string_free().">
2528
<constructor name="new" c:identifier="pango_glyph_string_new">
2529
<doc xml:whitespace="preserve">Create a new #PangoGlyphString.
2530
should be freed with pango_glyph_string_free().</doc>
2556
2531
<return-value transfer-ownership="full">
2532
<doc xml:whitespace="preserve">the newly allocated #PangoGlyphString, which</doc>
2557
2533
<type name="GlyphString" c:type="PangoGlyphString*"/>
2558
2534
</return-value>
2559
2535
</constructor>
2560
<method name="set_size"
2561
c:identifier="pango_glyph_string_set_size"
2562
doc="Resize a glyph string to the given length.">
2563
<return-value transfer-ownership="none">
2564
<type name="none" c:type="void"/>
2565
</return-value>
2566
<parameters>
2567
<parameter name="new_len" transfer-ownership="none">
2568
<type name="int" c:type="gint"/>
2569
</parameter>
2570
</parameters>
2571
</method>
2572
<method name="copy"
2573
c:identifier="pango_glyph_string_copy"
2574
doc="Copy a glyph string and associated storage.
2536
<method name="copy" c:identifier="pango_glyph_string_copy">
2537
<doc xml:whitespace="preserve">Copy a glyph string and associated storage.
2575
2538
should be freed with pango_glyph_string_free(),
2576
or %NULL if @string was %NULL.">
2539
or %NULL if @string was %NULL.</doc>
2577
2540
<return-value transfer-ownership="full">
2541
<doc xml:whitespace="preserve">the newly allocated #PangoGlyphString, which</doc>
2578
2542
<type name="GlyphString" c:type="PangoGlyphString*"/>
2579
2543
</return-value>
2580
2544
</method>
2581
<method name="free"
2582
c:identifier="pango_glyph_string_free"
2583
doc="Free a glyph string and associated storage.">
2584
<return-value transfer-ownership="none">
2585
<type name="none" c:type="void"/>
2586
</return-value>
2587
</method>
2588
<method name="extents"
2589
c:identifier="pango_glyph_string_extents"
2590
doc="or %NULL to indicate that the result is not needed.
2591
or %NULL to indicate that the result is not needed.
2592
Compute the logical and ink extents of a glyph string. See the documentation
2545
<method name="extents" c:identifier="pango_glyph_string_extents">
2546
<doc xml:whitespace="preserve">Compute the logical and ink extents of a glyph string. See the documentation
2593
2547
for pango_font_get_glyph_extents() for details about the interpretation
2594
of the rectangles.">
2548
of the rectangles.</doc>
2595
2549
<return-value transfer-ownership="none">
2596
2550
<type name="none" c:type="void"/>
2597
2551
</return-value>
2598
2552
<parameters>
2599
2553
<parameter name="font" transfer-ownership="none">
2554
<doc xml:whitespace="preserve">a #PangoFont</doc>
2600
2555
<type name="Font" c:type="PangoFont*"/>
2601
2556
</parameter>
2602
2557
<parameter name="ink_rect" transfer-ownership="none">
2558
<doc xml:whitespace="preserve">rectangle used to store the extents of the glyph string as drawn or %NULL to indicate that the result is not needed.</doc>
2603
2559
<type name="Rectangle" c:type="PangoRectangle*"/>
2604
2560
</parameter>
2605
2561
<parameter name="logical_rect" transfer-ownership="none">
2562
<doc xml:whitespace="preserve">rectangle used to store the logical extents of the glyph string or %NULL to indicate that the result is not needed.</doc>
2606
2563
<type name="Rectangle" c:type="PangoRectangle*"/>
2607
2564
</parameter>
2608
2565
</parameters>
2609
2566
</method>
2610
<method name="get_width"
2611
c:identifier="pango_glyph_string_get_width"
2612
doc="Computes the logical width of the glyph string as can also be computed
2613
using pango_glyph_string_extents(). However, since this only computes the
2614
width, it's much faster. This is in fact only a convenience function that
2615
computes the sum of geometry.width for each glyph in the @glyphs."
2616
version="1.14">
2617
<return-value transfer-ownership="none">
2618
<type name="int" c:type="int"/>
2619
</return-value>
2620
</method>
2621
2567
<method name="extents_range"
2622
c:identifier="pango_glyph_string_extents_range"
2623
doc="dices such that start <= index < end)
2624
or %NULL to indicate that the result is not needed.
2568
c:identifier="pango_glyph_string_extents_range">
2569
<doc xml:whitespace="preserve">or %NULL to indicate that the result is not needed.
2625
2570
or %NULL to indicate that the result is not needed.
2626
2571
Computes the extents of a sub-portion of a glyph string. The extents are
2627
2572
relative to the start of the glyph string range (the origin of their
2628
2573
coordinate system is at the start of the range, not at the start of the entire
2629
glyph string).">
2574
glyph string).</doc>
2630
2575
<return-value transfer-ownership="none">
2631
2576
<type name="none" c:type="void"/>
2632
2577
</return-value>
2633
2578
<parameters>
2634
2579
<parameter name="start" transfer-ownership="none">
2635
<type name="int" c:type="int"/>
2580
<doc xml:whitespace="preserve">start index</doc>
2581
<type name="gint" c:type="int"/>
2636
2582
</parameter>
2637
2583
<parameter name="end" transfer-ownership="none">
2638
<type name="int" c:type="int"/>
2584
<doc xml:whitespace="preserve">end index (the range is the set of bytes with</doc>
2585
<type name="gint" c:type="int"/>
2639
2586
</parameter>
2640
2587
<parameter name="font" transfer-ownership="none">
2588
<doc xml:whitespace="preserve">a #PangoFont</doc>
2641
2589
<type name="Font" c:type="PangoFont*"/>
2642
2590
</parameter>
2643
2591
<parameter name="ink_rect" transfer-ownership="none">
2592
<doc xml:whitespace="preserve">rectangle used to store the extents of the glyph string range as drawn</doc>
2644
2593
<type name="Rectangle" c:type="PangoRectangle*"/>
2645
2594
</parameter>
2646
2595
<parameter name="logical_rect" transfer-ownership="none">
2596
<doc xml:whitespace="preserve">rectangle used to store the logical extents of the glyph string range</doc>
2647
2597
<type name="Rectangle" c:type="PangoRectangle*"/>
2648
2598
</parameter>
2649
2599
</parameters>
2650
2600
</method>
2601
<method name="free" c:identifier="pango_glyph_string_free">
2602
<doc xml:whitespace="preserve">Free a glyph string and associated storage.</doc>
2603
<return-value transfer-ownership="none">
2604
<type name="none" c:type="void"/>
2605
</return-value>
2606
</method>
2651
2607
<method name="get_logical_widths"
2652
c:identifier="pango_glyph_string_get_logical_widths"
2653
doc="text (equal to g_utf8_strlen (text, length) unless
2654
text has NUL bytes)
2655
to be filled in with the resulting character widths.
2656
Given a #PangoGlyphString resulting from pango_shape() and the corresponding
2608
c:identifier="pango_glyph_string_get_logical_widths">
2609
<doc xml:whitespace="preserve">Given a #PangoGlyphString resulting from pango_shape() and the corresponding
2657
2610
text, determine the screen width corresponding to each character. When
2658
2611
multiple characters compose a single cluster, the width of the entire
2659
2612
cluster is divided equally among the characters.
2660
See also pango_glyph_item_get_logical_widths().">
2613
See also pango_glyph_item_get_logical_widths().</doc>
2661
2614
<return-value transfer-ownership="none">
2662
2615
<type name="none" c:type="void"/>
2663
2616
</return-value>
2664
2617
<parameters>
2665
2618
<parameter name="text" transfer-ownership="none">
2619
<doc xml:whitespace="preserve">the text corresponding to the glyphs</doc>
2666
2620
<type name="utf8" c:type="char*"/>
2667
2621
</parameter>
2668
2622
<parameter name="length" transfer-ownership="none">
2669
<type name="int" c:type="int"/>
2623
<doc xml:whitespace="preserve">the length of @text, in bytes</doc>
2624
<type name="gint" c:type="int"/>
2670
2625
</parameter>
2671
2626
<parameter name="embedding_level" transfer-ownership="none">
2672
<type name="int" c:type="int"/>
2627
<doc xml:whitespace="preserve">the embedding level of the string</doc>
2628
<type name="gint" c:type="int"/>
2673
2629
</parameter>
2674
<parameter name="logical_widths"
2675
direction="out"
2676
transfer-ownership="full">
2677
<type name="int" c:type="int*"/>
2630
<parameter name="logical_widths" transfer-ownership="none">
2631
<doc xml:whitespace="preserve">an array whose length is the number of characters in text (equal to g_utf8_strlen (text, length) unless text has NUL bytes) to be filled in with the resulting character widths.</doc>
2632
<type name="gint" c:type="int*"/>
2678
2633
</parameter>
2679
2634
</parameters>
2680
2635
</method>
2681
<method name="index_to_x"
2682
c:identifier="pango_glyph_string_index_to_x"
2683
doc="or end (%TRUE) of the character.
2684
Converts from character position to x position. (X position
2636
<method name="get_width"
2637
c:identifier="pango_glyph_string_get_width"
2638
version="1.14">
2639
<doc xml:whitespace="preserve">Computes the logical width of the glyph string as can also be computed
2640
using pango_glyph_string_extents(). However, since this only computes the
2641
width, it's much faster. This is in fact only a convenience function that
2642
computes the sum of geometry.width for each glyph in the @glyphs.</doc>
2643
<return-value transfer-ownership="none">
2644
<doc xml:whitespace="preserve">the logical width of the glyph string.</doc>
2645
<type name="gint" c:type="int"/>
2646
</return-value>
2647
</method>
2648
<method name="index_to_x" c:identifier="pango_glyph_string_index_to_x">
2649
<doc xml:whitespace="preserve">Converts from character position to x position. (X position
2685
2650
is measured from the left edge of the run). Character positions
2686
are computed by dividing up each cluster into equal portions.">
2651
are computed by dividing up each cluster into equal portions.</doc>
2687
2652
<return-value transfer-ownership="none">
2688
2653
<type name="none" c:type="void"/>
2689
2654
</return-value>
2690
2655
<parameters>
2691
<parameter name="text" transfer-ownership="full">
2656
<parameter name="text" transfer-ownership="none">
2657
<doc xml:whitespace="preserve">the text for the run</doc>
2692
2658
<type name="utf8" c:type="char*"/>
2693
2659
</parameter>
2694
<parameter name="length" transfer-ownership="none" doc="in @text.">
2695
<type name="int" c:type="int"/>
2660
<parameter name="length" transfer-ownership="none">
2661
<doc xml:whitespace="preserve">the number of bytes (not characters) in @text.</doc>
2662
<type name="gint" c:type="int"/>
2696
2663
</parameter>
2697
2664
<parameter name="analysis" transfer-ownership="none">
2665
<doc xml:whitespace="preserve">the analysis information return from pango_itemize()</doc>
2698
2666
<type name="Analysis" c:type="PangoAnalysis*"/>
2699
2667
</parameter>
2700
2668
<parameter name="index_" transfer-ownership="none">
2701
<type name="int" c:type="int"/>
2669
<doc xml:whitespace="preserve">the byte index within @text</doc>
2670
<type name="gint" c:type="int"/>
2702
2671
</parameter>
2703
2672
<parameter name="trailing" transfer-ownership="none">
2704
<type name="boolean" c:type="gboolean"/>
2705
</parameter>
2706
<parameter name="x_pos" direction="out" transfer-ownership="full">
2707
<type name="int" c:type="int*"/>
2708
</parameter>
2709
</parameters>
2710
</method>
2711
<method name="x_to_index"
2712
c:identifier="pango_glyph_string_x_to_index"
2713
doc="whether the user clicked on the leading or trailing
2714
edge of the character.
2715
Convert from x offset to character position. Character positions
2673
<doc xml:whitespace="preserve">whether we should compute the result for the beginning (%FALSE) or end (%TRUE) of the character.</doc>
2674
<type name="gboolean" c:type="gboolean"/>
2675
</parameter>
2676
<parameter name="x_pos" transfer-ownership="none">
2677
<doc xml:whitespace="preserve">location to store result</doc>
2678
<type name="gint" c:type="int*"/>
2679
</parameter>
2680
</parameters>
2681
</method>
2682
<method name="set_size" c:identifier="pango_glyph_string_set_size">
2683
<doc xml:whitespace="preserve">Resize a glyph string to the given length.</doc>
2684
<return-value transfer-ownership="none">
2685
<type name="none" c:type="void"/>
2686
</return-value>
2687
<parameters>
2688
<parameter name="new_len" transfer-ownership="none">
2689
<doc xml:whitespace="preserve">the new length of the string.</doc>
2690
<type name="gint" c:type="gint"/>
2691
</parameter>
2692
</parameters>
2693
</method>
2694
<method name="x_to_index" c:identifier="pango_glyph_string_x_to_index">
2695
<doc xml:whitespace="preserve">Convert from x offset to character position. Character positions
2716
2696
are computed by dividing up each cluster into equal portions.
2717
2697
In scripts where positioning within a cluster is not allowed
2718
2698
(such as Thai), the returned value may not be a valid cursor
2719
2699
position; the caller must combine the result with the logical
2720
attributes for the text to compute the valid cursor position.">
2700
attributes for the text to compute the valid cursor position.</doc>
2721
2701
<return-value transfer-ownership="none">
2722
2702
<type name="none" c:type="void"/>
2723
2703
</return-value>
2724
2704
<parameters>
2725
<parameter name="text" transfer-ownership="full">
2705
<parameter name="text" transfer-ownership="none">
2706
<doc xml:whitespace="preserve">the text for the run</doc>
2726
2707
<type name="utf8" c:type="char*"/>
2727
2708
</parameter>
2728
<parameter name="length" transfer-ownership="none" doc="in text.">
2729
<type name="int" c:type="int"/>
2709
<parameter name="length" transfer-ownership="none">
2710
<doc xml:whitespace="preserve">the number of bytes (not characters) in text.</doc>
2711
<type name="gint" c:type="int"/>
2730
2712
</parameter>
2731
2713
<parameter name="analysis" transfer-ownership="none">
2714
<doc xml:whitespace="preserve">the analysis information return from pango_itemize()</doc>
2732
2715
<type name="Analysis" c:type="PangoAnalysis*"/>
2733
2716
</parameter>
2734
2717
<parameter name="x_pos" transfer-ownership="none">
2735
<type name="int" c:type="int"/>
2736
</parameter>
2737
<parameter name="index_" direction="out" transfer-ownership="full">
2738
<type name="int" c:type="int*"/>
2739
</parameter>
2740
<parameter name="trailing" direction="out" transfer-ownership="full">
2741
<type name="int" c:type="int*"/>
2718
<doc xml:whitespace="preserve">the x offset (in Pango units)</doc>
2719
<type name="gint" c:type="int"/>
2720
</parameter>
2721
<parameter name="index_" transfer-ownership="none">
2722
<doc xml:whitespace="preserve">location to store calculated byte index within @text</doc>
2723
<type name="gint" c:type="int*"/>
2724
</parameter>
2725
<parameter name="trailing" transfer-ownership="none">
2726
<doc xml:whitespace="preserve">location to store a boolean indicating whether the user clicked on the leading or trailing edge of the character.</doc>
2727
<type name="gint" c:type="int*"/>
2742
2728
</parameter>
2743
2729
</parameters>
2744
2730
</method>
2745
2731
</record>
2746
2732
<record name="GlyphVisAttr" c:type="PangoGlyphVisAttr">
2747
2733
<field name="is_cluster_start" writable="1" bits="1">
2748
<type name="uint" c:type="guint"/>
2734
<type name="guint" c:type="guint"/>
2749
2735
</field>
2750
2736
</record>
2751
2737
<enumeration name="Gravity"
2752
doc="The #PangoGravity type represents the orientation of glyphs in a segment
2738
version="1.16"
2739
glib:type-name="PangoGravity"
2740
glib:get-type="pango_gravity_get_type"
2741
c:type="PangoGravity">
2742
<doc xml:whitespace="preserve">The #PangoGravity type represents the orientation of glyphs in a segment
2753
2743
of text. This is useful when rendering vertical text layouts. In
2754
2744
those situations, the layout is rotated using a non-identity PangoMatrix,
2755
2745
and then glyph orientation is controlled using #PangoGravity.
2756
2746
Not every value in this enumeration makes sense for every usage of
2757
2747
#PangoGravity; for example, %PANGO_GRAVITY_AUTO only can be passed to
2758
2748
pango_context_set_base_gravity() and can only be returned by
2759
pango_context_get_base_gravity()."
2760
version="1.16"
2761
glib:type-name="PangoGravity"
2762
glib:get-type="pango_gravity_get_type"
2763
c:type="PangoGravity">
2749
pango_context_get_base_gravity().</doc>
2764
2750
<member name="south"
2765
2751
value="0"
2766
2752
c:identifier="PANGO_GRAVITY_SOUTH"
2783
2769
glib:nick="auto"/>
2784
2770
</enumeration>
2785
2771
<enumeration name="GravityHint"
2786
doc="on the base gravity and the script. This is the default.
2787
the script.
2788
Latin in East gravity), choose per-script gravity such that every script
2789
respects the line progression. This means, Latin and Arabic will take
2790
opposite gravities and both flow top-to-bottom for example.
2791
The #PangoGravityHint defines how horizontal scripts should behave in a
2792
vertical context. That is, English excerpt in a vertical paragraph for
2793
example.
2794
See #PangoGravity."
2795
2772
version="1.16"
2796
2773
glib:type-name="PangoGravityHint"
2797
2774
glib:get-type="pango_gravity_hint_get_type"
2798
2775
c:type="PangoGravityHint">
2776
<doc xml:whitespace="preserve">The #PangoGravityHint defines how horizontal scripts should behave in a
2777
vertical context. That is, English excerpt in a vertical paragraph for
2778
example.
2779
See #PangoGravity.</doc>
2799
2780
<member name="natural"
2800
2781
value="0"
2801
2782
c:identifier="PANGO_GRAVITY_HINT_NATURAL"
2812
2793
<record name="Item"
2813
2794
c:type="PangoItem"
2814
2795
glib:type-name="PangoItem"
2815
glib:get-type="pango_item_get_type">
2796
glib:get-type="pango_item_get_type"
2797
c:symbol-prefix="item">
2816
2798
<field name="offset" writable="1">
2817
<type name="int" c:type="gint"/>
2799
<type name="gint" c:type="gint"/>
2818
2800
</field>
2819
2801
<field name="length" writable="1">
2820
<type name="int" c:type="gint"/>
2802
<type name="gint" c:type="gint"/>
2821
2803
</field>
2822
2804
<field name="num_chars" writable="1">
2823
<type name="int" c:type="gint"/>
2805
<type name="gint" c:type="gint"/>
2824
2806
</field>
2825
2807
<field name="analysis" writable="1">
2826
2808
<type name="Analysis" c:type="PangoAnalysis"/>
2827
2809
</field>
2828
<constructor name="new"
2829
c:identifier="pango_item_new"
2830
doc="Creates a new #PangoItem structure initialized to default values.
2831
be freed with pango_item_free().">
2810
<constructor name="new" c:identifier="pango_item_new">
2811
<doc xml:whitespace="preserve">Creates a new #PangoItem structure initialized to default values.
2812
be freed with pango_item_free().</doc>
2832
2813
<return-value transfer-ownership="full">
2814
<doc xml:whitespace="preserve">the newly allocated #PangoItem, which should</doc>
2833
2815
<type name="Item" c:type="PangoItem*"/>
2834
2816
</return-value>
2835
2817
</constructor>
2836
<method name="copy"
2837
c:identifier="pango_item_copy"
2838
doc="Copy an existing #PangoItem structure.
2839
be freed with pango_item_free(), or %NULL if">
2818
<method name="copy" c:identifier="pango_item_copy">
2819
<doc xml:whitespace="preserve">Copy an existing #PangoItem structure.
2820
be freed with pango_item_free(), or %NULL if</doc>
2840
2821
<return-value transfer-ownership="full">
2822
<doc xml:whitespace="preserve">the newly allocated #PangoItem, which should</doc>
2841
2823
<type name="Item" c:type="PangoItem*"/>
2842
2824
</return-value>
2843
2825
</method>
2844
<method name="free"
2845
c:identifier="pango_item_free"
2846
doc="Free a #PangoItem and all associated memory.">
2826
<method name="free" c:identifier="pango_item_free">
2827
<doc xml:whitespace="preserve">Free a #PangoItem and all associated memory.</doc>
2847
2828
<return-value transfer-ownership="none">
2848
2829
<type name="none" c:type="void"/>
2849
2830
</return-value>
2850
2831
</method>
2851
<method name="split"
2852
c:identifier="pango_item_split"
2853
doc="Modifies @orig to cover only the text after @split_index, and
2832
<method name="split" c:identifier="pango_item_split">
2833
<doc xml:whitespace="preserve">Modifies @orig to cover only the text after @split_index, and
2854
2834
returns a new item that covers the text before @split_index that
2855
2835
used to be in @orig. You can think of @split_index as the length of
2856
2836
the returned item. @split_index may not be 0, and it may not be
2857
2837
greater than or equal to the length of @orig (that is, there must
2858
be at least one byte assigned to each item, you can't create a
2838
be at least one byte assigned to each item, you can't create a
2859
2839
zero-length item). @split_offset is the length of the first item in
2860
2840
chars, and must be provided because the text used to generate the
2861
item isn't available, so pango_item_split() can't count the char
2841
item isn't available, so pango_item_split() can't count the char
2862
2842
length of the split items itself.
2863
should be freed with pango_item_free().">
2843
should be freed with pango_item_free().</doc>
2864
2844
<return-value transfer-ownership="full">
2845
<doc xml:whitespace="preserve">new item representing text before @split_index, which</doc>
2865
2846
<type name="Item" c:type="PangoItem*"/>
2866
2847
</return-value>
2867
2848
<parameters>
2868
2849
<parameter name="split_index" transfer-ownership="none">
2869
<type name="int" c:type="int"/>
2850
<doc xml:whitespace="preserve">byte index of position to split item, relative to the start of the item</doc>
2851
<type name="gint" c:type="int"/>
2870
2852
</parameter>
2871
2853
<parameter name="split_offset" transfer-ownership="none">
2872
<type name="int" c:type="int"/>
2854
<doc xml:whitespace="preserve">number of chars between start of @orig and @split_index</doc>
2855
<type name="gint" c:type="int"/>
2873
2856
</parameter>
2874
2857
</parameters>
2875
2858
</method>
2877
2860
<record name="Language"
2878
2861
c:type="PangoLanguage"
2879
2862
glib:type-name="PangoLanguage"
2880
glib:get-type="pango_language_get_type">
2881
<method name="to_string"
2882
c:identifier="pango_language_to_string"
2883
doc="Gets the RFC-3066 format string representing the given language tag.
2884
Pango and should not be freed.">
2885
<return-value transfer-ownership="none">
2886
<type name="utf8" c:type="char*"/>
2887
</return-value>
2888
</method>
2863
glib:get-type="pango_language_get_type"
2864
c:symbol-prefix="language">
2889
2865
<method name="get_sample_string"
2890
c:identifier="pango_language_get_sample_string"
2891
doc="Get a string that is representative of the characters needed to
2866
c:identifier="pango_language_get_sample_string">
2867
<doc xml:whitespace="preserve">Get a string that is representative of the characters needed to
2892
2868
render a particular language.
2893
2869
The sample text may be a pangram, but is not necessarily. It is chosen to
2894
2870
be demonstrative of normal text in the language, as well as exposing font
2897
2873
If @language is %NULL, the default language as found by
2898
2874
pango_language_get_default() is used.
2899
2875
If Pango does not have a sample string for @language, the classic
2900
"The quick brown fox..." is returned. This can be detected by
2876
"The quick brown fox..." is returned. This can be detected by
2901
2877
comparing the returned pointer value to that returned for (non-existent)
2902
language code "xx". That is, compare to:
2878
language code "xx". That is, compare to:
2903
2879
<informalexample><programlisting>
2904
pango_language_get_sample_string (pango_language_from_string ("xx"))
2880
pango_language_get_sample_string (pango_language_from_string ("xx"))
2905
2881
</programlisting></informalexample>
2906
and should not be freed.">
2882
and should not be freed.</doc>
2907
2883
<return-value transfer-ownership="none">
2884
<doc xml:whitespace="preserve">the sample string. This value is owned by Pango</doc>
2908
2885
<type name="utf8" c:type="char*"/>
2909
2886
</return-value>
2910
2887
</method>
2911
<method name="matches"
2912
c:identifier="pango_language_matches"
2913
doc="%NULL is allowed and matches nothing but '*'
2914
',', or space characters.
2915
Each element must either be '*', or a RFC 3066 language range
2916
canonicalized as by pango_language_from_string()
2917
Checks if a language tag matches one of the elements in a list of
2918
language ranges. A language tag is considered to match a range
2919
in the list if the range is '*', the range is exactly the tag,
2920
or the range is a prefix of the tag, and the character after it
2921
in the tag is '-'.">
2922
<return-value transfer-ownership="none">
2923
<type name="boolean" c:type="gboolean"/>
2924
</return-value>
2925
<parameters>
2926
<parameter name="range_list" transfer-ownership="none">
2927
<type name="utf8" c:type="char*"/>
2928
</parameter>
2929
</parameters>
2930
</method>
2931
<method name="includes_script"
2932
c:identifier="pango_language_includes_script"
2933
doc="Determines if @script is one of the scripts used to
2934
write @language. The returned value is conservative;
2935
if nothing is known about the language tag @language,
2936
%TRUE will be returned, since, as far as Pango knows,
2937
This routine is used in Pango's itemization process when
2938
determining if a supplied language tag is relevant to
2939
a particular section of text. It probably is not useful for
2940
applications in most circumstances.
2941
This function uses pango_language_get_scripts() internally.
2942
to write @language or if nothing is known about @language
2943
(including the case that @language is %NULL),
2944
%FALSE otherwise."
2945
version="1.4">
2946
<return-value transfer-ownership="none">
2947
<type name="boolean" c:type="gboolean"/>
2948
</return-value>
2949
<parameters>
2950
<parameter name="script" transfer-ownership="none">
2951
<type name="Script" c:type="PangoScript"/>
2952
</parameter>
2953
</parameters>
2954
</method>
2955
2888
<method name="get_scripts"
2956
2889
c:identifier="pango_language_get_scripts"
2957
doc="Determines the scripts used to to write @language.
2890
version="1.22">
2891
<doc xml:whitespace="preserve">Determines the scripts used to to write @language.
2958
2892
If nothing is known about the language tag @language,
2959
2893
or if @language is %NULL, then %NULL is returned.
2960
2894
The list of scripts returned starts with the script that the
2973
2907
%NULL if Pango does not have any information about this
2974
2908
particular language tag (also the case if @language is %NULL).
2975
2909
The returned array is owned by Pango and should not be modified
2976
or freed."
2977
version="1.22">
2910
or freed.</doc>
2978
2911
<return-value transfer-ownership="none">
2912
<doc xml:whitespace="preserve">An array of #PangoScript values, with the</doc>
2979
2913
<type name="Script" c:type="PangoScript*"/>
2980
2914
</return-value>
2981
2915
<parameters>
2982
<parameter name="num_scripts"
2983
direction="out"
2984
transfer-ownership="full">
2985
<type name="int" c:type="int*"/>
2986
</parameter>
2987
</parameters>
2916
<parameter name="num_scripts" transfer-ownership="none">
2917
<doc xml:whitespace="preserve">location to return number of scripts, or %NULL</doc>
2918
<type name="gint" c:type="int*"/>
2919
</parameter>
2920
</parameters>
2921
</method>
2922
<method name="includes_script"
2923
c:identifier="pango_language_includes_script"
2924
version="1.4">
2925
<doc xml:whitespace="preserve">Determines if @script is one of the scripts used to
2926
write @language. The returned value is conservative;
2927
if nothing is known about the language tag @language,
2928
%TRUE will be returned, since, as far as Pango knows,
2929
This routine is used in Pango's itemization process when
2930
determining if a supplied language tag is relevant to
2931
a particular section of text. It probably is not useful for
2932
applications in most circumstances.
2933
This function uses pango_language_get_scripts() internally.
2934
to write @language or if nothing is known about @language
2935
(including the case that @language is %NULL),
2936
%FALSE otherwise.</doc>
2937
<return-value transfer-ownership="none">
2938
<doc xml:whitespace="preserve">%TRUE if @script is one of the scripts used</doc>
2939
<type name="gboolean" c:type="gboolean"/>
2940
</return-value>
2941
<parameters>
2942
<parameter name="script" transfer-ownership="none">
2943
<doc xml:whitespace="preserve">a #PangoScript</doc>
2944
<type name="Script" c:type="PangoScript"/>
2945
</parameter>
2946
</parameters>
2947
</method>
2948
<method name="matches" c:identifier="pango_language_matches">
2949
<doc xml:whitespace="preserve">Checks if a language tag matches one of the elements in a list of
2950
language ranges. A language tag is considered to match a range
2951
in the list if the range is '*', the range is exactly the tag,
2952
or the range is a prefix of the tag, and the character after it
2953
in the tag is '-'.</doc>
2954
<return-value transfer-ownership="none">
2955
<doc xml:whitespace="preserve">%TRUE if a match was found.</doc>
2956
<type name="gboolean" c:type="gboolean"/>
2957
</return-value>
2958
<parameters>
2959
<parameter name="range_list" transfer-ownership="none">
2960
<doc xml:whitespace="preserve">a list of language ranges, separated by ';', ':', ',', or space characters. Each element must either be '*', or a RFC 3066 language range canonicalized as by pango_language_from_string()</doc>
2961
<type name="utf8" c:type="char*"/>
2962
</parameter>
2963
</parameters>
2964
</method>
2965
<method name="to_string" c:identifier="pango_language_to_string">
2966
<doc xml:whitespace="preserve">Gets the RFC-3066 format string representing the given language tag.
2967
Pango and should not be freed.</doc>
2968
<return-value transfer-ownership="none">
2969
<doc xml:whitespace="preserve">a string representing the language tag. This is owned by</doc>
2970
<type name="utf8" c:type="char*"/>
2971
</return-value>
2988
2972
</method>
2989
2973
</record>
2990
2974
<class name="Layout"
2975
c:symbol-prefix="layout"
2991
2976
c:type="PangoLayout"
2992
2977
parent="GObject.Object"
2993
2978
glib:type-name="PangoLayout"
2994
2979
glib:get-type="pango_layout_get_type"
2995
2980
glib:type-struct="LayoutClass">
2996
<constructor name="new"
2997
c:identifier="pango_layout_new"
2998
doc="Create a new #PangoLayout object with attributes initialized to
2981
<constructor name="new" c:identifier="pango_layout_new">
2982
<doc xml:whitespace="preserve">Create a new #PangoLayout object with attributes initialized to
2999
2983
default values for a particular #PangoContext.
3000
2984
count of one, which should be freed with
3001
g_object_unref().">
2985
g_object_unref().</doc>
3002
2986
<return-value transfer-ownership="full">
2987
<doc xml:whitespace="preserve">the newly allocated #PangoLayout, with a reference</doc>
3003
2988
<type name="Layout" c:type="PangoLayout*"/>
3004
2989
</return-value>
3005
2990
<parameters>
3006
2991
<parameter name="context" transfer-ownership="none">
2992
<doc xml:whitespace="preserve">a #PangoContext</doc>
3007
2993
<type name="Context" c:type="PangoContext*"/>
3008
2994
</parameter>
3009
2995
</parameters>
3010
2996
</constructor>
3011
<method name="copy"
3012
c:identifier="pango_layout_copy"
3013
doc="Does a deep copy-by-value of the @src layout. The attribute list,
2997
<method name="context_changed"
2998
c:identifier="pango_layout_context_changed">
2999
<doc xml:whitespace="preserve">Forces recomputation of any state in the #PangoLayout that
3000
might depend on the layout's context. This function should
3001
be called if you make changes to the context subsequent
3002
to creating the layout.</doc>
3003
<return-value transfer-ownership="none">
3004
<type name="none" c:type="void"/>
3005
</return-value>
3006
</method>
3007
<method name="copy" c:identifier="pango_layout_copy" introspectable="0">
3008
<doc xml:whitespace="preserve">Does a deep copy-by-value of the @src layout. The attribute list,
3014
3009
tab array, and text from the original layout are all copied by
3015
3010
value.
3016
3011
count of one, which should be freed with
3017
g_object_unref().">
3012
g_object_unref().</doc>
3013
<return-value>
3014
<doc xml:whitespace="preserve">the newly allocated #PangoLayout, with a reference</doc>
3015
<type name="Layout" c:type="PangoLayout*"/>
3016
</return-value>
3017
</method>
3018
<method name="get_alignment" c:identifier="pango_layout_get_alignment">
3019
<doc xml:whitespace="preserve">positioned within the horizontal space available.</doc>
3020
<return-value transfer-ownership="none">
3021
<doc xml:whitespace="preserve">the alignment.</doc>
3022
<type name="Alignment" c:type="PangoAlignment"/>
3023
</return-value>
3024
</method>
3025
<method name="get_attributes" c:identifier="pango_layout_get_attributes">
3026
<doc xml:whitespace="preserve">Gets the attribute list for the layout, if any.</doc>
3018
3027
<return-value transfer-ownership="full">
3019
<type name="Layout" c:type="PangoLayout*"/>
3028
<doc xml:whitespace="preserve">a #PangoAttrList.</doc>
3029
<type name="AttrList" c:type="PangoAttrList*"/>
3030
</return-value>
3031
</method>
3032
<method name="get_auto_dir"
3033
c:identifier="pango_layout_get_auto_dir"
3034
version="1.4">
3035
<doc xml:whitespace="preserve">Gets whether to calculate the bidirectional base direction
3036
for the layout according to the contents of the layout.
3037
See pango_layout_set_auto_dir().
3038
is computed from the layout's contents, %FALSE otherwise.</doc>
3039
<return-value transfer-ownership="none">
3040
<doc xml:whitespace="preserve">%TRUE if the bidirectional base direction</doc>
3041
<type name="gboolean" c:type="gboolean"/>
3042
</return-value>
3043
</method>
3044
<method name="get_baseline"
3045
c:identifier="pango_layout_get_baseline"
3046
version="1.22">
3047
<doc xml:whitespace="preserve">Gets the Y position of baseline of the first line in @layout.</doc>
3048
<return-value transfer-ownership="none">
3049
<doc xml:whitespace="preserve">baseline of first line, from top of @layout.</doc>
3050
<type name="gint" c:type="int"/>
3020
3051
</return-value>
3021
3052
</method>
3022
3053
<method name="get_context"
3023
3054
c:identifier="pango_layout_get_context"
3024
doc="Retrieves the #PangoContext used for this layout.
3055
introspectable="0">
3056
<doc xml:whitespace="preserve">Retrieves the #PangoContext used for this layout.
3025
3057
have an additional refcount added, so if you want to keep
3026
a copy of this around, you must reference it yourself.">
3027
<return-value transfer-ownership="full">
3058
a copy of this around, you must reference it yourself.</doc>
3059
<return-value>
3060
<doc xml:whitespace="preserve">the #PangoContext for the layout. This does not</doc>
3028
3061
<type name="Context" c:type="PangoContext*"/>
3029
3062
</return-value>
3030
3063
</method>
3031
<method name="set_attributes"
3032
c:identifier="pango_layout_set_attributes"
3033
doc="Sets the text attributes for a layout object.
3034
References @attrs, so the caller can unref its reference.">
3035
<return-value transfer-ownership="none">
3036
<type name="none" c:type="void"/>
3037
</return-value>
3038
<parameters>
3039
<parameter name="attrs" transfer-ownership="none">
3040
<type name="AttrList" c:type="PangoAttrList*"/>
3041
</parameter>
3042
</parameters>
3043
</method>
3044
<method name="get_attributes"
3045
c:identifier="pango_layout_get_attributes"
3046
doc="Gets the attribute list for the layout, if any.">
3047
<return-value transfer-ownership="full">
3048
<type name="AttrList" c:type="PangoAttrList*"/>
3049
</return-value>
3050
</method>
3051
<method name="set_text"
3052
c:identifier="pango_layout_set_text"
3053
doc="the string is nul-terminated and the length should be
3054
calculated. The text will also be truncated on
3055
encountering a nul-termination even when @length is
3056
positive.
3057
Sets the text of the layout.
3058
Note that if you have used
3059
pango_layout_set_markup() or pango_layout_set_markup_with_accel() on
3060
the attributes set on the layout from the markup as this function does not
3061
clear attributes.">
3062
<return-value transfer-ownership="none">
3063
<type name="none" c:type="void"/>
3064
</return-value>
3065
<parameters>
3066
<parameter name="text" transfer-ownership="none">
3067
<type name="utf8" c:type="char*"/>
3068
</parameter>
3069
<parameter name="length" transfer-ownership="none">
3070
<type name="int" c:type="int"/>
3071
</parameter>
3072
</parameters>
3073
</method>
3074
<method name="get_text"
3075
c:identifier="pango_layout_get_text"
3076
doc="Gets the text in the layout. The returned text should not
3077
be freed or modified.">
3078
<return-value transfer-ownership="none">
3079
<type name="utf8" c:type="char*"/>
3080
</return-value>
3081
</method>
3082
<method name="set_markup"
3083
c:identifier="pango_layout_set_markup"
3084
doc="nul-terminated
3085
Same as pango_layout_set_markup_with_accel(), but
3086
the markup text isn't scanned for accelerators.">
3087
<return-value transfer-ownership="none">
3088
<type name="none" c:type="void"/>
3089
</return-value>
3090
<parameters>
3091
<parameter name="markup" transfer-ownership="none">
3092
<type name="utf8" c:type="char*"/>
3093
</parameter>
3094
<parameter name="length" transfer-ownership="none">
3095
<type name="int" c:type="int"/>
3096
</parameter>
3097
</parameters>
3098
</method>
3099
<method name="set_markup_with_accel"
3100
c:identifier="pango_layout_set_markup_with_accel"
3101
doc="(see <link linkend="PangoMarkupFormat">markup format</link>)
3102
nul-terminated
3103
Sets the layout text and attribute list from marked-up text (see
3104
<link linkend="PangoMarkupFormat">markup format</link>). Replaces
3105
the current text and attribute list.
3106
If @accel_marker is nonzero, the given character will mark the
3107
character following it as an accelerator. For example, @accel_marker
3108
might be an ampersand or underscore. All characters marked
3109
as an accelerator will receive a %PANGO_UNDERLINE_LOW attribute,
3110
and the first character so marked will be returned in @accel_char.
3111
Two @accel_marker characters following each other produce a single
3112
literal @accel_marker character.">
3113
<return-value transfer-ownership="none">
3114
<type name="none" c:type="void"/>
3115
</return-value>
3116
<parameters>
3117
<parameter name="markup" transfer-ownership="none">
3118
<type name="utf8" c:type="char*"/>
3119
</parameter>
3120
<parameter name="length" transfer-ownership="none">
3121
<type name="int" c:type="int"/>
3122
</parameter>
3123
<parameter name="accel_marker" transfer-ownership="none">
3124
<type name="GLib.unichar" c:type="gunichar"/>
3125
</parameter>
3126
<parameter name="accel_char" transfer-ownership="none">
3127
<type name="GLib.unichar" c:type="gunichar*"/>
3128
</parameter>
3129
</parameters>
3130
</method>
3131
<method name="set_font_description"
3132
c:identifier="pango_layout_set_font_description"
3133
doc="current font description
3134
Sets the default font description for the layout. If no font
3135
description is set on the layout, the font description from
3136
the layout's context is used.">
3137
<return-value transfer-ownership="none">
3138
<type name="none" c:type="void"/>
3139
</return-value>
3140
<parameters>
3141
<parameter name="desc" transfer-ownership="none">
3142
<type name="FontDescription" c:type="PangoFontDescription*"/>
3064
<method name="get_cursor_pos" c:identifier="pango_layout_get_cursor_pos">
3065
<doc xml:whitespace="preserve">Given an index within a layout, determines the positions that of the
3066
strong and weak cursors if the insertion point is at that
3067
index. The position of each cursor is stored as a zero-width
3068
rectangle. The strong cursor location is the location where
3069
characters of the directionality equal to the base direction of the
3070
layout are inserted. The weak cursor location is the location
3071
where characters of the directionality opposite to the base
3072
direction of the layout are inserted.</doc>
3073
<return-value transfer-ownership="none">
3074
<type name="none" c:type="void"/>
3075
</return-value>
3076
<parameters>
3077
<parameter name="index_" transfer-ownership="none">
3078
<doc xml:whitespace="preserve">the byte index of the cursor</doc>
3079
<type name="gint" c:type="int"/>
3080
</parameter>
3081
<parameter name="strong_pos" transfer-ownership="none">
3082
<doc xml:whitespace="preserve">location to store the strong cursor position (may be %NULL)</doc>
3083
<type name="Rectangle" c:type="PangoRectangle*"/>
3084
</parameter>
3085
<parameter name="weak_pos" transfer-ownership="none">
3086
<doc xml:whitespace="preserve">location to store the weak cursor position (may be %NULL)</doc>
3087
<type name="Rectangle" c:type="PangoRectangle*"/>
3088
</parameter>
3089
</parameters>
3090
</method>
3091
<method name="get_ellipsize"
3092
c:identifier="pango_layout_get_ellipsize"
3093
version="1.6">
3094
<doc xml:whitespace="preserve">Gets the type of ellipsization being performed for @layout.
3095
See pango_layout_set_ellipsize()
3096
Use pango_layout_is_ellipsized() to query whether any paragraphs
3097
were actually ellipsized.</doc>
3098
<return-value transfer-ownership="none">
3099
<doc xml:whitespace="preserve">the current ellipsization mode for @layout.</doc>
3100
<type name="EllipsizeMode" c:type="PangoEllipsizeMode"/>
3101
</return-value>
3102
</method>
3103
<method name="get_extents" c:identifier="pango_layout_get_extents">
3104
<doc xml:whitespace="preserve">Computes the logical and ink extents of @layout. Logical extents
3105
are usually what you want for positioning things. Note that both extents
3106
may have non-zero x and y. You may want to use those to offset where you
3107
render the layout. Not doing that is a very typical bug that shows up as
3108
right-to-left layouts not being correctly positioned in a layout with
3109
a set width.
3110
The extents are given in layout coordinates and in Pango units; layout
3111
coordinates begin at the top left corner of the layout.</doc>
3112
<return-value transfer-ownership="none">
3113
<type name="none" c:type="void"/>
3114
</return-value>
3115
<parameters>
3116
<parameter name="ink_rect" transfer-ownership="none">
3117
<doc xml:whitespace="preserve">rectangle used to store the extents of the layout as drawn or %NULL to indicate that the result is not needed.</doc>
3118
<type name="Rectangle" c:type="PangoRectangle*"/>
3119
</parameter>
3120
<parameter name="logical_rect" transfer-ownership="none">
3121
<doc xml:whitespace="preserve">rectangle used to store the logical extents of the layout</doc>
3122
<type name="Rectangle" c:type="PangoRectangle*"/>
3143
3123
</parameter>
3144
3124
</parameters>
3145
3125
</method>
3146
3126
<method name="get_font_description"
3147
3127
c:identifier="pango_layout_get_font_description"
3148
doc="Gets the font description for the layout, if any.
3149
or %NULL if the font description from the layout's
3128
version="1.8">
3129
<doc xml:whitespace="preserve">Gets the font description for the layout, if any.
3130
or %NULL if the font description from the layout's
3150
3131
context is inherited. This value is owned by the layout
3151
and must not be modified or freed."
3152
version="1.8">
3132
and must not be modified or freed.</doc>
3153
3133
<return-value transfer-ownership="none">
3134
<doc xml:whitespace="preserve">a pointer to the layout's font description,</doc>
3154
3135
<type name="FontDescription" c:type="PangoFontDescription*"/>
3155
3136
</return-value>
3156
3137
</method>
3157
<method name="set_width"
3158
c:identifier="pango_layout_set_width"
3159
doc="wrapping or ellipsization should be performed.
3160
Sets the width to which the lines of the #PangoLayout should wrap or">
3161
<return-value transfer-ownership="none">
3162
<type name="none" c:type="void"/>
3163
</return-value>
3164
<parameters>
3165
<parameter name="width" transfer-ownership="none">
3166
<type name="int" c:type="int"/>
3167
</parameter>
3168
</parameters>
3169
</method>
3170
<method name="get_width"
3171
c:identifier="pango_layout_get_width"
3172
doc="Gets the width to which the lines of the #PangoLayout should wrap.">
3173
<return-value transfer-ownership="none">
3174
<type name="int" c:type="int"/>
3175
</return-value>
3176
</method>
3177
<method name="set_height"
3178
c:identifier="pango_layout_set_height"
3179
doc="or desired number of lines if negative.
3180
Sets the height to which the #PangoLayout should be ellipsized at. There
3181
are two different behaviors, based on whether @height is positive or
3182
negative.
3183
If @height is positive, it will be the maximum height of the layout. Only
3184
lines would be shown that would fit, and if there is any text omitted,
3185
an ellipsis added. At least one line is included in each paragraph regardless
3186
of how small the height value is. A value of zero will render exactly one
3187
line for the entire layout.
3188
If @height is negative, it will be the (negative of) maximum number of lines per
3189
paragraph. That is, the total number of lines shown may well be more than
3190
this value if the layout contains multiple paragraphs of text.
3191
The default value of -1 means that first line of each paragraph is ellipsized.
3192
This behvaior may be changed in the future to act per layout instead of per
3193
paragraph. File a bug against pango at <ulink
3194
url="http://bugzilla.gnome.org/">http://bugzilla.gnome.org/</ulink> if your
3195
code relies on this behavior.
3196
Height setting only has effect if a positive width is set on
3197
The behavior is undefined if a height other than -1 is set and
3198
ellipsization mode is set to %PANGO_ELLIPSIZE_NONE, and may change in the
3199
future."
3200
version="1.20">
3201
<return-value transfer-ownership="none">
3202
<type name="none" c:type="void"/>
3203
</return-value>
3204
<parameters>
3205
<parameter name="height" transfer-ownership="none">
3206
<type name="int" c:type="int"/>
3207
</parameter>
3208
</parameters>
3209
</method>
3210
3138
<method name="get_height"
3211
3139
c:identifier="pango_layout_get_height"
3212
doc="Gets the height of layout used for ellipsization. See
3140
version="1.20">
3141
<doc xml:whitespace="preserve">Gets the height of layout used for ellipsization. See
3213
3142
pango_layout_set_height() for details.
3214
number of lines if negative."
3215
version="1.20">
3216
<return-value transfer-ownership="none">
3217
<type name="int" c:type="int"/>
3218
</return-value>
3219
</method>
3220
<method name="set_wrap"
3221
c:identifier="pango_layout_set_wrap"
3222
doc="Sets the wrap mode; the wrap mode only has effect if a width
3223
is set on the layout with pango_layout_set_width().
3224
To turn off wrapping, set the width to -1.">
3225
<return-value transfer-ownership="none">
3226
<type name="none" c:type="void"/>
3227
</return-value>
3228
<parameters>
3229
<parameter name="wrap" transfer-ownership="none">
3230
<type name="WrapMode" c:type="PangoWrapMode"/>
3231
</parameter>
3232
</parameters>
3233
</method>
3234
<method name="get_wrap"
3235
c:identifier="pango_layout_get_wrap"
3236
doc="Gets the wrap mode for the layout.
3143
number of lines if negative.</doc>
3144
<return-value transfer-ownership="none">
3145
<doc xml:whitespace="preserve">the height, in Pango units if positive, or</doc>
3146
<type name="gint" c:type="int"/>
3147
</return-value>
3148
</method>
3149
<method name="get_indent" c:identifier="pango_layout_get_indent">
3150
<doc xml:whitespace="preserve">Gets the paragraph indent width in Pango units. A negative value
3151
indicates a hanging indentation.</doc>
3152
<return-value transfer-ownership="none">
3153
<doc xml:whitespace="preserve">the indent in Pango units.</doc>
3154
<type name="gint" c:type="int"/>
3155
</return-value>
3156
</method>
3157
<method name="get_iter" c:identifier="pango_layout_get_iter">
3158
<doc xml:whitespace="preserve">Returns an iterator to iterate over the visual extents of the layout.
3159
pango_layout_iter_free().</doc>
3160
<return-value transfer-ownership="full">
3161
<doc xml:whitespace="preserve">the new #PangoLayoutIter that should be freed using</doc>
3162
<type name="LayoutIter" c:type="PangoLayoutIter*"/>
3163
</return-value>
3164
</method>
3165
<method name="get_justify" c:identifier="pango_layout_get_justify">
3166
<doc xml:whitespace="preserve">Gets whether each complete line should be stretched to fill the entire
3167
width of the layout.</doc>
3168
<return-value transfer-ownership="none">
3169
<doc xml:whitespace="preserve">the justify.</doc>
3170
<type name="gboolean" c:type="gboolean"/>
3171
</return-value>
3172
</method>
3173
<method name="get_line" c:identifier="pango_layout_get_line">
3174
<doc xml:whitespace="preserve">Retrieves a particular line from a #PangoLayout.
3175
Use the faster pango_layout_get_line_readonly() if you do not plan
3176
to modify the contents of the line (glyphs, glyph widths, etc.).
3177
index is out of range. This layout line can
3178
be ref'ed and retained, but will become invalid
3179
if changes are made to the #PangoLayout.</doc>
3180
<return-value transfer-ownership="full">
3181
<doc xml:whitespace="preserve">the requested #PangoLayoutLine, or %NULL if the</doc>
3182
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
3183
</return-value>
3184
<parameters>
3185
<parameter name="line" transfer-ownership="none">
3186
<doc xml:whitespace="preserve">the index of a line, which must be between 0 and <literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.</doc>
3187
<type name="gint" c:type="int"/>
3188
</parameter>
3189
</parameters>
3190
</method>
3191
<method name="get_line_count" c:identifier="pango_layout_get_line_count">
3192
<doc xml:whitespace="preserve">Retrieves the count of lines for the @layout.</doc>
3193
<return-value transfer-ownership="none">
3194
<doc xml:whitespace="preserve">the line count.</doc>
3195
<type name="gint" c:type="int"/>
3196
</return-value>
3197
</method>
3198
<method name="get_line_readonly"
3199
c:identifier="pango_layout_get_line_readonly"
3200
version="1.16">
3201
<doc xml:whitespace="preserve">Retrieves a particular line from a #PangoLayout.
3202
This is a faster alternative to pango_layout_get_line(),
3203
but the user is not expected
3204
to modify the contents of the line (glyphs, glyph widths, etc.).
3205
index is out of range. This layout line can
3206
be ref'ed and retained, but will become invalid
3207
if changes are made to the #PangoLayout.
3208
No changes should be made to the line.</doc>
3209
<return-value transfer-ownership="full">
3210
<doc xml:whitespace="preserve">the requested #PangoLayoutLine, or %NULL if the</doc>
3211
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
3212
</return-value>
3213
<parameters>
3214
<parameter name="line" transfer-ownership="none">
3215
<doc xml:whitespace="preserve">the index of a line, which must be between 0 and <literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.</doc>
3216
<type name="gint" c:type="int"/>
3217
</parameter>
3218
</parameters>
3219
</method>
3220
<method name="get_lines"
3221
c:identifier="pango_layout_get_lines"
3222
introspectable="0">
3223
<doc xml:whitespace="preserve">Returns the lines of the @layout as a list.
3224
Use the faster pango_layout_get_lines_readonly() if you do not plan
3225
to modify the contents of the lines (glyphs, glyph widths, etc.).
3226
the lines in the layout. This points to internal data of the #PangoLayout
3227
and must be used with care. It will become invalid on any change to the layout's
3228
text or properties.</doc>
3229
<return-value>
3230
<doc xml:whitespace="preserve">(transfer none): a #GSList containing</doc>
3231
<type name="GLib.SList" c:type="GSList*">
3232
<type name="LayoutLine"/>
3233
</type>
3234
</return-value>
3235
</method>
3236
<method name="get_lines_readonly"
3237
c:identifier="pango_layout_get_lines_readonly"
3238
version="1.16"
3239
introspectable="0">
3240
<doc xml:whitespace="preserve">Returns the lines of the @layout as a list.
3241
This is a faster alternative to pango_layout_get_lines(),
3242
but the user is not expected
3243
to modify the contents of the lines (glyphs, glyph widths, etc.).
3244
the lines in the layout. This points to internal data of the #PangoLayout and
3245
must be used with care. It will become invalid on any change to the layout's
3246
text or properties. No changes should be made to the lines.</doc>
3247
<return-value>
3248
<doc xml:whitespace="preserve">(transfer none): a #GSList containing</doc>
3249
<type name="GLib.SList" c:type="GSList*">
3250
<type name="LayoutLine"/>
3251
</type>
3252
</return-value>
3253
</method>
3254
<method name="get_log_attrs" c:identifier="pango_layout_get_log_attrs">
3255
<doc xml:whitespace="preserve">Retrieves an array of logical attributes for each character in
3256
the @layout.</doc>
3257
<return-value transfer-ownership="none">
3258
<type name="none" c:type="void"/>
3259
</return-value>
3260
<parameters>
3261
<parameter name="attrs" transfer-ownership="none">
3262
<doc xml:whitespace="preserve">location to store a pointer to an array of logical attributes This value must be freed with g_free().</doc>
3263
<type name="LogAttr" c:type="PangoLogAttr**"/>
3264
</parameter>
3265
<parameter name="n_attrs" transfer-ownership="none">
3266
<doc xml:whitespace="preserve">location to store the number of the attributes in the array. (The stored value will be one more than the total number of characters in the layout, since there need to be attributes corresponding to both the position before the first character and the position after the last character.)</doc>
3267
<type name="gint" c:type="gint*"/>
3268
</parameter>
3269
</parameters>
3270
</method>
3271
<method name="get_pixel_extents"
3272
c:identifier="pango_layout_get_pixel_extents">
3273
<doc xml:whitespace="preserve">Computes the logical and ink extents of @layout in device units.
3274
This function just calls pango_layout_get_extents() followed by
3275
two pango_extents_to_pixels() calls, rounding @ink_rect and @logical_rect
3276
such that the rounded rectangles fully contain the unrounded one (that is,
3277
passes them as first argument to pango_extents_to_pixels()).</doc>
3278
<return-value transfer-ownership="none">
3279
<type name="none" c:type="void"/>
3280
</return-value>
3281
<parameters>
3282
<parameter name="ink_rect" transfer-ownership="none">
3283
<doc xml:whitespace="preserve">rectangle used to store the extents of the layout as drawn or %NULL to indicate that the result is not needed.</doc>
3284
<type name="Rectangle" c:type="PangoRectangle*"/>
3285
</parameter>
3286
<parameter name="logical_rect" transfer-ownership="none">
3287
<doc xml:whitespace="preserve">rectangle used to store the logical extents of the layout or %NULL to indicate that the result is not needed.</doc>
3288
<type name="Rectangle" c:type="PangoRectangle*"/>
3289
</parameter>
3290
</parameters>
3291
</method>
3292
<method name="get_pixel_size" c:identifier="pango_layout_get_pixel_size">
3293
<doc xml:whitespace="preserve">Determines the logical width and height of a #PangoLayout
3294
in device units. (pango_layout_get_size() returns the width
3295
and height scaled by %PANGO_SCALE.) This
3296
is simply a convenience function around
3297
pango_layout_get_pixel_extents().</doc>
3298
<return-value transfer-ownership="none">
3299
<type name="none" c:type="void"/>
3300
</return-value>
3301
<parameters>
3302
<parameter name="width" transfer-ownership="none">
3303
<doc xml:whitespace="preserve">location to store the logical width, or %NULL</doc>
3304
<type name="gint" c:type="int*"/>
3305
</parameter>
3306
<parameter name="height" transfer-ownership="none">
3307
<doc xml:whitespace="preserve">location to store the logical height, or %NULL</doc>
3308
<type name="gint" c:type="int*"/>
3309
</parameter>
3310
</parameters>
3311
</method>
3312
<method name="get_single_paragraph_mode"
3313
c:identifier="pango_layout_get_single_paragraph_mode">
3314
<doc xml:whitespace="preserve">Obtains the value set by pango_layout_set_single_paragraph_mode().
3315
paragraph separator characters, %FALSE otherwise.</doc>
3316
<return-value transfer-ownership="none">
3317
<doc xml:whitespace="preserve">%TRUE if the layout does not break paragraphs at</doc>
3318
<type name="gboolean" c:type="gboolean"/>
3319
</return-value>
3320
</method>
3321
<method name="get_size" c:identifier="pango_layout_get_size">
3322
<doc xml:whitespace="preserve">Determines the logical width and height of a #PangoLayout
3323
in Pango units (device units scaled by %PANGO_SCALE). This
3324
is simply a convenience function around pango_layout_get_extents().</doc>
3325
<return-value transfer-ownership="none">
3326
<type name="none" c:type="void"/>
3327
</return-value>
3328
<parameters>
3329
<parameter name="width" transfer-ownership="none">
3330
<doc xml:whitespace="preserve">location to store the logical width, or %NULL</doc>
3331
<type name="gint" c:type="int*"/>
3332
</parameter>
3333
<parameter name="height" transfer-ownership="none">
3334
<doc xml:whitespace="preserve">location to store the logical height, or %NULL</doc>
3335
<type name="gint" c:type="int*"/>
3336
</parameter>
3337
</parameters>
3338
</method>
3339
<method name="get_spacing" c:identifier="pango_layout_get_spacing">
3340
<doc xml:whitespace="preserve">Gets the amount of spacing between the lines of the layout.</doc>
3341
<return-value transfer-ownership="none">
3342
<doc xml:whitespace="preserve">the spacing in Pango units.</doc>
3343
<type name="gint" c:type="int"/>
3344
</return-value>
3345
</method>
3346
<method name="get_tabs" c:identifier="pango_layout_get_tabs">
3347
<doc xml:whitespace="preserve">Gets the current #PangoTabArray used by this layout. If no
3348
#PangoTabArray has been set, then the default tabs are in use
3349
and %NULL is returned. Default tabs are every 8 spaces.
3350
The return value should be freed with pango_tab_array_free().</doc>
3351
<return-value transfer-ownership="full">
3352
<doc xml:whitespace="preserve">a copy of the tabs for this layout, or %NULL.</doc>
3353
<type name="TabArray" c:type="PangoTabArray*"/>
3354
</return-value>
3355
</method>
3356
<method name="get_text" c:identifier="pango_layout_get_text">
3357
<doc xml:whitespace="preserve">Gets the text in the layout. The returned text should not
3358
be freed or modified.</doc>
3359
<return-value transfer-ownership="none">
3360
<doc xml:whitespace="preserve">the text in the @layout.</doc>
3361
<type name="utf8" c:type="char*"/>
3362
</return-value>
3363
</method>
3364
<method name="get_unknown_glyphs_count"
3365
c:identifier="pango_layout_get_unknown_glyphs_count"
3366
version="1.16">
3367
<doc xml:whitespace="preserve">Counts the number unknown glyphs in @layout. That is, zero if
3368
glyphs for all characters in the layout text were found, or more
3369
than zero otherwise.
3370
This function can be used to determine if there are any fonts
3371
available to render all characters in a certain string, or when
3372
used in combination with %PANGO_ATTR_FALLBACK, to check if a
3373
certain font supports all the characters in the string.</doc>
3374
<return-value transfer-ownership="none">
3375
<doc xml:whitespace="preserve">The number of unknown glyphs in @layout.</doc>
3376
<type name="gint" c:type="int"/>
3377
</return-value>
3378
</method>
3379
<method name="get_width" c:identifier="pango_layout_get_width">
3380
<doc xml:whitespace="preserve">Gets the width to which the lines of the #PangoLayout should wrap.</doc>
3381
<return-value transfer-ownership="none">
3382
<doc xml:whitespace="preserve">the width in Pango units, or -1 if no width set.</doc>
3383
<type name="gint" c:type="int"/>
3384
</return-value>
3385
</method>
3386
<method name="get_wrap" c:identifier="pango_layout_get_wrap">
3387
<doc xml:whitespace="preserve">Gets the wrap mode for the layout.
3237
3388
Use pango_layout_is_wrapped() to query whether any paragraphs
3238
were actually wrapped.">
3239
<return-value transfer-ownership="full">
3389
were actually wrapped.</doc>
3390
<return-value transfer-ownership="none">
3391
<doc xml:whitespace="preserve">active wrap mode.</doc>
3240
3392
<type name="WrapMode" c:type="PangoWrapMode"/>
3241
3393
</return-value>
3242
3394
</method>
3395
<method name="index_to_line_x"
3396
c:identifier="pango_layout_index_to_line_x">
3397
<doc xml:whitespace="preserve">Converts from byte @index_ within the @layout to line and X position.
3398
(X position is measured from the left edge of the line)</doc>
3399
<return-value transfer-ownership="none">
3400
<type name="none" c:type="void"/>
3401
</return-value>
3402
<parameters>
3403
<parameter name="index_" transfer-ownership="none">
3404
<doc xml:whitespace="preserve">the byte index of a grapheme within the layout.</doc>
3405
<type name="gint" c:type="int"/>
3406
</parameter>
3407
<parameter name="trailing" transfer-ownership="none">
3408
<doc xml:whitespace="preserve">an integer indicating the edge of the grapheme to retrieve the position of. If 0, the trailing edge of the grapheme, if > 0, the leading of the grapheme.</doc>
3409
<type name="gboolean" c:type="gboolean"/>
3410
</parameter>
3411
<parameter name="line" transfer-ownership="none">
3412
<doc xml:whitespace="preserve">location to store resulting line index. (which will between 0 and pango_layout_get_line_count(layout) - 1)</doc>
3413
<type name="gint" c:type="int*"/>
3414
</parameter>
3415
<parameter name="x_pos" transfer-ownership="none">
3416
<doc xml:whitespace="preserve">location to store resulting position within line (%PANGO_SCALE units per device unit)</doc>
3417
<type name="gint" c:type="int*"/>
3418
</parameter>
3419
</parameters>
3420
</method>
3421
<method name="index_to_pos" c:identifier="pango_layout_index_to_pos">
3422
<doc xml:whitespace="preserve">Converts from an index within a #PangoLayout to the onscreen position
3423
corresponding to the grapheme at that index, which is represented
3424
as rectangle. Note that <literal>pos->x</literal> is always the leading
3425
edge of the grapheme and <literal>pos->x + pos->width</literal> the trailing
3426
edge of the grapheme. If the directionality of the grapheme is right-to-left,
3427
then <literal>pos->width</literal> will be negative.</doc>
3428
<return-value transfer-ownership="none">
3429
<type name="none" c:type="void"/>
3430
</return-value>
3431
<parameters>
3432
<parameter name="index_" transfer-ownership="none">
3433
<doc xml:whitespace="preserve">byte index within @layout</doc>
3434
<type name="gint" c:type="int"/>
3435
</parameter>
3436
<parameter name="pos" transfer-ownership="none">
3437
<doc xml:whitespace="preserve">rectangle in which to store the position of the grapheme</doc>
3438
<type name="Rectangle" c:type="PangoRectangle*"/>
3439
</parameter>
3440
</parameters>
3441
</method>
3442
<method name="is_ellipsized"
3443
c:identifier="pango_layout_is_ellipsized"
3444
version="1.16">
3445
<doc xml:whitespace="preserve">Queries whether the layout had to ellipsize any paragraphs.
3446
This returns %TRUE if the ellipsization mode for @layout
3447
is not %PANGO_ELLIPSIZE_NONE, a positive width is set on @layout,
3448
and there are paragraphs exceeding that width that have to be
3449
ellipsized.
3450
otherwise.</doc>
3451
<return-value transfer-ownership="none">
3452
<doc xml:whitespace="preserve">%TRUE if any paragraphs had to be ellipsized, %FALSE</doc>
3453
<type name="gboolean" c:type="gboolean"/>
3454
</return-value>
3455
</method>
3243
3456
<method name="is_wrapped"
3244
3457
c:identifier="pango_layout_is_wrapped"
3245
doc="Queries whether the layout had to wrap any paragraphs.
3458
version="1.16">
3459
<doc xml:whitespace="preserve">Queries whether the layout had to wrap any paragraphs.
3246
3460
This returns %TRUE if a positive width is set on @layout,
3247
3461
ellipsization mode of @layout is set to %PANGO_ELLIPSIZE_NONE,
3248
3462
and there are paragraphs exceeding the layout width that have
3249
3463
to be wrapped.
3250
otherwise."
3251
version="1.16">
3252
<return-value transfer-ownership="none">
3253
<type name="boolean" c:type="gboolean"/>
3254
</return-value>
3255
</method>
3256
<method name="set_indent" c:identifier="pango_layout_set_indent">
3257
<return-value transfer-ownership="none">
3258
<type name="none" c:type="void"/>
3259
</return-value>
3260
<parameters>
3261
<parameter name="indent" transfer-ownership="none">
3262
<type name="int" c:type="int"/>
3263
</parameter>
3264
</parameters>
3265
</method>
3266
<method name="get_indent"
3267
c:identifier="pango_layout_get_indent"
3268
doc="Gets the paragraph indent width in Pango units. A negative value
3269
indicates a hanging indentation.">
3270
<return-value transfer-ownership="none">
3271
<type name="int" c:type="int"/>
3272
</return-value>
3273
</method>
3274
<method name="set_spacing"
3275
c:identifier="pango_layout_set_spacing"
3276
doc="Sets the amount of spacing in Pango unit between the lines of the
3277
layout.">
3278
<return-value transfer-ownership="none">
3279
<type name="none" c:type="void"/>
3280
</return-value>
3281
<parameters>
3282
<parameter name="spacing" transfer-ownership="none">
3283
<type name="int" c:type="int"/>
3284
</parameter>
3285
</parameters>
3286
</method>
3287
<method name="get_spacing"
3288
c:identifier="pango_layout_get_spacing"
3289
doc="Gets the amount of spacing between the lines of the layout.">
3290
<return-value transfer-ownership="none">
3291
<type name="int" c:type="int"/>
3292
</return-value>
3293
</method>
3294
<method name="set_justify"
3295
c:identifier="pango_layout_set_justify"
3296
doc="Sets whether each complete line should be stretched to
3297
fill the entire width of the layout. This stretching is typically
3298
done by adding whitespace, but for some scripts (such as Arabic),
3299
the justification may be done in more complex ways, like extending
3300
the characters.
3301
Note that this setting is not implemented and so is ignored in Pango
3302
older than 1.18.">
3303
<return-value transfer-ownership="none">
3304
<type name="none" c:type="void"/>
3305
</return-value>
3306
<parameters>
3307
<parameter name="justify" transfer-ownership="none">
3308
<type name="boolean" c:type="gboolean"/>
3309
</parameter>
3310
</parameters>
3311
</method>
3312
<method name="get_justify"
3313
c:identifier="pango_layout_get_justify"
3314
doc="Gets whether each complete line should be stretched to fill the entire
3315
width of the layout.">
3316
<return-value transfer-ownership="none">
3317
<type name="boolean" c:type="gboolean"/>
3318
</return-value>
3464
otherwise.</doc>
3465
<return-value transfer-ownership="none">
3466
<doc xml:whitespace="preserve">%TRUE if any paragraphs had to be wrapped, %FALSE</doc>
3467
<type name="gboolean" c:type="gboolean"/>
3468
</return-value>
3469
</method>
3470
<method name="move_cursor_visually"
3471
c:identifier="pango_layout_move_cursor_visually">
3472
<doc xml:whitespace="preserve">Computes a new cursor position from an old position and
3473
a count of positions to move visually. If @direction is positive,
3474
then the new strong cursor position will be one position
3475
to the right of the old cursor position. If @direction is negative,
3476
then the new strong cursor position will be one position
3477
to the left of the old cursor position.
3478
In the presence of bidirectional text, the correspondence
3479
between logical and visual order will depend on the direction
3480
of the current run, and there may be jumps when the cursor
3481
is moved off of the end of a run.
3482
Motion here is in cursor positions, not in characters, so a
3483
single call to pango_layout_move_cursor_visually() may move the
3484
cursor over multiple characters when multiple characters combine
3485
to form a single grapheme.</doc>
3486
<return-value transfer-ownership="none">
3487
<type name="none" c:type="void"/>
3488
</return-value>
3489
<parameters>
3490
<parameter name="strong" transfer-ownership="none">
3491
<doc xml:whitespace="preserve">whether the moving cursor is the strong cursor or the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout.</doc>
3492
<type name="gboolean" c:type="gboolean"/>
3493
</parameter>
3494
<parameter name="old_index" transfer-ownership="none">
3495
<doc xml:whitespace="preserve">the byte index of the grapheme for the old index</doc>
3496
<type name="gint" c:type="int"/>
3497
</parameter>
3498
<parameter name="old_trailing" transfer-ownership="none">
3499
<doc xml:whitespace="preserve">if 0, the cursor was at the trailing edge of the grapheme indicated by @old_index, if > 0, the cursor was at the leading edge.</doc>
3500
<type name="gint" c:type="int"/>
3501
</parameter>
3502
<parameter name="direction" transfer-ownership="none">
3503
<doc xml:whitespace="preserve">direction to move cursor. A negative value indicates motion to the left.</doc>
3504
<type name="gint" c:type="int"/>
3505
</parameter>
3506
<parameter name="new_index" transfer-ownership="none">
3507
<doc xml:whitespace="preserve">location to store the new cursor byte index. A value of -1 indicates that the cursor has been moved off the beginning of the layout. A value of %G_MAXINT indicates that the cursor has been moved off the end of the layout.</doc>
3508
<type name="gint" c:type="int*"/>
3509
</parameter>
3510
<parameter name="new_trailing" transfer-ownership="none">
3511
<doc xml:whitespace="preserve">number of characters to move forward from the location returned for @new_index to get the position where the cursor should be displayed. This allows distinguishing the position at the beginning of one line from the position at the end of the preceding line. @new_index is always on the line where the cursor should be displayed.</doc>
3512
<type name="gint" c:type="int*"/>
3513
</parameter>
3514
</parameters>
3515
</method>
3516
<method name="set_alignment" c:identifier="pango_layout_set_alignment">
3517
<doc xml:whitespace="preserve">positioned within the horizontal space available.</doc>
3518
<return-value transfer-ownership="none">
3519
<type name="none" c:type="void"/>
3520
</return-value>
3521
<parameters>
3522
<parameter name="alignment" transfer-ownership="none">
3523
<doc xml:whitespace="preserve">the alignment</doc>
3524
<type name="Alignment" c:type="PangoAlignment"/>
3525
</parameter>
3526
</parameters>
3527
</method>
3528
<method name="set_attributes" c:identifier="pango_layout_set_attributes">
3529
<doc xml:whitespace="preserve">Sets the text attributes for a layout object.
3530
References @attrs, so the caller can unref its reference.</doc>
3531
<return-value transfer-ownership="none">
3532
<type name="none" c:type="void"/>
3533
</return-value>
3534
<parameters>
3535
<parameter name="attrs" transfer-ownership="none">
3536
<doc xml:whitespace="preserve">a #PangoAttrList, can be %NULL</doc>
3537
<type name="AttrList" c:type="PangoAttrList*"/>
3538
</parameter>
3539
</parameters>
3319
3540
</method>
3320
3541
<method name="set_auto_dir"
3321
3542
c:identifier="pango_layout_set_auto_dir"
3322
doc="from the layout's contents.
3323
Sets whether to calculate the bidirectional base direction
3543
version="1.4">
3544
<doc xml:whitespace="preserve">Sets whether to calculate the bidirectional base direction
3324
3545
for the layout according to the contents of the layout;
3325
3546
when this flag is on (the default), then paragraphs in
3326
ayout that begin with strong right-to-left characters
3327
3547
(Arabic and Hebrew principally), will have right-to-left
3328
3548
layout, paragraphs with letters from other scripts will
3329
3549
have left-to-right layout. Paragraphs with only neutral
3330
3550
characters get their direction from the surrounding paragraphs.
3331
3551
When %FALSE, the choice between left-to-right and
3332
3552
right-to-left layout is done according to the base direction
3333
of the layout's #PangoContext. (See pango_context_set_base_dir()).
3553
of the layout's #PangoContext. (See pango_context_set_base_dir()).
3334
3554
When the auto-computed direction of a paragraph differs from the
3335
3555
base direction of the context, the interpretation of
3336
%PANGO_ALIGN_LEFT and %PANGO_ALIGN_RIGHT are swapped."
3337
version="1.4">
3556
%PANGO_ALIGN_LEFT and %PANGO_ALIGN_RIGHT are swapped.</doc>
3338
3557
<return-value transfer-ownership="none">
3339
3558
<type name="none" c:type="void"/>
3340
3559
</return-value>
3341
3560
<parameters>
3342
3561
<parameter name="auto_dir" transfer-ownership="none">
3343
<type name="boolean" c:type="gboolean"/>
3344
</parameter>
3345
</parameters>
3346
</method>
3347
<method name="get_auto_dir"
3348
c:identifier="pango_layout_get_auto_dir"
3349
doc="Gets whether to calculate the bidirectional base direction
3350
for the layout according to the contents of the layout.
3351
See pango_layout_set_auto_dir().
3352
is computed from the layout's contents, %FALSE otherwise."
3353
version="1.4">
3354
<return-value transfer-ownership="none">
3355
<type name="boolean" c:type="gboolean"/>
3356
</return-value>
3357
</method>
3358
<method name="set_alignment"
3359
c:identifier="pango_layout_set_alignment"
3360
doc="positioned within the horizontal space available.">
3361
<return-value transfer-ownership="none">
3362
<type name="none" c:type="void"/>
3363
</return-value>
3364
<parameters>
3365
<parameter name="alignment" transfer-ownership="none">
3366
<type name="Alignment" c:type="PangoAlignment"/>
3367
</parameter>
3368
</parameters>
3369
</method>
3370
<method name="get_alignment"
3371
c:identifier="pango_layout_get_alignment"
3372
doc="positioned within the horizontal space available.">
3373
<return-value transfer-ownership="full">
3374
<type name="Alignment" c:type="PangoAlignment"/>
3375
</return-value>
3376
</method>
3377
<method name="set_tabs"
3378
c:identifier="pango_layout_set_tabs"
3379
doc="Sets the tabs to use for @layout, overriding the default tabs
3380
(by default, tabs are every 8 spaces). If @tabs is %NULL, the default
3381
tabs are reinstated. @tabs is copied into the layout; you must
3382
free your copy of @tabs yourself.">
3383
<return-value transfer-ownership="none">
3384
<type name="none" c:type="void"/>
3385
</return-value>
3386
<parameters>
3387
<parameter name="tabs" transfer-ownership="none">
3388
<type name="TabArray" c:type="PangoTabArray*"/>
3389
</parameter>
3390
</parameters>
3391
</method>
3392
<method name="get_tabs"
3393
c:identifier="pango_layout_get_tabs"
3394
doc="Gets the current #PangoTabArray used by this layout. If no
3395
#PangoTabArray has been set, then the default tabs are in use
3396
and %NULL is returned. Default tabs are every 8 spaces.
3397
The return value should be freed with pango_tab_array_free().">
3398
<return-value transfer-ownership="full">
3399
<type name="TabArray" c:type="PangoTabArray*"/>
3400
</return-value>
3401
</method>
3402
<method name="set_single_paragraph_mode"
3403
c:identifier="pango_layout_set_single_paragraph_mode"
3404
doc="If @setting is %TRUE, do not treat newlines and similar characters
3405
as paragraph separators; instead, keep all text in a single paragraph,
3406
and display a glyph for paragraph separator characters. Used when
3407
you want to allow editing of newlines on a single text line.">
3408
<return-value transfer-ownership="none">
3409
<type name="none" c:type="void"/>
3410
</return-value>
3411
<parameters>
3412
<parameter name="setting" transfer-ownership="none">
3413
<type name="boolean" c:type="gboolean"/>
3414
</parameter>
3415
</parameters>
3416
</method>
3417
<method name="get_single_paragraph_mode"
3418
c:identifier="pango_layout_get_single_paragraph_mode"
3419
doc="Obtains the value set by pango_layout_set_single_paragraph_mode().
3420
paragraph separator characters, %FALSE otherwise.">
3421
<return-value transfer-ownership="none">
3422
<type name="boolean" c:type="gboolean"/>
3423
</return-value>
3562
<doc xml:whitespace="preserve">if %TRUE, compute the bidirectional base direction from the layout's contents.</doc>
3563
<type name="gboolean" c:type="gboolean"/>
3564
</parameter>
3565
</parameters>
3424
3566
</method>
3425
3567
<method name="set_ellipsize"
3426
3568
c:identifier="pango_layout_set_ellipsize"
3427
doc="Sets the type of ellipsization being performed for @layout.
3569
version="1.6">
3570
<doc xml:whitespace="preserve">Sets the type of ellipsization being performed for @layout.
3428
3571
Depending on the ellipsization mode @ellipsize text is
3429
3572
removed from the start, middle, or end of text so they
3430
3573
fit within the width and height of layout set with
3433
3576
force it to be layed out in multiple paragraphs, then whether
3434
3577
each paragraph is ellipsized separately or the entire layout
3435
3578
is ellipsized as a whole depends on the set height of the layout.
3436
See pango_layout_set_height() for details."
3437
version="1.6">
3579
See pango_layout_set_height() for details.</doc>
3438
3580
<return-value transfer-ownership="none">
3439
3581
<type name="none" c:type="void"/>
3440
3582
</return-value>
3441
3583
<parameters>
3442
3584
<parameter name="ellipsize" transfer-ownership="none">
3585
<doc xml:whitespace="preserve">the new ellipsization mode for @layout</doc>
3443
3586
<type name="EllipsizeMode" c:type="PangoEllipsizeMode"/>
3444
3587
</parameter>
3445
3588
</parameters>
3446
3589
</method>
3447
<method name="get_ellipsize"
3448
c:identifier="pango_layout_get_ellipsize"
3449
doc="Gets the type of ellipsization being performed for @layout.
3450
See pango_layout_set_ellipsize()
3451
Use pango_layout_is_ellipsized() to query whether any paragraphs
3452
were actually ellipsized."
3453
version="1.6">
3454
<return-value transfer-ownership="full">
3455
<type name="EllipsizeMode" c:type="PangoEllipsizeMode"/>
3456
</return-value>
3457
</method>
3458
<method name="is_ellipsized"
3459
c:identifier="pango_layout_is_ellipsized"
3460
doc="Queries whether the layout had to ellipsize any paragraphs.
3461
This returns %TRUE if the ellipsization mode for @layout
3462
is not %PANGO_ELLIPSIZE_NONE, a positive width is set on @layout,
3463
and there are paragraphs exceeding that width that have to be
3464
ellipsized.
3465
otherwise."
3466
version="1.16">
3467
<return-value transfer-ownership="none">
3468
<type name="boolean" c:type="gboolean"/>
3469
</return-value>
3470
</method>
3471
<method name="get_unknown_glyphs_count"
3472
c:identifier="pango_layout_get_unknown_glyphs_count"
3473
doc="Counts the number unknown glyphs in @layout. That is, zero if
3474
glyphs for all characters in the layout text were found, or more
3475
than zero otherwise.
3476
This function can be used to determine if there are any fonts
3477
available to render all characters in a certain string, or when
3478
used in combination with %PANGO_ATTR_FALLBACK, to check if a
3479
certain font supports all the characters in the string."
3480
version="1.16">
3481
<return-value transfer-ownership="none">
3482
<type name="int" c:type="int"/>
3483
</return-value>
3484
</method>
3485
<method name="context_changed"
3486
c:identifier="pango_layout_context_changed"
3487
doc="Forces recomputation of any state in the #PangoLayout that
3488
might depend on the layout's context. This function should
3489
be called if you make changes to the context subsequent
3490
to creating the layout.">
3491
<return-value transfer-ownership="none">
3492
<type name="none" c:type="void"/>
3493
</return-value>
3494
</method>
3495
<method name="get_log_attrs"
3496
c:identifier="pango_layout_get_log_attrs"
3497
doc="This value must be freed with g_free().
3498
array. (The stored value will be one more than the total number
3499
of characters in the layout, since there need to be attributes
3500
corresponding to both the position before the first character
3501
and the position after the last character.)
3502
Retrieves an array of logical attributes for each character in
3503
the @layout.">
3504
<return-value transfer-ownership="none">
3505
<type name="none" c:type="void"/>
3506
</return-value>
3507
<parameters>
3508
<parameter name="attrs" transfer-ownership="none">
3509
<type name="LogAttr" c:type="PangoLogAttr**"/>
3510
</parameter>
3511
<parameter name="n_attrs" direction="out" transfer-ownership="full">
3512
<type name="int" c:type="gint*"/>
3513
</parameter>
3514
</parameters>
3515
</method>
3516
<method name="index_to_pos"
3517
c:identifier="pango_layout_index_to_pos"
3518
doc="Converts from an index within a #PangoLayout to the onscreen position
3519
corresponding to the grapheme at that index, which is represented
3520
as rectangle. Note that <literal>pos->x</literal> is always the leading
3521
edge of the grapheme and <literal>pos->x + pos->width</literal> the trailing
3522
edge of the grapheme. If the directionality of the grapheme is right-to-left,
3523
then <literal>pos->width</literal> will be negative.">
3524
<return-value transfer-ownership="none">
3525
<type name="none" c:type="void"/>
3526
</return-value>
3527
<parameters>
3528
<parameter name="index_" transfer-ownership="none">
3529
<type name="int" c:type="int"/>
3530
</parameter>
3531
<parameter name="pos" transfer-ownership="none">
3532
<type name="Rectangle" c:type="PangoRectangle*"/>
3533
</parameter>
3534
</parameters>
3535
</method>
3536
<method name="index_to_line_x"
3537
c:identifier="pango_layout_index_to_line_x"
3538
doc="position of. If 0, the trailing edge of the grapheme, if > 0,
3539
the leading of the grapheme.
3540
between 0 and pango_layout_get_line_count(layout) - 1)
3541
(%PANGO_SCALE units per device unit)
3542
Converts from byte @index_ within the @layout to line and X position.
3543
(X position is measured from the left edge of the line)">
3544
<return-value transfer-ownership="none">
3545
<type name="none" c:type="void"/>
3546
</return-value>
3547
<parameters>
3548
<parameter name="index_" transfer-ownership="none">
3549
<type name="int" c:type="int"/>
3550
</parameter>
3551
<parameter name="trailing" transfer-ownership="none">
3552
<type name="boolean" c:type="gboolean"/>
3553
</parameter>
3554
<parameter name="line" direction="out" transfer-ownership="full">
3555
<type name="int" c:type="int*"/>
3556
</parameter>
3557
<parameter name="x_pos" direction="out" transfer-ownership="full">
3558
<type name="int" c:type="int*"/>
3559
</parameter>
3560
</parameters>
3561
</method>
3562
<method name="get_cursor_pos"
3563
c:identifier="pango_layout_get_cursor_pos"
3564
doc="Given an index within a layout, determines the positions that of the
3565
strong and weak cursors if the insertion point is at that
3566
index. The position of each cursor is stored as a zero-width
3567
rectangle. The strong cursor location is the location where
3568
characters of the directionality equal to the base direction of the
3569
layout are inserted. The weak cursor location is the location
3570
where characters of the directionality opposite to the base
3571
direction of the layout are inserted.">
3572
<return-value transfer-ownership="none">
3573
<type name="none" c:type="void"/>
3574
</return-value>
3575
<parameters>
3576
<parameter name="index_" transfer-ownership="none">
3577
<type name="int" c:type="int"/>
3578
</parameter>
3579
<parameter name="strong_pos" transfer-ownership="none">
3580
<type name="Rectangle" c:type="PangoRectangle*"/>
3581
</parameter>
3582
<parameter name="weak_pos" transfer-ownership="none">
3583
<type name="Rectangle" c:type="PangoRectangle*"/>
3584
</parameter>
3585
</parameters>
3586
</method>
3587
<method name="move_cursor_visually"
3588
c:identifier="pango_layout_move_cursor_visually"
3589
doc="weak cursor. The strong cursor is the cursor corresponding
3590
to text insertion in the base direction for the layout.
3591
grapheme indicated by @old_index, if > 0, the cursor
3592
was at the leading edge.
3593
value indicates motion to the left.
3594
indicates that the cursor has been moved off the beginning
3595
of the layout. A value of %G_MAXINT indicates that
3596
the cursor has been moved off the end of the layout.
3597
for @new_index to get the position where the cursor should
3598
be displayed. This allows distinguishing the position at
3599
the beginning of one line from the position at the end
3600
of the preceding line. @new_index is always on the line
3601
where the cursor should be displayed.
3602
Computes a new cursor position from an old position and
3603
a count of positions to move visually. If @direction is positive,
3604
then the new strong cursor position will be one position
3605
to the right of the old cursor position. If @direction is negative,
3606
then the new strong cursor position will be one position
3607
to the left of the old cursor position.
3608
In the presence of bidirectional text, the correspondence
3609
between logical and visual order will depend on the direction
3610
of the current run, and there may be jumps when the cursor
3611
is moved off of the end of a run.
3612
Motion here is in cursor positions, not in characters, so a
3613
single call to pango_layout_move_cursor_visually() may move the
3614
cursor over multiple characters when multiple characters combine
3615
to form a single grapheme.">
3616
<return-value transfer-ownership="none">
3617
<type name="none" c:type="void"/>
3618
</return-value>
3619
<parameters>
3620
<parameter name="strong" transfer-ownership="none">
3621
<type name="boolean" c:type="gboolean"/>
3622
</parameter>
3623
<parameter name="old_index" transfer-ownership="none">
3624
<type name="int" c:type="int"/>
3625
</parameter>
3626
<parameter name="old_trailing" transfer-ownership="none">
3627
<type name="int" c:type="int"/>
3628
</parameter>
3629
<parameter name="direction" transfer-ownership="none">
3630
<type name="int" c:type="int"/>
3631
</parameter>
3632
<parameter name="new_index"
3633
direction="out"
3634
transfer-ownership="full">
3635
<type name="int" c:type="int*"/>
3636
</parameter>
3637
<parameter name="new_trailing"
3638
direction="out"
3639
transfer-ownership="full">
3640
<type name="int" c:type="int*"/>
3641
</parameter>
3642
</parameters>
3643
</method>
3644
<method name="xy_to_index"
3645
c:identifier="pango_layout_xy_to_index"
3646
doc="from the left edge of the layout.
3647
from the top edge of the layout
3648
in the grapheme the user clicked. It will either
3649
be zero, or the number of characters in the
3650
grapheme. 0 represents the trailing edge of the grapheme.
3651
Converts from X and Y position within a layout to the byte
3590
<method name="set_font_description"
3591
c:identifier="pango_layout_set_font_description">
3592
<doc xml:whitespace="preserve">Sets the default font description for the layout. If no font
3593
description is set on the layout, the font description from
3594
the layout's context is used.</doc>
3595
<return-value transfer-ownership="none">
3596
<type name="none" c:type="void"/>
3597
</return-value>
3598
<parameters>
3599
<parameter name="desc" transfer-ownership="none">
3600
<doc xml:whitespace="preserve">the new #PangoFontDescription, or %NULL to unset the current font description</doc>
3601
<type name="FontDescription" c:type="PangoFontDescription*"/>
3602
</parameter>
3603
</parameters>
3604
</method>
3605
<method name="set_height"
3606
c:identifier="pango_layout_set_height"
3607
version="1.20">
3608
<doc xml:whitespace="preserve">Sets the height to which the #PangoLayout should be ellipsized at. There
3609
are two different behaviors, based on whether @height is positive or
3610
negative.
3611
If @height is positive, it will be the maximum height of the layout. Only
3612
lines would be shown that would fit, and if there is any text omitted,
3613
an ellipsis added. At least one line is included in each paragraph regardless
3614
of how small the height value is. A value of zero will render exactly one
3615
line for the entire layout.
3616
If @height is negative, it will be the (negative of) maximum number of lines per
3617
paragraph. That is, the total number of lines shown may well be more than
3618
this value if the layout contains multiple paragraphs of text.
3619
The default value of -1 means that first line of each paragraph is ellipsized.
3620
This behvaior may be changed in the future to act per layout instead of per
3621
paragraph. File a bug against pango at <ulink
3622
url="http://bugzilla.gnome.org/">http://bugzilla.gnome.org/</ulink> if your
3623
code relies on this behavior.
3624
Height setting only has effect if a positive width is set on
3625
The behavior is undefined if a height other than -1 is set and
3626
ellipsization mode is set to %PANGO_ELLIPSIZE_NONE, and may change in the
3627
future.</doc>
3628
<return-value transfer-ownership="none">
3629
<type name="none" c:type="void"/>
3630
</return-value>
3631
<parameters>
3632
<parameter name="height" transfer-ownership="none">
3633
<doc xml:whitespace="preserve">the desired height of the layout in Pango units if positive, or desired number of lines if negative.</doc>
3634
<type name="gint" c:type="int"/>
3635
</parameter>
3636
</parameters>
3637
</method>
3638
<method name="set_indent" c:identifier="pango_layout_set_indent">
3639
<return-value transfer-ownership="none">
3640
<type name="none" c:type="void"/>
3641
</return-value>
3642
<parameters>
3643
<parameter name="indent" transfer-ownership="none">
3644
<type name="gint" c:type="int"/>
3645
</parameter>
3646
</parameters>
3647
</method>
3648
<method name="set_justify" c:identifier="pango_layout_set_justify">
3649
<doc xml:whitespace="preserve">Sets whether each complete line should be stretched to
3650
fill the entire width of the layout. This stretching is typically
3651
done by adding whitespace, but for some scripts (such as Arabic),
3652
the justification may be done in more complex ways, like extending
3653
the characters.
3654
Note that this setting is not implemented and so is ignored in Pango
3655
older than 1.18.</doc>
3656
<return-value transfer-ownership="none">
3657
<type name="none" c:type="void"/>
3658
</return-value>
3659
<parameters>
3660
<parameter name="justify" transfer-ownership="none">
3661
<doc xml:whitespace="preserve">whether the lines in the layout should be justified.</doc>
3662
<type name="gboolean" c:type="gboolean"/>
3663
</parameter>
3664
</parameters>
3665
</method>
3666
<method name="set_markup" c:identifier="pango_layout_set_markup">
3667
<doc xml:whitespace="preserve">Same as pango_layout_set_markup_with_accel(), but
3668
the markup text isn't scanned for accelerators.</doc>
3669
<return-value transfer-ownership="none">
3670
<type name="none" c:type="void"/>
3671
</return-value>
3672
<parameters>
3673
<parameter name="markup" transfer-ownership="none">
3674
<doc xml:whitespace="preserve">marked-up text</doc>
3675
<type name="utf8" c:type="char*"/>
3676
</parameter>
3677
<parameter name="length" transfer-ownership="none">
3678
<doc xml:whitespace="preserve">length of marked-up text in bytes, or -1 if @markup is nul-terminated</doc>
3679
<type name="gint" c:type="int"/>
3680
</parameter>
3681
</parameters>
3682
</method>
3683
<method name="set_markup_with_accel"
3684
c:identifier="pango_layout_set_markup_with_accel"
3685
introspectable="0">
3686
<doc xml:whitespace="preserve">Sets the layout text and attribute list from marked-up text (see
3687
<link linkend="PangoMarkupFormat">markup format</link>). Replaces
3688
the current text and attribute list.
3689
If @accel_marker is nonzero, the given character will mark the
3690
character following it as an accelerator. For example, @accel_marker
3691
might be an ampersand or underscore. All characters marked
3692
as an accelerator will receive a %PANGO_UNDERLINE_LOW attribute,
3693
and the first character so marked will be returned in @accel_char.
3694
Two @accel_marker characters following each other produce a single
3695
literal @accel_marker character.</doc>
3696
<return-value transfer-ownership="none">
3697
<type name="none" c:type="void"/>
3698
</return-value>
3699
<parameters>
3700
<parameter name="markup" transfer-ownership="none">
3701
<doc xml:whitespace="preserve">marked-up text (see <link linkend="PangoMarkupFormat">markup format</link>)</doc>
3702
<type name="utf8" c:type="char*"/>
3703
</parameter>
3704
<parameter name="length" transfer-ownership="none">
3705
<doc xml:whitespace="preserve">length of marked-up text in bytes, or -1 if @markup is nul-terminated</doc>
3706
<type name="gint" c:type="int"/>
3707
</parameter>
3708
<parameter name="accel_marker" transfer-ownership="none">
3709
<doc xml:whitespace="preserve">marker for accelerators in the text</doc>
3710
<type name="gunichar" c:type="gunichar"/>
3711
</parameter>
3712
<parameter name="accel_char" transfer-ownership="none">
3713
<doc xml:whitespace="preserve">return location for first located accelerator, or %NULL</doc>
3714
<type name="gunichar" c:type="gunichar*"/>
3715
</parameter>
3716
</parameters>
3717
</method>
3718
<method name="set_single_paragraph_mode"
3719
c:identifier="pango_layout_set_single_paragraph_mode">
3720
<doc xml:whitespace="preserve">If @setting is %TRUE, do not treat newlines and similar characters
3721
as paragraph separators; instead, keep all text in a single paragraph,
3722
and display a glyph for paragraph separator characters. Used when
3723
you want to allow editing of newlines on a single text line.</doc>
3724
<return-value transfer-ownership="none">
3725
<type name="none" c:type="void"/>
3726
</return-value>
3727
<parameters>
3728
<parameter name="setting" transfer-ownership="none">
3729
<doc xml:whitespace="preserve">new setting</doc>
3730
<type name="gboolean" c:type="gboolean"/>
3731
</parameter>
3732
</parameters>
3733
</method>
3734
<method name="set_spacing" c:identifier="pango_layout_set_spacing">
3735
<doc xml:whitespace="preserve">Sets the amount of spacing in Pango unit between the lines of the
3736
layout.</doc>
3737
<return-value transfer-ownership="none">
3738
<type name="none" c:type="void"/>
3739
</return-value>
3740
<parameters>
3741
<parameter name="spacing" transfer-ownership="none">
3742
<doc xml:whitespace="preserve">the amount of spacing</doc>
3743
<type name="gint" c:type="int"/>
3744
</parameter>
3745
</parameters>
3746
</method>
3747
<method name="set_tabs" c:identifier="pango_layout_set_tabs">
3748
<doc xml:whitespace="preserve">Sets the tabs to use for @layout, overriding the default tabs
3749
(by default, tabs are every 8 spaces). If @tabs is %NULL, the default
3750
tabs are reinstated. @tabs is copied into the layout; you must
3751
free your copy of @tabs yourself.</doc>
3752
<return-value transfer-ownership="none">
3753
<type name="none" c:type="void"/>
3754
</return-value>
3755
<parameters>
3756
<parameter name="tabs" transfer-ownership="none">
3757
<doc xml:whitespace="preserve">a #PangoTabArray, or %NULL</doc>
3758
<type name="TabArray" c:type="PangoTabArray*"/>
3759
</parameter>
3760
</parameters>
3761
</method>
3762
<method name="set_text" c:identifier="pango_layout_set_text">
3763
<doc xml:whitespace="preserve">Sets the text of the layout.
3764
Note that if you have used
3765
pango_layout_set_markup() or pango_layout_set_markup_with_accel() on
3766
the attributes set on the layout from the markup as this function does not
3767
clear attributes.</doc>
3768
<return-value transfer-ownership="none">
3769
<type name="none" c:type="void"/>
3770
</return-value>
3771
<parameters>
3772
<parameter name="text" transfer-ownership="none">
3773
<doc xml:whitespace="preserve">a valid UTF-8 string</doc>
3774
<type name="utf8" c:type="char*"/>
3775
</parameter>
3776
<parameter name="length" transfer-ownership="none">
3777
<doc xml:whitespace="preserve">maximum length of @text, in bytes. -1 indicates that the string is nul-terminated and the length should be calculated. The text will also be truncated on encountering a nul-termination even when @length is positive.</doc>
3778
<type name="gint" c:type="int"/>
3779
</parameter>
3780
</parameters>
3781
</method>
3782
<method name="set_width" c:identifier="pango_layout_set_width">
3783
<doc xml:whitespace="preserve">Sets the width to which the lines of the #PangoLayout should wrap or</doc>
3784
<return-value transfer-ownership="none">
3785
<type name="none" c:type="void"/>
3786
</return-value>
3787
<parameters>
3788
<parameter name="width" transfer-ownership="none">
3789
<doc xml:whitespace="preserve">the desired width in Pango units, or -1 to indicate that no wrapping or ellipsization should be performed.</doc>
3790
<type name="gint" c:type="int"/>
3791
</parameter>
3792
</parameters>
3793
</method>
3794
<method name="set_wrap" c:identifier="pango_layout_set_wrap">
3795
<doc xml:whitespace="preserve">Sets the wrap mode; the wrap mode only has effect if a width
3796
is set on the layout with pango_layout_set_width().
3797
To turn off wrapping, set the width to -1.</doc>
3798
<return-value transfer-ownership="none">
3799
<type name="none" c:type="void"/>
3800
</return-value>
3801
<parameters>
3802
<parameter name="wrap" transfer-ownership="none">
3803
<doc xml:whitespace="preserve">the wrap mode</doc>
3804
<type name="WrapMode" c:type="PangoWrapMode"/>
3805
</parameter>
3806
</parameters>
3807
</method>
3808
<method name="xy_to_index" c:identifier="pango_layout_xy_to_index">
3809
<doc xml:whitespace="preserve">Converts from X and Y position within a layout to the byte
3652
3810
index to the character at that logical position. If the
3653
3811
Y position is not inside the layout, the closest position is chosen
3654
3812
(the position will be clamped inside the layout). If the
3655
3813
X position is not within the layout, then the start or the
3656
3814
end of the line is chosen as described for pango_layout_x_to_index().
3657
3815
If either the X or Y positions were not inside the layout, then the
3658
function returns %FALSE; on an exact hit, it returns %TRUE.">
3816
function returns %FALSE; on an exact hit, it returns %TRUE.</doc>
3659
3817
<return-value transfer-ownership="none">
3660
<type name="boolean" c:type="gboolean"/>
3818
<doc xml:whitespace="preserve">%TRUE if the coordinates were inside text, %FALSE otherwise.</doc>
3819
<type name="gboolean" c:type="gboolean"/>
3661
3820
</return-value>
3662
3821
<parameters>
3663
3822
<parameter name="x" transfer-ownership="none">
3664
<type name="int" c:type="int"/>
3823
<doc xml:whitespace="preserve">the X offset (in Pango units) from the left edge of the layout.</doc>
3824
<type name="gint" c:type="int"/>
3665
3825
</parameter>
3666
3826
<parameter name="y" transfer-ownership="none">
3667
<type name="int" c:type="int"/>
3668
</parameter>
3669
<parameter name="index_" direction="out" transfer-ownership="full">
3670
<type name="int" c:type="int*"/>
3671
</parameter>
3672
<parameter name="trailing" direction="out" transfer-ownership="full">
3673
<type name="int" c:type="int*"/>
3674
</parameter>
3675
</parameters>
3676
</method>
3677
<method name="get_extents"
3678
c:identifier="pango_layout_get_extents"
3679
doc="or %NULL to indicate that the result is not needed.
3680
%NULL to indicate that the result is not needed.
3681
Computes the logical and ink extents of @layout. Logical extents
3682
are usually what you want for positioning things. Note that both extents
3683
may have non-zero x and y. You may want to use those to offset where you
3684
render the layout. Not doing that is a very typical bug that shows up as
3685
right-to-left layouts not being correctly positioned in a layout with
3686
a set width.
3687
The extents are given in layout coordinates and in Pango units; layout
3688
coordinates begin at the top left corner of the layout.">
3689
<return-value transfer-ownership="none">
3690
<type name="none" c:type="void"/>
3691
</return-value>
3692
<parameters>
3693
<parameter name="ink_rect" transfer-ownership="none">
3694
<type name="Rectangle" c:type="PangoRectangle*"/>
3695
</parameter>
3696
<parameter name="logical_rect" transfer-ownership="none">
3697
<type name="Rectangle" c:type="PangoRectangle*"/>
3698
</parameter>
3699
</parameters>
3700
</method>
3701
<method name="get_pixel_extents"
3702
c:identifier="pango_layout_get_pixel_extents"
3703
doc="or %NULL to indicate that the result is not needed.
3704
layout or %NULL to indicate that the result is not needed.
3705
Computes the logical and ink extents of @layout in device units.
3706
This function just calls pango_layout_get_extents() followed by
3707
two pango_extents_to_pixels() calls, rounding @ink_rect and @logical_rect
3708
such that the rounded rectangles fully contain the unrounded one (that is,
3709
passes them as first argument to pango_extents_to_pixels()).">
3710
<return-value transfer-ownership="none">
3711
<type name="none" c:type="void"/>
3712
</return-value>
3713
<parameters>
3714
<parameter name="ink_rect" transfer-ownership="none">
3715
<type name="Rectangle" c:type="PangoRectangle*"/>
3716
</parameter>
3717
<parameter name="logical_rect" transfer-ownership="none">
3718
<type name="Rectangle" c:type="PangoRectangle*"/>
3719
</parameter>
3720
</parameters>
3721
</method>
3722
<method name="get_size"
3723
c:identifier="pango_layout_get_size"
3724
doc="Determines the logical width and height of a #PangoLayout
3725
in Pango units (device units scaled by %PANGO_SCALE). This
3726
is simply a convenience function around pango_layout_get_extents().">
3727
<return-value transfer-ownership="none">
3728
<type name="none" c:type="void"/>
3729
</return-value>
3730
<parameters>
3731
<parameter name="width" direction="out" transfer-ownership="full">
3732
<type name="int" c:type="int*"/>
3733
</parameter>
3734
<parameter name="height" direction="out" transfer-ownership="full">
3735
<type name="int" c:type="int*"/>
3736
</parameter>
3737
</parameters>
3738
</method>
3739
<method name="get_pixel_size"
3740
c:identifier="pango_layout_get_pixel_size"
3741
doc="Determines the logical width and height of a #PangoLayout
3742
in device units. (pango_layout_get_size() returns the width
3743
and height scaled by %PANGO_SCALE.) This
3744
is simply a convenience function around
3745
pango_layout_get_pixel_extents().">
3746
<return-value transfer-ownership="none">
3747
<type name="none" c:type="void"/>
3748
</return-value>
3749
<parameters>
3750
<parameter name="width" direction="out" transfer-ownership="full">
3751
<type name="int" c:type="int*"/>
3752
</parameter>
3753
<parameter name="height" direction="out" transfer-ownership="full">
3754
<type name="int" c:type="int*"/>
3755
</parameter>
3756
</parameters>
3757
</method>
3758
<method name="get_baseline"
3759
c:identifier="pango_layout_get_baseline"
3760
doc="Gets the Y position of baseline of the first line in @layout."
3761
version="1.22">
3762
<return-value transfer-ownership="none">
3763
<type name="int" c:type="int"/>
3764
</return-value>
3765
</method>
3766
<method name="get_line_count"
3767
c:identifier="pango_layout_get_line_count"
3768
doc="Retrieves the count of lines for the @layout.">
3769
<return-value transfer-ownership="none">
3770
<type name="int" c:type="int"/>
3771
</return-value>
3772
</method>
3773
<method name="get_line"
3774
c:identifier="pango_layout_get_line"
3775
doc="<literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.
3776
Retrieves a particular line from a #PangoLayout.
3777
Use the faster pango_layout_get_line_readonly() if you do not plan
3778
to modify the contents of the line (glyphs, glyph widths, etc.).
3779
index is out of range. This layout line can
3780
be ref'ed and retained, but will become invalid
3781
if changes are made to the #PangoLayout.">
3782
<return-value transfer-ownership="full">
3783
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
3784
</return-value>
3785
<parameters>
3786
<parameter name="line" transfer-ownership="none">
3787
<type name="int" c:type="int"/>
3788
</parameter>
3789
</parameters>
3790
</method>
3791
<method name="get_line_readonly"
3792
c:identifier="pango_layout_get_line_readonly"
3793
doc="<literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.
3794
Retrieves a particular line from a #PangoLayout.
3795
This is a faster alternative to pango_layout_get_line(),
3796
but the user is not expected
3797
to modify the contents of the line (glyphs, glyph widths, etc.).
3798
index is out of range. This layout line can
3799
be ref'ed and retained, but will become invalid
3800
if changes are made to the #PangoLayout.
3801
No changes should be made to the line."
3802
version="1.16">
3803
<return-value transfer-ownership="full">
3804
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
3805
</return-value>
3806
<parameters>
3807
<parameter name="line" transfer-ownership="none">
3808
<type name="int" c:type="int"/>
3809
</parameter>
3810
</parameters>
3811
</method>
3812
<method name="get_lines"
3813
c:identifier="pango_layout_get_lines"
3814
doc="Returns the lines of the @layout as a list.
3815
Use the faster pango_layout_get_lines_readonly() if you do not plan
3816
to modify the contents of the lines (glyphs, glyph widths, etc.).
3817
the lines in the layout. This points to internal data of the #PangoLayout
3818
and must be used with care. It will become invalid on any change to the layout's
3819
text or properties.">
3820
<return-value transfer-ownership="none" doc="a #GSList containing">
3821
<type name="GLib.SList" c:type="GSList*">
3822
<type name="Pango.LayoutLine"/>
3823
</type>
3824
</return-value>
3825
</method>
3826
<method name="get_lines_readonly"
3827
c:identifier="pango_layout_get_lines_readonly"
3828
doc="Returns the lines of the @layout as a list.
3829
This is a faster alternative to pango_layout_get_lines(),
3830
but the user is not expected
3831
to modify the contents of the lines (glyphs, glyph widths, etc.).
3832
the lines in the layout. This points to internal data of the #PangoLayout and
3833
must be used with care. It will become invalid on any change to the layout's
3834
text or properties. No changes should be made to the lines."
3835
version="1.16">
3836
<return-value transfer-ownership="none" doc="a #GSList containing">
3837
<type name="GLib.SList" c:type="GSList*">
3838
<type name="Pango.LayoutLine"/>
3839
</type>
3840
</return-value>
3841
</method>
3842
<method name="get_iter"
3843
c:identifier="pango_layout_get_iter"
3844
doc="Returns an iterator to iterate over the visual extents of the layout.
3845
pango_layout_iter_free().">
3846
<return-value transfer-ownership="full">
3847
<type name="LayoutIter" c:type="PangoLayoutIter*"/>
3848
</return-value>
3849
</method>
3850
<field name="parent_instance">
3851
<type name="GObject.Object" c:type="GObject"/>
3852
</field>
3853
<field name="context">
3854
<type name="Context" c:type="PangoContext*"/>
3855
</field>
3856
<field name="attrs">
3857
<type name="AttrList" c:type="PangoAttrList*"/>
3858
</field>
3859
<field name="font_desc">
3860
<type name="FontDescription" c:type="PangoFontDescription*"/>
3861
</field>
3862
<field name="tabs">
3863
<type name="TabArray" c:type="PangoTabArray*"/>
3864
</field>
3865
<field name="text">
3866
<type name="utf8" c:type="gchar*"/>
3867
</field>
3868
<field name="copy_begin">
3869
<type name="int" c:type="int"/>
3870
</field>
3871
<field name="length">
3872
<type name="int" c:type="int"/>
3873
</field>
3874
<field name="n_chars">
3875
<type name="int" c:type="int"/>
3876
</field>
3877
<field name="width">
3878
<type name="int" c:type="int"/>
3879
</field>
3880
<field name="height">
3881
<type name="int" c:type="int"/>
3882
</field>
3883
<field name="indent">
3884
<type name="int" c:type="int"/>
3885
</field>
3886
<field name="spacing">
3887
<type name="int" c:type="int"/>
3888
</field>
3889
<field name="justify" bits="1">
3890
<type name="uint" c:type="guint"/>
3891
</field>
3892
<field name="alignment" bits="2">
3893
<type name="uint" c:type="guint"/>
3894
</field>
3895
<field name="single_paragraph" bits="1">
3896
<type name="uint" c:type="guint"/>
3897
</field>
3898
<field name="auto_dir" bits="1">
3899
<type name="uint" c:type="guint"/>
3900
</field>
3901
<field name="wrap" bits="2">
3902
<type name="uint" c:type="guint"/>
3903
</field>
3904
<field name="is_wrapped" bits="1">
3905
<type name="uint" c:type="guint"/>
3906
</field>
3907
<field name="ellipsize" bits="2">
3908
<type name="uint" c:type="guint"/>
3909
</field>
3910
<field name="is_ellipsized" bits="1">
3911
<type name="uint" c:type="guint"/>
3912
</field>
3913
<field name="unknown_glyphs_count">
3914
<type name="int" c:type="int"/>
3915
</field>
3916
<field name="logical_rect_cached" bits="1">
3917
<type name="uint" c:type="guint"/>
3918
</field>
3919
<field name="ink_rect_cached" bits="1">
3920
<type name="uint" c:type="guint"/>
3921
</field>
3922
<field name="logical_rect">
3923
<type name="Rectangle" c:type="PangoRectangle"/>
3924
</field>
3925
<field name="ink_rect">
3926
<type name="Rectangle" c:type="PangoRectangle"/>
3927
</field>
3928
<field name="tab_width">
3929
<type name="int" c:type="int"/>
3930
</field>
3931
<field name="copy_end">
3932
<type name="int" c:type="int"/>
3933
</field>
3934
<field name="log_attrs">
3935
<type name="LogAttr" c:type="PangoLogAttr*"/>
3936
</field>
3937
<field name="lines">
3938
<type name="GLib.SList" c:type="GSList*"/>
3939
</field>
3940
<field name="line_count">
3941
<type name="uint" c:type="guint"/>
3942
</field>
3827
<doc xml:whitespace="preserve">the Y offset (in Pango units) from the top edge of the layout</doc>
3828
<type name="gint" c:type="int"/>
3829
</parameter>
3830
<parameter name="index_" transfer-ownership="none">
3831
<doc xml:whitespace="preserve">location to store calculated byte index</doc>
3832
<type name="gint" c:type="int*"/>
3833
</parameter>
3834
<parameter name="trailing" transfer-ownership="none">
3835
<doc xml:whitespace="preserve">location to store a integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme.</doc>
3836
<type name="gint" c:type="int*"/>
3837
</parameter>
3838
</parameters>
3839
</method>
3943
3840
</class>
3944
3841
<record name="LayoutClass"
3945
3842
c:type="PangoLayoutClass"
3843
disguised="1"
3946
3844
glib:is-gtype-struct-for="Layout">
3947
3845
</record>
3948
3846
<record name="LayoutIter"
3949
3847
c:type="PangoLayoutIter"
3950
3848
glib:type-name="PangoLayoutIter"
3951
glib:get-type="pango_layout_iter_get_type">
3952
<method name="copy"
3953
c:identifier="pango_layout_iter_copy"
3954
doc="Copies a #PangLayoutIter.
3955
be freed with pango_layout_iter_free(), or %NULL if"
3956
version="1.20">
3957
<return-value transfer-ownership="full">
3958
<type name="LayoutIter" c:type="PangoLayoutIter*"/>
3959
</return-value>
3960
</method>
3961
<method name="free"
3962
c:identifier="pango_layout_iter_free"
3963
doc="Frees an iterator that's no longer in use.">
3964
<return-value transfer-ownership="none">
3965
<type name="none" c:type="void"/>
3966
</return-value>
3967
</method>
3968
<method name="get_index"
3969
c:identifier="pango_layout_iter_get_index"
3970
doc="Gets the current byte index. Note that iterating forward by char
3971
moves in visual order, not logical order, so indexes may not be
3972
sequential. Also, the index may be equal to the length of the text
3973
in the layout, if on the %NULL run (see pango_layout_iter_get_run()).">
3974
<return-value transfer-ownership="none">
3975
<type name="int" c:type="int"/>
3976
</return-value>
3977
</method>
3978
<method name="get_run"
3979
c:identifier="pango_layout_iter_get_run"
3980
doc="Gets the current run. When iterating by run, at the end of each
3981
line, there's a position with a %NULL run, so this function can return
3982
%NULL. The %NULL run at the end of each line ensures that all lines have
3983
at least one run, even lines consisting of only a newline.
3984
Use the faster pango_layout_iter_get_run_readonly() if you do not plan
3985
to modify the contents of the run (glyphs, glyph widths, etc.).">
3986
<return-value transfer-ownership="full">
3987
<type name="LayoutRun" c:type="PangoLayoutRun*"/>
3988
</return-value>
3989
</method>
3990
<method name="get_run_readonly"
3991
c:identifier="pango_layout_iter_get_run_readonly"
3992
doc="Gets the current run. When iterating by run, at the end of each
3993
line, there's a position with a %NULL run, so this function can return
3994
%NULL. The %NULL run at the end of each line ensures that all lines have
3995
at least one run, even lines consisting of only a newline.
3996
This is a faster alternative to pango_layout_iter_get_run(),
3997
but the user is not expected
3998
to modify the contents of the run (glyphs, glyph widths, etc.)."
3999
version="1.16">
4000
<return-value transfer-ownership="full">
4001
<type name="LayoutRun" c:type="PangoLayoutRun*"/>
4002
</return-value>
4003
</method>
4004
<method name="get_line"
4005
c:identifier="pango_layout_iter_get_line"
4006
doc="Gets the current line.
4007
Use the faster pango_layout_iter_get_line_readonly() if you do not plan
4008
to modify the contents of the line (glyphs, glyph widths, etc.).">
4009
<return-value transfer-ownership="full">
4010
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
4011
</return-value>
4012
</method>
4013
<method name="get_line_readonly"
4014
c:identifier="pango_layout_iter_get_line_readonly"
4015
doc="Gets the current line for read-only access.
4016
This is a faster alternative to pango_layout_iter_get_line(),
4017
but the user is not expected
4018
to modify the contents of the line (glyphs, glyph widths, etc.)."
4019
version="1.16">
4020
<return-value transfer-ownership="full">
4021
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
4022
</return-value>
4023
</method>
3849
glib:get-type="pango_layout_iter_get_type"
3850
c:symbol-prefix="layout_iter">
4024
3851
<method name="at_last_line"
4025
c:identifier="pango_layout_iter_at_last_line"
4026
doc="Determines whether @iter is on the last line of the layout.">
3852
c:identifier="pango_layout_iter_at_last_line">
3853
<doc xml:whitespace="preserve">Determines whether @iter is on the last line of the layout.</doc>
4027
3854
<return-value transfer-ownership="none">
4028
<type name="boolean" c:type="gboolean"/>
3855
<doc xml:whitespace="preserve">%TRUE if @iter is on the last line.</doc>
3856
<type name="gboolean" c:type="gboolean"/>
4029
3857
</return-value>
4030
3858
</method>
4031
<method name="get_layout"
4032
c:identifier="pango_layout_iter_get_layout"
4033
doc="Gets the layout associated with a #PangoLayoutIter."
4034
version="1.20">
3859
<method name="copy" c:identifier="pango_layout_iter_copy" version="1.20">
3860
<doc xml:whitespace="preserve">Copies a #PangLayoutIter.
3861
be freed with pango_layout_iter_free(), or %NULL if</doc>
4035
3862
<return-value transfer-ownership="full">
4036
<type name="Layout" c:type="PangoLayout*"/>
4037
</return-value>
4038
</method>
4039
<method name="next_char"
4040
c:identifier="pango_layout_iter_next_char"
4041
doc="Moves @iter forward to the next character in visual order. If @iter was already at
4042
the end of the layout, returns %FALSE.">
4043
<return-value transfer-ownership="none">
4044
<type name="boolean" c:type="gboolean"/>
4045
</return-value>
4046
</method>
4047
<method name="next_cluster"
4048
c:identifier="pango_layout_iter_next_cluster"
4049
doc="Moves @iter forward to the next cluster in visual order. If @iter
4050
was already at the end of the layout, returns %FALSE.">
4051
<return-value transfer-ownership="none">
4052
<type name="boolean" c:type="gboolean"/>
4053
</return-value>
4054
</method>
4055
<method name="next_run"
4056
c:identifier="pango_layout_iter_next_run"
4057
doc="Moves @iter forward to the next run in visual order. If @iter was
4058
already at the end of the layout, returns %FALSE.">
4059
<return-value transfer-ownership="none">
4060
<type name="boolean" c:type="gboolean"/>
4061
</return-value>
4062
</method>
4063
<method name="next_line"
4064
c:identifier="pango_layout_iter_next_line"
4065
doc="Moves @iter forward to the start of the next line. If @iter is
4066
already on the last line, returns %FALSE.">
4067
<return-value transfer-ownership="none">
4068
<type name="boolean" c:type="gboolean"/>
3863
<doc xml:whitespace="preserve">the newly allocated #PangoLayoutIter, which should</doc>
3864
<type name="LayoutIter" c:type="PangoLayoutIter*"/>
3865
</return-value>
3866
</method>
3867
<method name="free" c:identifier="pango_layout_iter_free">
3868
<doc xml:whitespace="preserve">Frees an iterator that's no longer in use.</doc>
3869
<return-value transfer-ownership="none">
3870
<type name="none" c:type="void"/>
3871
</return-value>
3872
</method>
3873
<method name="get_baseline"
3874
c:identifier="pango_layout_iter_get_baseline">
3875
<doc xml:whitespace="preserve">Gets the Y position of the current line's baseline, in layout
3876
coordinates (origin at top left of the entire layout).</doc>
3877
<return-value transfer-ownership="none">
3878
<doc xml:whitespace="preserve">baseline of current line.</doc>
3879
<type name="gint" c:type="int"/>
4069
3880
</return-value>
4070
3881
</method>
4071
3882
<method name="get_char_extents"
4072
c:identifier="pango_layout_iter_get_char_extents"
4073
doc="Gets the extents of the current character, in layout coordinates
3883
c:identifier="pango_layout_iter_get_char_extents">
3884
<doc xml:whitespace="preserve">Gets the extents of the current character, in layout coordinates
4074
3885
(origin is the top left of the entire layout). Only logical extents
4075
3886
can sensibly be obtained for characters; ink extents make sense only
4076
down to the level of clusters.">
3887
down to the level of clusters.</doc>
4077
3888
<return-value transfer-ownership="none">
4078
3889
<type name="none" c:type="void"/>
4079
3890
</return-value>
4080
3891
<parameters>
4081
3892
<parameter name="logical_rect" transfer-ownership="none">
3893
<doc xml:whitespace="preserve">rectangle to fill with logical extents</doc>
4082
3894
<type name="Rectangle" c:type="PangoRectangle*"/>
4083
3895
</parameter>
4084
3896
</parameters>
4085
3897
</method>
4086
3898
<method name="get_cluster_extents"
4087
c:identifier="pango_layout_iter_get_cluster_extents"
4088
doc="Gets the extents of the current cluster, in layout coordinates
4089
(origin is the top left of the entire layout).">
4090
<return-value transfer-ownership="none">
4091
<type name="none" c:type="void"/>
4092
</return-value>
4093
<parameters>
4094
<parameter name="ink_rect" transfer-ownership="none">
4095
<type name="Rectangle" c:type="PangoRectangle*"/>
4096
</parameter>
4097
<parameter name="logical_rect" transfer-ownership="none">
4098
<type name="Rectangle" c:type="PangoRectangle*"/>
4099
</parameter>
4100
</parameters>
4101
</method>
4102
<method name="get_run_extents"
4103
c:identifier="pango_layout_iter_get_run_extents"
4104
doc="Gets the extents of the current run in layout coordinates
4105
(origin is the top left of the entire layout).">
4106
<return-value transfer-ownership="none">
4107
<type name="none" c:type="void"/>
4108
</return-value>
4109
<parameters>
4110
<parameter name="ink_rect" transfer-ownership="none">
4111
<type name="Rectangle" c:type="PangoRectangle*"/>
4112
</parameter>
4113
<parameter name="logical_rect" transfer-ownership="none">
4114
<type name="Rectangle" c:type="PangoRectangle*"/>
4115
</parameter>
4116
</parameters>
3899
c:identifier="pango_layout_iter_get_cluster_extents">
3900
<doc xml:whitespace="preserve">Gets the extents of the current cluster, in layout coordinates
3901
(origin is the top left of the entire layout).</doc>
3902
<return-value transfer-ownership="none">
3903
<type name="none" c:type="void"/>
3904
</return-value>
3905
<parameters>
3906
<parameter name="ink_rect" transfer-ownership="none">
3907
<doc xml:whitespace="preserve">rectangle to fill with ink extents, or %NULL</doc>
3908
<type name="Rectangle" c:type="PangoRectangle*"/>
3909
</parameter>
3910
<parameter name="logical_rect" transfer-ownership="none">
3911
<doc xml:whitespace="preserve">rectangle to fill with logical extents, or %NULL</doc>
3912
<type name="Rectangle" c:type="PangoRectangle*"/>
3913
</parameter>
3914
</parameters>
3915
</method>
3916
<method name="get_index" c:identifier="pango_layout_iter_get_index">
3917
<doc xml:whitespace="preserve">Gets the current byte index. Note that iterating forward by char
3918
moves in visual order, not logical order, so indexes may not be
3919
sequential. Also, the index may be equal to the length of the text
3920
in the layout, if on the %NULL run (see pango_layout_iter_get_run()).</doc>
3921
<return-value transfer-ownership="none">
3922
<doc xml:whitespace="preserve">current byte index.</doc>
3923
<type name="gint" c:type="int"/>
3924
</return-value>
3925
</method>
3926
<method name="get_layout"
3927
c:identifier="pango_layout_iter_get_layout"
3928
version="1.20"
3929
introspectable="0">
3930
<doc xml:whitespace="preserve">Gets the layout associated with a #PangoLayoutIter.</doc>
3931
<return-value>
3932
<doc xml:whitespace="preserve">the layout associated with @iter.</doc>
3933
<type name="Layout" c:type="PangoLayout*"/>
3934
</return-value>
3935
</method>
3936
<method name="get_layout_extents"
3937
c:identifier="pango_layout_iter_get_layout_extents">
3938
<doc xml:whitespace="preserve">Obtains the extents of the #PangoLayout being iterated
3939
over. @ink_rect or @logical_rect can be %NULL if you
3940
aren't interested in them.</doc>
3941
<return-value transfer-ownership="none">
3942
<type name="none" c:type="void"/>
3943
</return-value>
3944
<parameters>
3945
<parameter name="ink_rect" transfer-ownership="none">
3946
<doc xml:whitespace="preserve">rectangle to fill with ink extents, or %NULL</doc>
3947
<type name="Rectangle" c:type="PangoRectangle*"/>
3948
</parameter>
3949
<parameter name="logical_rect" transfer-ownership="none">
3950
<doc xml:whitespace="preserve">rectangle to fill with logical extents, or %NULL</doc>
3951
<type name="Rectangle" c:type="PangoRectangle*"/>
3952
</parameter>
3953
</parameters>
3954
</method>
3955
<method name="get_line" c:identifier="pango_layout_iter_get_line">
3956
<doc xml:whitespace="preserve">Gets the current line.
3957
Use the faster pango_layout_iter_get_line_readonly() if you do not plan
3958
to modify the contents of the line (glyphs, glyph widths, etc.).</doc>
3959
<return-value transfer-ownership="full">
3960
<doc xml:whitespace="preserve">the current line.</doc>
3961
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
3962
</return-value>
4117
3963
</method>
4118
3964
<method name="get_line_extents"
4119
c:identifier="pango_layout_iter_get_line_extents"
4120
doc="Obtains the extents of the current line. @ink_rect or @logical_rect
4121
can be %NULL if you aren't interested in them. Extents are in layout
3965
c:identifier="pango_layout_iter_get_line_extents">
3966
<doc xml:whitespace="preserve">Obtains the extents of the current line. @ink_rect or @logical_rect
3967
can be %NULL if you aren't interested in them. Extents are in layout
4122
3968
coordinates (origin is the top-left corner of the entire
4123
3969
#PangoLayout). Thus the extents returned by this function will be
4124
3970
the same width/height but not at the same x/y as the extents
4125
returned from pango_layout_line_get_extents().">
3971
returned from pango_layout_line_get_extents().</doc>
4126
3972
<return-value transfer-ownership="none">
4127
3973
<type name="none" c:type="void"/>
4128
3974
</return-value>
4129
3975
<parameters>
4130
3976
<parameter name="ink_rect" transfer-ownership="none">
3977
<doc xml:whitespace="preserve">rectangle to fill with ink extents, or %NULL</doc>
4131
3978
<type name="Rectangle" c:type="PangoRectangle*"/>
4132
3979
</parameter>
4133
3980
<parameter name="logical_rect" transfer-ownership="none">
3981
<doc xml:whitespace="preserve">rectangle to fill with logical extents, or %NULL</doc>
4134
3982
<type name="Rectangle" c:type="PangoRectangle*"/>
4135
3983
</parameter>
4136
3984
</parameters>
4137
3985
</method>
3986
<method name="get_line_readonly"
3987
c:identifier="pango_layout_iter_get_line_readonly"
3988
version="1.16">
3989
<doc xml:whitespace="preserve">Gets the current line for read-only access.
3990
This is a faster alternative to pango_layout_iter_get_line(),
3991
but the user is not expected
3992
to modify the contents of the line (glyphs, glyph widths, etc.).</doc>
3993
<return-value transfer-ownership="full">
3994
<doc xml:whitespace="preserve">the current line, that should not be modified.</doc>
3995
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
3996
</return-value>
3997
</method>
4138
3998
<method name="get_line_yrange"
4139
c:identifier="pango_layout_iter_get_line_yrange"
4140
doc="Divides the vertical space in the #PangoLayout being iterated over
3999
c:identifier="pango_layout_iter_get_line_yrange">
4000
<doc xml:whitespace="preserve">Divides the vertical space in the #PangoLayout being iterated over
4141
4001
between the lines in the layout, and returns the space belonging to
4142
the current line. A line's range includes the line's logical
4002
the current line. A line's range includes the line's logical
4143
4003
extents, plus half of the spacing above and below the line, if
4144
4004
pango_layout_set_spacing() has been called to set layout spacing.
4145
4005
The Y positions are in layout coordinates (origin at top left of the
4146
entire layout).">
4006
entire layout).</doc>
4147
4007
<return-value transfer-ownership="none">
4148
4008
<type name="none" c:type="void"/>
4149
4009
</return-value>
4150
4010
<parameters>
4151
<parameter name="y0_" direction="out" transfer-ownership="full">
4152
<type name="int" c:type="int*"/>
4011
<parameter name="y0_" transfer-ownership="none">
4012
<doc xml:whitespace="preserve">start of line</doc>
4013
<type name="gint" c:type="int*"/>
4153
4014
</parameter>
4154
<parameter name="y1_" direction="out" transfer-ownership="full">
4155
<type name="int" c:type="int*"/>
4015
<parameter name="y1_" transfer-ownership="none">
4016
<doc xml:whitespace="preserve">end of line</doc>
4017
<type name="gint" c:type="int*"/>
4156
4018
</parameter>
4157
4019
</parameters>
4158
4020
</method>
4159
<method name="get_layout_extents"
4160
c:identifier="pango_layout_iter_get_layout_extents"
4161
doc="Obtains the extents of the #PangoLayout being iterated
4162
over. @ink_rect or @logical_rect can be %NULL if you
4163
aren't interested in them.">
4021
<method name="get_run"
4022
c:identifier="pango_layout_iter_get_run"
4023
introspectable="0">
4024
<doc xml:whitespace="preserve">Gets the current run. When iterating by run, at the end of each
4025
line, there's a position with a %NULL run, so this function can return
4026
%NULL. The %NULL run at the end of each line ensures that all lines have
4027
at least one run, even lines consisting of only a newline.
4028
Use the faster pango_layout_iter_get_run_readonly() if you do not plan
4029
to modify the contents of the run (glyphs, glyph widths, etc.).</doc>
4030
<return-value>
4031
<doc xml:whitespace="preserve">the current run.</doc>
4032
<type name="LayoutRun" c:type="PangoLayoutRun*"/>
4033
</return-value>
4034
</method>
4035
<method name="get_run_extents"
4036
c:identifier="pango_layout_iter_get_run_extents">
4037
<doc xml:whitespace="preserve">Gets the extents of the current run in layout coordinates
4038
(origin is the top left of the entire layout).</doc>
4164
4039
<return-value transfer-ownership="none">
4165
4040
<type name="none" c:type="void"/>
4166
4041
</return-value>
4167
4042
<parameters>
4168
4043
<parameter name="ink_rect" transfer-ownership="none">
4044
<doc xml:whitespace="preserve">rectangle to fill with ink extents, or %NULL</doc>
4169
4045
<type name="Rectangle" c:type="PangoRectangle*"/>
4170
4046
</parameter>
4171
4047
<parameter name="logical_rect" transfer-ownership="none">
4048
<doc xml:whitespace="preserve">rectangle to fill with logical extents, or %NULL</doc>
4172
4049
<type name="Rectangle" c:type="PangoRectangle*"/>
4173
4050
</parameter>
4174
4051
</parameters>
4175
4052
</method>
4176
<method name="get_baseline"
4177
c:identifier="pango_layout_iter_get_baseline"
4178
doc="Gets the Y position of the current line's baseline, in layout
4179
coordinates (origin at top left of the entire layout).">
4180
<return-value transfer-ownership="none">
4181
<type name="int" c:type="int"/>
4053
<method name="get_run_readonly"
4054
c:identifier="pango_layout_iter_get_run_readonly"
4055
version="1.16"
4056
introspectable="0">
4057
<doc xml:whitespace="preserve">Gets the current run. When iterating by run, at the end of each
4058
line, there's a position with a %NULL run, so this function can return
4059
%NULL. The %NULL run at the end of each line ensures that all lines have
4060
at least one run, even lines consisting of only a newline.
4061
This is a faster alternative to pango_layout_iter_get_run(),
4062
but the user is not expected
4063
to modify the contents of the run (glyphs, glyph widths, etc.).</doc>
4064
<return-value>
4065
<doc xml:whitespace="preserve">the current run, that should not be modified.</doc>
4066
<type name="LayoutRun" c:type="PangoLayoutRun*"/>
4067
</return-value>
4068
</method>
4069
<method name="next_char" c:identifier="pango_layout_iter_next_char">
4070
<doc xml:whitespace="preserve">Moves @iter forward to the next character in visual order. If @iter was already at
4071
the end of the layout, returns %FALSE.</doc>
4072
<return-value transfer-ownership="none">
4073
<doc xml:whitespace="preserve">whether motion was possible.</doc>
4074
<type name="gboolean" c:type="gboolean"/>
4075
</return-value>
4076
</method>
4077
<method name="next_cluster"
4078
c:identifier="pango_layout_iter_next_cluster">
4079
<doc xml:whitespace="preserve">Moves @iter forward to the next cluster in visual order. If @iter
4080
was already at the end of the layout, returns %FALSE.</doc>
4081
<return-value transfer-ownership="none">
4082
<doc xml:whitespace="preserve">whether motion was possible.</doc>
4083
<type name="gboolean" c:type="gboolean"/>
4084
</return-value>
4085
</method>
4086
<method name="next_line" c:identifier="pango_layout_iter_next_line">
4087
<doc xml:whitespace="preserve">Moves @iter forward to the start of the next line. If @iter is
4088
already on the last line, returns %FALSE.</doc>
4089
<return-value transfer-ownership="none">
4090
<doc xml:whitespace="preserve">whether motion was possible.</doc>
4091
<type name="gboolean" c:type="gboolean"/>
4092
</return-value>
4093
</method>
4094
<method name="next_run" c:identifier="pango_layout_iter_next_run">
4095
<doc xml:whitespace="preserve">Moves @iter forward to the next run in visual order. If @iter was
4096
already at the end of the layout, returns %FALSE.</doc>
4097
<return-value transfer-ownership="none">
4098
<doc xml:whitespace="preserve">whether motion was possible.</doc>
4099
<type name="gboolean" c:type="gboolean"/>
4182
4100
</return-value>
4183
4101
</method>
4184
4102
</record>
4185
4103
<record name="LayoutLine"
4186
4104
c:type="PangoLayoutLine"
4187
4105
glib:type-name="PangoLayoutLine"
4188
glib:get-type="pango_layout_line_get_type">
4106
glib:get-type="pango_layout_line_get_type"
4107
c:symbol-prefix="layout_line">
4189
4108
<field name="layout" writable="1">
4190
4109
<type name="Layout" c:type="PangoLayout*"/>
4191
4110
</field>
4192
4111
<field name="start_index" writable="1">
4193
<type name="int" c:type="gint"/>
4112
<type name="gint" c:type="gint"/>
4194
4113
</field>
4195
4114
<field name="length" writable="1">
4196
<type name="int" c:type="gint"/>
4115
<type name="gint" c:type="gint"/>
4197
4116
</field>
4198
4117
<field name="runs" writable="1">
4199
<type name="GLib.SList" c:type="GSList*"/>
4118
<type name="GLib.SList" c:type="GSList*">
4119
<type name="gpointer" c:type="gpointer"/>
4120
</type>
4200
4121
</field>
4201
4122
<field name="is_paragraph_start" writable="1" bits="1">
4202
<type name="uint" c:type="guint"/>
4123
<type name="guint" c:type="guint"/>
4203
4124
</field>
4204
4125
<field name="resolved_dir" writable="1" bits="3">
4205
<type name="uint" c:type="guint"/>
4126
<type name="guint" c:type="guint"/>
4206
4127
</field>
4207
<method name="ref"
4208
c:identifier="pango_layout_line_ref"
4209
doc="Increase the reference count of a #PangoLayoutLine by one."
4210
version="1.10">
4128
<method name="get_extents" c:identifier="pango_layout_line_get_extents">
4129
<doc xml:whitespace="preserve">Computes the logical and ink extents of a layout line. See
4130
pango_font_get_glyph_extents() for details about the interpretation
4131
of the rectangles.</doc>
4132
<return-value transfer-ownership="none">
4133
<type name="none" c:type="void"/>
4134
</return-value>
4135
<parameters>
4136
<parameter name="ink_rect" transfer-ownership="none">
4137
<doc xml:whitespace="preserve">rectangle used to store the extents of the glyph string as drawn, or %NULL</doc>
4138
<type name="Rectangle" c:type="PangoRectangle*"/>
4139
</parameter>
4140
<parameter name="logical_rect" transfer-ownership="none">
4141
<doc xml:whitespace="preserve">rectangle used to store the logical extents of the glyph string, or %NULL</doc>
4142
<type name="Rectangle" c:type="PangoRectangle*"/>
4143
</parameter>
4144
</parameters>
4145
</method>
4146
<method name="get_pixel_extents"
4147
c:identifier="pango_layout_line_get_pixel_extents">
4148
<doc xml:whitespace="preserve">Computes the logical and ink extents of @layout_line in device units.
4149
This function just calls pango_layout_line_get_extents() followed by
4150
two pango_extents_to_pixels() calls, rounding @ink_rect and @logical_rect
4151
such that the rounded rectangles fully contain the unrounded one (that is,
4152
passes them as first argument to pango_extents_to_pixels()).</doc>
4153
<return-value transfer-ownership="none">
4154
<type name="none" c:type="void"/>
4155
</return-value>
4156
<parameters>
4157
<parameter name="ink_rect" transfer-ownership="none">
4158
<doc xml:whitespace="preserve">rectangle used to store the extents of the glyph string as drawn, or %NULL</doc>
4159
<type name="Rectangle" c:type="PangoRectangle*"/>
4160
</parameter>
4161
<parameter name="logical_rect" transfer-ownership="none">
4162
<doc xml:whitespace="preserve">rectangle used to store the logical extents of the glyph string, or %NULL</doc>
4163
<type name="Rectangle" c:type="PangoRectangle*"/>
4164
</parameter>
4165
</parameters>
4166
</method>
4167
<method name="get_x_ranges"
4168
c:identifier="pango_layout_line_get_x_ranges">
4169
<doc xml:whitespace="preserve">Gets a list of visual ranges corresponding to a given logical range.
4170
This list is not necessarily minimal - there may be consecutive
4171
ranges which are adjacent. The ranges will be sorted from left to
4172
right. The ranges are with respect to the left edge of the entire
4173
layout, not with respect to the line.</doc>
4174
<return-value transfer-ownership="none">
4175
<type name="none" c:type="void"/>
4176
</return-value>
4177
<parameters>
4178
<parameter name="start_index" transfer-ownership="none">
4179
<doc xml:whitespace="preserve">Start byte index of the logical range. If this value is less than the start index for the line, then the first range will extend all the way to the leading edge of the layout. Otherwise it will start at the leading edge of the first character.</doc>
4180
<type name="gint" c:type="int"/>
4181
</parameter>
4182
<parameter name="end_index" transfer-ownership="none">
4183
<doc xml:whitespace="preserve">Ending byte index of the logical range. If this value is greater than the end index for the line, then the last range will extend all the way to the trailing edge of the layout. Otherwise, it will end at the trailing edge of the last character.</doc>
4184
<type name="gint" c:type="int"/>
4185
</parameter>
4186
<parameter name="ranges"
4187
direction="out"
4188
caller-allocates="0"
4189
transfer-ownership="full">
4190
<doc xml:whitespace="preserve">(array length=n_ranges): (transfer=full): location to store a pointer to an array of ranges. The array will be of length <literal>2*n_ranges</literal>, with each range starting at <literal>(*ranges)[2*n]</literal> and of width <literal>(*ranges)[2*n + 1] - (*ranges)[2*n]</literal>. This array must be freed with g_free(). The coordinates are relative to the layout and are in Pango units.</doc>
4191
<type name="gint" c:type="int**"/>
4192
</parameter>
4193
<parameter name="n_ranges" transfer-ownership="none">
4194
<doc xml:whitespace="preserve">The number of ranges stored in @ranges.</doc>
4195
<type name="gint" c:type="int*"/>
4196
</parameter>
4197
</parameters>
4198
</method>
4199
<method name="index_to_x" c:identifier="pango_layout_line_index_to_x">
4200
<doc xml:whitespace="preserve">Converts an index within a line to a X position.</doc>
4201
<return-value transfer-ownership="none">
4202
<type name="none" c:type="void"/>
4203
</return-value>
4204
<parameters>
4205
<parameter name="index_" transfer-ownership="none">
4206
<doc xml:whitespace="preserve">byte offset of a grapheme within the layout</doc>
4207
<type name="gint" c:type="int"/>
4208
</parameter>
4209
<parameter name="trailing" transfer-ownership="none">
4210
<doc xml:whitespace="preserve">an integer indicating the edge of the grapheme to retrieve the position of. If > 0, the trailing edge of the grapheme, if 0, the leading of the grapheme.</doc>
4211
<type name="gboolean" c:type="gboolean"/>
4212
</parameter>
4213
<parameter name="x_pos" transfer-ownership="none">
4214
<doc xml:whitespace="preserve">location to store the x_offset (in Pango unit)</doc>
4215
<type name="gint" c:type="int*"/>
4216
</parameter>
4217
</parameters>
4218
</method>
4219
<method name="ref" c:identifier="pango_layout_line_ref" version="1.10">
4220
<doc xml:whitespace="preserve">Increase the reference count of a #PangoLayoutLine by one.</doc>
4211
4221
<return-value transfer-ownership="full">
4222
<doc xml:whitespace="preserve">the line passed in.</doc>
4212
4223
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
4213
4224
</return-value>
4214
4225
</method>
4215
<method name="unref"
4216
c:identifier="pango_layout_line_unref"
4217
doc="Decrease the reference count of a #PangoLayoutLine by one.
4226
<method name="unref" c:identifier="pango_layout_line_unref">
4227
<doc xml:whitespace="preserve">Decrease the reference count of a #PangoLayoutLine by one.
4218
4228
If the result is zero, the line and all associated memory
4219
will be freed.">
4229
will be freed.</doc>
4220
4230
<return-value transfer-ownership="none">
4221
4231
<type name="none" c:type="void"/>
4222
4232
</return-value>
4223
4233
</method>
4224
<method name="x_to_index"
4225
c:identifier="pango_layout_line_x_to_index"
4226
doc="from the left edge of the line.
4227
the grapheme in which the user clicked.
4228
in the grapheme the user clicked. It will either
4229
be zero, or the number of characters in the
4230
grapheme. 0 represents the leading edge of the grapheme.
4231
Converts from x offset to the byte index of the corresponding
4234
<method name="x_to_index" c:identifier="pango_layout_line_x_to_index">
4235
<doc xml:whitespace="preserve">Converts from x offset to the byte index of the corresponding
4232
4236
character within the text of the layout. If @x_pos is outside the line,
4233
4237
in the line. This determination is based on the resolved direction
4234
4238
of the paragraph; for example, if the resolved direction is
4236
4240
results in 0 being stored in @index_ and @trailing. An X position to the
4237
4241
left of the line results in @index_ pointing to the (logical) last
4238
4242
grapheme in the line and @trailing being set to the number of characters
4239
in that grapheme. The reverse is true for a left-to-right line.">
4243
in that grapheme. The reverse is true for a left-to-right line.</doc>
4240
4244
<return-value transfer-ownership="none">
4241
<type name="boolean" c:type="gboolean"/>
4245
<doc xml:whitespace="preserve">%FALSE if @x_pos was outside the line, %TRUE if inside</doc>
4246
<type name="gboolean" c:type="gboolean"/>
4242
4247
</return-value>
4243
4248
<parameters>
4244
4249
<parameter name="x_pos" transfer-ownership="none">
4245
<type name="int" c:type="int"/>
4246
</parameter>
4247
<parameter name="index_" direction="out" transfer-ownership="full">
4248
<type name="int" c:type="int*"/>
4249
</parameter>
4250
<parameter name="trailing" direction="out" transfer-ownership="full">
4251
<type name="int" c:type="int*"/>
4252
</parameter>
4253
</parameters>
4254
</method>
4255
<method name="index_to_x"
4256
c:identifier="pango_layout_line_index_to_x"
4257
doc="the position of. If > 0, the trailing edge of the grapheme,
4258
if 0, the leading of the grapheme.
4259
Converts an index within a line to a X position.">
4260
<return-value transfer-ownership="none">
4261
<type name="none" c:type="void"/>
4262
</return-value>
4263
<parameters>
4250
<doc xml:whitespace="preserve">the X offset (in Pango units) from the left edge of the line.</doc>
4251
<type name="gint" c:type="int"/>
4252
</parameter>
4264
4253
<parameter name="index_" transfer-ownership="none">
4265
<type name="int" c:type="int"/>
4254
<doc xml:whitespace="preserve">location to store calculated byte index for the grapheme in which the user clicked.</doc>
4255
<type name="gint" c:type="int*"/>
4266
4256
</parameter>
4267
4257
<parameter name="trailing" transfer-ownership="none">
4268
<type name="boolean" c:type="gboolean"/>
4269
</parameter>
4270
<parameter name="x_pos" transfer-ownership="none">
4271
<type name="int" c:type="int*"/>
4272
</parameter>
4273
</parameters>
4274
</method>
4275
<method name="get_x_ranges"
4276
c:identifier="pango_layout_line_get_x_ranges"
4277
doc="is less than the start index for the line, then
4278
the first range will extend all the way to the leading
4279
edge of the layout. Otherwise it will start at the
4280
leading edge of the first character.
4281
is greater than the end index for the line, then
4282
the last range will extend all the way to the trailing
4283
edge of the layout. Otherwise, it will end at the
4284
trailing edge of the last character.
4285
location to store a pointer to an array of ranges.
4286
The array will be of length <literal>2*n_ranges</literal>,
4287
with each range starting at <literal>(*ranges)[2*n]</literal>
4288
and of width <literal>(*ranges)[2*n + 1] - (*ranges)[2*n]</literal>.
4289
This array must be freed with g_free(). The coordinates are relative
4290
to the layout and are in Pango units.
4291
Gets a list of visual ranges corresponding to a given logical range.
4292
This list is not necessarily minimal - there may be consecutive
4293
ranges which are adjacent. The ranges will be sorted from left to
4294
right. The ranges are with respect to the left edge of the entire
4295
layout, not with respect to the line.">
4296
<return-value transfer-ownership="none">
4297
<type name="none" c:type="void"/>
4298
</return-value>
4299
<parameters>
4300
<parameter name="start_index" transfer-ownership="none">
4301
<type name="int" c:type="int"/>
4302
</parameter>
4303
<parameter name="end_index" transfer-ownership="none">
4304
<type name="int" c:type="int"/>
4305
</parameter>
4306
<parameter name="ranges" direction="out" transfer-ownership="full">
4307
<array length="4" c:type="int**">
4308
<type name="int"/>
4309
</array>
4310
</parameter>
4311
<parameter name="n_ranges" direction="out" transfer-ownership="full">
4312
<type name="int" c:type="int*"/>
4313
</parameter>
4314
</parameters>
4315
</method>
4316
<method name="get_extents"
4317
c:identifier="pango_layout_line_get_extents"
4318
doc="as drawn, or %NULL
4319
string, or %NULL
4320
Computes the logical and ink extents of a layout line. See
4321
pango_font_get_glyph_extents() for details about the interpretation
4322
of the rectangles.">
4323
<return-value transfer-ownership="none">
4324
<type name="none" c:type="void"/>
4325
</return-value>
4326
<parameters>
4327
<parameter name="ink_rect" transfer-ownership="none">
4328
<type name="Rectangle" c:type="PangoRectangle*"/>
4329
</parameter>
4330
<parameter name="logical_rect" transfer-ownership="none">
4331
<type name="Rectangle" c:type="PangoRectangle*"/>
4332
</parameter>
4333
</parameters>
4334
</method>
4335
<method name="get_pixel_extents"
4336
c:identifier="pango_layout_line_get_pixel_extents"
4337
doc="as drawn, or %NULL
4338
string, or %NULL
4339
Computes the logical and ink extents of @layout_line in device units.
4340
This function just calls pango_layout_line_get_extents() followed by
4341
two pango_extents_to_pixels() calls, rounding @ink_rect and @logical_rect
4342
such that the rounded rectangles fully contain the unrounded one (that is,
4343
passes them as first argument to pango_extents_to_pixels()).">
4344
<return-value transfer-ownership="none">
4345
<type name="none" c:type="void"/>
4346
</return-value>
4347
<parameters>
4348
<parameter name="ink_rect" transfer-ownership="none">
4349
<type name="Rectangle" c:type="PangoRectangle*"/>
4350
</parameter>
4351
<parameter name="logical_rect" transfer-ownership="none">
4352
<type name="Rectangle" c:type="PangoRectangle*"/>
4258
<doc xml:whitespace="preserve">location to store an integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the leading edge of the grapheme.</doc>
4259
<type name="gint" c:type="int*"/>
4353
4260
</parameter>
4354
4261
</parameters>
4355
4262
</method>
4356
4263
</record>
4357
4264
<record name="LogAttr" c:type="PangoLogAttr">
4358
4265
<field name="is_line_break" writable="1" bits="1">
4359
<type name="uint" c:type="guint"/>
4266
<type name="guint" c:type="guint"/>
4360
4267
</field>
4361
4268
<field name="is_mandatory_break" writable="1" bits="1">
4362
<type name="uint" c:type="guint"/>
4269
<type name="guint" c:type="guint"/>
4363
4270
</field>
4364
4271
<field name="is_char_break" writable="1" bits="1">
4365
<type name="uint" c:type="guint"/>
4272
<type name="guint" c:type="guint"/>
4366
4273
</field>
4367
4274
<field name="is_white" writable="1" bits="1">
4368
<type name="uint" c:type="guint"/>
4275
<type name="guint" c:type="guint"/>
4369
4276
</field>
4370
4277
<field name="is_cursor_position" writable="1" bits="1">
4371
<type name="uint" c:type="guint"/>
4278
<type name="guint" c:type="guint"/>
4372
4279
</field>
4373
4280
<field name="is_word_start" writable="1" bits="1">
4374
<type name="uint" c:type="guint"/>
4281
<type name="guint" c:type="guint"/>
4375
4282
</field>
4376
4283
<field name="is_word_end" writable="1" bits="1">
4377
<type name="uint" c:type="guint"/>
4284
<type name="guint" c:type="guint"/>
4378
4285
</field>
4379
4286
<field name="is_sentence_boundary" writable="1" bits="1">
4380
<type name="uint" c:type="guint"/>
4287
<type name="guint" c:type="guint"/>
4381
4288
</field>
4382
4289
<field name="is_sentence_start" writable="1" bits="1">
4383
<type name="uint" c:type="guint"/>
4290
<type name="guint" c:type="guint"/>
4384
4291
</field>
4385
4292
<field name="is_sentence_end" writable="1" bits="1">
4386
<type name="uint" c:type="guint"/>
4293
<type name="guint" c:type="guint"/>
4387
4294
</field>
4388
4295
<field name="backspace_deletes_character" writable="1" bits="1">
4389
<type name="uint" c:type="guint"/>
4296
<type name="guint" c:type="guint"/>
4390
4297
</field>
4391
4298
<field name="is_expandable_space" writable="1" bits="1">
4392
<type name="uint" c:type="guint"/>
4299
<type name="guint" c:type="guint"/>
4393
4300
</field>
4394
4301
<field name="is_word_boundary" writable="1" bits="1">
4395
<type name="uint" c:type="guint"/>
4302
<type name="guint" c:type="guint"/>
4396
4303
</field>
4397
4304
</record>
4398
4305
<record name="Matrix"
4399
4306
c:type="PangoMatrix"
4400
doc="A structure specifying a transformation between user-space
4307
version="1.6"
4308
glib:type-name="PangoMatrix"
4309
glib:get-type="pango_matrix_get_type"
4310
c:symbol-prefix="matrix">
4311
<doc xml:whitespace="preserve">A structure specifying a transformation between user-space
4401
4312
coordinates and device coordinates. The transformation
4402
4313
is given by
4403
4314
<programlisting>
4404
4315
x_device = x_user * matrix->xx + y_user * matrix->xy + matrix->x0;
4405
4316
y_device = x_user * matrix->yx + y_user * matrix->yy + matrix->y0;
4406
</programlisting>"
4407
version="1.6"
4408
glib:type-name="PangoMatrix"
4409
glib:get-type="pango_matrix_get_type">
4317
</programlisting></doc>
4410
4318
<field name="xx" writable="1">
4411
<type name="double" c:type="double"/>
4319
<type name="gdouble" c:type="double"/>
4412
4320
</field>
4413
4321
<field name="xy" writable="1">
4414
<type name="double" c:type="double"/>
4322
<type name="gdouble" c:type="double"/>
4415
4323
</field>
4416
4324
<field name="yx" writable="1">
4417
<type name="double" c:type="double"/>
4325
<type name="gdouble" c:type="double"/>
4418
4326
</field>
4419
4327
<field name="yy" writable="1">
4420
<type name="double" c:type="double"/>
4328
<type name="gdouble" c:type="double"/>
4421
4329
</field>
4422
4330
<field name="x0" writable="1">
4423
<type name="double" c:type="double"/>
4331
<type name="gdouble" c:type="double"/>
4424
4332
</field>
4425
4333
<field name="y0" writable="1">
4426
<type name="double" c:type="double"/>
4334
<type name="gdouble" c:type="double"/>
4427
4335
</field>
4428
<method name="copy"
4429
c:identifier="pango_matrix_copy"
4430
doc="Copies a #PangoMatrix.
4431
be freed with pango_matrix_free(), or %NULL if"
4432
version="1.6">
4336
<method name="concat" c:identifier="pango_matrix_concat" version="1.6">
4337
<doc xml:whitespace="preserve">Changes the transformation represented by @matrix to be the
4338
transformation given by first applying transformation
4339
given by @new_matrix then applying the original transformation.</doc>
4340
<return-value transfer-ownership="none">
4341
<type name="none" c:type="void"/>
4342
</return-value>
4343
<parameters>
4344
<parameter name="new_matrix" transfer-ownership="none">
4345
<doc xml:whitespace="preserve">a #PangoMatrix</doc>
4346
<type name="Matrix" c:type="PangoMatrix*"/>
4347
</parameter>
4348
</parameters>
4349
</method>
4350
<method name="copy" c:identifier="pango_matrix_copy" version="1.6">
4351
<doc xml:whitespace="preserve">Copies a #PangoMatrix.
4352
be freed with pango_matrix_free(), or %NULL if</doc>
4433
4353
<return-value transfer-ownership="full">
4354
<doc xml:whitespace="preserve">the newly allocated #PangoMatrix, which should</doc>
4434
4355
<type name="Matrix" c:type="PangoMatrix*"/>
4435
4356
</return-value>
4436
4357
</method>
4437
<method name="free"
4438
c:identifier="pango_matrix_free"
4439
doc="Free a #PangoMatrix created with pango_matrix_copy()."
4440
version="1.6">
4358
<method name="free" c:identifier="pango_matrix_free" version="1.6">
4359
<doc xml:whitespace="preserve">Free a #PangoMatrix created with pango_matrix_copy().</doc>
4441
4360
<return-value transfer-ownership="none">
4442
4361
<type name="none" c:type="void"/>
4443
4362
</return-value>
4444
4363
</method>
4445
<method name="translate"
4446
c:identifier="pango_matrix_translate"
4447
doc="Changes the transformation represented by @matrix to be the
4448
transformation given by first translating by (@tx, @ty)
4449
then applying the original transformation."
4450
version="1.6">
4364
<method name="get_font_scale_factor"
4365
c:identifier="pango_matrix_get_font_scale_factor"
4366
version="1.12">
4367
<doc xml:whitespace="preserve">Returns the scale factor of a matrix on the height of the font.
4368
That is, the scale factor in the direction perpendicular to the
4369
vector that the X coordinate is mapped to.
4370
or 1.0 if @matrix is %NULL.</doc>
4371
<return-value transfer-ownership="none">
4372
<doc xml:whitespace="preserve">the scale factor of @matrix on the height of the font,</doc>
4373
<type name="gdouble" c:type="double"/>
4374
</return-value>
4375
</method>
4376
<method name="rotate" c:identifier="pango_matrix_rotate" version="1.6">
4377
<doc xml:whitespace="preserve">Changes the transformation represented by @matrix to be the
4378
transformation given by first rotating by @degrees degrees
4379
counter-clockwise then applying the original transformation.</doc>
4451
4380
<return-value transfer-ownership="none">
4452
4381
<type name="none" c:type="void"/>
4453
4382
</return-value>
4454
4383
<parameters>
4455
<parameter name="tx" transfer-ownership="none">
4456
<type name="double" c:type="double"/>
4457
</parameter>
4458
<parameter name="ty" transfer-ownership="none">
4459
<type name="double" c:type="double"/>
4384
<parameter name="degrees" transfer-ownership="none">
4385
<doc xml:whitespace="preserve">degrees to rotate counter-clockwise</doc>
4386
<type name="gdouble" c:type="double"/>
4460
4387
</parameter>
4461
4388
</parameters>
4462
4389
</method>
4463
<method name="scale"
4464
c:identifier="pango_matrix_scale"
4465
doc="Changes the transformation represented by @matrix to be the
4390
<method name="scale" c:identifier="pango_matrix_scale" version="1.6">
4391
<doc xml:whitespace="preserve">Changes the transformation represented by @matrix to be the
4466
4392
transformation given by first scaling by @sx in the X direction
4467
4393
and @sy in the Y direction then applying the original
4468
transformation."
4469
version="1.6">
4394
transformation.</doc>
4470
4395
<return-value transfer-ownership="none">
4471
4396
<type name="none" c:type="void"/>
4472
4397
</return-value>
4473
4398
<parameters>
4474
4399
<parameter name="scale_x" transfer-ownership="none">
4475
<type name="double" c:type="double"/>
4400
<doc xml:whitespace="preserve">amount to scale by in X direction</doc>
4401
<type name="gdouble" c:type="double"/>
4476
4402
</parameter>
4477
4403
<parameter name="scale_y" transfer-ownership="none">
4478
<type name="double" c:type="double"/>
4479
</parameter>
4480
</parameters>
4481
</method>
4482
<method name="rotate"
4483
c:identifier="pango_matrix_rotate"
4484
doc="Changes the transformation represented by @matrix to be the
4485
transformation given by first rotating by @degrees degrees
4486
counter-clockwise then applying the original transformation."
4487
version="1.6">
4488
<return-value transfer-ownership="none">
4489
<type name="none" c:type="void"/>
4490
</return-value>
4491
<parameters>
4492
<parameter name="degrees" transfer-ownership="none">
4493
<type name="double" c:type="double"/>
4494
</parameter>
4495
</parameters>
4496
</method>
4497
<method name="concat"
4498
c:identifier="pango_matrix_concat"
4499
doc="Changes the transformation represented by @matrix to be the
4500
transformation given by first applying transformation
4501
given by @new_matrix then applying the original transformation."
4502
version="1.6">
4503
<return-value transfer-ownership="none">
4504
<type name="none" c:type="void"/>
4505
</return-value>
4506
<parameters>
4507
<parameter name="new_matrix" transfer-ownership="none">
4508
<type name="Matrix" c:type="PangoMatrix*"/>
4509
</parameter>
4510
</parameters>
4511
</method>
4512
<method name="transform_point"
4513
c:identifier="pango_matrix_transform_point"
4514
doc="Transforms the point (@x, @y) by @matrix."
4515
version="1.16">
4516
<return-value transfer-ownership="none">
4517
<type name="none" c:type="void"/>
4518
</return-value>
4519
<parameters>
4520
<parameter name="x" direction="out" transfer-ownership="full">
4521
<type name="double" c:type="double*"/>
4522
</parameter>
4523
<parameter name="y" direction="out" transfer-ownership="full">
4524
<type name="double" c:type="double*"/>
4404
<doc xml:whitespace="preserve">amount to scale by in Y direction</doc>
4405
<type name="gdouble" c:type="double"/>
4525
4406
</parameter>
4526
4407
</parameters>
4527
4408
</method>
4528
4409
<method name="transform_distance"
4529
4410
c:identifier="pango_matrix_transform_distance"
4530
doc="Transforms the distance vector (@dx,@dy) by @matrix. This is
4411
version="1.16">
4412
<doc xml:whitespace="preserve">Transforms the distance vector (@dx,@dy) by @matrix. This is
4531
4413
similar to pango_matrix_transform_point() except that the translation
4532
4414
components of the transformation are ignored. The calculation of
4533
4415
the returned vector is as follows:
4538
4420
Affine transformations are position invariant, so the same vector
4539
4421
always transforms to the same vector. If (@x1,@y1) transforms
4540
4422
to (@x2,@y2) then (@x1+@dx1,@y1+@dy1) will transform to
4541
(@x1+@dx2,@y1+@dy2) for all values of @x1 and @x2."
4542
version="1.16">
4543
<return-value transfer-ownership="none">
4544
<type name="none" c:type="void"/>
4545
</return-value>
4546
<parameters>
4547
<parameter name="dx" direction="out" transfer-ownership="full">
4548
<type name="double" c:type="double*"/>
4549
</parameter>
4550
<parameter name="dy" direction="out" transfer-ownership="full">
4551
<type name="double" c:type="double*"/>
4423
(@x1+@dx2,@y1+@dy2) for all values of @x1 and @x2.</doc>
4424
<return-value transfer-ownership="none">
4425
<type name="none" c:type="void"/>
4426
</return-value>
4427
<parameters>
4428
<parameter name="dx" transfer-ownership="none">
4429
<doc xml:whitespace="preserve">in/out X component of a distance vector</doc>
4430
<type name="gdouble" c:type="double*"/>
4431
</parameter>
4432
<parameter name="dy" transfer-ownership="none">
4433
<doc xml:whitespace="preserve">yn/out Y component of a distance vector</doc>
4434
<type name="gdouble" c:type="double*"/>
4435
</parameter>
4436
</parameters>
4437
</method>
4438
<method name="transform_pixel_rectangle"
4439
c:identifier="pango_matrix_transform_pixel_rectangle"
4440
version="1.16">
4441
<doc xml:whitespace="preserve">First transforms the @rect using @matrix, then calculates the bounding box
4442
of the transformed rectangle. The rectangle should be in device units
4443
(pixels).
4444
This function is useful for example when you want to draw a rotated
4445
should be and how much you should shift the layout when rendering.
4446
For better accuracy, you should use pango_matrix_transform_rectangle() on
4447
original rectangle in Pango units and convert to pixels afterward
4448
using pango_extents_to_pixels()'s first argument.</doc>
4449
<return-value transfer-ownership="none">
4450
<type name="none" c:type="void"/>
4451
</return-value>
4452
<parameters>
4453
<parameter name="rect" transfer-ownership="none">
4454
<doc xml:whitespace="preserve">in/out bounding box in device units, or %NULL</doc>
4455
<type name="Rectangle" c:type="PangoRectangle*"/>
4456
</parameter>
4457
</parameters>
4458
</method>
4459
<method name="transform_point"
4460
c:identifier="pango_matrix_transform_point"
4461
version="1.16">
4462
<doc xml:whitespace="preserve">Transforms the point (@x, @y) by @matrix.</doc>
4463
<return-value transfer-ownership="none">
4464
<type name="none" c:type="void"/>
4465
</return-value>
4466
<parameters>
4467
<parameter name="x" transfer-ownership="none">
4468
<doc xml:whitespace="preserve">in/out X position</doc>
4469
<type name="gdouble" c:type="double*"/>
4470
</parameter>
4471
<parameter name="y" transfer-ownership="none">
4472
<doc xml:whitespace="preserve">in/out Y position</doc>
4473
<type name="gdouble" c:type="double*"/>
4552
4474
</parameter>
4553
4475
</parameters>
4554
4476
</method>
4555
4477
<method name="transform_rectangle"
4556
4478
c:identifier="pango_matrix_transform_rectangle"
4557
doc="First transforms @rect using @matrix, then calculates the bounding box
4479
version="1.16">
4480
<doc xml:whitespace="preserve">First transforms @rect using @matrix, then calculates the bounding box
4558
4481
of the transformed rectangle. The rectangle should be in Pango units.
4559
4482
This function is useful for example when you want to draw a rotated
4560
4483
should be and how much you should shift the layout when rendering.
4567
4490
However, there are valid reasons that you may want to convert
4568
4491
to pixels first and then transform, for example when the transformed
4569
4492
coordinates may overflow in Pango units (large matrix translation for
4570
example)."
4571
version="1.16">
4572
<return-value transfer-ownership="none">
4573
<type name="none" c:type="void"/>
4574
</return-value>
4575
<parameters>
4576
<parameter name="rect" transfer-ownership="none">
4577
<type name="Rectangle" c:type="PangoRectangle*"/>
4578
</parameter>
4579
</parameters>
4580
</method>
4581
<method name="transform_pixel_rectangle"
4582
c:identifier="pango_matrix_transform_pixel_rectangle"
4583
doc="First transforms the @rect using @matrix, then calculates the bounding box
4584
of the transformed rectangle. The rectangle should be in device units
4585
(pixels).
4586
This function is useful for example when you want to draw a rotated
4587
should be and how much you should shift the layout when rendering.
4588
For better accuracy, you should use pango_matrix_transform_rectangle() on
4589
original rectangle in Pango units and convert to pixels afterward
4590
using pango_extents_to_pixels()'s first argument."
4591
version="1.16">
4592
<return-value transfer-ownership="none">
4593
<type name="none" c:type="void"/>
4594
</return-value>
4595
<parameters>
4596
<parameter name="rect" transfer-ownership="none">
4597
<type name="Rectangle" c:type="PangoRectangle*"/>
4598
</parameter>
4599
</parameters>
4600
</method>
4601
<method name="get_font_scale_factor"
4602
c:identifier="pango_matrix_get_font_scale_factor"
4603
doc="Returns the scale factor of a matrix on the height of the font.
4604
That is, the scale factor in the direction perpendicular to the
4605
vector that the X coordinate is mapped to.
4606
or 1.0 if @matrix is %NULL."
4607
version="1.12">
4608
<return-value transfer-ownership="none">
4609
<type name="double" c:type="double"/>
4610
</return-value>
4611
</method>
4612
</record>
4613
<record name="ParenStackEntry" c:type="ParenStackEntry">
4614
<field name="pair_index" writable="1">
4615
<type name="int" c:type="int"/>
4616
</field>
4617
<field name="script_code" writable="1">
4618
<type name="Script" c:type="PangoScript"/>
4619
</field>
4493
example).</doc>
4494
<return-value transfer-ownership="none">
4495
<type name="none" c:type="void"/>
4496
</return-value>
4497
<parameters>
4498
<parameter name="rect" transfer-ownership="none">
4499
<doc xml:whitespace="preserve">in/out bounding box in Pango units, or %NULL</doc>
4500
<type name="Rectangle" c:type="PangoRectangle*"/>
4501
</parameter>
4502
</parameters>
4503
</method>
4504
<method name="translate"
4505
c:identifier="pango_matrix_translate"
4506
version="1.6">
4507
<doc xml:whitespace="preserve">Changes the transformation represented by @matrix to be the
4508
transformation given by first translating by (@tx, @ty)
4509
then applying the original transformation.</doc>
4510
<return-value transfer-ownership="none">
4511
<type name="none" c:type="void"/>
4512
</return-value>
4513
<parameters>
4514
<parameter name="tx" transfer-ownership="none">
4515
<doc xml:whitespace="preserve">amount to translate in the X direction</doc>
4516
<type name="gdouble" c:type="double"/>
4517
</parameter>
4518
<parameter name="ty" transfer-ownership="none">
4519
<doc xml:whitespace="preserve">amount to translate in the Y direction</doc>
4520
<type name="gdouble" c:type="double"/>
4521
</parameter>
4522
</parameters>
4523
</method>
4620
4524
</record>
4621
4525
<constant name="RENDER_TYPE_NONE" value="PangoRenderNone">
4622
<type name="utf8"/>
4526
<type name="utf8" c:type="gchar*"/>
4623
4527
</constant>
4624
4528
<record name="Rectangle" c:type="PangoRectangle">
4625
4529
<field name="x" writable="1">
4626
<type name="int" c:type="int"/>
4530
<type name="gint" c:type="int"/>
4627
4531
</field>
4628
4532
<field name="y" writable="1">
4629
<type name="int" c:type="int"/>
4533
<type name="gint" c:type="int"/>
4630
4534
</field>
4631
4535
<field name="width" writable="1">
4632
<type name="int" c:type="int"/>
4536
<type name="gint" c:type="int"/>
4633
4537
</field>
4634
4538
<field name="height" writable="1">
4635
<type name="int" c:type="int"/>
4539
<type name="gint" c:type="int"/>
4636
4540
</field>
4637
4541
</record>
4638
4542
<enumeration name="RenderPart"
4639
doc="#PangoRenderPart defines different items to render for such
4640
purposes as setting colors."
4641
4543
version="1.8"
4642
4544
glib:type-name="PangoRenderPart"
4643
4545
glib:get-type="pango_render_part_get_type"
4644
4546
c:type="PangoRenderPart">
4547
<doc xml:whitespace="preserve">#PangoRenderPart defines different items to render for such
4548
purposes as setting colors.</doc>
4645
4549
<member name="foreground"
4646
4550
value="0"
4647
4551
c:identifier="PANGO_RENDER_PART_FOREGROUND"
4660
4564
glib:nick="strikethrough"/>
4661
4565
</enumeration>
4662
4566
<class name="Renderer"
4567
c:symbol-prefix="renderer"
4663
4568
c:type="PangoRenderer"
4664
doc="be %NULL, which should be treated the same as the identity matrix.
4665
#PangoRenderer is a base class for objects that are used to
4666
render Pango objects such as #PangoGlyphString and
4667
#PangoLayout."
4668
4569
version="1.8"
4669
4570
parent="GObject.Object"
4670
4571
abstract="1"
4671
4572
glib:type-name="PangoRenderer"
4672
4573
glib:get-type="pango_renderer_get_type"
4673
4574
glib:type-struct="RendererClass">
4674
<virtual-method name="draw_glyphs" invoker="draw_glyphs">
4675
<return-value transfer-ownership="none">
4676
<type name="none" c:type="void"/>
4677
</return-value>
4678
<parameters>
4679
<parameter name="font" transfer-ownership="none">
4680
<type name="Font" c:type="PangoFont*"/>
4681
</parameter>
4682
<parameter name="glyphs" transfer-ownership="none">
4683
<type name="GlyphString" c:type="PangoGlyphString*"/>
4684
</parameter>
4685
<parameter name="x" transfer-ownership="none">
4686
<type name="int" c:type="int"/>
4687
</parameter>
4688
<parameter name="y" transfer-ownership="none">
4689
<type name="int" c:type="int"/>
4690
</parameter>
4691
</parameters>
4692
</virtual-method>
4693
<virtual-method name="draw_rectangle" invoker="draw_rectangle">
4694
<return-value transfer-ownership="none">
4695
<type name="none" c:type="void"/>
4696
</return-value>
4697
<parameters>
4698
<parameter name="part" transfer-ownership="none">
4699
<type name="RenderPart" c:type="PangoRenderPart"/>
4700
</parameter>
4701
<parameter name="x" transfer-ownership="none">
4702
<type name="int" c:type="int"/>
4703
</parameter>
4704
<parameter name="y" transfer-ownership="none">
4705
<type name="int" c:type="int"/>
4706
</parameter>
4707
<parameter name="width" transfer-ownership="none">
4708
<type name="int" c:type="int"/>
4709
</parameter>
4710
<parameter name="height" transfer-ownership="none">
4711
<type name="int" c:type="int"/>
4712
</parameter>
4713
</parameters>
4575
<doc xml:whitespace="preserve">#PangoRenderer is a base class for objects that are used to
4576
render Pango objects such as #PangoGlyphString and
4577
#PangoLayout.</doc>
4578
<virtual-method name="begin">
4579
<return-value transfer-ownership="none">
4580
<type name="none" c:type="void"/>
4581
</return-value>
4714
4582
</virtual-method>
4715
4583
<virtual-method name="draw_error_underline"
4716
invoker="draw_error_underline">
4717
<return-value transfer-ownership="none">
4718
<type name="none" c:type="void"/>
4719
</return-value>
4720
<parameters>
4721
<parameter name="x" transfer-ownership="none">
4722
<type name="int" c:type="int"/>
4723
</parameter>
4724
<parameter name="y" transfer-ownership="none">
4725
<type name="int" c:type="int"/>
4726
</parameter>
4727
<parameter name="width" transfer-ownership="none">
4728
<type name="int" c:type="int"/>
4729
</parameter>
4730
<parameter name="height" transfer-ownership="none">
4731
<type name="int" c:type="int"/>
4584
invoker="draw_error_underline"
4585
version="1.8">
4586
<doc xml:whitespace="preserve">Draw a squiggly line that approximately covers the given rectangle
4587
in the style of an underline used to indicate a spelling error.
4588
(The width of the underline is rounded to an integer number
4589
of up/down segments and the resulting rectangle is centered
4590
in the original rectangle)
4591
This should be called while @renderer is already active. Use
4592
pango_renderer_activate() to activate a renderer.</doc>
4593
<return-value transfer-ownership="none">
4594
<type name="none" c:type="void"/>
4595
</return-value>
4596
<parameters>
4597
<parameter name="x" transfer-ownership="none">
4598
<doc xml:whitespace="preserve">X coordinate of underline, in Pango units in user coordinate system</doc>
4599
<type name="gint" c:type="int"/>
4600
</parameter>
4601
<parameter name="y" transfer-ownership="none">
4602
<doc xml:whitespace="preserve">Y coordinate of underline, in Pango units in user coordinate system</doc>
4603
<type name="gint" c:type="int"/>
4604
</parameter>
4605
<parameter name="width" transfer-ownership="none">
4606
<doc xml:whitespace="preserve">width of underline, in Pango units in user coordinate system</doc>
4607
<type name="gint" c:type="int"/>
4608
</parameter>
4609
<parameter name="height" transfer-ownership="none">
4610
<doc xml:whitespace="preserve">height of underline, in Pango units in user coordinate system</doc>
4611
<type name="gint" c:type="int"/>
4612
</parameter>
4613
</parameters>
4614
</virtual-method>
4615
<virtual-method name="draw_glyph" invoker="draw_glyph" version="1.8">
4616
<doc xml:whitespace="preserve">Draws a single glyph with coordinates in device space.</doc>
4617
<return-value transfer-ownership="none">
4618
<type name="none" c:type="void"/>
4619
</return-value>
4620
<parameters>
4621
<parameter name="font" transfer-ownership="none">
4622
<doc xml:whitespace="preserve">a #PangoFont</doc>
4623
<type name="Font" c:type="PangoFont*"/>
4624
</parameter>
4625
<parameter name="glyph" transfer-ownership="none">
4626
<doc xml:whitespace="preserve">the glyph index of a single glyph</doc>
4627
<type name="Glyph" c:type="PangoGlyph"/>
4628
</parameter>
4629
<parameter name="x" transfer-ownership="none">
4630
<doc xml:whitespace="preserve">X coordinate of left edge of baseline of glyph</doc>
4631
<type name="gdouble" c:type="double"/>
4632
</parameter>
4633
<parameter name="y" transfer-ownership="none">
4634
<doc xml:whitespace="preserve">Y coordinate of left edge of baseline of glyph</doc>
4635
<type name="gdouble" c:type="double"/>
4636
</parameter>
4637
</parameters>
4638
</virtual-method>
4639
<virtual-method name="draw_glyph_item"
4640
invoker="draw_glyph_item"
4641
version="1.22">
4642
<doc xml:whitespace="preserve">Draws the glyphs in @glyph_item with the specified #PangoRenderer,
4643
embedding the text associated with the glyphs in the output if the
4644
output format supports it (PDF for example).
4645
Note that @text is the start of the text for layout, which is then
4646
indexed by <literal>@glyph_item->item->offset</literal>.
4647
If @text is %NULL, this simply calls pango_renderer_draw_glyphs().
4648
The default implementation of this method simply falls back to
4649
pango_renderer_draw_glyphs().</doc>
4650
<return-value transfer-ownership="none">
4651
<type name="none" c:type="void"/>
4652
</return-value>
4653
<parameters>
4654
<parameter name="text" transfer-ownership="none">
4655
<doc xml:whitespace="preserve">the UTF-8 text that @glyph_item refers to, or %NULL</doc>
4656
<type name="utf8" c:type="char*"/>
4657
</parameter>
4658
<parameter name="glyph_item" transfer-ownership="none">
4659
<doc xml:whitespace="preserve">a #PangoGlyphItem</doc>
4660
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
4661
</parameter>
4662
<parameter name="x" transfer-ownership="none">
4663
<doc xml:whitespace="preserve">X position of left edge of baseline, in user space coordinates in Pango units.</doc>
4664
<type name="gint" c:type="int"/>
4665
</parameter>
4666
<parameter name="y" transfer-ownership="none">
4667
<doc xml:whitespace="preserve">Y position of left edge of baseline, in user space coordinates in Pango units.</doc>
4668
<type name="gint" c:type="int"/>
4669
</parameter>
4670
</parameters>
4671
</virtual-method>
4672
<virtual-method name="draw_glyphs" invoker="draw_glyphs" version="1.8">
4673
<doc xml:whitespace="preserve">Draws the glyphs in @glyphs with the specified #PangoRenderer.</doc>
4674
<return-value transfer-ownership="none">
4675
<type name="none" c:type="void"/>
4676
</return-value>
4677
<parameters>
4678
<parameter name="font" transfer-ownership="none">
4679
<doc xml:whitespace="preserve">a #PangoFont</doc>
4680
<type name="Font" c:type="PangoFont*"/>
4681
</parameter>
4682
<parameter name="glyphs" transfer-ownership="none">
4683
<doc xml:whitespace="preserve">a #PangoGlyphString</doc>
4684
<type name="GlyphString" c:type="PangoGlyphString*"/>
4685
</parameter>
4686
<parameter name="x" transfer-ownership="none">
4687
<doc xml:whitespace="preserve">X position of left edge of baseline, in user space coordinates in Pango units.</doc>
4688
<type name="gint" c:type="int"/>
4689
</parameter>
4690
<parameter name="y" transfer-ownership="none">
4691
<doc xml:whitespace="preserve">Y position of left edge of baseline, in user space coordinates in Pango units.</doc>
4692
<type name="gint" c:type="int"/>
4693
</parameter>
4694
</parameters>
4695
</virtual-method>
4696
<virtual-method name="draw_rectangle"
4697
invoker="draw_rectangle"
4698
version="1.8">
4699
<doc xml:whitespace="preserve">Draws an axis-aligned rectangle in user space coordinates with the
4700
specified #PangoRenderer.
4701
This should be called while @renderer is already active. Use
4702
pango_renderer_activate() to activate a renderer.</doc>
4703
<return-value transfer-ownership="none">
4704
<type name="none" c:type="void"/>
4705
</return-value>
4706
<parameters>
4707
<parameter name="part" transfer-ownership="none">
4708
<doc xml:whitespace="preserve">type of object this rectangle is part of</doc>
4709
<type name="RenderPart" c:type="PangoRenderPart"/>
4710
</parameter>
4711
<parameter name="x" transfer-ownership="none">
4712
<doc xml:whitespace="preserve">X position at which to draw rectangle, in user space coordinates in Pango units</doc>
4713
<type name="gint" c:type="int"/>
4714
</parameter>
4715
<parameter name="y" transfer-ownership="none">
4716
<doc xml:whitespace="preserve">Y position at which to draw rectangle, in user space coordinates in Pango units</doc>
4717
<type name="gint" c:type="int"/>
4718
</parameter>
4719
<parameter name="width" transfer-ownership="none">
4720
<doc xml:whitespace="preserve">width of rectangle in Pango units in user space coordinates</doc>
4721
<type name="gint" c:type="int"/>
4722
</parameter>
4723
<parameter name="height" transfer-ownership="none">
4724
<doc xml:whitespace="preserve">height of rectangle in Pango units in user space coordinates</doc>
4725
<type name="gint" c:type="int"/>
4732
4726
</parameter>
4733
4727
</parameters>
4734
4728
</virtual-method>
4741
4735
<type name="AttrShape" c:type="PangoAttrShape*"/>
4742
4736
</parameter>
4743
4737
<parameter name="x" transfer-ownership="none">
4744
<type name="int" c:type="int"/>
4738
<type name="gint" c:type="int"/>
4745
4739
</parameter>
4746
4740
<parameter name="y" transfer-ownership="none">
4747
<type name="int" c:type="int"/>
4741
<type name="gint" c:type="int"/>
4748
4742
</parameter>
4749
4743
</parameters>
4750
4744
</virtual-method>
4751
<virtual-method name="draw_trapezoid" invoker="draw_trapezoid">
4745
<virtual-method name="draw_trapezoid"
4746
invoker="draw_trapezoid"
4747
version="1.8">
4748
<doc xml:whitespace="preserve">Draws a trapezoid with the parallel sides aligned with the X axis
4749
using the given #PangoRenderer; coordinates are in device space.</doc>
4752
4750
<return-value transfer-ownership="none">
4753
4751
<type name="none" c:type="void"/>
4754
4752
</return-value>
4755
4753
<parameters>
4756
4754
<parameter name="part" transfer-ownership="none">
4755
<doc xml:whitespace="preserve">type of object this trapezoid is part of</doc>
4757
4756
<type name="RenderPart" c:type="PangoRenderPart"/>
4758
4757
</parameter>
4759
4758
<parameter name="y1_" transfer-ownership="none">
4760
<type name="double" c:type="double"/>
4759
<doc xml:whitespace="preserve">Y coordinate of top of trapezoid</doc>
4760
<type name="gdouble" c:type="double"/>
4761
4761
</parameter>
4762
4762
<parameter name="x11" transfer-ownership="none">
4763
<type name="double" c:type="double"/>
4763
<doc xml:whitespace="preserve">X coordinate of left end of top of trapezoid</doc>
4764
<type name="gdouble" c:type="double"/>
4764
4765
</parameter>
4765
4766
<parameter name="x21" transfer-ownership="none">
4766
<type name="double" c:type="double"/>
4767
<doc xml:whitespace="preserve">X coordinate of right end of top of trapezoid</doc>
4768
<type name="gdouble" c:type="double"/>
4767
4769
</parameter>
4768
4770
<parameter name="y2" transfer-ownership="none">
4769
<type name="double" c:type="double"/>
4771
<doc xml:whitespace="preserve">Y coordinate of bottom of trapezoid</doc>
4772
<type name="gdouble" c:type="double"/>
4770
4773
</parameter>
4771
4774
<parameter name="x12" transfer-ownership="none">
4772
<type name="double" c:type="double"/>
4775
<doc xml:whitespace="preserve">X coordinate of left end of bottom of trapezoid</doc>
4776
<type name="gdouble" c:type="double"/>
4773
4777
</parameter>
4774
4778
<parameter name="x22" transfer-ownership="none">
4775
<type name="double" c:type="double"/>
4776
</parameter>
4777
</parameters>
4778
</virtual-method>
4779
<virtual-method name="draw_glyph" invoker="draw_glyph">
4780
<return-value transfer-ownership="none">
4781
<type name="none" c:type="void"/>
4782
</return-value>
4783
<parameters>
4784
<parameter name="font" transfer-ownership="none">
4785
<type name="Font" c:type="PangoFont*"/>
4786
</parameter>
4787
<parameter name="glyph" transfer-ownership="none">
4788
<type name="Glyph" c:type="PangoGlyph"/>
4789
</parameter>
4790
<parameter name="x" transfer-ownership="none">
4791
<type name="double" c:type="double"/>
4792
</parameter>
4793
<parameter name="y" transfer-ownership="none">
4794
<type name="double" c:type="double"/>
4795
</parameter>
4796
</parameters>
4797
</virtual-method>
4798
<virtual-method name="part_changed" invoker="part_changed">
4799
<return-value transfer-ownership="none">
4800
<type name="none" c:type="void"/>
4801
</return-value>
4802
<parameters>
4803
<parameter name="part" transfer-ownership="none">
4804
<type name="RenderPart" c:type="PangoRenderPart"/>
4805
</parameter>
4806
</parameters>
4807
</virtual-method>
4808
<virtual-method name="begin">
4809
<return-value transfer-ownership="none">
4810
<type name="none" c:type="void"/>
4811
</return-value>
4779
<doc xml:whitespace="preserve">X coordinate of right end of bottom of trapezoid</doc>
4780
<type name="gdouble" c:type="double"/>
4781
</parameter>
4782
</parameters>
4812
4783
</virtual-method>
4813
4784
<virtual-method name="end">
4814
4785
<return-value transfer-ownership="none">
4815
4786
<type name="none" c:type="void"/>
4816
4787
</return-value>
4817
4788
</virtual-method>
4789
<virtual-method name="part_changed" invoker="part_changed" version="1.8">
4790
<doc xml:whitespace="preserve">Informs Pango that the way that the rendering is done
4791
for @part has changed in a way that would prevent multiple
4792
pieces being joined together into one drawing call. For
4793
instance, if a subclass of #PangoRenderer was to add a stipple
4794
option for drawing underlines, it needs to call
4795
<informalexample><programlisting>
4796
pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE);
4797
</programlisting></informalexample>
4798
When the stipple changes or underlines with different stipples
4799
might be joined together. Pango automatically calls this for
4800
changes to colors. (See pango_renderer_set_color())</doc>
4801
<return-value transfer-ownership="none">
4802
<type name="none" c:type="void"/>
4803
</return-value>
4804
<parameters>
4805
<parameter name="part" transfer-ownership="none">
4806
<doc xml:whitespace="preserve">the part for which rendering has changed.</doc>
4807
<type name="RenderPart" c:type="PangoRenderPart"/>
4808
</parameter>
4809
</parameters>
4810
</virtual-method>
4818
4811
<virtual-method name="prepare_run">
4819
4812
<return-value transfer-ownership="none">
4820
4813
<type name="none" c:type="void"/>
4825
4818
</parameter>
4826
4819
</parameters>
4827
4820
</virtual-method>
4828
<virtual-method name="draw_glyph_item" invoker="draw_glyph_item">
4821
<method name="activate"
4822
c:identifier="pango_renderer_activate"
4823
version="1.8">
4824
<doc xml:whitespace="preserve">Does initial setup before rendering operations on @renderer.
4825
pango_renderer_deactivate() should be called when done drawing.
4826
Calls such as pango_renderer_draw_layout() automatically
4827
activate the layout before drawing on it. Calls to
4828
pango_renderer_activate() and pango_renderer_deactivate() can
4829
be nested and the renderer will only be initialized and
4830
deinitialized once.</doc>
4831
<return-value transfer-ownership="none">
4832
<type name="none" c:type="void"/>
4833
</return-value>
4834
</method>
4835
<method name="deactivate"
4836
c:identifier="pango_renderer_deactivate"
4837
version="1.8">
4838
<doc xml:whitespace="preserve">Cleans up after rendering operations on @renderer. See
4839
docs for pango_renderer_activate().</doc>
4840
<return-value transfer-ownership="none">
4841
<type name="none" c:type="void"/>
4842
</return-value>
4843
</method>
4844
<method name="draw_error_underline"
4845
c:identifier="pango_renderer_draw_error_underline"
4846
version="1.8">
4847
<doc xml:whitespace="preserve">Draw a squiggly line that approximately covers the given rectangle
4848
in the style of an underline used to indicate a spelling error.
4849
(The width of the underline is rounded to an integer number
4850
of up/down segments and the resulting rectangle is centered
4851
in the original rectangle)
4852
This should be called while @renderer is already active. Use
4853
pango_renderer_activate() to activate a renderer.</doc>
4854
<return-value transfer-ownership="none">
4855
<type name="none" c:type="void"/>
4856
</return-value>
4857
<parameters>
4858
<parameter name="x" transfer-ownership="none">
4859
<doc xml:whitespace="preserve">X coordinate of underline, in Pango units in user coordinate system</doc>
4860
<type name="gint" c:type="int"/>
4861
</parameter>
4862
<parameter name="y" transfer-ownership="none">
4863
<doc xml:whitespace="preserve">Y coordinate of underline, in Pango units in user coordinate system</doc>
4864
<type name="gint" c:type="int"/>
4865
</parameter>
4866
<parameter name="width" transfer-ownership="none">
4867
<doc xml:whitespace="preserve">width of underline, in Pango units in user coordinate system</doc>
4868
<type name="gint" c:type="int"/>
4869
</parameter>
4870
<parameter name="height" transfer-ownership="none">
4871
<doc xml:whitespace="preserve">height of underline, in Pango units in user coordinate system</doc>
4872
<type name="gint" c:type="int"/>
4873
</parameter>
4874
</parameters>
4875
</method>
4876
<method name="draw_glyph"
4877
c:identifier="pango_renderer_draw_glyph"
4878
version="1.8">
4879
<doc xml:whitespace="preserve">Draws a single glyph with coordinates in device space.</doc>
4880
<return-value transfer-ownership="none">
4881
<type name="none" c:type="void"/>
4882
</return-value>
4883
<parameters>
4884
<parameter name="font" transfer-ownership="none">
4885
<doc xml:whitespace="preserve">a #PangoFont</doc>
4886
<type name="Font" c:type="PangoFont*"/>
4887
</parameter>
4888
<parameter name="glyph" transfer-ownership="none">
4889
<doc xml:whitespace="preserve">the glyph index of a single glyph</doc>
4890
<type name="Glyph" c:type="PangoGlyph"/>
4891
</parameter>
4892
<parameter name="x" transfer-ownership="none">
4893
<doc xml:whitespace="preserve">X coordinate of left edge of baseline of glyph</doc>
4894
<type name="gdouble" c:type="double"/>
4895
</parameter>
4896
<parameter name="y" transfer-ownership="none">
4897
<doc xml:whitespace="preserve">Y coordinate of left edge of baseline of glyph</doc>
4898
<type name="gdouble" c:type="double"/>
4899
</parameter>
4900
</parameters>
4901
</method>
4902
<method name="draw_glyph_item"
4903
c:identifier="pango_renderer_draw_glyph_item"
4904
version="1.22">
4905
<doc xml:whitespace="preserve">Draws the glyphs in @glyph_item with the specified #PangoRenderer,
4906
embedding the text associated with the glyphs in the output if the
4907
output format supports it (PDF for example).
4908
Note that @text is the start of the text for layout, which is then
4909
indexed by <literal>@glyph_item->item->offset</literal>.
4910
If @text is %NULL, this simply calls pango_renderer_draw_glyphs().
4911
The default implementation of this method simply falls back to
4912
pango_renderer_draw_glyphs().</doc>
4829
4913
<return-value transfer-ownership="none">
4830
4914
<type name="none" c:type="void"/>
4831
4915
</return-value>
4832
4916
<parameters>
4833
4917
<parameter name="text" transfer-ownership="none">
4918
<doc xml:whitespace="preserve">the UTF-8 text that @glyph_item refers to, or %NULL</doc>
4834
4919
<type name="utf8" c:type="char*"/>
4835
4920
</parameter>
4836
4921
<parameter name="glyph_item" transfer-ownership="none">
4922
<doc xml:whitespace="preserve">a #PangoGlyphItem</doc>
4837
4923
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
4838
4924
</parameter>
4839
4925
<parameter name="x" transfer-ownership="none">
4840
<type name="int" c:type="int"/>
4841
</parameter>
4842
<parameter name="y" transfer-ownership="none">
4843
<type name="int" c:type="int"/>
4844
</parameter>
4845
</parameters>
4846
</virtual-method>
4926
<doc xml:whitespace="preserve">X position of left edge of baseline, in user space coordinates in Pango units.</doc>
4927
<type name="gint" c:type="int"/>
4928
</parameter>
4929
<parameter name="y" transfer-ownership="none">
4930
<doc xml:whitespace="preserve">Y position of left edge of baseline, in user space coordinates in Pango units.</doc>
4931
<type name="gint" c:type="int"/>
4932
</parameter>
4933
</parameters>
4934
</method>
4935
<method name="draw_glyphs"
4936
c:identifier="pango_renderer_draw_glyphs"
4937
version="1.8">
4938
<doc xml:whitespace="preserve">Draws the glyphs in @glyphs with the specified #PangoRenderer.</doc>
4939
<return-value transfer-ownership="none">
4940
<type name="none" c:type="void"/>
4941
</return-value>
4942
<parameters>
4943
<parameter name="font" transfer-ownership="none">
4944
<doc xml:whitespace="preserve">a #PangoFont</doc>
4945
<type name="Font" c:type="PangoFont*"/>
4946
</parameter>
4947
<parameter name="glyphs" transfer-ownership="none">
4948
<doc xml:whitespace="preserve">a #PangoGlyphString</doc>
4949
<type name="GlyphString" c:type="PangoGlyphString*"/>
4950
</parameter>
4951
<parameter name="x" transfer-ownership="none">
4952
<doc xml:whitespace="preserve">X position of left edge of baseline, in user space coordinates in Pango units.</doc>
4953
<type name="gint" c:type="int"/>
4954
</parameter>
4955
<parameter name="y" transfer-ownership="none">
4956
<doc xml:whitespace="preserve">Y position of left edge of baseline, in user space coordinates in Pango units.</doc>
4957
<type name="gint" c:type="int"/>
4958
</parameter>
4959
</parameters>
4960
</method>
4847
4961
<method name="draw_layout"
4848
4962
c:identifier="pango_renderer_draw_layout"
4849
doc="in Pango units.
4850
in Pango units.
4851
Draws @layout with the specified #PangoRenderer."
4852
4963
version="1.8">
4964
<doc xml:whitespace="preserve">Draws @layout with the specified #PangoRenderer.</doc>
4853
4965
<return-value transfer-ownership="none">
4854
4966
<type name="none" c:type="void"/>
4855
4967
</return-value>
4856
4968
<parameters>
4857
4969
<parameter name="layout" transfer-ownership="none">
4970
<doc xml:whitespace="preserve">a #PangoLayout</doc>
4858
4971
<type name="Layout" c:type="PangoLayout*"/>
4859
4972
</parameter>
4860
4973
<parameter name="x" transfer-ownership="none">
4861
<type name="int" c:type="int"/>
4974
<doc xml:whitespace="preserve">X position of left edge of baseline, in user space coordinates in Pango units.</doc>
4975
<type name="gint" c:type="int"/>
4862
4976
</parameter>
4863
4977
<parameter name="y" transfer-ownership="none">
4864
<type name="int" c:type="int"/>
4978
<doc xml:whitespace="preserve">Y position of left edge of baseline, in user space coordinates in Pango units.</doc>
4979
<type name="gint" c:type="int"/>
4865
4980
</parameter>
4866
4981
</parameters>
4867
4982
</method>
4868
4983
<method name="draw_layout_line"
4869
4984
c:identifier="pango_renderer_draw_layout_line"
4870
doc="in Pango units.
4871
in Pango units.
4872
Draws @line with the specified #PangoRenderer."
4873
4985
version="1.8">
4986
<doc xml:whitespace="preserve">Draws @line with the specified #PangoRenderer.</doc>
4874
4987
<return-value transfer-ownership="none">
4875
4988
<type name="none" c:type="void"/>
4876
4989
</return-value>
4877
4990
<parameters>
4878
4991
<parameter name="line" transfer-ownership="none">
4992
<doc xml:whitespace="preserve">a #PangoLayoutLine</doc>
4879
4993
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
4880
4994
</parameter>
4881
4995
<parameter name="x" transfer-ownership="none">
4882
<type name="int" c:type="int"/>
4883
</parameter>
4884
<parameter name="y" transfer-ownership="none">
4885
<type name="int" c:type="int"/>
4886
</parameter>
4887
</parameters>
4888
</method>
4889
<method name="draw_glyphs"
4890
c:identifier="pango_renderer_draw_glyphs"
4891
doc="in Pango units.
4892
in Pango units.
4893
Draws the glyphs in @glyphs with the specified #PangoRenderer."
4894
version="1.8">
4895
<return-value transfer-ownership="none">
4896
<type name="none" c:type="void"/>
4897
</return-value>
4898
<parameters>
4899
<parameter name="font" transfer-ownership="none">
4900
<type name="Font" c:type="PangoFont*"/>
4901
</parameter>
4902
<parameter name="glyphs" transfer-ownership="none">
4903
<type name="GlyphString" c:type="PangoGlyphString*"/>
4904
</parameter>
4905
<parameter name="x" transfer-ownership="none">
4906
<type name="int" c:type="int"/>
4907
</parameter>
4908
<parameter name="y" transfer-ownership="none">
4909
<type name="int" c:type="int"/>
4910
</parameter>
4911
</parameters>
4912
</method>
4913
<method name="draw_glyph_item"
4914
c:identifier="pango_renderer_draw_glyph_item"
4915
doc="in Pango units.
4916
in Pango units.
4917
Draws the glyphs in @glyph_item with the specified #PangoRenderer,
4918
embedding the text associated with the glyphs in the output if the
4919
output format supports it (PDF for example).
4920
Note that @text is the start of the text for layout, which is then
4921
indexed by <literal>@glyph_item->item->offset</literal>.
4922
If @text is %NULL, this simply calls pango_renderer_draw_glyphs().
4923
The default implementation of this method simply falls back to
4924
pango_renderer_draw_glyphs()."
4925
version="1.22">
4926
<return-value transfer-ownership="none">
4927
<type name="none" c:type="void"/>
4928
</return-value>
4929
<parameters>
4930
<parameter name="text" transfer-ownership="none">
4931
<type name="utf8" c:type="char*"/>
4932
</parameter>
4933
<parameter name="glyph_item" transfer-ownership="none">
4934
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
4935
</parameter>
4936
<parameter name="x" transfer-ownership="none">
4937
<type name="int" c:type="int"/>
4938
</parameter>
4939
<parameter name="y" transfer-ownership="none">
4940
<type name="int" c:type="int"/>
4996
<doc xml:whitespace="preserve">X position of left edge of baseline, in user space coordinates in Pango units.</doc>
4997
<type name="gint" c:type="int"/>
4998
</parameter>
4999
<parameter name="y" transfer-ownership="none">
5000
<doc xml:whitespace="preserve">Y position of left edge of baseline, in user space coordinates in Pango units.</doc>
5001
<type name="gint" c:type="int"/>
4941
5002
</parameter>
4942
5003
</parameters>
4943
5004
</method>
4944
5005
<method name="draw_rectangle"
4945
5006
c:identifier="pango_renderer_draw_rectangle"
4946
doc="Draws an axis-aligned rectangle in user space coordinates with the
5007
version="1.8">
5008
<doc xml:whitespace="preserve">Draws an axis-aligned rectangle in user space coordinates with the
4947
5009
specified #PangoRenderer.
4948
5010
This should be called while @renderer is already active. Use
4949
pango_renderer_activate() to activate a renderer."
4950
version="1.8">
5011
pango_renderer_activate() to activate a renderer.</doc>
4951
5012
<return-value transfer-ownership="none">
4952
5013
<type name="none" c:type="void"/>
4953
5014
</return-value>
4954
5015
<parameters>
4955
5016
<parameter name="part" transfer-ownership="none">
5017
<doc xml:whitespace="preserve">type of object this rectangle is part of</doc>
4956
5018
<type name="RenderPart" c:type="PangoRenderPart"/>
4957
5019
</parameter>
4958
5020
<parameter name="x" transfer-ownership="none">
4959
<type name="int" c:type="int"/>
4960
</parameter>
4961
<parameter name="y" transfer-ownership="none">
4962
<type name="int" c:type="int"/>
4963
</parameter>
4964
<parameter name="width" transfer-ownership="none">
4965
<type name="int" c:type="int"/>
4966
</parameter>
4967
<parameter name="height" transfer-ownership="none">
4968
<type name="int" c:type="int"/>
4969
</parameter>
4970
</parameters>
4971
</method>
4972
<method name="draw_error_underline"
4973
c:identifier="pango_renderer_draw_error_underline"
4974
doc="Draw a squiggly line that approximately covers the given rectangle
4975
in the style of an underline used to indicate a spelling error.
4976
(The width of the underline is rounded to an integer number
4977
of up/down segments and the resulting rectangle is centered
4978
in the original rectangle)
4979
This should be called while @renderer is already active. Use
4980
pango_renderer_activate() to activate a renderer."
4981
version="1.8">
4982
<return-value transfer-ownership="none">
4983
<type name="none" c:type="void"/>
4984
</return-value>
4985
<parameters>
4986
<parameter name="x" transfer-ownership="none">
4987
<type name="int" c:type="int"/>
4988
</parameter>
4989
<parameter name="y" transfer-ownership="none">
4990
<type name="int" c:type="int"/>
4991
</parameter>
4992
<parameter name="width" transfer-ownership="none">
4993
<type name="int" c:type="int"/>
4994
</parameter>
4995
<parameter name="height" transfer-ownership="none">
4996
<type name="int" c:type="int"/>
5021
<doc xml:whitespace="preserve">X position at which to draw rectangle, in user space coordinates in Pango units</doc>
5022
<type name="gint" c:type="int"/>
5023
</parameter>
5024
<parameter name="y" transfer-ownership="none">
5025
<doc xml:whitespace="preserve">Y position at which to draw rectangle, in user space coordinates in Pango units</doc>
5026
<type name="gint" c:type="int"/>
5027
</parameter>
5028
<parameter name="width" transfer-ownership="none">
5029
<doc xml:whitespace="preserve">width of rectangle in Pango units in user space coordinates</doc>
5030
<type name="gint" c:type="int"/>
5031
</parameter>
5032
<parameter name="height" transfer-ownership="none">
5033
<doc xml:whitespace="preserve">height of rectangle in Pango units in user space coordinates</doc>
5034
<type name="gint" c:type="int"/>
4997
5035
</parameter>
4998
5036
</parameters>
4999
5037
</method>
5000
5038
<method name="draw_trapezoid"
5001
5039
c:identifier="pango_renderer_draw_trapezoid"
5002
doc="Draws a trapezoid with the parallel sides aligned with the X axis
5003
using the given #PangoRenderer; coordinates are in device space."
5004
5040
version="1.8">
5041
<doc xml:whitespace="preserve">Draws a trapezoid with the parallel sides aligned with the X axis
5042
using the given #PangoRenderer; coordinates are in device space.</doc>
5005
5043
<return-value transfer-ownership="none">
5006
5044
<type name="none" c:type="void"/>
5007
5045
</return-value>
5008
5046
<parameters>
5009
5047
<parameter name="part" transfer-ownership="none">
5048
<doc xml:whitespace="preserve">type of object this trapezoid is part of</doc>
5010
5049
<type name="RenderPart" c:type="PangoRenderPart"/>
5011
5050
</parameter>
5012
5051
<parameter name="y1_" transfer-ownership="none">
5013
<type name="double" c:type="double"/>
5052
<doc xml:whitespace="preserve">Y coordinate of top of trapezoid</doc>
5053
<type name="gdouble" c:type="double"/>
5014
5054
</parameter>
5015
5055
<parameter name="x11" transfer-ownership="none">
5016
<type name="double" c:type="double"/>
5056
<doc xml:whitespace="preserve">X coordinate of left end of top of trapezoid</doc>
5057
<type name="gdouble" c:type="double"/>
5017
5058
</parameter>
5018
5059
<parameter name="x21" transfer-ownership="none">
5019
<type name="double" c:type="double"/>
5060
<doc xml:whitespace="preserve">X coordinate of right end of top of trapezoid</doc>
5061
<type name="gdouble" c:type="double"/>
5020
5062
</parameter>
5021
5063
<parameter name="y2" transfer-ownership="none">
5022
<type name="double" c:type="double"/>
5064
<doc xml:whitespace="preserve">Y coordinate of bottom of trapezoid</doc>
5065
<type name="gdouble" c:type="double"/>
5023
5066
</parameter>
5024
5067
<parameter name="x12" transfer-ownership="none">
5025
<type name="double" c:type="double"/>
5068
<doc xml:whitespace="preserve">X coordinate of left end of bottom of trapezoid</doc>
5069
<type name="gdouble" c:type="double"/>
5026
5070
</parameter>
5027
5071
<parameter name="x22" transfer-ownership="none">
5028
<type name="double" c:type="double"/>
5072
<doc xml:whitespace="preserve">X coordinate of right end of bottom of trapezoid</doc>
5073
<type name="gdouble" c:type="double"/>
5029
5074
</parameter>
5030
5075
</parameters>
5031
5076
</method>
5032
<method name="draw_glyph"
5033
c:identifier="pango_renderer_draw_glyph"
5034
doc="Draws a single glyph with coordinates in device space."
5077
<method name="get_color"
5078
c:identifier="pango_renderer_get_color"
5035
5079
version="1.8">
5036
<return-value transfer-ownership="none">
5037
<type name="none" c:type="void"/>
5080
<doc xml:whitespace="preserve">Gets the current rendering color for the specified part.
5081
if it hasn't been set and should be inherited from the
5082
environment.</doc>
5083
<return-value transfer-ownership="full">
5084
<doc xml:whitespace="preserve">the color for the specified part, or %NULL</doc>
5085
<type name="Color" c:type="PangoColor*"/>
5038
5086
</return-value>
5039
5087
<parameters>
5040
<parameter name="font" transfer-ownership="none">
5041
<type name="Font" c:type="PangoFont*"/>
5042
</parameter>
5043
<parameter name="glyph" transfer-ownership="none">
5044
<type name="Glyph" c:type="PangoGlyph"/>
5045
</parameter>
5046
<parameter name="x" transfer-ownership="none">
5047
<type name="double" c:type="double"/>
5048
</parameter>
5049
<parameter name="y" transfer-ownership="none">
5050
<type name="double" c:type="double"/>
5088
<parameter name="part" transfer-ownership="none">
5089
<doc xml:whitespace="preserve">the part to get the color for</doc>
5090
<type name="RenderPart" c:type="PangoRenderPart"/>
5051
5091
</parameter>
5052
5092
</parameters>
5053
5093
</method>
5054
<method name="activate"
5055
c:identifier="pango_renderer_activate"
5056
doc="Does initial setup before rendering operations on @renderer.
5057
pango_renderer_deactivate() should be called when done drawing.
5058
Calls such as pango_renderer_draw_layout() automatically
5059
activate the layout before drawing on it. Calls to
5060
pango_renderer_activate() and pango_renderer_deactivate() can
5061
be nested and the renderer will only be initialized and
5062
deinitialized once."
5063
version="1.8">
5064
<return-value transfer-ownership="none">
5065
<type name="none" c:type="void"/>
5066
</return-value>
5067
</method>
5068
<method name="deactivate"
5069
c:identifier="pango_renderer_deactivate"
5070
doc="Cleans up after rendering operations on @renderer. See
5071
docs for pango_renderer_activate()."
5072
version="1.8">
5073
<return-value transfer-ownership="none">
5074
<type name="none" c:type="void"/>
5094
<method name="get_layout"
5095
c:identifier="pango_renderer_get_layout"
5096
version="1.20"
5097
introspectable="0">
5098
<doc xml:whitespace="preserve">Gets the layout currently being rendered using @renderer.
5099
Calling this function only makes sense from inside a subclass's
5100
methods, like in its draw_shape<!---->() for example.
5101
The returned layout should not be modified while still being
5102
rendered.
5103
rendered using @renderer at this time.</doc>
5104
<return-value>
5105
<doc xml:whitespace="preserve">the layout, or %NULL if no layout is being</doc>
5106
<type name="Layout" c:type="PangoLayout*"/>
5107
</return-value>
5108
</method>
5109
<method name="get_layout_line"
5110
c:identifier="pango_renderer_get_layout_line"
5111
version="1.20">
5112
<doc xml:whitespace="preserve">Gets the layout line currently being rendered using @renderer.
5113
Calling this function only makes sense from inside a subclass's
5114
methods, like in its draw_shape<!---->() for example.
5115
The returned layout line should not be modified while still being
5116
rendered.
5117
rendered using @renderer at this time.</doc>
5118
<return-value transfer-ownership="full">
5119
<doc xml:whitespace="preserve">the layout line, or %NULL if no layout line is being</doc>
5120
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
5121
</return-value>
5122
</method>
5123
<method name="get_matrix"
5124
c:identifier="pango_renderer_get_matrix"
5125
version="1.8">
5126
<doc xml:whitespace="preserve">Gets the transformation matrix that will be applied when
5127
rendering. See pango_renderer_set_matrix().
5128
(which is the same as the identity matrix). The returned
5129
matrix is owned by Pango and must not be modified or
5130
freed.</doc>
5131
<return-value transfer-ownership="none">
5132
<doc xml:whitespace="preserve">the matrix, or %NULL if no matrix has been set</doc>
5133
<type name="Matrix" c:type="PangoMatrix*"/>
5075
5134
</return-value>
5076
5135
</method>
5077
5136
<method name="part_changed"
5078
5137
c:identifier="pango_renderer_part_changed"
5079
doc="Informs Pango that the way that the rendering is done
5138
version="1.8">
5139
<doc xml:whitespace="preserve">Informs Pango that the way that the rendering is done
5080
5140
for @part has changed in a way that would prevent multiple
5081
5141
pieces being joined together into one drawing call. For
5082
5142
instance, if a subclass of #PangoRenderer was to add a stipple
5086
5146
</programlisting></informalexample>
5087
5147
When the stipple changes or underlines with different stipples
5088
5148
might be joined together. Pango automatically calls this for
5089
changes to colors. (See pango_renderer_set_color())"
5090
version="1.8">
5149
changes to colors. (See pango_renderer_set_color())</doc>
5091
5150
<return-value transfer-ownership="none">
5092
5151
<type name="none" c:type="void"/>
5093
5152
</return-value>
5094
5153
<parameters>
5095
5154
<parameter name="part" transfer-ownership="none">
5155
<doc xml:whitespace="preserve">the part for which rendering has changed.</doc>
5096
5156
<type name="RenderPart" c:type="PangoRenderPart"/>
5097
5157
</parameter>
5098
5158
</parameters>
5099
5159
</method>
5100
5160
<method name="set_color"
5101
5161
c:identifier="pango_renderer_set_color"
5102
doc="Sets the color for part of the rendering."
5103
5162
version="1.8">
5163
<doc xml:whitespace="preserve">Sets the color for part of the rendering.</doc>
5104
5164
<return-value transfer-ownership="none">
5105
5165
<type name="none" c:type="void"/>
5106
5166
</return-value>
5107
5167
<parameters>
5108
5168
<parameter name="part" transfer-ownership="none">
5169
<doc xml:whitespace="preserve">the part to change the color of</doc>
5109
5170
<type name="RenderPart" c:type="PangoRenderPart"/>
5110
5171
</parameter>
5111
5172
<parameter name="color" transfer-ownership="none">
5173
<doc xml:whitespace="preserve">the new color or %NULL to unset the current color</doc>
5112
5174
<type name="Color" c:type="PangoColor*"/>
5113
5175
</parameter>
5114
5176
</parameters>
5115
5177
</method>
5116
<method name="get_color"
5117
c:identifier="pango_renderer_get_color"
5118
doc="Gets the current rendering color for the specified part.
5119
if it hasn't been set and should be inherited from the
5120
environment."
5121
version="1.8">
5122
<return-value transfer-ownership="full">
5123
<type name="Color" c:type="PangoColor*"/>
5124
</return-value>
5125
<parameters>
5126
<parameter name="part" transfer-ownership="none">
5127
<type name="RenderPart" c:type="PangoRenderPart"/>
5128
</parameter>
5129
</parameters>
5130
</method>
5131
5178
<method name="set_matrix"
5132
5179
c:identifier="pango_renderer_set_matrix"
5133
doc="(No matrix set is the same as setting the identity matrix.)
5134
Sets the transformation matrix that will be applied when rendering."
5135
5180
version="1.8">
5181
<doc xml:whitespace="preserve">Sets the transformation matrix that will be applied when rendering.</doc>
5136
5182
<return-value transfer-ownership="none">
5137
5183
<type name="none" c:type="void"/>
5138
5184
</return-value>
5139
5185
<parameters>
5140
5186
<parameter name="matrix" transfer-ownership="none">
5187
<doc xml:whitespace="preserve">a #PangoMatrix, or %NULL to unset any existing matrix. (No matrix set is the same as setting the identity matrix.)</doc>
5141
5188
<type name="Matrix" c:type="PangoMatrix*"/>
5142
5189
</parameter>
5143
5190
</parameters>
5144
5191
</method>
5145
<method name="get_matrix"
5146
c:identifier="pango_renderer_get_matrix"
5147
doc="Gets the transformation matrix that will be applied when
5148
rendering. See pango_renderer_set_matrix().
5149
(which is the same as the identity matrix). The returned
5150
matrix is owned by Pango and must not be modified or
5151
freed."
5152
version="1.8">
5153
<return-value transfer-ownership="none">
5154
<type name="Matrix" c:type="PangoMatrix*"/>
5155
</return-value>
5156
</method>
5157
<method name="get_layout"
5158
c:identifier="pango_renderer_get_layout"
5159
doc="Gets the layout currently being rendered using @renderer.
5160
Calling this function only makes sense from inside a subclass's
5161
methods, like in its draw_shape<!---->() for example.
5162
The returned layout should not be modified while still being
5163
rendered.
5164
rendered using @renderer at this time."
5165
version="1.20">
5166
<return-value transfer-ownership="full">
5167
<type name="Layout" c:type="PangoLayout*"/>
5168
</return-value>
5169
</method>
5170
<method name="get_layout_line"
5171
c:identifier="pango_renderer_get_layout_line"
5172
doc="Gets the layout line currently being rendered using @renderer.
5173
Calling this function only makes sense from inside a subclass's
5174
methods, like in its draw_shape<!---->() for example.
5175
The returned layout line should not be modified while still being
5176
rendered.
5177
rendered using @renderer at this time."
5178
version="1.20">
5179
<return-value transfer-ownership="full">
5180
<type name="LayoutLine" c:type="PangoLayoutLine*"/>
5181
</return-value>
5182
</method>
5183
5192
<field name="parent_instance">
5184
5193
<type name="GObject.Object" c:type="GObject"/>
5185
5194
</field>
5187
5196
<type name="Underline" c:type="PangoUnderline"/>
5188
5197
</field>
5189
5198
<field name="strikethrough">
5190
<type name="boolean" c:type="gboolean"/>
5199
<type name="gboolean" c:type="gboolean"/>
5191
5200
</field>
5192
5201
<field name="active_count">
5193
<type name="int" c:type="int"/>
5202
<type name="gint" c:type="int"/>
5194
5203
</field>
5195
5204
<field name="matrix">
5196
5205
<type name="Matrix" c:type="PangoMatrix*"/>
5202
5211
<record name="RendererClass"
5203
5212
c:type="PangoRendererClass"
5204
5213
glib:is-gtype-struct-for="Renderer"
5205
doc="covers the given rectangle in the style of an underline used to
5206
indicate a spelling error.
5207
in user coordinates.
5208
attributes change
5209
Class structure for #PangoRenderer."
5210
5214
version="1.8">
5215
<doc xml:whitespace="preserve">Class structure for #PangoRenderer.</doc>
5211
5216
<field name="parent_class">
5212
5217
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
5213
5218
</field>
5214
5219
<field name="draw_glyphs">
5215
<callback name="draw_glyphs" c:type="draw_glyphs">
5220
<callback name="draw_glyphs">
5216
5221
<return-value transfer-ownership="none">
5217
5222
<type name="none" c:type="void"/>
5218
5223
</return-value>
5221
5226
<type name="Renderer" c:type="PangoRenderer*"/>
5222
5227
</parameter>
5223
5228
<parameter name="font" transfer-ownership="none">
5229
<doc xml:whitespace="preserve">a #PangoFont</doc>
5224
5230
<type name="Font" c:type="PangoFont*"/>
5225
5231
</parameter>
5226
5232
<parameter name="glyphs" transfer-ownership="none">
5233
<doc xml:whitespace="preserve">a #PangoGlyphString</doc>
5227
5234
<type name="GlyphString" c:type="PangoGlyphString*"/>
5228
5235
</parameter>
5229
5236
<parameter name="x" transfer-ownership="none">
5230
<type name="int" c:type="int"/>
5237
<doc xml:whitespace="preserve">X position of left edge of baseline, in user space coordinates in Pango units.</doc>
5238
<type name="gint" c:type="int"/>
5231
5239
</parameter>
5232
5240
<parameter name="y" transfer-ownership="none">
5233
<type name="int" c:type="int"/>
5241
<doc xml:whitespace="preserve">Y position of left edge of baseline, in user space coordinates in Pango units.</doc>
5242
<type name="gint" c:type="int"/>
5234
5243
</parameter>
5235
5244
</parameters>
5236
5245
</callback>
5237
5246
</field>
5238
5247
<field name="draw_rectangle">
5239
<callback name="draw_rectangle" c:type="draw_rectangle">
5248
<callback name="draw_rectangle">
5240
5249
<return-value transfer-ownership="none">
5241
5250
<type name="none" c:type="void"/>
5242
5251
</return-value>
5245
5254
<type name="Renderer" c:type="PangoRenderer*"/>
5246
5255
</parameter>
5247
5256
<parameter name="part" transfer-ownership="none">
5257
<doc xml:whitespace="preserve">type of object this rectangle is part of</doc>
5248
5258
<type name="RenderPart" c:type="PangoRenderPart"/>
5249
5259
</parameter>
5250
5260
<parameter name="x" transfer-ownership="none">
5251
<type name="int" c:type="int"/>
5261
<doc xml:whitespace="preserve">X position at which to draw rectangle, in user space coordinates in Pango units</doc>
5262
<type name="gint" c:type="int"/>
5252
5263
</parameter>
5253
5264
<parameter name="y" transfer-ownership="none">
5254
<type name="int" c:type="int"/>
5265
<doc xml:whitespace="preserve">Y position at which to draw rectangle, in user space coordinates in Pango units</doc>
5266
<type name="gint" c:type="int"/>
5255
5267
</parameter>
5256
5268
<parameter name="width" transfer-ownership="none">
5257
<type name="int" c:type="int"/>
5269
<doc xml:whitespace="preserve">width of rectangle in Pango units in user space coordinates</doc>
5270
<type name="gint" c:type="int"/>
5258
5271
</parameter>
5259
5272
<parameter name="height" transfer-ownership="none">
5260
<type name="int" c:type="int"/>
5273
<doc xml:whitespace="preserve">height of rectangle in Pango units in user space coordinates</doc>
5274
<type name="gint" c:type="int"/>
5261
5275
</parameter>
5262
5276
</parameters>
5263
5277
</callback>
5264
5278
</field>
5265
5279
<field name="draw_error_underline">
5266
<callback name="draw_error_underline" c:type="draw_error_underline">
5280
<callback name="draw_error_underline">
5267
5281
<return-value transfer-ownership="none">
5268
5282
<type name="none" c:type="void"/>
5269
5283
</return-value>
5272
5286
<type name="Renderer" c:type="PangoRenderer*"/>
5273
5287
</parameter>
5274
5288
<parameter name="x" transfer-ownership="none">
5275
<type name="int" c:type="int"/>
5289
<doc xml:whitespace="preserve">X coordinate of underline, in Pango units in user coordinate system</doc>
5290
<type name="gint" c:type="int"/>
5276
5291
</parameter>
5277
5292
<parameter name="y" transfer-ownership="none">
5278
<type name="int" c:type="int"/>
5293
<doc xml:whitespace="preserve">Y coordinate of underline, in Pango units in user coordinate system</doc>
5294
<type name="gint" c:type="int"/>
5279
5295
</parameter>
5280
5296
<parameter name="width" transfer-ownership="none">
5281
<type name="int" c:type="int"/>
5297
<doc xml:whitespace="preserve">width of underline, in Pango units in user coordinate system</doc>
5298
<type name="gint" c:type="int"/>
5282
5299
</parameter>
5283
5300
<parameter name="height" transfer-ownership="none">
5284
<type name="int" c:type="int"/>
5301
<doc xml:whitespace="preserve">height of underline, in Pango units in user coordinate system</doc>
5302
<type name="gint" c:type="int"/>
5285
5303
</parameter>
5286
5304
</parameters>
5287
5305
</callback>
5288
5306
</field>
5289
5307
<field name="draw_shape">
5290
<callback name="draw_shape" c:type="draw_shape">
5308
<callback name="draw_shape">
5291
5309
<return-value transfer-ownership="none">
5292
5310
<type name="none" c:type="void"/>
5293
5311
</return-value>
5299
5317
<type name="AttrShape" c:type="PangoAttrShape*"/>
5300
5318
</parameter>
5301
5319
<parameter name="x" transfer-ownership="none">
5302
<type name="int" c:type="int"/>
5320
<type name="gint" c:type="int"/>
5303
5321
</parameter>
5304
5322
<parameter name="y" transfer-ownership="none">
5305
<type name="int" c:type="int"/>
5323
<type name="gint" c:type="int"/>
5306
5324
</parameter>
5307
5325
</parameters>
5308
5326
</callback>
5309
5327
</field>
5310
5328
<field name="draw_trapezoid">
5311
<callback name="draw_trapezoid" c:type="draw_trapezoid">
5329
<callback name="draw_trapezoid">
5312
5330
<return-value transfer-ownership="none">
5313
5331
<type name="none" c:type="void"/>
5314
5332
</return-value>
5317
5335
<type name="Renderer" c:type="PangoRenderer*"/>
5318
5336
</parameter>
5319
5337
<parameter name="part" transfer-ownership="none">
5338
<doc xml:whitespace="preserve">type of object this trapezoid is part of</doc>
5320
5339
<type name="RenderPart" c:type="PangoRenderPart"/>
5321
5340
</parameter>
5322
5341
<parameter name="y1_" transfer-ownership="none">
5323
<type name="double" c:type="double"/>
5342
<doc xml:whitespace="preserve">Y coordinate of top of trapezoid</doc>
5343
<type name="gdouble" c:type="double"/>
5324
5344
</parameter>
5325
5345
<parameter name="x11" transfer-ownership="none">
5326
<type name="double" c:type="double"/>
5346
<doc xml:whitespace="preserve">X coordinate of left end of top of trapezoid</doc>
5347
<type name="gdouble" c:type="double"/>
5327
5348
</parameter>
5328
5349
<parameter name="x21" transfer-ownership="none">
5329
<type name="double" c:type="double"/>
5350
<doc xml:whitespace="preserve">X coordinate of right end of top of trapezoid</doc>
5351
<type name="gdouble" c:type="double"/>
5330
5352
</parameter>
5331
5353
<parameter name="y2" transfer-ownership="none">
5332
<type name="double" c:type="double"/>
5354
<doc xml:whitespace="preserve">Y coordinate of bottom of trapezoid</doc>
5355
<type name="gdouble" c:type="double"/>
5333
5356
</parameter>
5334
5357
<parameter name="x12" transfer-ownership="none">
5335
<type name="double" c:type="double"/>
5358
<doc xml:whitespace="preserve">X coordinate of left end of bottom of trapezoid</doc>
5359
<type name="gdouble" c:type="double"/>
5336
5360
</parameter>
5337
5361
<parameter name="x22" transfer-ownership="none">
5338
<type name="double" c:type="double"/>
5362
<doc xml:whitespace="preserve">X coordinate of right end of bottom of trapezoid</doc>
5363
<type name="gdouble" c:type="double"/>
5339
5364
</parameter>
5340
5365
</parameters>
5341
5366
</callback>
5342
5367
</field>
5343
5368
<field name="draw_glyph">
5344
<callback name="draw_glyph" c:type="draw_glyph">
5369
<callback name="draw_glyph">
5345
5370
<return-value transfer-ownership="none">
5346
5371
<type name="none" c:type="void"/>
5347
5372
</return-value>
5350
5375
<type name="Renderer" c:type="PangoRenderer*"/>
5351
5376
</parameter>
5352
5377
<parameter name="font" transfer-ownership="none">
5378
<doc xml:whitespace="preserve">a #PangoFont</doc>
5353
5379
<type name="Font" c:type="PangoFont*"/>
5354
5380
</parameter>
5355
5381
<parameter name="glyph" transfer-ownership="none">
5382
<doc xml:whitespace="preserve">the glyph index of a single glyph</doc>
5356
5383
<type name="Glyph" c:type="PangoGlyph"/>
5357
5384
</parameter>
5358
5385
<parameter name="x" transfer-ownership="none">
5359
<type name="double" c:type="double"/>
5386
<doc xml:whitespace="preserve">X coordinate of left edge of baseline of glyph</doc>
5387
<type name="gdouble" c:type="double"/>
5360
5388
</parameter>
5361
5389
<parameter name="y" transfer-ownership="none">
5362
<type name="double" c:type="double"/>
5390
<doc xml:whitespace="preserve">Y coordinate of left edge of baseline of glyph</doc>
5391
<type name="gdouble" c:type="double"/>
5363
5392
</parameter>
5364
5393
</parameters>
5365
5394
</callback>
5366
5395
</field>
5367
5396
<field name="part_changed">
5368
<callback name="part_changed" c:type="part_changed">
5397
<callback name="part_changed">
5369
5398
<return-value transfer-ownership="none">
5370
5399
<type name="none" c:type="void"/>
5371
5400
</return-value>
5374
5403
<type name="Renderer" c:type="PangoRenderer*"/>
5375
5404
</parameter>
5376
5405
<parameter name="part" transfer-ownership="none">
5406
<doc xml:whitespace="preserve">the part for which rendering has changed.</doc>
5377
5407
<type name="RenderPart" c:type="PangoRenderPart"/>
5378
5408
</parameter>
5379
5409
</parameters>
5380
5410
</callback>
5381
5411
</field>
5382
5412
<field name="begin">
5383
<callback name="begin" c:type="begin">
5413
<callback name="begin">
5384
5414
<return-value transfer-ownership="none">
5385
5415
<type name="none" c:type="void"/>
5386
5416
</return-value>
5392
5422
</callback>
5393
5423
</field>
5394
5424
<field name="end">
5395
<callback name="end" c:type="end">
5425
<callback name="end">
5396
5426
<return-value transfer-ownership="none">
5397
5427
<type name="none" c:type="void"/>
5398
5428
</return-value>
5404
5434
</callback>
5405
5435
</field>
5406
5436
<field name="prepare_run">
5407
<callback name="prepare_run" c:type="prepare_run">
5437
<callback name="prepare_run">
5408
5438
<return-value transfer-ownership="none">
5409
5439
<type name="none" c:type="void"/>
5410
5440
</return-value>
5419
5449
</callback>
5420
5450
</field>
5421
5451
<field name="draw_glyph_item">
5422
<callback name="draw_glyph_item" c:type="draw_glyph_item">
5452
<callback name="draw_glyph_item">
5423
5453
<return-value transfer-ownership="none">
5424
5454
<type name="none" c:type="void"/>
5425
5455
</return-value>
5428
5458
<type name="Renderer" c:type="PangoRenderer*"/>
5429
5459
</parameter>
5430
5460
<parameter name="text" transfer-ownership="none">
5461
<doc xml:whitespace="preserve">the UTF-8 text that @glyph_item refers to, or %NULL</doc>
5431
5462
<type name="utf8" c:type="char*"/>
5432
5463
</parameter>
5433
5464
<parameter name="glyph_item" transfer-ownership="none">
5465
<doc xml:whitespace="preserve">a #PangoGlyphItem</doc>
5434
5466
<type name="GlyphItem" c:type="PangoGlyphItem*"/>
5435
5467
</parameter>
5436
5468
<parameter name="x" transfer-ownership="none">
5437
<type name="int" c:type="int"/>
5469
<doc xml:whitespace="preserve">X position of left edge of baseline, in user space coordinates in Pango units.</doc>
5470
<type name="gint" c:type="int"/>
5438
5471
</parameter>
5439
5472
<parameter name="y" transfer-ownership="none">
5440
<type name="int" c:type="int"/>
5473
<doc xml:whitespace="preserve">Y position of left edge of baseline, in user space coordinates in Pango units.</doc>
5474
<type name="gint" c:type="int"/>
5441
5475
</parameter>
5442
5476
</parameters>
5443
5477
</callback>
5444
5478
</field>
5445
<field name="pango_reserved2">
5446
<callback name="pango_reserved2" c:type="_pango_reserved2">
5447
<return-value transfer-ownership="none">
5448
<type name="none" c:type="void"/>
5449
</return-value>
5450
</callback>
5451
</field>
5452
<field name="pango_reserved3">
5453
<callback name="pango_reserved3" c:type="_pango_reserved3">
5454
<return-value transfer-ownership="none">
5455
<type name="none" c:type="void"/>
5456
</return-value>
5457
</callback>
5458
</field>
5459
<field name="pango_reserved4">
5460
<callback name="pango_reserved4" c:type="_pango_reserved4">
5479
<field name="_pango_reserved2" introspectable="0">
5480
<callback name="_pango_reserved2">
5481
<return-value transfer-ownership="none">
5482
<type name="none" c:type="void"/>
5483
</return-value>
5484
</callback>
5485
</field>
5486
<field name="_pango_reserved3" introspectable="0">
5487
<callback name="_pango_reserved3">
5488
<return-value transfer-ownership="none">
5489
<type name="none" c:type="void"/>
5490
</return-value>
5491
</callback>
5492
</field>
5493
<field name="_pango_reserved4" introspectable="0">
5494
<callback name="_pango_reserved4">
5461
5495
<return-value transfer-ownership="none">
5462
5496
<type name="none" c:type="void"/>
5463
5497
</return-value>
5464
5498
</callback>
5465
5499
</field>
5466
5500
</record>
5467
<record name="RendererPrivate" c:type="PangoRendererPrivate">
5501
<record name="RendererPrivate" c:type="PangoRendererPrivate" disguised="1">
5468
5502
</record>
5469
5503
<constant name="SCALE" value="1024">
5470
<type name="int"/>
5504
<type name="gint" c:type="gint"/>
5471
5505
</constant>
5472
5506
<enumeration name="Script"
5473
5507
glib:type-name="PangoScript"
5790
5824
c:identifier="PANGO_SCRIPT_LYDIAN"
5791
5825
glib:nick="lydian"/>
5792
5826
</enumeration>
5793
<record name="ScriptForLang" c:type="_PangoScriptForLang">
5794
<field name="lang" writable="1">
5795
<array zero-terminated="0" c:type="char" fixed-size="7">
5796
<type name="int8"/>
5797
</array>
5798
</field>
5799
<field name="scripts" writable="1">
5800
<array zero-terminated="0" c:type="PangoScript" fixed-size="3">
5801
<type name="Script"/>
5802
</array>
5803
</field>
5804
</record>
5805
<record name="ScriptIter"
5806
c:type="PangoScriptIter"
5807
doc="A #PangoScriptIter is used to iterate through a string
5808
and identify ranges in different scripts.">
5809
<field name="text_start" writable="1">
5810
<type name="utf8" c:type="gchar*"/>
5811
</field>
5812
<field name="text_end" writable="1">
5813
<type name="utf8" c:type="gchar*"/>
5814
</field>
5815
<field name="script_start" writable="1">
5816
<type name="utf8" c:type="gchar*"/>
5817
</field>
5818
<field name="script_end" writable="1">
5819
<type name="utf8" c:type="gchar*"/>
5820
</field>
5821
<field name="script_code" writable="1">
5822
<type name="Script" c:type="PangoScript"/>
5823
</field>
5824
<field name="paren_stack" writable="1">
5825
<array zero-terminated="0" c:type="ParenStackEntry" fixed-size="128">
5826
<type name="ParenStackEntry"/>
5827
</array>
5828
</field>
5829
<field name="paren_sp" writable="1">
5830
<type name="int" c:type="int"/>
5831
</field>
5832
<constructor name="new"
5833
c:identifier="pango_script_iter_new"
5834
doc="Create a new #PangoScriptIter, used to break a string of
5835
Unicode into runs by text. No copy is made of @text, so
5836
the caller needs to make sure it remains valid until
5837
the iterator is freed with pango_script_iter_free().
5838
to point at the first range in the text, which should be
5839
freed with pango_script_iter_free(). If the string is
5840
empty, it will point at an empty range."
5841
version="1.4">
5842
<return-value transfer-ownership="full">
5843
<type name="ScriptIter" c:type="PangoScriptIter*"/>
5827
<record name="ScriptIter" c:type="PangoScriptIter" disguised="1">
5828
<doc xml:whitespace="preserve">A #PangoScriptIter is used to iterate through a string
5829
and identify ranges in different scripts.</doc>
5830
<method name="free" c:identifier="pango_script_iter_free" version="1.4">
5831
<doc xml:whitespace="preserve">Frees a #PangoScriptIter created with pango_script_iter_new().</doc>
5832
<return-value transfer-ownership="none">
5833
<type name="none" c:type="void"/>
5844
5834
</return-value>
5845
<parameters>
5846
<parameter name="text" transfer-ownership="none">
5847
<type name="utf8" c:type="char*"/>
5848
</parameter>
5849
<parameter name="length" transfer-ownership="none">
5850
<type name="int" c:type="int"/>
5851
</parameter>
5852
</parameters>
5853
</constructor>
5835
</method>
5854
5836
<method name="get_range"
5855
5837
c:identifier="pango_script_iter_get_range"
5856
doc="Gets information about the range to which @iter currently points.
5838
version="1.4">
5839
<doc xml:whitespace="preserve">Gets information about the range to which @iter currently points.
5857
5840
The range is the set of locations p where *start <= p < *end.
5858
(That is, it doesn't include the character stored at *end)"
5859
version="1.4">
5841
(That is, it doesn't include the character stored at *end)</doc>
5860
5842
<return-value transfer-ownership="none">
5861
5843
<type name="none" c:type="void"/>
5862
5844
</return-value>
5863
5845
<parameters>
5864
5846
<parameter name="start" transfer-ownership="none">
5865
<array c:type="char**">
5866
<type name="utf8"/>
5867
</array>
5847
<doc xml:whitespace="preserve">location to store start position of the range, or %NULL</doc>
5848
<type name="utf8" c:type="char**"/>
5868
5849
</parameter>
5869
5850
<parameter name="end" transfer-ownership="none">
5870
<array c:type="char**">
5871
<type name="utf8"/>
5872
</array>
5851
<doc xml:whitespace="preserve">location to store end position of the range, or %NULL</doc>
5852
<type name="utf8" c:type="char**"/>
5873
5853
</parameter>
5874
5854
<parameter name="script" transfer-ownership="none">
5855
<doc xml:whitespace="preserve">location to store script for range, or %NULL</doc>
5875
5856
<type name="Script" c:type="PangoScript*"/>
5876
5857
</parameter>
5877
5858
</parameters>
5878
5859
</method>
5879
<method name="next"
5880
c:identifier="pango_script_iter_next"
5881
doc="Advances a #PangoScriptIter to the next range. If @iter
5860
<method name="next" c:identifier="pango_script_iter_next" version="1.4">
5861
<doc xml:whitespace="preserve">Advances a #PangoScriptIter to the next range. If @iter
5882
5862
is already at the end, it is left unchanged and %FALSE
5883
is returned."
5884
version="1.4">
5885
<return-value transfer-ownership="none">
5886
<type name="boolean" c:type="gboolean"/>
5887
</return-value>
5888
</method>
5889
<method name="free"
5890
c:identifier="pango_script_iter_free"
5891
doc="Frees a #PangoScriptIter created with pango_script_iter_new()."
5892
version="1.4">
5893
<return-value transfer-ownership="none">
5894
<type name="none" c:type="void"/>
5863
is returned.</doc>
5864
<return-value transfer-ownership="none">
5865
<doc xml:whitespace="preserve">%TRUE if @iter was successfully advanced.</doc>
5866
<type name="gboolean" c:type="gboolean"/>
5895
5867
</return-value>
5896
5868
</method>
5897
5869
</record>
5937
5909
glib:nick="ultra-expanded"/>
5938
5910
</enumeration>
5939
5911
<enumeration name="Style"
5940
doc="An enumeration specifying the various slant styles possible for a font."
5941
5912
glib:type-name="PangoStyle"
5942
5913
glib:get-type="pango_style_get_type"
5943
5914
c:type="PangoStyle">
5915
<doc xml:whitespace="preserve">An enumeration specifying the various slant styles possible for a font.</doc>
5944
5916
<member name="normal"
5945
5917
value="0"
5946
5918
c:identifier="PANGO_STYLE_NORMAL"
5966
5938
<record name="TabArray"
5967
5939
c:type="PangoTabArray"
5968
5940
glib:type-name="PangoTabArray"
5969
glib:get-type="pango_tab_array_get_type">
5970
<constructor name="new"
5971
c:identifier="pango_tab_array_new"
5972
doc="Creates an array of @initial_size tab stops. Tab stops are specified in
5941
glib:get-type="pango_tab_array_get_type"
5942
c:symbol-prefix="tab_array">
5943
<constructor name="new" c:identifier="pango_tab_array_new">
5944
<doc xml:whitespace="preserve">Creates an array of @initial_size tab stops. Tab stops are specified in
5973
5945
pixel units if @positions_in_pixels is %TRUE, otherwise in Pango
5974
5946
units. All stops are initially at position 0.
5975
be freed with pango_tab_array_free().">
5947
be freed with pango_tab_array_free().</doc>
5976
5948
<return-value transfer-ownership="full">
5949
<doc xml:whitespace="preserve">the newly allocated #PangoTabArray, which should</doc>
5977
5950
<type name="TabArray" c:type="PangoTabArray*"/>
5978
5951
</return-value>
5979
5952
<parameters>
5980
5953
<parameter name="initial_size" transfer-ownership="none">
5981
<type name="int" c:type="gint"/>
5954
<doc xml:whitespace="preserve">Initial number of tab stops to allocate, can be 0</doc>
5955
<type name="gint" c:type="gint"/>
5982
5956
</parameter>
5983
5957
<parameter name="positions_in_pixels" transfer-ownership="none">
5984
<type name="boolean" c:type="gboolean"/>
5958
<doc xml:whitespace="preserve">whether positions are in pixel units</doc>
5959
<type name="gboolean" c:type="gboolean"/>
5985
5960
</parameter>
5986
5961
</parameters>
5987
5962
</constructor>
5988
5963
<constructor name="new_with_positions"
5989
5964
c:identifier="pango_tab_array_new_with_positions"
5990
doc="This is a convenience function that creates a #PangoTabArray
5965
introspectable="0">
5966
<doc xml:whitespace="preserve">This is a convenience function that creates a #PangoTabArray
5991
5967
and allows you to specify the alignment and position of each
5992
5968
tab stop. You <emphasis>must</emphasis> provide an alignment
5993
5969
and position for @size tab stops.
5994
be freed with pango_tab_array_free().">
5970
be freed with pango_tab_array_free().</doc>
5995
5971
<return-value transfer-ownership="full">
5972
<doc xml:whitespace="preserve">the newly allocated #PangoTabArray, which should</doc>
5996
5973
<type name="TabArray" c:type="PangoTabArray*"/>
5997
5974
</return-value>
5998
5975
<parameters>
5999
5976
<parameter name="size" transfer-ownership="none">
6000
<type name="int" c:type="gint"/>
5977
<doc xml:whitespace="preserve">number of tab stops in the array</doc>
5978
<type name="gint" c:type="gint"/>
6001
5979
</parameter>
6002
5980
<parameter name="positions_in_pixels" transfer-ownership="none">
6003
<type name="boolean" c:type="gboolean"/>
5981
<doc xml:whitespace="preserve">whether positions are in pixel units</doc>
5982
<type name="gboolean" c:type="gboolean"/>
6004
5983
</parameter>
6005
5984
<parameter name="first_alignment" transfer-ownership="none">
5985
<doc xml:whitespace="preserve">alignment of first tab stop</doc>
6006
5986
<type name="TabAlign" c:type="PangoTabAlign"/>
6007
5987
</parameter>
6008
5988
<parameter name="first_position" transfer-ownership="none">
6009
<type name="int" c:type="gint"/>
5989
<doc xml:whitespace="preserve">position of first tab stop</doc>
5990
<type name="gint" c:type="gint"/>
6010
5991
</parameter>
6011
5992
<parameter transfer-ownership="none">
6012
5993
<varargs>
6014
5995
</parameter>
6015
5996
</parameters>
6016
5997
</constructor>
6017
<method name="copy"
6018
c:identifier="pango_tab_array_copy"
6019
doc="Copies a #PangoTabArray
6020
be freed with pango_tab_array_free().">
5998
<method name="copy" c:identifier="pango_tab_array_copy">
5999
<doc xml:whitespace="preserve">Copies a #PangoTabArray
6000
be freed with pango_tab_array_free().</doc>
6021
6001
<return-value transfer-ownership="full">
6002
<doc xml:whitespace="preserve">the newly allocated #PangoTabArray, which should</doc>
6022
6003
<type name="TabArray" c:type="PangoTabArray*"/>
6023
6004
</return-value>
6024
6005
</method>
6025
<method name="free"
6026
c:identifier="pango_tab_array_free"
6027
doc="Frees a tab array and associated resources.">
6028
<return-value transfer-ownership="none">
6029
<type name="none" c:type="void"/>
6030
</return-value>
6031
</method>
6032
<method name="get_size"
6033
c:identifier="pango_tab_array_get_size"
6034
doc="Gets the number of tab stops in @tab_array.">
6035
<return-value transfer-ownership="none">
6036
<type name="int" c:type="gint"/>
6037
</return-value>
6038
</method>
6039
<method name="resize"
6040
c:identifier="pango_tab_array_resize"
6041
doc="Resizes a tab array. You must subsequently initialize any tabs that
6042
were added as a result of growing the array.">
6043
<return-value transfer-ownership="none">
6044
<type name="none" c:type="void"/>
6045
</return-value>
6046
<parameters>
6047
<parameter name="new_size" transfer-ownership="none">
6048
<type name="int" c:type="gint"/>
6049
</parameter>
6050
</parameters>
6051
</method>
6052
<method name="set_tab"
6053
c:identifier="pango_tab_array_set_tab"
6054
doc="Sets the alignment and location of a tab stop.
6055
implementation.">
6056
<return-value transfer-ownership="none">
6057
<type name="none" c:type="void"/>
6058
</return-value>
6059
<parameters>
6060
<parameter name="tab_index" transfer-ownership="none">
6061
<type name="int" c:type="gint"/>
6062
</parameter>
6063
<parameter name="alignment" transfer-ownership="none">
6064
<type name="TabAlign" c:type="PangoTabAlign"/>
6065
</parameter>
6066
<parameter name="location" transfer-ownership="none">
6067
<type name="int" c:type="gint"/>
6068
</parameter>
6069
</parameters>
6070
</method>
6071
<method name="get_tab"
6072
c:identifier="pango_tab_array_get_tab"
6073
doc="Gets the alignment and position of a tab stop.">
6074
<return-value transfer-ownership="none">
6075
<type name="none" c:type="void"/>
6076
</return-value>
6077
<parameters>
6078
<parameter name="tab_index" transfer-ownership="none">
6079
<type name="int" c:type="gint"/>
6080
</parameter>
6081
<parameter name="alignment" transfer-ownership="none">
6006
<method name="free" c:identifier="pango_tab_array_free">
6007
<doc xml:whitespace="preserve">Frees a tab array and associated resources.</doc>
6008
<return-value transfer-ownership="none">
6009
<type name="none" c:type="void"/>
6010
</return-value>
6011
</method>
6012
<method name="get_positions_in_pixels"
6013
c:identifier="pango_tab_array_get_positions_in_pixels">
6014
<doc xml:whitespace="preserve">Returns %TRUE if the tab positions are in pixels, %FALSE if they are
6015
in Pango units.</doc>
6016
<return-value transfer-ownership="none">
6017
<doc xml:whitespace="preserve">whether positions are in pixels.</doc>
6018
<type name="gboolean" c:type="gboolean"/>
6019
</return-value>
6020
</method>
6021
<method name="get_size" c:identifier="pango_tab_array_get_size">
6022
<doc xml:whitespace="preserve">Gets the number of tab stops in @tab_array.</doc>
6023
<return-value transfer-ownership="none">
6024
<doc xml:whitespace="preserve">the number of tab stops in the array.</doc>
6025
<type name="gint" c:type="gint"/>
6026
</return-value>
6027
</method>
6028
<method name="get_tab" c:identifier="pango_tab_array_get_tab">
6029
<doc xml:whitespace="preserve">Gets the alignment and position of a tab stop.</doc>
6030
<return-value transfer-ownership="none">
6031
<type name="none" c:type="void"/>
6032
</return-value>
6033
<parameters>
6034
<parameter name="tab_index" transfer-ownership="none">
6035
<doc xml:whitespace="preserve">tab stop index</doc>
6036
<type name="gint" c:type="gint"/>
6037
</parameter>
6038
<parameter name="alignment" transfer-ownership="none">
6039
<doc xml:whitespace="preserve">location to store alignment, or %NULL</doc>
6082
6040
<type name="TabAlign" c:type="PangoTabAlign*"/>
6083
6041
</parameter>
6084
<parameter name="location" direction="out" transfer-ownership="full">
6085
<type name="int" c:type="gint*"/>
6042
<parameter name="location" transfer-ownership="none">
6043
<doc xml:whitespace="preserve">location to store tab position, or %NULL</doc>
6044
<type name="gint" c:type="gint*"/>
6086
6045
</parameter>
6087
6046
</parameters>
6088
6047
</method>
6089
<method name="get_tabs"
6090
c:identifier="pango_tab_array_get_tabs"
6091
doc="If non-%NULL, @alignments and @locations are filled with allocated
6048
<method name="get_tabs" c:identifier="pango_tab_array_get_tabs">
6049
<doc xml:whitespace="preserve">If non-%NULL, @alignments and @locations are filled with allocated
6092
6050
arrays of length pango_tab_array_get_size(). You must free the
6093
returned array.">
6051
returned array.</doc>
6094
6052
<return-value transfer-ownership="none">
6095
6053
<type name="none" c:type="void"/>
6096
6054
</return-value>
6097
6055
<parameters>
6098
6056
<parameter name="alignments" transfer-ownership="none">
6057
<doc xml:whitespace="preserve">location to store an array of tab stop alignments, or %NULL</doc>
6099
6058
<type name="TabAlign" c:type="PangoTabAlign**"/>
6100
6059
</parameter>
6101
<parameter name="locations"
6102
direction="out"
6103
transfer-ownership="full">
6104
<type name="int" c:type="gint**"/>
6105
</parameter>
6106
</parameters>
6107
</method>
6108
<method name="get_positions_in_pixels"
6109
c:identifier="pango_tab_array_get_positions_in_pixels"
6110
doc="Returns %TRUE if the tab positions are in pixels, %FALSE if they are
6111
in Pango units.">
6112
<return-value transfer-ownership="none">
6113
<type name="boolean" c:type="gboolean"/>
6114
</return-value>
6060
<parameter name="locations" transfer-ownership="none">
6061
<doc xml:whitespace="preserve">location to store an array of tab positions, or %NULL</doc>
6062
<type name="gint" c:type="gint**"/>
6063
</parameter>
6064
</parameters>
6065
</method>
6066
<method name="resize" c:identifier="pango_tab_array_resize">
6067
<doc xml:whitespace="preserve">Resizes a tab array. You must subsequently initialize any tabs that
6068
were added as a result of growing the array.</doc>
6069
<return-value transfer-ownership="none">
6070
<type name="none" c:type="void"/>
6071
</return-value>
6072
<parameters>
6073
<parameter name="new_size" transfer-ownership="none">
6074
<doc xml:whitespace="preserve">new size of the array</doc>
6075
<type name="gint" c:type="gint"/>
6076
</parameter>
6077
</parameters>
6078
</method>
6079
<method name="set_tab" c:identifier="pango_tab_array_set_tab">
6080
<doc xml:whitespace="preserve">Sets the alignment and location of a tab stop.
6081
implementation.</doc>
6082
<return-value transfer-ownership="none">
6083
<type name="none" c:type="void"/>
6084
</return-value>
6085
<parameters>
6086
<parameter name="tab_index" transfer-ownership="none">
6087
<doc xml:whitespace="preserve">the index of a tab stop</doc>
6088
<type name="gint" c:type="gint"/>
6089
</parameter>
6090
<parameter name="alignment" transfer-ownership="none">
6091
<doc xml:whitespace="preserve">tab alignment</doc>
6092
<type name="TabAlign" c:type="PangoTabAlign"/>
6093
</parameter>
6094
<parameter name="location" transfer-ownership="none">
6095
<doc xml:whitespace="preserve">tab location in Pango units</doc>
6096
<type name="gint" c:type="gint"/>
6097
</parameter>
6098
</parameters>
6115
6099
</method>
6116
6100
</record>
6117
6101
<constant name="UNKNOWN_GLYPH_HEIGHT" value="14">
6118
<type name="int"/>
6102
<type name="gint" c:type="gint"/>
6119
6103
</constant>
6120
6104
<constant name="UNKNOWN_GLYPH_WIDTH" value="10">
6121
<type name="int"/>
6105
<type name="gint" c:type="gint"/>
6122
6106
</constant>
6123
6107
<enumeration name="Underline"
6124
6108
glib:type-name="PangoUnderline"
6224
6208
c:identifier="PANGO_WRAP_WORD_CHAR"
6225
6209
glib:nick="word-char"/>
6226
6210
</enumeration>
6211
<record name="_ScriptForLang" c:type="_PangoScriptForLang">
6212
<field name="lang" writable="1">
6213
<array zero-terminated="0" c:type="gchar" fixed-size="7">
6214
<type name="gchar" c:type="char"/>
6215
</array>
6216
</field>
6217
<field name="scripts" writable="1">
6218
<array zero-terminated="0" c:type="PangoScript" fixed-size="3">
6219
<type name="Script" c:type="PangoScript"/>
6220
</array>
6221
</field>
6222
</record>
6227
6223
<function name="attr_background_new"
6228
6224
c:identifier="pango_attr_background_new"
6229
doc="Create a new background color attribute.
6230
freed with pango_attribute_destroy().">
6231
<return-value transfer-ownership="full">
6225
introspectable="0">
6226
<doc xml:whitespace="preserve">Create a new background color attribute.
6227
freed with pango_attribute_destroy().</doc>
6228
<return-value>
6229
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6232
6230
<type name="Attribute" c:type="PangoAttribute*"/>
6233
6231
</return-value>
6234
6232
<parameters>
6235
6233
<parameter name="red" transfer-ownership="none">
6236
<type name="uint16" c:type="guint16"/>
6234
<doc xml:whitespace="preserve">the red value (ranging from 0 to 65535)</doc>
6235
<type name="guint16" c:type="guint16"/>
6237
6236
</parameter>
6238
6237
<parameter name="green" transfer-ownership="none">
6239
<type name="uint16" c:type="guint16"/>
6238
<doc xml:whitespace="preserve">the green value</doc>
6239
<type name="guint16" c:type="guint16"/>
6240
6240
</parameter>
6241
6241
<parameter name="blue" transfer-ownership="none">
6242
<type name="uint16" c:type="guint16"/>
6242
<doc xml:whitespace="preserve">the blue value</doc>
6243
<type name="guint16" c:type="guint16"/>
6243
6244
</parameter>
6244
6245
</parameters>
6245
6246
</function>
6246
6247
<function name="attr_fallback_new"
6247
6248
c:identifier="pango_attr_fallback_new"
6248
doc="for characters the active font is missing.
6249
Create a new font fallback attribute.
6249
version="1.4"
6250
introspectable="0">
6251
<doc xml:whitespace="preserve">Create a new font fallback attribute.
6250
6252
If fallback is disabled, characters will only be used from the
6251
6253
closest matching font on the system. No fallback will be done to
6252
6254
other fonts on the system that might contain the characters in the
6253
6255
text.
6254
freed with pango_attribute_destroy()."
6255
version="1.4">
6256
<return-value transfer-ownership="full">
6256
freed with pango_attribute_destroy().</doc>
6257
<return-value>
6258
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6257
6259
<type name="Attribute" c:type="PangoAttribute*"/>
6258
6260
</return-value>
6259
6261
<parameters>
6260
6262
<parameter name="enable_fallback" transfer-ownership="none">
6261
<type name="boolean" c:type="gboolean"/>
6263
<doc xml:whitespace="preserve">%TRUE if we should fall back on other fonts for characters the active font is missing.</doc>
6264
<type name="gboolean" c:type="gboolean"/>
6262
6265
</parameter>
6263
6266
</parameters>
6264
6267
</function>
6265
6268
<function name="attr_family_new"
6266
6269
c:identifier="pango_attr_family_new"
6267
doc="Create a new font family attribute.
6268
freed with pango_attribute_destroy().">
6269
<return-value transfer-ownership="full">
6270
introspectable="0">
6271
<doc xml:whitespace="preserve">Create a new font family attribute.
6272
freed with pango_attribute_destroy().</doc>
6273
<return-value>
6274
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6270
6275
<type name="Attribute" c:type="PangoAttribute*"/>
6271
6276
</return-value>
6272
6277
<parameters>
6273
6278
<parameter name="family" transfer-ownership="none">
6279
<doc xml:whitespace="preserve">the family or comma separated list of families</doc>
6274
6280
<type name="utf8" c:type="char*"/>
6275
6281
</parameter>
6276
6282
</parameters>
6277
6283
</function>
6284
<function name="attr_font_desc_new"
6285
c:identifier="pango_attr_font_desc_new"
6286
introspectable="0">
6287
<doc xml:whitespace="preserve">Create a new font description attribute. This attribute
6288
allows setting family, style, weight, variant, stretch,
6289
and size simultaneously.
6290
freed with pango_attribute_destroy().</doc>
6291
<return-value>
6292
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6293
<type name="Attribute" c:type="PangoAttribute*"/>
6294
</return-value>
6295
<parameters>
6296
<parameter name="desc" transfer-ownership="none">
6297
<doc xml:whitespace="preserve">the font description</doc>
6298
<type name="FontDescription" c:type="PangoFontDescription*"/>
6299
</parameter>
6300
</parameters>
6301
</function>
6278
6302
<function name="attr_foreground_new"
6279
6303
c:identifier="pango_attr_foreground_new"
6280
doc="Create a new foreground color attribute.
6281
freed with pango_attribute_destroy().">
6282
<return-value transfer-ownership="full">
6304
introspectable="0">
6305
<doc xml:whitespace="preserve">Create a new foreground color attribute.
6306
freed with pango_attribute_destroy().</doc>
6307
<return-value>
6308
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6283
6309
<type name="Attribute" c:type="PangoAttribute*"/>
6284
6310
</return-value>
6285
6311
<parameters>
6286
6312
<parameter name="red" transfer-ownership="none">
6287
<type name="uint16" c:type="guint16"/>
6313
<doc xml:whitespace="preserve">the red value (ranging from 0 to 65535)</doc>
6314
<type name="guint16" c:type="guint16"/>
6288
6315
</parameter>
6289
6316
<parameter name="green" transfer-ownership="none">
6290
<type name="uint16" c:type="guint16"/>
6317
<doc xml:whitespace="preserve">the green value</doc>
6318
<type name="guint16" c:type="guint16"/>
6291
6319
</parameter>
6292
6320
<parameter name="blue" transfer-ownership="none">
6293
<type name="uint16" c:type="guint16"/>
6321
<doc xml:whitespace="preserve">the blue value</doc>
6322
<type name="guint16" c:type="guint16"/>
6294
6323
</parameter>
6295
6324
</parameters>
6296
6325
</function>
6297
6326
<function name="attr_gravity_hint_new"
6298
6327
c:identifier="pango_attr_gravity_hint_new"
6299
doc="Create a new gravity hint attribute.
6300
freed with pango_attribute_destroy()."
6301
version="1.16">
6302
<return-value transfer-ownership="full">
6328
version="1.16"
6329
introspectable="0">
6330
<doc xml:whitespace="preserve">Create a new gravity hint attribute.
6331
freed with pango_attribute_destroy().</doc>
6332
<return-value>
6333
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6303
6334
<type name="Attribute" c:type="PangoAttribute*"/>
6304
6335
</return-value>
6305
6336
<parameters>
6306
6337
<parameter name="hint" transfer-ownership="none">
6338
<doc xml:whitespace="preserve">the gravity hint value.</doc>
6307
6339
<type name="GravityHint" c:type="PangoGravityHint"/>
6308
6340
</parameter>
6309
6341
</parameters>
6310
6342
</function>
6311
6343
<function name="attr_gravity_new"
6312
6344
c:identifier="pango_attr_gravity_new"
6313
doc="Create a new gravity attribute.
6314
freed with pango_attribute_destroy()."
6315
version="1.16">
6316
<return-value transfer-ownership="full">
6345
version="1.16"
6346
introspectable="0">
6347
<doc xml:whitespace="preserve">Create a new gravity attribute.
6348
freed with pango_attribute_destroy().</doc>
6349
<return-value>
6350
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6317
6351
<type name="Attribute" c:type="PangoAttribute*"/>
6318
6352
</return-value>
6319
6353
<parameters>
6320
6354
<parameter name="gravity" transfer-ownership="none">
6355
<doc xml:whitespace="preserve">the gravity value; should not be %PANGO_GRAVITY_AUTO.</doc>
6321
6356
<type name="Gravity" c:type="PangoGravity"/>
6322
6357
</parameter>
6323
6358
</parameters>
6324
6359
</function>
6360
<function name="attr_language_new"
6361
c:identifier="pango_attr_language_new"
6362
introspectable="0">
6363
<doc xml:whitespace="preserve">Create a new language tag attribute.
6364
freed with pango_attribute_destroy().</doc>
6365
<return-value>
6366
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6367
<type name="Attribute" c:type="PangoAttribute*"/>
6368
</return-value>
6369
<parameters>
6370
<parameter name="language" transfer-ownership="none">
6371
<doc xml:whitespace="preserve">language tag</doc>
6372
<type name="Language" c:type="PangoLanguage*"/>
6373
</parameter>
6374
</parameters>
6375
</function>
6325
6376
<function name="attr_letter_spacing_new"
6326
6377
c:identifier="pango_attr_letter_spacing_new"
6327
doc="of the text, in Pango units.
6328
Create a new letter-spacing attribute.
6329
freed with pango_attribute_destroy()."
6330
version="1.6">
6331
<return-value transfer-ownership="full">
6378
version="1.6"
6379
introspectable="0">
6380
<doc xml:whitespace="preserve">Create a new letter-spacing attribute.
6381
freed with pango_attribute_destroy().</doc>
6382
<return-value>
6383
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6332
6384
<type name="Attribute" c:type="PangoAttribute*"/>
6333
6385
</return-value>
6334
6386
<parameters>
6335
6387
<parameter name="letter_spacing" transfer-ownership="none">
6336
<type name="int" c:type="int"/>
6388
<doc xml:whitespace="preserve">amount of extra space to add between graphemes of the text, in Pango units.</doc>
6389
<type name="gint" c:type="int"/>
6337
6390
</parameter>
6338
6391
</parameters>
6339
6392
</function>
6340
6393
<function name="attr_rise_new"
6341
6394
c:identifier="pango_attr_rise_new"
6342
doc="in Pango units. Positive values displace the text upwards.
6343
Create a new baseline displacement attribute.
6344
freed with pango_attribute_destroy().">
6345
<return-value transfer-ownership="full">
6395
introspectable="0">
6396
<doc xml:whitespace="preserve">Create a new baseline displacement attribute.
6397
freed with pango_attribute_destroy().</doc>
6398
<return-value>
6399
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6346
6400
<type name="Attribute" c:type="PangoAttribute*"/>
6347
6401
</return-value>
6348
6402
<parameters>
6349
6403
<parameter name="rise" transfer-ownership="none">
6350
<type name="int" c:type="int"/>
6404
<doc xml:whitespace="preserve">the amount that the text should be displaced vertically, in Pango units. Positive values displace the text upwards.</doc>
6405
<type name="gint" c:type="int"/>
6351
6406
</parameter>
6352
6407
</parameters>
6353
6408
</function>
6354
6409
<function name="attr_scale_new"
6355
6410
c:identifier="pango_attr_scale_new"
6356
doc="Create a new font size scale attribute. The base font for the
6411
introspectable="0">
6412
<doc xml:whitespace="preserve">Create a new font size scale attribute. The base font for the
6357
6413
affected text will have its size multiplied by @scale_factor.
6358
freed with pango_attribute_destroy().">
6359
<return-value transfer-ownership="full">
6414
freed with pango_attribute_destroy().</doc>
6415
<return-value>
6416
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6360
6417
<type name="Attribute" c:type="PangoAttribute*"/>
6361
6418
</return-value>
6362
6419
<parameters>
6363
6420
<parameter name="scale_factor" transfer-ownership="none">
6364
<type name="double" c:type="double"/>
6421
<doc xml:whitespace="preserve">factor to scale the font</doc>
6422
<type name="gdouble" c:type="double"/>
6423
</parameter>
6424
</parameters>
6425
</function>
6426
<function name="attr_shape_new"
6427
c:identifier="pango_attr_shape_new"
6428
introspectable="0">
6429
<doc xml:whitespace="preserve">Create a new shape attribute. A shape is used to impose a
6430
particular ink and logical rectangle on the result of shaping a
6431
particular glyph. This might be used, for instance, for
6432
embedding a picture or a widget inside a #PangoLayout.
6433
freed with pango_attribute_destroy().</doc>
6434
<return-value>
6435
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6436
<type name="Attribute" c:type="PangoAttribute*"/>
6437
</return-value>
6438
<parameters>
6439
<parameter name="ink_rect" transfer-ownership="none">
6440
<doc xml:whitespace="preserve">ink rectangle to assign to each character</doc>
6441
<type name="Rectangle" c:type="PangoRectangle*"/>
6442
</parameter>
6443
<parameter name="logical_rect" transfer-ownership="none">
6444
<doc xml:whitespace="preserve">logical rectangle to assign to each character</doc>
6445
<type name="Rectangle" c:type="PangoRectangle*"/>
6446
</parameter>
6447
</parameters>
6448
</function>
6449
<function name="attr_shape_new_with_data"
6450
c:identifier="pango_attr_shape_new_with_data"
6451
version="1.8"
6452
introspectable="0">
6453
<doc xml:whitespace="preserve">Like pango_attr_shape_new(), but a user data pointer is also
6454
provided; this pointer can be accessed when later
6455
rendering the glyph.
6456
freed with pango_attribute_destroy().</doc>
6457
<return-value>
6458
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6459
<type name="Attribute" c:type="PangoAttribute*"/>
6460
</return-value>
6461
<parameters>
6462
<parameter name="ink_rect" transfer-ownership="none">
6463
<doc xml:whitespace="preserve">ink rectangle to assign to each character</doc>
6464
<type name="Rectangle" c:type="PangoRectangle*"/>
6465
</parameter>
6466
<parameter name="logical_rect" transfer-ownership="none">
6467
<doc xml:whitespace="preserve">logical rectangle to assign to each character</doc>
6468
<type name="Rectangle" c:type="PangoRectangle*"/>
6469
</parameter>
6470
<parameter name="data" transfer-ownership="none">
6471
<doc xml:whitespace="preserve">user data pointer</doc>
6472
<type name="gpointer" c:type="gpointer"/>
6473
</parameter>
6474
<parameter name="copy_func"
6475
transfer-ownership="none"
6476
scope="notified"
6477
destroy="4">
6478
<doc xml:whitespace="preserve">function to copy @data when the attribute is copied. If %NULL, @data is simply copied as a pointer.</doc>
6479
<type name="AttrDataCopyFunc" c:type="PangoAttrDataCopyFunc"/>
6480
</parameter>
6481
<parameter name="destroy_func" transfer-ownership="none" scope="async">
6482
<doc xml:whitespace="preserve">function to free @data when the attribute is freed, or %NULL</doc>
6483
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
6484
</parameter>
6485
</parameters>
6486
</function>
6487
<function name="attr_size_new"
6488
c:identifier="pango_attr_size_new"
6489
introspectable="0">
6490
<doc xml:whitespace="preserve">Create a new font-size attribute in fractional points.
6491
freed with pango_attribute_destroy().</doc>
6492
<return-value>
6493
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6494
<type name="Attribute" c:type="PangoAttribute*"/>
6495
</return-value>
6496
<parameters>
6497
<parameter name="size" transfer-ownership="none">
6498
<doc xml:whitespace="preserve">the font size, in %PANGO_SCALE<!-- -->ths of a point.</doc>
6499
<type name="gint" c:type="int"/>
6500
</parameter>
6501
</parameters>
6502
</function>
6503
<function name="attr_size_new_absolute"
6504
c:identifier="pango_attr_size_new_absolute"
6505
version="1.8"
6506
introspectable="0">
6507
<doc xml:whitespace="preserve">Create a new font-size attribute in device units.
6508
freed with pango_attribute_destroy().</doc>
6509
<return-value>
6510
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6511
<type name="Attribute" c:type="PangoAttribute*"/>
6512
</return-value>
6513
<parameters>
6514
<parameter name="size" transfer-ownership="none">
6515
<doc xml:whitespace="preserve">the font size, in %PANGO_SCALE<!-- -->ths of a device unit.</doc>
6516
<type name="gint" c:type="int"/>
6365
6517
</parameter>
6366
6518
</parameters>
6367
6519
</function>
6368
6520
<function name="attr_stretch_new"
6369
6521
c:identifier="pango_attr_stretch_new"
6370
doc="Create a new font stretch attribute
6371
freed with pango_attribute_destroy().">
6372
<return-value transfer-ownership="full">
6522
introspectable="0">
6523
<doc xml:whitespace="preserve">Create a new font stretch attribute
6524
freed with pango_attribute_destroy().</doc>
6525
<return-value>
6526
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6373
6527
<type name="Attribute" c:type="PangoAttribute*"/>
6374
6528
</return-value>
6375
6529
<parameters>
6376
6530
<parameter name="stretch" transfer-ownership="none">
6531
<doc xml:whitespace="preserve">the stretch</doc>
6377
6532
<type name="Stretch" c:type="PangoStretch"/>
6378
6533
</parameter>
6379
6534
</parameters>
6380
6535
</function>
6381
6536
<function name="attr_strikethrough_color_new"
6382
6537
c:identifier="pango_attr_strikethrough_color_new"
6383
doc="Create a new strikethrough color attribute. This attribute
6538
version="1.8"
6539
introspectable="0">
6540
<doc xml:whitespace="preserve">Create a new strikethrough color attribute. This attribute
6384
6541
modifies the color of strikethrough lines. If not set, strikethrough
6385
6542
lines will use the foreground color.
6386
freed with pango_attribute_destroy()."
6387
version="1.8">
6388
<return-value transfer-ownership="full">
6543
freed with pango_attribute_destroy().</doc>
6544
<return-value>
6545
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6389
6546
<type name="Attribute" c:type="PangoAttribute*"/>
6390
6547
</return-value>
6391
6548
<parameters>
6392
6549
<parameter name="red" transfer-ownership="none">
6393
<type name="uint16" c:type="guint16"/>
6550
<doc xml:whitespace="preserve">the red value (ranging from 0 to 65535)</doc>
6551
<type name="guint16" c:type="guint16"/>
6394
6552
</parameter>
6395
6553
<parameter name="green" transfer-ownership="none">
6396
<type name="uint16" c:type="guint16"/>
6554
<doc xml:whitespace="preserve">the green value</doc>
6555
<type name="guint16" c:type="guint16"/>
6397
6556
</parameter>
6398
6557
<parameter name="blue" transfer-ownership="none">
6399
<type name="uint16" c:type="guint16"/>
6558
<doc xml:whitespace="preserve">the blue value</doc>
6559
<type name="guint16" c:type="guint16"/>
6400
6560
</parameter>
6401
6561
</parameters>
6402
6562
</function>
6403
6563
<function name="attr_strikethrough_new"
6404
6564
c:identifier="pango_attr_strikethrough_new"
6405
doc="Create a new strike-through attribute.
6406
freed with pango_attribute_destroy().">
6407
<return-value transfer-ownership="full">
6565
introspectable="0">
6566
<doc xml:whitespace="preserve">Create a new strike-through attribute.
6567
freed with pango_attribute_destroy().</doc>
6568
<return-value>
6569
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6408
6570
<type name="Attribute" c:type="PangoAttribute*"/>
6409
6571
</return-value>
6410
6572
<parameters>
6411
6573
<parameter name="strikethrough" transfer-ownership="none">
6412
<type name="boolean" c:type="gboolean"/>
6574
<doc xml:whitespace="preserve">%TRUE if the text should be struck-through.</doc>
6575
<type name="gboolean" c:type="gboolean"/>
6413
6576
</parameter>
6414
6577
</parameters>
6415
6578
</function>
6416
6579
<function name="attr_style_new"
6417
6580
c:identifier="pango_attr_style_new"
6418
doc="Create a new font slant style attribute.
6419
freed with pango_attribute_destroy().">
6420
<return-value transfer-ownership="full">
6581
introspectable="0">
6582
<doc xml:whitespace="preserve">Create a new font slant style attribute.
6583
freed with pango_attribute_destroy().</doc>
6584
<return-value>
6585
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6421
6586
<type name="Attribute" c:type="PangoAttribute*"/>
6422
6587
</return-value>
6423
6588
<parameters>
6424
6589
<parameter name="style" transfer-ownership="none">
6590
<doc xml:whitespace="preserve">the slant style</doc>
6425
6591
<type name="Style" c:type="PangoStyle"/>
6426
6592
</parameter>
6427
6593
</parameters>
6428
6594
</function>
6429
6595
<function name="attr_type_get_name"
6430
6596
c:identifier="pango_attr_type_get_name"
6431
doc="Fetches the attribute type name passed in when registering the type using
6597
version="1.22">
6598
<doc xml:whitespace="preserve">Fetches the attribute type name passed in when registering the type using
6432
6599
pango_attr_type_register().
6433
6600
The returned value is an interned string (see g_intern_string() for what
6434
6601
that means) that should not be modified or freed.
6435
a built-in Pango attribute type or invalid."
6436
version="1.22">
6437
<return-value transfer-ownership="none" doc="or %NULL if @type is">
6602
a built-in Pango attribute type or invalid.</doc>
6603
<return-value transfer-ownership="none">
6604
<doc xml:whitespace="preserve">the type ID name (which may be %NULL), or %NULL if @type is</doc>
6438
6605
<type name="utf8" c:type="char*"/>
6439
6606
</return-value>
6440
6607
<parameters>
6441
6608
<parameter name="type" transfer-ownership="none">
6609
<doc xml:whitespace="preserve">an attribute type ID to fetch the name for</doc>
6442
6610
<type name="AttrType" c:type="PangoAttrType"/>
6443
6611
</parameter>
6444
6612
</parameters>
6445
6613
</function>
6446
6614
<function name="attr_type_register"
6447
c:identifier="pango_attr_type_register"
6448
doc="Allocate a new attribute type ID. The attribute type name can be accessed
6449
later by using pango_attr_type_get_name().">
6450
<return-value transfer-ownership="full">
6615
c:identifier="pango_attr_type_register">
6616
<doc xml:whitespace="preserve">Allocate a new attribute type ID. The attribute type name can be accessed
6617
later by using pango_attr_type_get_name().</doc>
6618
<return-value transfer-ownership="none">
6619
<doc xml:whitespace="preserve">the new type ID.</doc>
6451
6620
<type name="AttrType" c:type="PangoAttrType"/>
6452
6621
</return-value>
6453
6622
<parameters>
6454
6623
<parameter name="name" transfer-ownership="none">
6624
<doc xml:whitespace="preserve">an identifier for the type</doc>
6455
6625
<type name="utf8" c:type="gchar*"/>
6456
6626
</parameter>
6457
6627
</parameters>
6458
6628
</function>
6459
6629
<function name="attr_underline_color_new"
6460
6630
c:identifier="pango_attr_underline_color_new"
6461
doc="Create a new underline color attribute. This attribute
6631
version="1.8"
6632
introspectable="0">
6633
<doc xml:whitespace="preserve">Create a new underline color attribute. This attribute
6462
6634
modifies the color of underlines. If not set, underlines
6463
6635
will use the foreground color.
6464
freed with pango_attribute_destroy()."
6465
version="1.8">
6466
<return-value transfer-ownership="full">
6636
freed with pango_attribute_destroy().</doc>
6637
<return-value>
6638
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6467
6639
<type name="Attribute" c:type="PangoAttribute*"/>
6468
6640
</return-value>
6469
6641
<parameters>
6470
6642
<parameter name="red" transfer-ownership="none">
6471
<type name="uint16" c:type="guint16"/>
6643
<doc xml:whitespace="preserve">the red value (ranging from 0 to 65535)</doc>
6644
<type name="guint16" c:type="guint16"/>
6472
6645
</parameter>
6473
6646
<parameter name="green" transfer-ownership="none">
6474
<type name="uint16" c:type="guint16"/>
6647
<doc xml:whitespace="preserve">the green value</doc>
6648
<type name="guint16" c:type="guint16"/>
6475
6649
</parameter>
6476
6650
<parameter name="blue" transfer-ownership="none">
6477
<type name="uint16" c:type="guint16"/>
6651
<doc xml:whitespace="preserve">the blue value</doc>
6652
<type name="guint16" c:type="guint16"/>
6478
6653
</parameter>
6479
6654
</parameters>
6480
6655
</function>
6481
6656
<function name="attr_underline_new"
6482
6657
c:identifier="pango_attr_underline_new"
6483
doc="Create a new underline-style attribute.
6484
freed with pango_attribute_destroy().">
6485
<return-value transfer-ownership="full">
6658
introspectable="0">
6659
<doc xml:whitespace="preserve">Create a new underline-style attribute.
6660
freed with pango_attribute_destroy().</doc>
6661
<return-value>
6662
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6486
6663
<type name="Attribute" c:type="PangoAttribute*"/>
6487
6664
</return-value>
6488
6665
<parameters>
6489
6666
<parameter name="underline" transfer-ownership="none">
6667
<doc xml:whitespace="preserve">the underline style.</doc>
6490
6668
<type name="Underline" c:type="PangoUnderline"/>
6491
6669
</parameter>
6492
6670
</parameters>
6493
6671
</function>
6494
6672
<function name="attr_variant_new"
6495
6673
c:identifier="pango_attr_variant_new"
6496
doc="Create a new font variant attribute (normal or small caps)
6497
freed with pango_attribute_destroy().">
6498
<return-value transfer-ownership="full">
6674
introspectable="0">
6675
<doc xml:whitespace="preserve">Create a new font variant attribute (normal or small caps)
6676
freed with pango_attribute_destroy().</doc>
6677
<return-value>
6678
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6499
6679
<type name="Attribute" c:type="PangoAttribute*"/>
6500
6680
</return-value>
6501
6681
<parameters>
6502
6682
<parameter name="variant" transfer-ownership="none">
6683
<doc xml:whitespace="preserve">the variant</doc>
6503
6684
<type name="Variant" c:type="PangoVariant"/>
6504
6685
</parameter>
6505
6686
</parameters>
6506
6687
</function>
6507
6688
<function name="attr_weight_new"
6508
6689
c:identifier="pango_attr_weight_new"
6509
doc="Create a new font weight attribute.
6510
freed with pango_attribute_destroy().">
6511
<return-value transfer-ownership="full">
6690
introspectable="0">
6691
<doc xml:whitespace="preserve">Create a new font weight attribute.
6692
freed with pango_attribute_destroy().</doc>
6693
<return-value>
6694
<doc xml:whitespace="preserve">the newly allocated #PangoAttribute, which should be</doc>
6512
6695
<type name="Attribute" c:type="PangoAttribute*"/>
6513
6696
</return-value>
6514
6697
<parameters>
6515
6698
<parameter name="weight" transfer-ownership="none">
6699
<doc xml:whitespace="preserve">the weight</doc>
6516
6700
<type name="Weight" c:type="PangoWeight"/>
6517
6701
</parameter>
6518
6702
</parameters>
6519
6703
</function>
6520
6704
<function name="bidi_type_for_unichar"
6521
c:identifier="pango_bidi_type_for_unichar">
6522
<return-value transfer-ownership="full">
6705
c:identifier="pango_bidi_type_for_unichar"
6706
introspectable="0">
6707
<return-value transfer-ownership="none">
6523
6708
<type name="BidiType" c:type="PangoBidiType"/>
6524
6709
</return-value>
6525
6710
<parameters>
6526
6711
<parameter name="ch" transfer-ownership="none">
6527
<type name="GLib.unichar" c:type="gunichar"/>
6712
<type name="gunichar" c:type="gunichar"/>
6528
6713
</parameter>
6529
6714
</parameters>
6530
6715
</function>
6531
<function name="break"
6532
c:identifier="pango_break"
6533
doc="Determines possible line, word, and character breaks
6716
<function name="break" c:identifier="pango_break">
6717
<doc xml:whitespace="preserve">Determines possible line, word, and character breaks
6534
6718
for a string of Unicode text with a single analysis. For most
6535
purposes you may want to use pango_get_log_attrs().">
6719
purposes you may want to use pango_get_log_attrs().</doc>
6536
6720
<return-value transfer-ownership="none">
6537
6721
<type name="none" c:type="void"/>
6538
6722
</return-value>
6539
6723
<parameters>
6540
6724
<parameter name="text" transfer-ownership="none">
6725
<doc xml:whitespace="preserve">the text to process</doc>
6541
6726
<type name="utf8" c:type="gchar*"/>
6542
6727
</parameter>
6543
6728
<parameter name="length" transfer-ownership="none">
6544
<type name="int" c:type="int"/>
6729
<doc xml:whitespace="preserve">length of @text in bytes (may be -1 if @text is nul-terminated)</doc>
6730
<type name="gint" c:type="int"/>
6545
6731
</parameter>
6546
6732
<parameter name="analysis" transfer-ownership="none">
6733
<doc xml:whitespace="preserve">#PangoAnalysis structure from pango_itemize()</doc>
6547
6734
<type name="Analysis" c:type="PangoAnalysis*"/>
6548
6735
</parameter>
6549
6736
<parameter name="attrs" transfer-ownership="none">
6737
<doc xml:whitespace="preserve">an array to store character information in</doc>
6550
6738
<type name="LogAttr" c:type="PangoLogAttr*"/>
6551
6739
</parameter>
6552
6740
<parameter name="attrs_len" transfer-ownership="none">
6553
<type name="int" c:type="int"/>
6741
<doc xml:whitespace="preserve">size of the array passed as @attrs</doc>
6742
<type name="gint" c:type="int"/>
6554
6743
</parameter>
6555
6744
</parameters>
6556
6745
</function>
6557
6746
<function name="coverage_from_bytes"
6558
6747
c:identifier="pango_coverage_from_bytes"
6559
doc="Convert data generated from pango_converage_to_bytes() back
6748
introspectable="0">
6749
<doc xml:whitespace="preserve">Convert data generated from pango_converage_to_bytes() back
6560
6750
to a #PangoCoverage
6561
the data was invalid.">
6562
<return-value transfer-ownership="full">
6751
the data was invalid.</doc>
6752
<return-value>
6753
<doc xml:whitespace="preserve">a newly allocated #PangoCoverage, or %NULL if</doc>
6563
6754
<type name="Coverage" c:type="PangoCoverage*"/>
6564
6755
</return-value>
6565
6756
<parameters>
6566
6757
<parameter name="bytes" transfer-ownership="none">
6567
<array c:type="guchar*">
6568
<type name="uint8"/>
6569
</array>
6758
<doc xml:whitespace="preserve">binary data representing a #PangoCoverage</doc>
6759
<type name="guint8" c:type="guchar*"/>
6570
6760
</parameter>
6571
6761
<parameter name="n_bytes" transfer-ownership="none">
6572
<type name="int" c:type="int"/>
6762
<doc xml:whitespace="preserve">the size of @bytes in bytes</doc>
6763
<type name="gint" c:type="int"/>
6573
6764
</parameter>
6574
6765
</parameters>
6575
6766
</function>
6767
<function name="coverage_new"
6768
c:identifier="pango_coverage_new"
6769
introspectable="0">
6770
<doc xml:whitespace="preserve">Create a new #PangoCoverage
6771
initialized to %PANGO_COVERAGE_NONE
6772
with a reference count of one, which
6773
should be freed with pango_coverage_unref().</doc>
6774
<return-value>
6775
<doc xml:whitespace="preserve">the newly allocated #PangoCoverage,</doc>
6776
<type name="Coverage" c:type="PangoCoverage*"/>
6777
</return-value>
6778
</function>
6576
6779
<function name="extents_to_pixels"
6577
6780
c:identifier="pango_extents_to_pixels"
6578
doc="Converts extents from Pango units to device units, dividing by the
6781
version="1.16">
6782
<doc xml:whitespace="preserve">Converts extents from Pango units to device units, dividing by the
6579
6783
%PANGO_SCALE factor and performing rounding.
6580
6784
The @inclusive rectangle is converted by flooring the x/y coordinates and extending
6581
6785
width/height, such that the final rectangle completely includes the original
6585
6789
rectangle to completely contain the original rectangle, pass it in as @inclusive.
6586
6790
If you want two touching-but-not-overlapping rectangles stay
6587
6791
touching-but-not-overlapping after rounding to device units, pass them in
6588
as @nearest."
6589
version="1.16">
6792
as @nearest.</doc>
6590
6793
<return-value transfer-ownership="none">
6591
6794
<type name="none" c:type="void"/>
6592
6795
</return-value>
6593
6796
<parameters>
6594
6797
<parameter name="inclusive" transfer-ownership="none">
6798
<doc xml:whitespace="preserve">rectangle to round to pixels inclusively, or %NULL.</doc>
6595
6799
<type name="Rectangle" c:type="PangoRectangle*"/>
6596
6800
</parameter>
6597
6801
<parameter name="nearest" transfer-ownership="none">
6802
<doc xml:whitespace="preserve">rectangle to round to nearest pixels, or %NULL.</doc>
6598
6803
<type name="Rectangle" c:type="PangoRectangle*"/>
6599
6804
</parameter>
6600
6805
</parameters>
6601
6806
</function>
6602
6807
<function name="find_base_dir"
6603
6808
c:identifier="pango_find_base_dir"
6604
doc="Searches a string the first character that has a strong
6809
version="1.4">
6810
<doc xml:whitespace="preserve">Searches a string the first character that has a strong
6605
6811
direction, according to the Unicode bidirectional algorithm.
6606
If no such character is found, then %PANGO_DIRECTION_NEUTRAL is returned."
6607
version="1.4">
6608
<return-value transfer-ownership="full">
6812
If no such character is found, then %PANGO_DIRECTION_NEUTRAL is returned.</doc>
6813
<return-value transfer-ownership="none">
6814
<doc xml:whitespace="preserve">The direction corresponding to the first strong character.</doc>
6609
6815
<type name="Direction" c:type="PangoDirection"/>
6610
6816
</return-value>
6611
6817
<parameters>
6612
6818
<parameter name="text" transfer-ownership="none">
6819
<doc xml:whitespace="preserve">the text to process</doc>
6613
6820
<type name="utf8" c:type="gchar*"/>
6614
6821
</parameter>
6615
6822
<parameter name="length" transfer-ownership="none">
6616
<type name="int" c:type="gint"/>
6823
<doc xml:whitespace="preserve">length of @text in bytes (may be -1 if @text is nul-terminated)</doc>
6824
<type name="gint" c:type="gint"/>
6617
6825
</parameter>
6618
6826
</parameters>
6619
6827
</function>
6620
6828
<function name="find_paragraph_boundary"
6621
c:identifier="pango_find_paragraph_boundary"
6622
doc="Locates a paragraph boundary in @text. A boundary is caused by
6829
c:identifier="pango_find_paragraph_boundary">
6830
<doc xml:whitespace="preserve">Locates a paragraph boundary in @text. A boundary is caused by
6623
6831
delimiter characters, such as a newline, carriage return, carriage
6624
6832
return-newline pair, or Unicode paragraph separator character. The
6625
6833
index of the run of delimiters is returned in
6626
6834
(index after all delimiters) is stored in @next_paragraph_start.
6627
6835
If no delimiters are found, both @paragraph_delimiter_index and
6628
off the end).">
6836
off the end).</doc>
6629
6837
<return-value transfer-ownership="none">
6630
6838
<type name="none" c:type="void"/>
6631
6839
</return-value>
6632
6840
<parameters>
6633
6841
<parameter name="text" transfer-ownership="none">
6842
<doc xml:whitespace="preserve">UTF-8 text</doc>
6634
6843
<type name="utf8" c:type="gchar*"/>
6635
6844
</parameter>
6636
6845
<parameter name="length" transfer-ownership="none">
6637
<type name="int" c:type="gint"/>
6638
</parameter>
6639
<parameter name="paragraph_delimiter_index"
6640
direction="out"
6641
transfer-ownership="full">
6642
<type name="int" c:type="gint*"/>
6643
</parameter>
6644
<parameter name="next_paragraph_start"
6645
direction="out"
6646
transfer-ownership="full">
6647
<type name="int" c:type="gint*"/>
6648
</parameter>
6649
</parameters>
6650
</function>
6651
<function name="get_log_attrs"
6652
c:identifier="pango_get_log_attrs"
6653
doc="Computes a #PangoLogAttr for each character in @text. The @log_attrs
6846
<doc xml:whitespace="preserve">length of @text in bytes, or -1 if nul-terminated</doc>
6847
<type name="gint" c:type="gint"/>
6848
</parameter>
6849
<parameter name="paragraph_delimiter_index" transfer-ownership="none">
6850
<doc xml:whitespace="preserve">return location for index of delimiter</doc>
6851
<type name="gint" c:type="gint*"/>
6852
</parameter>
6853
<parameter name="next_paragraph_start" transfer-ownership="none">
6854
<doc xml:whitespace="preserve">return location for start of next paragraph</doc>
6855
<type name="gint" c:type="gint*"/>
6856
</parameter>
6857
</parameters>
6858
</function>
6859
<function name="font_description_from_string"
6860
c:identifier="pango_font_description_from_string">
6861
<doc xml:whitespace="preserve">Creates a new font description from a string representation in the
6862
form "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]", where FAMILY-LIST is a
6863
comma separated list of families optionally terminated by a comma,
6864
STYLE_OPTIONS is a whitespace separated list of words where each WORD
6865
describes one of style, variant, weight, stretch, or gravity, and SIZE
6866
is a decimal number (size in points) or optionally followed by the
6867
unit modifier "px" for absolute size. Any one of the options may
6868
be absent. If FAMILY-LIST is absent, then the family_name field of
6869
the resulting font description will be initialized to %NULL. If
6870
STYLE-OPTIONS is missing, then all style options will be set to the
6871
default values. If SIZE is missing, the size in the resulting font
6872
description will be set to 0.</doc>
6873
<return-value transfer-ownership="full">
6874
<doc xml:whitespace="preserve">a new #PangoFontDescription.</doc>
6875
<type name="FontDescription" c:type="PangoFontDescription*"/>
6876
</return-value>
6877
<parameters>
6878
<parameter name="str" transfer-ownership="none">
6879
<doc xml:whitespace="preserve">string representation of a font description.</doc>
6880
<type name="utf8" c:type="char*"/>
6881
</parameter>
6882
</parameters>
6883
</function>
6884
<function name="get_log_attrs" c:identifier="pango_get_log_attrs">
6885
<doc xml:whitespace="preserve">Computes a #PangoLogAttr for each character in @text. The @log_attrs
6654
6886
array must have one #PangoLogAttr for each position in @text; if
6655
6887
last position at the end of the text. @text should be an entire
6656
paragraph; logical attributes can't be computed without context
6888
paragraph; logical attributes can't be computed without context
6657
6889
(for example you need to see spaces on either side of a word to know
6658
the word is a word).">
6890
the word is a word).</doc>
6659
6891
<return-value transfer-ownership="none">
6660
6892
<type name="none" c:type="void"/>
6661
6893
</return-value>
6662
6894
<parameters>
6663
6895
<parameter name="text" transfer-ownership="none">
6896
<doc xml:whitespace="preserve">text to process</doc>
6664
6897
<type name="utf8" c:type="char*"/>
6665
6898
</parameter>
6666
6899
<parameter name="length" transfer-ownership="none">
6667
<type name="int" c:type="int"/>
6900
<doc xml:whitespace="preserve">length in bytes of @text</doc>
6901
<type name="gint" c:type="int"/>
6668
6902
</parameter>
6669
6903
<parameter name="level" transfer-ownership="none">
6670
<type name="int" c:type="int"/>
6904
<doc xml:whitespace="preserve">embedding level, or -1 if unknown</doc>
6905
<type name="gint" c:type="int"/>
6671
6906
</parameter>
6672
6907
<parameter name="language" transfer-ownership="none">
6908
<doc xml:whitespace="preserve">language tag</doc>
6673
6909
<type name="Language" c:type="PangoLanguage*"/>
6674
6910
</parameter>
6675
6911
<parameter name="log_attrs" transfer-ownership="none">
6912
<doc xml:whitespace="preserve">array with one #PangoLogAttr per character in @text, plus one extra, to be filled in</doc>
6676
6913
<type name="LogAttr" c:type="PangoLogAttr*"/>
6677
6914
</parameter>
6678
6915
<parameter name="attrs_len" transfer-ownership="none">
6679
<type name="int" c:type="int"/>
6916
<doc xml:whitespace="preserve">length of @log_attrs array</doc>
6917
<type name="gint" c:type="int"/>
6680
6918
</parameter>
6681
6919
</parameters>
6682
6920
</function>
6683
6921
<function name="get_mirror_char"
6684
6922
c:identifier="pango_get_mirror_char"
6685
doc="If @ch has the Unicode mirrored property and there is another Unicode
6686
character that typically has a glyph that is the mirror image of @ch's
6923
introspectable="0">
6924
<doc xml:whitespace="preserve">If @ch has the Unicode mirrored property and there is another Unicode
6925
character that typically has a glyph that is the mirror image of @ch's
6687
6926
glyph, puts that character in the address pointed to by @mirrored_ch.
6688
6927
Use g_unichar_get_mirror_char() instead; the docs for that function
6689
6928
provide full details.
6690
filled in, %FALSE otherwise">
6929
filled in, %FALSE otherwise</doc>
6691
6930
<return-value transfer-ownership="none">
6692
<type name="boolean" c:type="gboolean"/>
6931
<doc xml:whitespace="preserve">%TRUE if @ch has a mirrored character and @mirrored_ch is</doc>
6932
<type name="gboolean" c:type="gboolean"/>
6693
6933
</return-value>
6694
6934
<parameters>
6695
6935
<parameter name="ch" transfer-ownership="none">
6696
<type name="GLib.unichar" c:type="gunichar"/>
6936
<doc xml:whitespace="preserve">a Unicode character</doc>
6937
<type name="gunichar" c:type="gunichar"/>
6697
6938
</parameter>
6698
6939
<parameter name="mirrored_ch" transfer-ownership="none">
6699
<type name="GLib.unichar" c:type="gunichar*"/>
6940
<doc xml:whitespace="preserve">location to store the mirrored character</doc>
6941
<type name="gunichar" c:type="gunichar*"/>
6700
6942
</parameter>
6701
6943
</parameters>
6702
6944
</function>
6703
6945
<function name="gravity_get_for_matrix"
6704
6946
c:identifier="pango_gravity_get_for_matrix"
6705
doc="Finds the gravity that best matches the rotation component
6947
version="1.16">
6948
<doc xml:whitespace="preserve">Finds the gravity that best matches the rotation component
6706
6949
in a #PangoMatrix.
6707
%PANGO_GRAVITY_AUTO, or %PANGO_GRAVITY_SOUTH if @matrix is %NULL"
6708
version="1.16">
6709
<return-value transfer-ownership="full">
6950
%PANGO_GRAVITY_AUTO, or %PANGO_GRAVITY_SOUTH if @matrix is %NULL</doc>
6951
<return-value transfer-ownership="none">
6952
<doc xml:whitespace="preserve">the gravity of @matrix, which will never be</doc>
6710
6953
<type name="Gravity" c:type="PangoGravity"/>
6711
6954
</return-value>
6712
6955
<parameters>
6713
6956
<parameter name="matrix" transfer-ownership="none">
6957
<doc xml:whitespace="preserve">a #PangoMatrix</doc>
6714
6958
<type name="Matrix" c:type="PangoMatrix*"/>
6715
6959
</parameter>
6716
6960
</parameters>
6717
6961
</function>
6718
6962
<function name="gravity_get_for_script"
6719
6963
c:identifier="pango_gravity_get_for_script"
6720
doc="Based on the script, base gravity, and hint, returns actual gravity
6964
version="1.16">
6965
<doc xml:whitespace="preserve">Based on the script, base gravity, and hint, returns actual gravity
6721
6966
to use in laying out a single #PangoItem.
6722
6967
If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the
6723
6968
preferred gravity of @script. To get the preferred gravity of a script,
6724
6969
pass %PANGO_GRAVITY_AUTO and %PANGO_GRAVITY_HINT_STRONG in.
6725
with @script."
6726
version="1.16">
6727
<return-value transfer-ownership="full">
6970
with @script.</doc>
6971
<return-value transfer-ownership="none">
6972
<doc xml:whitespace="preserve">resolved gravity suitable to use for a run of text</doc>
6728
6973
<type name="Gravity" c:type="PangoGravity"/>
6729
6974
</return-value>
6730
6975
<parameters>
6731
6976
<parameter name="script" transfer-ownership="none">
6977
<doc xml:whitespace="preserve">#PangoScript to query</doc>
6732
6978
<type name="Script" c:type="PangoScript"/>
6733
6979
</parameter>
6734
6980
<parameter name="base_gravity" transfer-ownership="none">
6981
<doc xml:whitespace="preserve">base gravity of the paragraph</doc>
6735
6982
<type name="Gravity" c:type="PangoGravity"/>
6736
6983
</parameter>
6737
6984
<parameter name="hint" transfer-ownership="none">
6985
<doc xml:whitespace="preserve">orientation hint</doc>
6738
6986
<type name="GravityHint" c:type="PangoGravityHint"/>
6739
6987
</parameter>
6740
6988
</parameters>
6741
6989
</function>
6742
6990
<function name="gravity_get_for_script_and_width"
6743
6991
c:identifier="pango_gravity_get_for_script_and_width"
6744
doc="Based on the script, East Asian width, base gravity, and hint,
6992
version="1.26">
6993
<doc xml:whitespace="preserve">Based on the script, East Asian width, base gravity, and hint,
6745
6994
returns actual gravity to use in laying out a single character
6746
6995
or #PangoItem.
6747
6996
This function is similar to pango_gravity_get_for_script() except
6752
7001
context.
6753
7002
If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the
6754
7003
preferred gravity of @script.
6755
with @script and @wide."
6756
version="1.26">
6757
<return-value transfer-ownership="full">
7004
with @script and @wide.</doc>
7005
<return-value transfer-ownership="none">
7006
<doc xml:whitespace="preserve">resolved gravity suitable to use for a run of text</doc>
6758
7007
<type name="Gravity" c:type="PangoGravity"/>
6759
7008
</return-value>
6760
7009
<parameters>
6761
7010
<parameter name="script" transfer-ownership="none">
7011
<doc xml:whitespace="preserve">#PangoScript to query</doc>
6762
7012
<type name="Script" c:type="PangoScript"/>
6763
7013
</parameter>
6764
7014
<parameter name="wide" transfer-ownership="none">
6765
<type name="boolean" c:type="gboolean"/>
7015
<doc xml:whitespace="preserve">%TRUE for wide characters as returned by g_unichar_iswide()</doc>
7016
<type name="gboolean" c:type="gboolean"/>
6766
7017
</parameter>
6767
7018
<parameter name="base_gravity" transfer-ownership="none">
7019
<doc xml:whitespace="preserve">base gravity of the paragraph</doc>
6768
7020
<type name="Gravity" c:type="PangoGravity"/>
6769
7021
</parameter>
6770
7022
<parameter name="hint" transfer-ownership="none">
7023
<doc xml:whitespace="preserve">orientation hint</doc>
6771
7024
<type name="GravityHint" c:type="PangoGravityHint"/>
6772
7025
</parameter>
6773
7026
</parameters>
6774
7027
</function>
6775
7028
<function name="gravity_to_rotation"
6776
7029
c:identifier="pango_gravity_to_rotation"
6777
doc="Converts a #PangoGravity value to its natural rotation in radians.
7030
version="1.16">
7031
<doc xml:whitespace="preserve">Converts a #PangoGravity value to its natural rotation in radians.
6778
7032
Note that pango_matrix_rotate() takes angle in degrees, not radians.
6779
7033
So, to call pango_matrix_rotate() with the output of this function
6780
you should multiply it by (180. / G_PI)."
6781
version="1.16">
7034
you should multiply it by (180. / G_PI).</doc>
6782
7035
<return-value transfer-ownership="none">
6783
<type name="double" c:type="double"/>
7036
<doc xml:whitespace="preserve">the rotation value corresponding to @gravity.</doc>
7037
<type name="gdouble" c:type="double"/>
6784
7038
</return-value>
6785
7039
<parameters>
6786
7040
<parameter name="gravity" transfer-ownership="none">
7041
<doc xml:whitespace="preserve">gravity to query</doc>
6787
7042
<type name="Gravity" c:type="PangoGravity"/>
6788
7043
</parameter>
6789
7044
</parameters>
6790
7045
</function>
6791
7046
<function name="is_zero_width"
6792
7047
c:identifier="pango_is_zero_width"
6793
doc="Checks @ch to see if it is a character that should not be
7048
version="1.10"
7049
introspectable="0">
7050
<doc xml:whitespace="preserve">Checks @ch to see if it is a character that should not be
6794
7051
normally rendered on the screen. This includes all Unicode characters
6795
with "ZERO WIDTH" in their name, as well as <firstterm>bidi</firstterm> formatting characters, and
7052
with "ZERO WIDTH" in their name, as well as <firstterm>bidi</firstterm> formatting characters, and
6796
7053
a few other ones. This is totally different from g_unichar_iszerowidth()
6797
and is at best misnamed."
6798
version="1.10">
7054
and is at best misnamed.</doc>
6799
7055
<return-value transfer-ownership="none">
6800
<type name="boolean" c:type="gboolean"/>
7056
<doc xml:whitespace="preserve">%TRUE if @ch is a zero-width character, %FALSE otherwise</doc>
7057
<type name="gboolean" c:type="gboolean"/>
6801
7058
</return-value>
6802
7059
<parameters>
6803
7060
<parameter name="ch" transfer-ownership="none">
6804
<type name="GLib.unichar" c:type="gunichar"/>
7061
<doc xml:whitespace="preserve">a Unicode character</doc>
7062
<type name="gunichar" c:type="gunichar"/>
6805
7063
</parameter>
6806
7064
</parameters>
6807
7065
</function>
6808
<function name="itemize"
6809
c:identifier="pango_itemize"
6810
doc="e itemization process.
6811
after @start_index.
7066
<function name="itemize" c:identifier="pango_itemize" introspectable="0">
7067
<doc xml:whitespace="preserve">after @start_index.
6812
7068
This must be >= 0.
6813
7069
Breaks a piece of text into segments with consistent
6814
7070
directional level and shaping engine. Each byte of @text will
6817
7073
offsets of the items are ascending).
6818
7074
range before or containing @start_index; @cached_iter will be advanced to
6819
7075
the range covering the position just after @start_index + @length.
6820
(i.e. if itemizing in a loop, just keep passing in the same @cached_iter).">
6821
<return-value transfer-ownership="full">
6822
<type name="GLib.List" c:type="GList*"/>
7076
(i.e. if itemizing in a loop, just keep passing in the same @cached_iter).</doc>
7077
<return-value>
7078
<doc xml:whitespace="preserve">a #GList of #PangoItem structures.</doc>
7079
<type name="GLib.List" c:type="GList*">
7080
<type name="gpointer" c:type="gpointer"/>
7081
</type>
6823
7082
</return-value>
6824
7083
<parameters>
6825
7084
<parameter name="context" transfer-ownership="none">
7085
<doc xml:whitespace="preserve">a structure holding information that affects</doc>
6826
7086
<type name="Context" c:type="PangoContext*"/>
6827
7087
</parameter>
6828
7088
<parameter name="text" transfer-ownership="none">
7089
<doc xml:whitespace="preserve">the text to itemize.</doc>
6829
7090
<type name="utf8" c:type="char*"/>
6830
7091
</parameter>
6831
7092
<parameter name="start_index" transfer-ownership="none">
6832
<type name="int" c:type="int"/>
7093
<doc xml:whitespace="preserve">first byte in @text to process</doc>
7094
<type name="gint" c:type="int"/>
6833
7095
</parameter>
6834
<parameter name="length" transfer-ownership="none" doc="to process">
6835
<type name="int" c:type="int"/>
7096
<parameter name="length" transfer-ownership="none">
7097
<doc xml:whitespace="preserve">the number of bytes (not characters) to process</doc>
7098
<type name="gint" c:type="int"/>
6836
7099
</parameter>
6837
7100
<parameter name="attrs" transfer-ownership="none">
7101
<doc xml:whitespace="preserve">the set of attributes that apply to @text.</doc>
6838
7102
<type name="AttrList" c:type="PangoAttrList*"/>
6839
7103
</parameter>
6840
7104
<parameter name="cached_iter" transfer-ownership="none">
7105
<doc xml:whitespace="preserve">Cached attribute iterator, or %NULL</doc>
6841
7106
<type name="AttrIterator" c:type="PangoAttrIterator*"/>
6842
7107
</parameter>
6843
7108
</parameters>
6844
7109
</function>
6845
7110
<function name="itemize_with_base_dir"
6846
7111
c:identifier="pango_itemize_with_base_dir"
6847
doc="e itemization process.
6848
after @start_index.
7112
version="1.4"
7113
introspectable="0">
7114
<doc xml:whitespace="preserve">after @start_index.
6849
7115
This must be >= 0.
6850
7116
Like pango_itemize(), but the base direction to use when
6851
7117
computing bidirectional levels (see pango_context_set_base_dir ()),
6852
7118
is specified explicitly rather than gotten from the #PangoContext.
6853
7119
freed using pango_item_free() probably in combination with g_list_foreach(),
6854
and the list itself using g_list_free()."
6855
version="1.4">
6856
<return-value transfer-ownership="full">
6857
<type name="GLib.List" c:type="GList*"/>
7120
and the list itself using g_list_free().</doc>
7121
<return-value>
7122
<doc xml:whitespace="preserve">a #GList of #PangoItem structures. The items should be</doc>
7123
<type name="GLib.List" c:type="GList*">
7124
<type name="gpointer" c:type="gpointer"/>
7125
</type>
6858
7126
</return-value>
6859
7127
<parameters>
6860
7128
<parameter name="context" transfer-ownership="none">
7129
<doc xml:whitespace="preserve">a structure holding information that affects</doc>
6861
7130
<type name="Context" c:type="PangoContext*"/>
6862
7131
</parameter>
6863
7132
<parameter name="base_dir" transfer-ownership="none">
7133
<doc xml:whitespace="preserve">base direction to use for bidirectional processing</doc>
6864
7134
<type name="Direction" c:type="PangoDirection"/>
6865
7135
</parameter>
6866
7136
<parameter name="text" transfer-ownership="none">
7137
<doc xml:whitespace="preserve">the text to itemize.</doc>
6867
7138
<type name="utf8" c:type="char*"/>
6868
7139
</parameter>
6869
7140
<parameter name="start_index" transfer-ownership="none">
6870
<type name="int" c:type="int"/>
7141
<doc xml:whitespace="preserve">first byte in @text to process</doc>
7142
<type name="gint" c:type="int"/>
6871
7143
</parameter>
6872
<parameter name="length" transfer-ownership="none" doc="to process">
6873
<type name="int" c:type="int"/>
7144
<parameter name="length" transfer-ownership="none">
7145
<doc xml:whitespace="preserve">the number of bytes (not characters) to process</doc>
7146
<type name="gint" c:type="int"/>
6874
7147
</parameter>
6875
7148
<parameter name="attrs" transfer-ownership="none">
7149
<doc xml:whitespace="preserve">the set of attributes that apply to @text.</doc>
6876
7150
<type name="AttrList" c:type="PangoAttrList*"/>
6877
7151
</parameter>
6878
7152
<parameter name="cached_iter" transfer-ownership="none">
7153
<doc xml:whitespace="preserve">Cached attribute iterator, or %NULL</doc>
6879
7154
<type name="AttrIterator" c:type="PangoAttrIterator*"/>
6880
7155
</parameter>
6881
7156
</parameters>
6882
7157
</function>
6883
7158
<function name="language_from_string"
6884
c:identifier="pango_language_from_string"
6885
doc="Take a RFC-3066 format language tag as a string and convert it to a
7159
c:identifier="pango_language_from_string">
7160
<doc xml:whitespace="preserve">Take a RFC-3066 format language tag as a string and convert it to a
6886
7161
#PangoLanguage pointer that can be efficiently copied (copy the
6887
7162
pointer) and compared with other language tags (compare the
6888
7163
pointer.)
6889
7164
This function first canonicalizes the string by converting it to
6890
lowercase, mapping '_' to '-', and stripping all characters other
6891
than letters and '-'.
7165
lowercase, mapping '_' to '-', and stripping all characters other
7166
than letters and '-'.
6892
7167
Use pango_language_get_default() if you want to get the #PangoLanguage for
6893
7168
the current locale of the process.
6894
7169
if @language was %NULL. The returned pointer will be valid
6895
forever after, and should not be freed.">
7170
forever after, and should not be freed.</doc>
6896
7171
<return-value transfer-ownership="full">
7172
<doc xml:whitespace="preserve">an opaque pointer to a #PangoLanguage structure, or %NULL</doc>
6897
7173
<type name="Language" c:type="PangoLanguage*"/>
6898
7174
</return-value>
6899
7175
<parameters>
6900
7176
<parameter name="language" transfer-ownership="none">
7177
<doc xml:whitespace="preserve">a string representing a language tag, or %NULL</doc>
6901
7178
<type name="utf8" c:type="char*"/>
6902
7179
</parameter>
6903
7180
</parameters>
6904
7181
</function>
6905
7182
<function name="language_get_default"
6906
7183
c:identifier="pango_language_get_default"
6907
doc="Returns the #PangoLanguage for the current locale of the process.
7184
version="1.16">
7185
<doc xml:whitespace="preserve">Returns the #PangoLanguage for the current locale of the process.
6908
7186
Note that this can change over the life of an application.
6909
7187
On Unix systems, this is the return value is derived from
6910
7188
<literal>setlocale(LC_CTYPE, NULL)</literal>, and the user can
6915
7193
Swedish as written in Finland or pt_BR for Portuguese as written in
6916
7194
Brazil.
6917
7195
On Windows, the C library does not use any such environment
6918
variables, and setting them won't affect the behavior of functions
7196
variables, and setting them won't affect the behavior of functions
6919
7197
like ctime(). The user sets the locale through the Regional Options
6920
7198
in the Control Panel. The C library (in the setlocale() function)
6921
7199
does not use country and language codes, but country and language
6922
7200
names spelled out in English.
6923
7201
However, this function does check the above environment
6924
7202
variables, and does return a Unix-style locale string based on
6925
either said environment variables or the thread's current locale.
6926
Your application should call <literal>setlocale(LC_ALL, "");</literal>
7203
either said environment variables or the thread's current locale.
7204
Your application should call <literal>setlocale(LC_ALL, "");</literal>
6927
7205
for the user settings to take effect. Gtk+ does this in its initialization
6928
7206
functions automatically (by calling gtk_set_locale()).
6929
7207
See <literal>man setlocale</literal> for more details.
6930
freed."
6931
version="1.16">
7208
freed.</doc>
6932
7209
<return-value transfer-ownership="full">
7210
<doc xml:whitespace="preserve">the default language as a #PangoLanguage, must not be</doc>
6933
7211
<type name="Language" c:type="PangoLanguage*"/>
6934
7212
</return-value>
6935
7213
</function>
6936
7214
<function name="log2vis_get_embedding_levels"
6937
7215
c:identifier="pango_log2vis_get_embedding_levels"
6938
doc="if @text is nul-terminated and the length should be calculated.
6939
This will return the bidirectional embedding levels of the input paragraph
7216
version="1.4">
7217
<doc xml:whitespace="preserve">This will return the bidirectional embedding levels of the input paragraph
6940
7218
as defined by the Unicode Bidirectional Algorithm available at:
6941
7219
http://www.unicode.org/reports/tr9/
6942
7220
If the input base direction is a weak direction, the direction of the
6943
7221
characters in the text will determine the final resolved direction.
6944
character (not byte), that should be freed using g_free."
6945
version="1.4">
6946
<return-value transfer-ownership="full">
6947
<array c:type="guint8*">
6948
<type name="uint8"/>
6949
</array>
7222
character (not byte), that should be freed using g_free.</doc>
7223
<return-value transfer-ownership="none">
7224
<doc xml:whitespace="preserve">a newly allocated array of embedding levels, one item per</doc>
7225
<type name="guint8" c:type="guint8*"/>
6950
7226
</return-value>
6951
7227
<parameters>
6952
7228
<parameter name="text" transfer-ownership="none">
7229
<doc xml:whitespace="preserve">the text to itemize.</doc>
6953
7230
<type name="utf8" c:type="gchar*"/>
6954
7231
</parameter>
6955
<parameter name="length"
6956
transfer-ownership="none"
6957
doc="to process, or -1">
6958
<type name="int" c:type="int"/>
7232
<parameter name="length" transfer-ownership="none">
7233
<doc xml:whitespace="preserve">the number of bytes (not characters) to process, or -1 if @text is nul-terminated and the length should be calculated.</doc>
7234
<type name="gint" c:type="int"/>
6959
7235
</parameter>
6960
7236
<parameter name="pbase_dir" transfer-ownership="none">
7237
<doc xml:whitespace="preserve">input base direction, and output resolved direction.</doc>
6961
7238
<type name="Direction" c:type="PangoDirection*"/>
6962
7239
</parameter>
6963
7240
</parameters>
6964
7241
</function>
6965
<function name="parse_enum"
6966
c:identifier="pango_parse_enum"
6967
doc="Parses an enum type and stores the result in @value.
7242
<function name="parse_enum" c:identifier="pango_parse_enum" version="1.16">
7243
<doc xml:whitespace="preserve">Parses an enum type and stores the result in @value.
6968
7244
If @str does not match the nick name of any of the possible values for the
6969
7245
enum and is not an integer, %FALSE is returned, a warning is issued
6970
7246
if @warn is %TRUE, and a
6971
7247
string representing the list of possible values is stored in
6972
"none/start/middle/end". If failed and @possible_values is not %NULL,
6973
returned string should be freed using g_free()."
6974
version="1.16">
7248
"none/start/middle/end". If failed and @possible_values is not %NULL,
7249
returned string should be freed using g_free().</doc>
6975
7250
<return-value transfer-ownership="none">
6976
<type name="boolean" c:type="gboolean"/>
7251
<doc xml:whitespace="preserve">%TRUE if @str was successfully parsed.</doc>
7252
<type name="gboolean" c:type="gboolean"/>
6977
7253
</return-value>
6978
7254
<parameters>
6979
7255
<parameter name="type" transfer-ownership="none">
7256
<doc xml:whitespace="preserve">enum type to parse, eg. %PANGO_TYPE_ELLIPSIZE_MODE.</doc>
6980
7257
<type name="GType" c:type="GType"/>
6981
7258
</parameter>
6982
7259
<parameter name="str" transfer-ownership="none">
7260
<doc xml:whitespace="preserve">string to parse. May be %NULL.</doc>
6983
7261
<type name="utf8" c:type="char*"/>
6984
7262
</parameter>
6985
<parameter name="value" direction="out" transfer-ownership="full">
6986
<type name="int" c:type="int*"/>
7263
<parameter name="value" transfer-ownership="none">
7264
<doc xml:whitespace="preserve">integer to store the result in, or %NULL.</doc>
7265
<type name="gint" c:type="int*"/>
6987
7266
</parameter>
6988
<parameter name="warn" transfer-ownership="none" doc="on bad input.">
6989
<type name="boolean" c:type="gboolean"/>
7267
<parameter name="warn" transfer-ownership="none">
7268
<doc xml:whitespace="preserve">if %TRUE, issue a g_warning() on bad input.</doc>
7269
<type name="gboolean" c:type="gboolean"/>
6990
7270
</parameter>
6991
7271
<parameter name="possible_values" transfer-ownership="none">
6992
<array c:type="char**">
6993
<type name="utf8"/>
6994
</array>
7272
<doc xml:whitespace="preserve">place to store list of possible values on failure, or %NULL.</doc>
7273
<type name="utf8" c:type="char**"/>
6995
7274
</parameter>
6996
7275
</parameters>
6997
7276
</function>
6998
7277
<function name="parse_markup"
6999
7278
c:identifier="pango_parse_markup"
7000
doc="Parses marked-up text (see
7001
<link linkend="PangoMarkupFormat">markup format</link>) to create
7279
introspectable="0"
7280
throws="1">
7281
<doc xml:whitespace="preserve">Parses marked-up text (see
7282
<link linkend="PangoMarkupFormat">markup format</link>) to create
7002
7283
a plain-text string and an attribute list.
7003
7284
If @accel_marker is nonzero, the given character will mark the
7004
7285
character following it as an accelerator. For example, @accel_marker
7008
7289
Two @accel_marker characters following each other produce a single
7009
7290
literal @accel_marker character.
7010
7291
If any error happens, none of the output arguments are touched except
7011
for @error."
7012
throws="1">
7292
for @error.</doc>
7013
7293
<return-value transfer-ownership="none">
7014
<type name="boolean" c:type="gboolean"/>
7294
<doc xml:whitespace="preserve">%FALSE if @error is set, otherwise %TRUE</doc>
7295
<type name="gboolean" c:type="gboolean"/>
7015
7296
</return-value>
7016
7297
<parameters>
7017
7298
<parameter name="markup_text" transfer-ownership="none">
7299
<doc xml:whitespace="preserve">markup to parse (see <link linkend="PangoMarkupFormat">markup format</link>)</doc>
7018
7300
<type name="utf8" c:type="char*"/>
7019
7301
</parameter>
7020
7302
<parameter name="length" transfer-ownership="none">
7021
<type name="int" c:type="int"/>
7303
<doc xml:whitespace="preserve">length of @markup_text, or -1 if nul-terminated</doc>
7304
<type name="gint" c:type="int"/>
7022
7305
</parameter>
7023
7306
<parameter name="accel_marker" transfer-ownership="none">
7024
<type name="GLib.unichar" c:type="gunichar"/>
7307
<doc xml:whitespace="preserve">character that precedes an accelerator, or 0 for none</doc>
7308
<type name="gunichar" c:type="gunichar"/>
7025
7309
</parameter>
7026
7310
<parameter name="attr_list" transfer-ownership="none">
7311
<doc xml:whitespace="preserve">address of return location for a #PangoAttrList, or %NULL</doc>
7027
7312
<type name="AttrList" c:type="PangoAttrList**"/>
7028
7313
</parameter>
7029
7314
<parameter name="text" transfer-ownership="none">
7030
<array c:type="char**">
7031
<type name="utf8"/>
7032
</array>
7315
<doc xml:whitespace="preserve">address of return location for text with tags stripped, or %NULL</doc>
7316
<type name="utf8" c:type="char**"/>
7033
7317
</parameter>
7034
7318
<parameter name="accel_char" transfer-ownership="none">
7035
<type name="GLib.unichar" c:type="gunichar*"/>
7319
<doc xml:whitespace="preserve">address of return location for accelerator char, or %NULL</doc>
7320
<type name="gunichar" c:type="gunichar*"/>
7036
7321
</parameter>
7037
7322
</parameters>
7038
7323
</function>
7039
<function name="parse_stretch"
7040
c:identifier="pango_parse_stretch"
7041
doc="Parses a font stretch. The allowed values are
7042
"ultra_condensed", "extra_condensed", "condensed",
7043
"semi_condensed", "normal", "semi_expanded", "expanded",
7044
"extra_expanded" and "ultra_expanded". Case variations are
7045
ignored and the '_' characters may be omitted.">
7324
<function name="parse_stretch" c:identifier="pango_parse_stretch">
7325
<doc xml:whitespace="preserve">Parses a font stretch. The allowed values are
7326
"ultra_condensed", "extra_condensed", "condensed",
7327
"semi_condensed", "normal", "semi_expanded", "expanded",
7328
"extra_expanded" and "ultra_expanded". Case variations are
7329
ignored and the '_' characters may be omitted.</doc>
7046
7330
<return-value transfer-ownership="none">
7047
<type name="boolean" c:type="gboolean"/>
7331
<doc xml:whitespace="preserve">%TRUE if @str was successfully parsed.</doc>
7332
<type name="gboolean" c:type="gboolean"/>
7048
7333
</return-value>
7049
7334
<parameters>
7050
7335
<parameter name="str" transfer-ownership="none">
7336
<doc xml:whitespace="preserve">a string to parse.</doc>
7051
7337
<type name="utf8" c:type="char*"/>
7052
7338
</parameter>
7053
7339
<parameter name="stretch" transfer-ownership="none">
7340
<doc xml:whitespace="preserve">a #PangoStretch to store the result in.</doc>
7054
7341
<type name="Stretch" c:type="PangoStretch*"/>
7055
7342
</parameter>
7056
<parameter name="warn" transfer-ownership="none" doc="on bad input.">
7057
<type name="boolean" c:type="gboolean"/>
7343
<parameter name="warn" transfer-ownership="none">
7344
<doc xml:whitespace="preserve">if %TRUE, issue a g_warning() on bad input.</doc>
7345
<type name="gboolean" c:type="gboolean"/>
7058
7346
</parameter>
7059
7347
</parameters>
7060
7348
</function>
7061
<function name="parse_style"
7062
c:identifier="pango_parse_style"
7063
doc="Parses a font style. The allowed values are "normal",
7064
"italic" and "oblique", case variations being
7065
ignored.">
7349
<function name="parse_style" c:identifier="pango_parse_style">
7350
<doc xml:whitespace="preserve">Parses a font style. The allowed values are "normal",
7351
"italic" and "oblique", case variations being
7352
ignored.</doc>
7066
7353
<return-value transfer-ownership="none">
7067
<type name="boolean" c:type="gboolean"/>
7354
<doc xml:whitespace="preserve">%TRUE if @str was successfully parsed.</doc>
7355
<type name="gboolean" c:type="gboolean"/>
7068
7356
</return-value>
7069
7357
<parameters>
7070
7358
<parameter name="str" transfer-ownership="none">
7359
<doc xml:whitespace="preserve">a string to parse.</doc>
7071
7360
<type name="utf8" c:type="char*"/>
7072
7361
</parameter>
7073
7362
<parameter name="style" transfer-ownership="none">
7363
<doc xml:whitespace="preserve">a #PangoStyle to store the result in.</doc>
7074
7364
<type name="Style" c:type="PangoStyle*"/>
7075
7365
</parameter>
7076
<parameter name="warn" transfer-ownership="none" doc="on bad input.">
7077
<type name="boolean" c:type="gboolean"/>
7366
<parameter name="warn" transfer-ownership="none">
7367
<doc xml:whitespace="preserve">if %TRUE, issue a g_warning() on bad input.</doc>
7368
<type name="gboolean" c:type="gboolean"/>
7078
7369
</parameter>
7079
7370
</parameters>
7080
7371
</function>
7081
<function name="parse_variant"
7082
c:identifier="pango_parse_variant"
7083
doc="Parses a font variant. The allowed values are "normal"
7084
and "smallcaps" or "small_caps", case variations being
7085
ignored.">
7372
<function name="parse_variant" c:identifier="pango_parse_variant">
7373
<doc xml:whitespace="preserve">Parses a font variant. The allowed values are "normal"
7374
and "smallcaps" or "small_caps", case variations being
7375
ignored.</doc>
7086
7376
<return-value transfer-ownership="none">
7087
<type name="boolean" c:type="gboolean"/>
7377
<doc xml:whitespace="preserve">%TRUE if @str was successfully parsed.</doc>
7378
<type name="gboolean" c:type="gboolean"/>
7088
7379
</return-value>
7089
7380
<parameters>
7090
7381
<parameter name="str" transfer-ownership="none">
7382
<doc xml:whitespace="preserve">a string to parse.</doc>
7091
7383
<type name="utf8" c:type="char*"/>
7092
7384
</parameter>
7093
7385
<parameter name="variant" transfer-ownership="none">
7386
<doc xml:whitespace="preserve">a #PangoVariant to store the result in.</doc>
7094
7387
<type name="Variant" c:type="PangoVariant*"/>
7095
7388
</parameter>
7096
<parameter name="warn" transfer-ownership="none" doc="on bad input.">
7097
<type name="boolean" c:type="gboolean"/>
7389
<parameter name="warn" transfer-ownership="none">
7390
<doc xml:whitespace="preserve">if %TRUE, issue a g_warning() on bad input.</doc>
7391
<type name="gboolean" c:type="gboolean"/>
7098
7392
</parameter>
7099
7393
</parameters>
7100
7394
</function>
7101
<function name="parse_weight"
7102
c:identifier="pango_parse_weight"
7103
doc="Parses a font weight. The allowed values are "heavy",
7104
"ultrabold", "bold", "normal", "light", "ultraleight"
7105
and integers. Case variations are ignored.">
7395
<function name="parse_weight" c:identifier="pango_parse_weight">
7396
<doc xml:whitespace="preserve">Parses a font weight. The allowed values are "heavy",
7397
"ultrabold", "bold", "normal", "light", "ultraleight"
7398
and integers. Case variations are ignored.</doc>
7106
7399
<return-value transfer-ownership="none">
7107
<type name="boolean" c:type="gboolean"/>
7400
<doc xml:whitespace="preserve">%TRUE if @str was successfully parsed.</doc>
7401
<type name="gboolean" c:type="gboolean"/>
7108
7402
</return-value>
7109
7403
<parameters>
7110
7404
<parameter name="str" transfer-ownership="none">
7405
<doc xml:whitespace="preserve">a string to parse.</doc>
7111
7406
<type name="utf8" c:type="char*"/>
7112
7407
</parameter>
7113
7408
<parameter name="weight" transfer-ownership="none">
7409
<doc xml:whitespace="preserve">a #PangoWeight to store the result in.</doc>
7114
7410
<type name="Weight" c:type="PangoWeight*"/>
7115
7411
</parameter>
7116
<parameter name="warn" transfer-ownership="none" doc="on bad input.">
7117
<type name="boolean" c:type="gboolean"/>
7412
<parameter name="warn" transfer-ownership="none">
7413
<doc xml:whitespace="preserve">if %TRUE, issue a g_warning() on bad input.</doc>
7414
<type name="gboolean" c:type="gboolean"/>
7118
7415
</parameter>
7119
7416
</parameters>
7120
7417
</function>
7121
7418
<function name="quantize_line_geometry"
7122
7419
c:identifier="pango_quantize_line_geometry"
7123
doc="Quantizes the thickness and position of a line, typically an
7420
version="1.12">
7421
<doc xml:whitespace="preserve">Quantizes the thickness and position of a line, typically an
7124
7422
underline or strikethrough, to whole device pixels, that is integer
7125
7423
multiples of %PANGO_SCALE. The purpose of this function is to avoid
7126
7424
such lines looking blurry.
7127
7425
Care is taken to make sure @thickness is at least one pixel when this
7128
7426
function returns, but returned @position may become zero as a result
7129
of rounding."
7130
version="1.12">
7427
of rounding.</doc>
7131
7428
<return-value transfer-ownership="none">
7132
7429
<type name="none" c:type="void"/>
7133
7430
</return-value>
7134
7431
<parameters>
7135
<parameter name="thickness" direction="out" transfer-ownership="full">
7136
<type name="int" c:type="int*"/>
7137
</parameter>
7138
<parameter name="position" direction="out" transfer-ownership="full">
7139
<type name="int" c:type="int*"/>
7432
<parameter name="thickness" transfer-ownership="none">
7433
<doc xml:whitespace="preserve">pointer to the thickness of a line, in Pango units</doc>
7434
<type name="gint" c:type="int*"/>
7435
</parameter>
7436
<parameter name="position" transfer-ownership="none">
7437
<doc xml:whitespace="preserve">corresponding position</doc>
7438
<type name="gint" c:type="int*"/>
7439
</parameter>
7440
</parameters>
7441
</function>
7442
<function name="read_line" c:identifier="pango_read_line">
7443
<doc xml:whitespace="preserve">Reads an entire line from a file into a buffer. Lines may
7444
be delimited with '\n', '\r', '\n\r', or '\r\n'. The delimiter
7445
is not written into the buffer. Text after a '#' character is treated as
7446
a comment and skipped. '\' can be used to escape a # character.
7447
'\' proceeding a line delimiter combines adjacent lines. A '\' proceeding
7448
any other character is ignored and written into the output buffer
7449
unmodified.
7450
the number of lines read (this is useful for maintaining
7451
a line number counter which doesn't combine lines with '\')</doc>
7452
<return-value transfer-ownership="none">
7453
<doc xml:whitespace="preserve">0 if the stream was already at an %EOF character, otherwise</doc>
7454
<type name="gint" c:type="gint"/>
7455
</return-value>
7456
<parameters>
7457
<parameter name="stream" transfer-ownership="none">
7458
<doc xml:whitespace="preserve">a stdio stream</doc>
7459
<type name="gpointer" c:type="FILE*"/>
7460
</parameter>
7461
<parameter name="str" transfer-ownership="none">
7462
<doc xml:whitespace="preserve">#GString buffer into which to write the result</doc>
7463
<type name="GLib.String" c:type="GString*"/>
7140
7464
</parameter>
7141
7465
</parameters>
7142
7466
</function>
7143
7467
<function name="reorder_items"
7144
7468
c:identifier="pango_reorder_items"
7145
doc="From a list of items in logical order and the associated
7469
introspectable="0">
7470
<doc xml:whitespace="preserve">From a list of items in logical order and the associated
7146
7471
directional levels, produce a list in visual order.
7147
7472
The original list is unmodified.
7148
7473
(Please open a bug if you use this function.
7149
7474
It is not a particularly convenient interface, and the code
7150
is duplicated elsewhere in Pango for that reason.)">
7151
<return-value transfer-ownership="full">
7152
<type name="GLib.List" c:type="GList*"/>
7475
is duplicated elsewhere in Pango for that reason.)</doc>
7476
<return-value>
7477
<doc xml:whitespace="preserve">a #GList of #PangoItem structures in visual order.</doc>
7478
<type name="GLib.List" c:type="GList*">
7479
<type name="gpointer" c:type="gpointer"/>
7480
</type>
7153
7481
</return-value>
7154
7482
<parameters>
7155
7483
<parameter name="logical_items" transfer-ownership="none">
7156
<type name="GLib.List" c:type="GList*"/>
7484
<doc xml:whitespace="preserve">a #GList of #PangoItem in logical order.</doc>
7485
<type name="GLib.List" c:type="GList*">
7486
<type name="gpointer" c:type="gpointer"/>
7487
</type>
7157
7488
</parameter>
7158
7489
</parameters>
7159
7490
</function>
7160
<function name="scan_int"
7161
c:identifier="pango_scan_int"
7162
doc="Scans an integer.
7163
Leading white space is skipped.">
7491
<function name="scan_int" c:identifier="pango_scan_int">
7492
<doc xml:whitespace="preserve">Scans an integer.
7493
Leading white space is skipped.</doc>
7164
7494
<return-value transfer-ownership="none">
7165
<type name="boolean" c:type="gboolean"/>
7495
<doc xml:whitespace="preserve">%FALSE if a parse error occurred.</doc>
7496
<type name="gboolean" c:type="gboolean"/>
7166
7497
</return-value>
7167
7498
<parameters>
7168
7499
<parameter name="pos" transfer-ownership="none">
7169
<array c:type="char**">
7170
<type name="utf8"/>
7171
</array>
7500
<doc xml:whitespace="preserve">in/out string position</doc>
7501
<type name="utf8" c:type="char**"/>
7172
7502
</parameter>
7173
<parameter name="out" direction="out" transfer-ownership="full">
7174
<type name="int" c:type="int*"/>
7503
<parameter name="out" transfer-ownership="none">
7504
<doc xml:whitespace="preserve">an int into which to write the result</doc>
7505
<type name="gint" c:type="int*"/>
7175
7506
</parameter>
7176
7507
</parameters>
7177
7508
</function>
7178
<function name="scan_string"
7179
c:identifier="pango_scan_string"
7180
doc="Scans a string into a #GString buffer. The string may either
7509
<function name="scan_string" c:identifier="pango_scan_string">
7510
<doc xml:whitespace="preserve">Scans a string into a #GString buffer. The string may either
7181
7511
be a sequence of non-white-space characters, or a quoted
7182
string with '"'. Instead a quoted string, '\"' represents
7183
a literal quote. Leading white space outside of quotes is skipped.">
7512
string with '"'. Instead a quoted string, '\"' represents
7513
a literal quote. Leading white space outside of quotes is skipped.</doc>
7184
7514
<return-value transfer-ownership="none">
7185
<type name="boolean" c:type="gboolean"/>
7515
<doc xml:whitespace="preserve">%FALSE if a parse error occurred.</doc>
7516
<type name="gboolean" c:type="gboolean"/>
7186
7517
</return-value>
7187
7518
<parameters>
7188
7519
<parameter name="pos" transfer-ownership="none">
7189
<array c:type="char**">
7190
<type name="utf8"/>
7191
</array>
7520
<doc xml:whitespace="preserve">in/out string position</doc>
7521
<type name="utf8" c:type="char**"/>
7192
7522
</parameter>
7193
7523
<parameter name="out" transfer-ownership="none">
7524
<doc xml:whitespace="preserve">a #GString into which to write the result</doc>
7194
7525
<type name="GLib.String" c:type="GString*"/>
7195
7526
</parameter>
7196
7527
</parameters>
7197
7528
</function>
7198
<function name="scan_word"
7199
c:identifier="pango_scan_word"
7200
doc="Scans a word into a #GString buffer. A word consists
7529
<function name="scan_word" c:identifier="pango_scan_word">
7530
<doc xml:whitespace="preserve">Scans a word into a #GString buffer. A word consists
7201
7531
of [A-Za-z_] followed by zero or more [A-Za-z_0-9]
7202
Leading white space is skipped.">
7532
Leading white space is skipped.</doc>
7203
7533
<return-value transfer-ownership="none">
7204
<type name="boolean" c:type="gboolean"/>
7534
<doc xml:whitespace="preserve">%FALSE if a parse error occurred.</doc>
7535
<type name="gboolean" c:type="gboolean"/>
7205
7536
</return-value>
7206
7537
<parameters>
7207
7538
<parameter name="pos" transfer-ownership="none">
7208
<array c:type="char**">
7209
<type name="utf8"/>
7210
</array>
7539
<doc xml:whitespace="preserve">in/out string position</doc>
7540
<type name="utf8" c:type="char**"/>
7211
7541
</parameter>
7212
7542
<parameter name="out" transfer-ownership="none">
7543
<doc xml:whitespace="preserve">a #GString into which to write the result</doc>
7213
7544
<type name="GLib.String" c:type="GString*"/>
7214
7545
</parameter>
7215
7546
</parameters>
7216
7547
</function>
7217
7548
<function name="script_for_unichar"
7218
7549
c:identifier="pango_script_for_unichar"
7219
doc="Looks up the #PangoScript for a particular character (as defined by
7550
version="1.4"
7551
introspectable="0">
7552
<doc xml:whitespace="preserve">Looks up the #PangoScript for a particular character (as defined by
7220
7553
Unicode Standard Annex #24). No check is made for @ch being a
7221
7554
valid Unicode character; if you pass in invalid character, the
7222
7555
result is undefined.
7223
7556
As of Pango 1.18, this function simply returns the return value of
7224
g_unichar_get_script()."
7225
version="1.4">
7226
<return-value transfer-ownership="full">
7557
g_unichar_get_script().</doc>
7558
<return-value transfer-ownership="none">
7559
<doc xml:whitespace="preserve">the #PangoScript for the character.</doc>
7227
7560
<type name="Script" c:type="PangoScript"/>
7228
7561
</return-value>
7229
7562
<parameters>
7230
7563
<parameter name="ch" transfer-ownership="none">
7231
<type name="GLib.unichar" c:type="gunichar"/>
7564
<doc xml:whitespace="preserve">a Unicode character</doc>
7565
<type name="gunichar" c:type="gunichar"/>
7232
7566
</parameter>
7233
7567
</parameters>
7234
7568
</function>
7235
7569
<function name="script_get_sample_language"
7236
7570
c:identifier="pango_script_get_sample_language"
7237
doc="Given a script, finds a language tag that is reasonably
7571
version="1.4">
7572
<doc xml:whitespace="preserve">Given a script, finds a language tag that is reasonably
7238
7573
representative of that script. This will usually be the
7239
7574
most widely spoken or used language written in that script:
7240
7575
for instance, the sample language for %PANGO_SCRIPT_CYRILLIC
7255
7590
will return the first language in the parsed list that Pango
7256
7591
believes may use @script for writing. This last predicate
7257
7592
is tested using pango_language_includes_script(). This can
7258
be used to control Pango's font selection for non-primary
7593
be used to control Pango's font selection for non-primary
7259
7594
languages. For example, a PANGO_LANGUAGE enviroment variable
7260
set to "en:fa" makes Pango choose fonts suitable for Persian (fa)
7595
set to "en:fa" makes Pango choose fonts suitable for Persian (fa)
7261
7596
instead of Arabic (ar) when a segment of Arabic text is found
7262
7597
in an otherwise non-Arabic text. The same trick can be used to
7263
7598
choose a default language for %PANGO_SCRIPT_HAN when setting
7264
7599
context language is not feasible.
7265
of the script, or %NULL if no such language exists."
7266
version="1.4">
7600
of the script, or %NULL if no such language exists.</doc>
7267
7601
<return-value transfer-ownership="full">
7602
<doc xml:whitespace="preserve">a #PangoLanguage that is representative</doc>
7268
7603
<type name="Language" c:type="PangoLanguage*"/>
7269
7604
</return-value>
7270
7605
<parameters>
7271
7606
<parameter name="script" transfer-ownership="none">
7607
<doc xml:whitespace="preserve">a #PangoScript</doc>
7272
7608
<type name="Script" c:type="PangoScript"/>
7273
7609
</parameter>
7274
7610
</parameters>
7275
7611
</function>
7276
<function name="shape"
7277
c:identifier="pango_shape"
7278
doc="Given a segment of text and the corresponding
7612
<function name="script_iter_new"
7613
c:identifier="pango_script_iter_new"
7614
version="1.4"
7615
introspectable="0">
7616
<doc xml:whitespace="preserve">Create a new #PangoScriptIter, used to break a string of
7617
Unicode into runs by text. No copy is made of @text, so
7618
the caller needs to make sure it remains valid until
7619
the iterator is freed with pango_script_iter_free().
7620
to point at the first range in the text, which should be
7621
freed with pango_script_iter_free(). If the string is
7622
empty, it will point at an empty range.</doc>
7623
<return-value>
7624
<doc xml:whitespace="preserve">the new script iterator, initialized</doc>
7625
<type name="ScriptIter" c:type="PangoScriptIter*"/>
7626
</return-value>
7627
<parameters>
7628
<parameter name="text" transfer-ownership="none">
7629
<doc xml:whitespace="preserve">a UTF-8 string</doc>
7630
<type name="utf8" c:type="char*"/>
7631
</parameter>
7632
<parameter name="length" transfer-ownership="none">
7633
<doc xml:whitespace="preserve">length of @text, or -1 if @text is nul-terminated.</doc>
7634
<type name="gint" c:type="int"/>
7635
</parameter>
7636
</parameters>
7637
</function>
7638
<function name="shape" c:identifier="pango_shape">
7639
<doc xml:whitespace="preserve">Given a segment of text and the corresponding
7279
7640
#PangoAnalysis structure returned from pango_itemize(),
7280
7641
convert the characters into glyphs. You may also pass
7281
in only a substring of the item from pango_itemize().">
7642
in only a substring of the item from pango_itemize().</doc>
7282
7643
<return-value transfer-ownership="none">
7283
7644
<type name="none" c:type="void"/>
7284
7645
</return-value>
7285
7646
<parameters>
7286
7647
<parameter name="text" transfer-ownership="none">
7648
<doc xml:whitespace="preserve">the text to process</doc>
7287
7649
<type name="utf8" c:type="gchar*"/>
7288
7650
</parameter>
7289
<parameter name="length" transfer-ownership="none" doc="of @text">
7290
<type name="int" c:type="gint"/>
7651
<parameter name="length" transfer-ownership="none">
7652
<doc xml:whitespace="preserve">the length (in bytes) of @text</doc>
7653
<type name="gint" c:type="gint"/>
7291
7654
</parameter>
7292
7655
<parameter name="analysis" transfer-ownership="none">
7656
<doc xml:whitespace="preserve">#PangoAnalysis structure from pango_itemize()</doc>
7293
7657
<type name="Analysis" c:type="PangoAnalysis*"/>
7294
7658
</parameter>
7295
7659
<parameter name="glyphs" transfer-ownership="none">
7660
<doc xml:whitespace="preserve">glyph string in which to store results</doc>
7296
7661
<type name="GlyphString" c:type="PangoGlyphString*"/>
7297
7662
</parameter>
7298
7663
</parameters>
7299
7664
</function>
7300
<function name="skip_space"
7301
c:identifier="pango_skip_space"
7302
doc="Skips 0 or more characters of white space.
7303
the position at a '\0' character.">
7665
<function name="skip_space" c:identifier="pango_skip_space">
7666
<doc xml:whitespace="preserve">Skips 0 or more characters of white space.
7667
the position at a '\0' character.</doc>
7304
7668
<return-value transfer-ownership="none">
7305
<type name="boolean" c:type="gboolean"/>
7669
<doc xml:whitespace="preserve">%FALSE if skipping the white space leaves</doc>
7670
<type name="gboolean" c:type="gboolean"/>
7306
7671
</return-value>
7307
7672
<parameters>
7308
7673
<parameter name="pos" transfer-ownership="none">
7309
<array c:type="char**">
7310
<type name="utf8"/>
7311
</array>
7674
<doc xml:whitespace="preserve">in/out string position</doc>
7675
<type name="utf8" c:type="char**"/>
7312
7676
</parameter>
7313
7677
</parameters>
7314
7678
</function>
7315
7679
<function name="split_file_list"
7316
7680
c:identifier="pango_split_file_list"
7317
doc="Splits a %G_SEARCHPATH_SEPARATOR-separated list of files, stripping
7318
white space and substituting ~/ with $HOME/.">
7319
<return-value transfer-ownership="full">
7681
introspectable="0">
7682
<doc xml:whitespace="preserve">Splits a %G_SEARCHPATH_SEPARATOR-separated list of files, stripping
7683
white space and substituting ~/ with $HOME/.</doc>
7684
<return-value>
7685
<doc xml:whitespace="preserve">a list of strings to be freed with g_strfreev()</doc>
7320
7686
<array c:type="char**">
7321
7687
<type name="utf8"/>
7322
7688
</array>
7323
7689
</return-value>
7324
7690
<parameters>
7325
7691
<parameter name="str" transfer-ownership="none">
7692
<doc xml:whitespace="preserve">a %G_SEARCHPATH_SEPARATOR separated list of filenames</doc>
7326
7693
<type name="utf8" c:type="char*"/>
7327
7694
</parameter>
7328
7695
</parameters>
7329
7696
</function>
7330
<function name="trim_string"
7331
c:identifier="pango_trim_string"
7332
doc="Trims leading and trailing whitespace from a string.">
7697
<function name="trim_string" c:identifier="pango_trim_string">
7698
<doc xml:whitespace="preserve">Trims leading and trailing whitespace from a string.</doc>
7333
7699
<return-value transfer-ownership="full">
7700
<doc xml:whitespace="preserve">A newly-allocated string that must be freed with g_free()</doc>
7334
7701
<type name="utf8" c:type="char*"/>
7335
7702
</return-value>
7336
7703
<parameters>
7337
7704
<parameter name="str" transfer-ownership="none">
7705
<doc xml:whitespace="preserve">a string</doc>
7338
7706
<type name="utf8" c:type="char*"/>
7339
7707
</parameter>
7340
7708
</parameters>
7341
7709
</function>
7342
7710
<function name="unichar_direction"
7343
7711
c:identifier="pango_unichar_direction"
7344
doc="Determines the inherent direction of a character; either
7712
introspectable="0">
7713
<doc xml:whitespace="preserve">Determines the inherent direction of a character; either
7345
7714
%PANGO_DIRECTION_LTR, %PANGO_DIRECTION_RTL, or
7346
7715
%PANGO_DIRECTION_NEUTRAL.
7347
7716
This function is useful to categorize characters into left-to-right
7348
7717
letters, right-to-left letters, and everything else. If full
7349
7718
Unicode bidirectional type of a character is needed,
7350
pango_bidi_type_for_gunichar() can be used instead.">
7351
<return-value transfer-ownership="full">
7719
pango_bidi_type_for_gunichar() can be used instead.</doc>
7720
<return-value transfer-ownership="none">
7721
<doc xml:whitespace="preserve">the direction of the character.</doc>
7352
7722
<type name="Direction" c:type="PangoDirection"/>
7353
7723
</return-value>
7354
7724
<parameters>
7355
7725
<parameter name="ch" transfer-ownership="none">
7356
<type name="GLib.unichar" c:type="gunichar"/>
7726
<doc xml:whitespace="preserve">a Unicode character</doc>
7727
<type name="gunichar" c:type="gunichar"/>
7357
7728
</parameter>
7358
7729
</parameters>
7359
7730
</function>
7360
7731
<function name="units_from_double"
7361
7732
c:identifier="pango_units_from_double"
7362
doc="it by %PANGO_SCALE and rounds to nearest integer."
7363
7733
version="1.16">
7734
<doc xml:whitespace="preserve">it by %PANGO_SCALE and rounds to nearest integer.</doc>
7364
7735
<return-value transfer-ownership="none">
7365
<type name="int" c:type="int"/>
7736
<doc xml:whitespace="preserve">the value in Pango units.</doc>
7737
<type name="gint" c:type="int"/>
7366
7738
</return-value>
7367
7739
<parameters>
7368
7740
<parameter name="d" transfer-ownership="none">
7369
<type name="double" c:type="double"/>
7741
<doc xml:whitespace="preserve">double floating-point value</doc>
7742
<type name="gdouble" c:type="double"/>
7370
7743
</parameter>
7371
7744
</parameters>
7372
7745
</function>
7373
7746
<function name="units_to_double"
7374
7747
c:identifier="pango_units_to_double"
7375
doc="it by %PANGO_SCALE."
7376
7748
version="1.16">
7749
<doc xml:whitespace="preserve">it by %PANGO_SCALE.</doc>
7377
7750
<return-value transfer-ownership="none">
7378
<type name="double" c:type="double"/>
7751
<doc xml:whitespace="preserve">the double value.</doc>
7752
<type name="gdouble" c:type="double"/>
7379
7753
</return-value>
7380
7754
<parameters>
7381
7755
<parameter name="i" transfer-ownership="none">
7382
<type name="int" c:type="int"/>
7756
<doc xml:whitespace="preserve">value in Pango units</doc>
7757
<type name="gint" c:type="int"/>
7383
7758
</parameter>
7384
7759
</parameters>
7385
7760
</function>
7386
<function name="version"
7387
c:identifier="pango_version"
7388
doc="This is similar to the macro %PANGO_VERSION except that
7761
<function name="version" c:identifier="pango_version" version="1.16">
7762
<doc xml:whitespace="preserve">This is similar to the macro %PANGO_VERSION except that
7389
7763
it returns the encoded version of Pango available at run-time,
7390
7764
as opposed to the version available at compile-time.
7391
7765
A version number can be encoded into an integer using
7392
7766
PANGO_VERSION_ENCODE().
7393
available at run time."
7394
version="1.16">
7767
available at run time.</doc>
7395
7768
<return-value transfer-ownership="none">
7396
<type name="int" c:type="int"/>
7769
<doc xml:whitespace="preserve">The encoded version of Pango library</doc>
7770
<type name="gint" c:type="int"/>
7397
7771
</return-value>
7398
7772
</function>
7399
7773
<function name="version_check"
7400
7774
c:identifier="pango_version_check"
7401
doc="Checks that the Pango library in use is compatible with the
7775
version="1.16">
7776
<doc xml:whitespace="preserve">Checks that the Pango library in use is compatible with the
7402
7777
given version. Generally you would pass in the constants
7403
7778
%PANGO_VERSION_MAJOR, %PANGO_VERSION_MINOR, %PANGO_VERSION_MICRO
7404
7779
as the three arguments to this function; that produces
7411
7786
For compile-time version checking use PANGO_VERSION_CHECK().
7412
7787
given version, or a string describing the version mismatch.
7413
7788
The returned string is owned by Pango and should not be modified
7414
or freed."
7415
version="1.16">
7789
or freed.</doc>
7416
7790
<return-value transfer-ownership="none">
7791
<doc xml:whitespace="preserve">%NULL if the Pango library is compatible with the</doc>
7417
7792
<type name="utf8" c:type="char*"/>
7418
7793
</return-value>
7419
7794
<parameters>
7420
7795
<parameter name="required_major" transfer-ownership="none">
7421
<type name="int" c:type="int"/>
7796
<doc xml:whitespace="preserve">the required major version.</doc>
7797
<type name="gint" c:type="int"/>
7422
7798
</parameter>
7423
7799
<parameter name="required_minor" transfer-ownership="none">
7424
<type name="int" c:type="int"/>
7800
<doc xml:whitespace="preserve">the required minor version.</doc>
7801
<type name="gint" c:type="int"/>
7425
7802
</parameter>
7426
7803
<parameter name="required_micro" transfer-ownership="none">
7427
<type name="int" c:type="int"/>
7804
<doc xml:whitespace="preserve">the required major version.</doc>
7805
<type name="gint" c:type="int"/>
7428
7806
</parameter>
7429
7807
</parameters>
7430
7808
</function>
7431
7809
<function name="version_string"
7432
7810
c:identifier="pango_version_string"
7433
doc="This is similar to the macro %PANGO_VERSION_STRING except that
7811
version="1.16">
7812
<doc xml:whitespace="preserve">This is similar to the macro %PANGO_VERSION_STRING except that
7434
7813
it returns the version of Pango available at run-time, as opposed to
7435
7814
the version available at compile-time.
7436
7815
available at run time.
7437
7816
The returned string is owned by Pango and should not be modified
7438
or freed."
7439
version="1.16">
7817
or freed.</doc>
7440
7818
<return-value transfer-ownership="none">
7819
<doc xml:whitespace="preserve">A string containing the version of Pango library</doc>
7441
7820
<type name="utf8" c:type="char*"/>
7442
7821
</return-value>
7443
7822
</function>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1