← Back to branch summary

~ubuntu-branches/debian/experimental/pango1.0/experimental

« back to all changes in this revision

Viewing changes to docs/xml/text-attributes.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-06-17 10:58:54 UTC
  • mfrom: (1.2.51 upstream)
  • Revision ID: james.westby@ubuntu.com-20080617105854-9yw4lw7mwncrwyae
Tags: 1.21.3-0ubuntu1
* New upstream version:
  - Various small fixes and improvements
  - Bugs fixed in this release:
  Bug 538661 – Improve pango_cairo_context_update_context
  Bug 536190 – Make pango_fc_font_map_clear_cache() public?
  Bug 537258 – Add a pango_language_to_string() function
  Bug 537257 – pango_language_from_string(NULL) not happy
  Bug 537186 – Make PangoFcFont pattern property readable
* debian/control.in:
  - updated libcairo requirement
  - updated maintainer information

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/xml/text-attributes.xml
1
1
<refentry id="pango-Text-Attributes">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page" id="pango-Text-Attributes.top_of_page">Text Attributes</refentrytitle>
 
3
<refentrytitle role="top_of_page">Text Attributes</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>PANGO Library</refmiscinfo>
6
6
</refmeta>
11
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
12
</refnamediv>
13
13
 
14
 
<refsynopsisdiv id="pango-Text-Attributes.synopsis" role="synopsis">
 
14
<refsynopsisdiv role="synopsis">
15
15
<title role="synopsis.title">Synopsis</title>
16
16
 
17
17
<synopsis>
 
18
 
 
19
 
 
20
 
18
21
enum                <link linkend="PangoAttrType">PangoAttrType</link>;
19
22
#define             <link linkend="PANGO-TYPE-ATTR-TYPE:CAPS">PANGO_TYPE_ATTR_TYPE</link>
20
23
                    <link linkend="PangoAttrClass">PangoAttrClass</link>;
35
38
                                                         <link linkend="gunichar">gunichar</link> *accel_char,
36
39
                                                         <link linkend="GError">GError</link> **error);
37
40
<link linkend="PangoAttrType">PangoAttrType</link>       <link linkend="pango-attr-type-register">pango_attr_type_register</link>            (const <link linkend="gchar">gchar</link> *name);
 
41
const <link linkend="char">char</link>*         <link linkend="pango-attr-type-get-name">pango_attr_type_get_name</link>            (<link linkend="PangoAttrType">PangoAttrType</link> type);
38
42
<link linkend="void">void</link>                <link linkend="pango-attribute-init">pango_attribute_init</link>                (<link linkend="PangoAttribute">PangoAttribute</link> *attr,
39
43
                                                         const <link linkend="PangoAttrClass">PangoAttrClass</link> *klass);
40
44
<link linkend="PangoAttribute">PangoAttribute</link>*     <link linkend="pango-attribute-copy">pango_attribute_copy</link>                (const <link linkend="PangoAttribute">PangoAttribute</link> *attr);
98
102
                    <link linkend="PangoLanguage">PangoLanguage</link>;
99
103
#define             <link linkend="PANGO-TYPE-LANGUAGE:CAPS">PANGO_TYPE_LANGUAGE</link>
100
104
<link linkend="PangoLanguage">PangoLanguage</link>*      <link linkend="pango-language-from-string">pango_language_from_string</link>          (const <link linkend="char">char</link> *language);
101
 
#define             <link linkend="pango-language-to-string">pango_language_to_string</link>            (language)
 
105
const <link linkend="char">char</link>*         <link linkend="pango-language-to-string">pango_language_to_string</link>            (<link linkend="PangoLanguage">PangoLanguage</link> *language);
102
106
<link linkend="gboolean">gboolean</link>            <link linkend="pango-language-matches">pango_language_matches</link>              (<link linkend="PangoLanguage">PangoLanguage</link> *language,
103
107
                                                         const <link linkend="char">char</link> *range_list);
104
108
 
138
142
                                                         <link linkend="GSList">GSList</link> **extra_attrs);
139
143
<link linkend="GSList">GSList</link>*             <link linkend="pango-attr-iterator-get-attrs">pango_attr_iterator_get_attrs</link>       (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);
140
144
<link linkend="void">void</link>                <link linkend="pango-attr-iterator-destroy">pango_attr_iterator_destroy</link>         (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);
 
145
 
141
146
</synopsis>
142
147
</refsynopsisdiv>
143
148
 
149
154
 
150
155
 
151
156
 
152
 
<refsect1 id="pango-Text-Attributes.description" role="desc">
 
157
<refsect1 role="desc">
153
158
<title role="desc.title">Description</title>
154
159
<para>
155
160
Attributed text is used in a number of places in Pango. It
160
165
</para>
161
166
</refsect1>
162
167
 
163
 
<refsect1 id="pango-Text-Attributes.details" role="details">
 
168
<refsect1 role="details">
164
169
<title role="details.title">Details</title>
165
 
<refsect2 id="PangoAttrType" role="enum">
166
 
<title>enum PangoAttrType</title>
167
 
<indexterm zone="PangoAttrType"><primary>PangoAttrType</primary></indexterm><programlisting>typedef enum
 
170
<refsect2>
 
171
<title><anchor id="PangoAttrType" role="enum"/>enum PangoAttrType</title>
 
172
<indexterm><primary>PangoAttrType</primary></indexterm><programlisting>typedef enum
168
173
{
169
174
  PANGO_ATTR_INVALID,           /* 0 is an invalid attribute type */
170
175
  PANGO_ATTR_LANGUAGE,          /* PangoAttrLanguage */
199
204
values are given below. The type of structure used to store the
200
205
attribute is listed in parentheses after the description.
201
206
</para><variablelist role="enum">
202
 
<varlistentry id="PANGO-ATTR-INVALID:CAPS" role="constant">
203
 
<term><literal>PANGO_ATTR_INVALID</literal></term>
 
207
<varlistentry>
 
208
<term><anchor id="PANGO-ATTR-INVALID:CAPS" role="constant"/><literal>PANGO_ATTR_INVALID</literal></term>
204
209
<listitem><simpara>does not happen
205
210
</simpara></listitem>
206
211
</varlistentry>
207
 
<varlistentry id="PANGO-ATTR-LANGUAGE:CAPS" role="constant">
208
 
<term><literal>PANGO_ATTR_LANGUAGE</literal></term>
 
212
<varlistentry>
 
213
<term><anchor id="PANGO-ATTR-LANGUAGE:CAPS" role="constant"/><literal>PANGO_ATTR_LANGUAGE</literal></term>
209
214
<listitem><simpara>language (<link linkend="PangoAttrLanguage"><type>PangoAttrLanguage</type></link>)
210
215
</simpara></listitem>
211
216
</varlistentry>
212
 
<varlistentry id="PANGO-ATTR-FAMILY:CAPS" role="constant">
213
 
<term><literal>PANGO_ATTR_FAMILY</literal></term>
 
217
<varlistentry>
 
218
<term><anchor id="PANGO-ATTR-FAMILY:CAPS" role="constant"/><literal>PANGO_ATTR_FAMILY</literal></term>
214
219
<listitem><simpara>font family name list (<link linkend="PangoAttrString"><type>PangoAttrString</type></link>)
215
220
</simpara></listitem>
216
221
</varlistentry>
217
 
<varlistentry id="PANGO-ATTR-STYLE:CAPS" role="constant">
218
 
<term><literal>PANGO_ATTR_STYLE</literal></term>
 
222
<varlistentry>
 
223
<term><anchor id="PANGO-ATTR-STYLE:CAPS" role="constant"/><literal>PANGO_ATTR_STYLE</literal></term>
219
224
<listitem><simpara>font slant style (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
220
225
</simpara></listitem>
221
226
</varlistentry>
222
 
<varlistentry id="PANGO-ATTR-WEIGHT:CAPS" role="constant">
223
 
<term><literal>PANGO_ATTR_WEIGHT</literal></term>
 
227
<varlistentry>
 
228
<term><anchor id="PANGO-ATTR-WEIGHT:CAPS" role="constant"/><literal>PANGO_ATTR_WEIGHT</literal></term>
224
229
<listitem><simpara>font weight (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
225
230
</simpara></listitem>
226
231
</varlistentry>
227
 
<varlistentry id="PANGO-ATTR-VARIANT:CAPS" role="constant">
228
 
<term><literal>PANGO_ATTR_VARIANT</literal></term>
 
232
<varlistentry>
 
233
<term><anchor id="PANGO-ATTR-VARIANT:CAPS" role="constant"/><literal>PANGO_ATTR_VARIANT</literal></term>
229
234
<listitem><simpara>font variant (normal or small caps) (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
230
235
</simpara></listitem>
231
236
</varlistentry>
232
 
<varlistentry id="PANGO-ATTR-STRETCH:CAPS" role="constant">
233
 
<term><literal>PANGO_ATTR_STRETCH</literal></term>
 
237
<varlistentry>
 
238
<term><anchor id="PANGO-ATTR-STRETCH:CAPS" role="constant"/><literal>PANGO_ATTR_STRETCH</literal></term>
234
239
<listitem><simpara>font stretch (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
235
240
</simpara></listitem>
236
241
</varlistentry>
237
 
<varlistentry id="PANGO-ATTR-SIZE:CAPS" role="constant">
238
 
<term><literal>PANGO_ATTR_SIZE</literal></term>
 
242
<varlistentry>
 
243
<term><anchor id="PANGO-ATTR-SIZE:CAPS" role="constant"/><literal>PANGO_ATTR_SIZE</literal></term>
239
244
<listitem><simpara>font size in points scaled by <link linkend="PANGO-SCALE:CAPS"><literal>PANGO_SCALE</literal></link> (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
240
245
</simpara></listitem>
241
246
</varlistentry>
242
 
<varlistentry id="PANGO-ATTR-FONT-DESC:CAPS" role="constant">
243
 
<term><literal>PANGO_ATTR_FONT_DESC</literal></term>
 
247
<varlistentry>
 
248
<term><anchor id="PANGO-ATTR-FONT-DESC:CAPS" role="constant"/><literal>PANGO_ATTR_FONT_DESC</literal></term>
244
249
<listitem><simpara>font description (<link linkend="PangoAttrFontDesc"><type>PangoAttrFontDesc</type></link>)
245
250
</simpara></listitem>
246
251
</varlistentry>
247
 
<varlistentry id="PANGO-ATTR-FOREGROUND:CAPS" role="constant">
248
 
<term><literal>PANGO_ATTR_FOREGROUND</literal></term>
 
252
<varlistentry>
 
253
<term><anchor id="PANGO-ATTR-FOREGROUND:CAPS" role="constant"/><literal>PANGO_ATTR_FOREGROUND</literal></term>
249
254
<listitem><simpara>foreground color (<link linkend="PangoAttrColor"><type>PangoAttrColor</type></link>)
250
255
</simpara></listitem>
251
256
</varlistentry>
252
 
<varlistentry id="PANGO-ATTR-BACKGROUND:CAPS" role="constant">
253
 
<term><literal>PANGO_ATTR_BACKGROUND</literal></term>
 
257
<varlistentry>
 
258
<term><anchor id="PANGO-ATTR-BACKGROUND:CAPS" role="constant"/><literal>PANGO_ATTR_BACKGROUND</literal></term>
254
259
<listitem><simpara>background color (<link linkend="PangoAttrColor"><type>PangoAttrColor</type></link>)
255
260
</simpara></listitem>
256
261
</varlistentry>
257
 
<varlistentry id="PANGO-ATTR-UNDERLINE:CAPS" role="constant">
258
 
<term><literal>PANGO_ATTR_UNDERLINE</literal></term>
 
262
<varlistentry>
 
263
<term><anchor id="PANGO-ATTR-UNDERLINE:CAPS" role="constant"/><literal>PANGO_ATTR_UNDERLINE</literal></term>
259
264
<listitem><simpara>whether the text has an underline (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
260
265
</simpara></listitem>
261
266
</varlistentry>
262
 
<varlistentry id="PANGO-ATTR-STRIKETHROUGH:CAPS" role="constant">
263
 
<term><literal>PANGO_ATTR_STRIKETHROUGH</literal></term>
 
267
<varlistentry>
 
268
<term><anchor id="PANGO-ATTR-STRIKETHROUGH:CAPS" role="constant"/><literal>PANGO_ATTR_STRIKETHROUGH</literal></term>
264
269
<listitem><simpara>whether the text is struck-through (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
265
270
</simpara></listitem>
266
271
</varlistentry>
267
 
<varlistentry id="PANGO-ATTR-RISE:CAPS" role="constant">
268
 
<term><literal>PANGO_ATTR_RISE</literal></term>
 
272
<varlistentry>
 
273
<term><anchor id="PANGO-ATTR-RISE:CAPS" role="constant"/><literal>PANGO_ATTR_RISE</literal></term>
269
274
<listitem><simpara>baseline displacement (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
270
275
</simpara></listitem>
271
276
</varlistentry>
272
 
<varlistentry id="PANGO-ATTR-SHAPE:CAPS" role="constant">
273
 
<term><literal>PANGO_ATTR_SHAPE</literal></term>
 
277
<varlistentry>
 
278
<term><anchor id="PANGO-ATTR-SHAPE:CAPS" role="constant"/><literal>PANGO_ATTR_SHAPE</literal></term>
274
279
<listitem><simpara>shape (<link linkend="PangoAttrShape"><type>PangoAttrShape</type></link>)
275
280
</simpara></listitem>
276
281
</varlistentry>
277
 
<varlistentry id="PANGO-ATTR-SCALE:CAPS" role="constant">
278
 
<term><literal>PANGO_ATTR_SCALE</literal></term>
 
282
<varlistentry>
 
283
<term><anchor id="PANGO-ATTR-SCALE:CAPS" role="constant"/><literal>PANGO_ATTR_SCALE</literal></term>
279
284
<listitem><simpara>font size scale factor (<link linkend="PangoAttrFloat"><type>PangoAttrFloat</type></link>)
280
285
</simpara></listitem>
281
286
</varlistentry>
282
 
<varlistentry id="PANGO-ATTR-FALLBACK:CAPS" role="constant">
283
 
<term><literal>PANGO_ATTR_FALLBACK</literal></term>
 
287
<varlistentry>
 
288
<term><anchor id="PANGO-ATTR-FALLBACK:CAPS" role="constant"/><literal>PANGO_ATTR_FALLBACK</literal></term>
284
289
<listitem><simpara>whether fallback is enabled (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
285
290
</simpara></listitem>
286
291
</varlistentry>
287
 
<varlistentry id="PANGO-ATTR-LETTER-SPACING:CAPS" role="constant">
288
 
<term><literal>PANGO_ATTR_LETTER_SPACING</literal></term>
 
292
<varlistentry>
 
293
<term><anchor id="PANGO-ATTR-LETTER-SPACING:CAPS" role="constant"/><literal>PANGO_ATTR_LETTER_SPACING</literal></term>
289
294
<listitem><simpara>letter spacing (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
290
295
</simpara></listitem>
291
296
</varlistentry>
292
 
<varlistentry id="PANGO-ATTR-UNDERLINE-COLOR:CAPS" role="constant">
293
 
<term><literal>PANGO_ATTR_UNDERLINE_COLOR</literal></term>
 
297
<varlistentry>
 
298
<term><anchor id="PANGO-ATTR-UNDERLINE-COLOR:CAPS" role="constant"/><literal>PANGO_ATTR_UNDERLINE_COLOR</literal></term>
294
299
<listitem><simpara>underline color (<link linkend="PangoAttrColor"><type>PangoAttrColor</type></link>)
295
300
</simpara></listitem>
296
301
</varlistentry>
297
 
<varlistentry id="PANGO-ATTR-STRIKETHROUGH-COLOR:CAPS" role="constant">
298
 
<term><literal>PANGO_ATTR_STRIKETHROUGH_COLOR</literal></term>
 
302
<varlistentry>
 
303
<term><anchor id="PANGO-ATTR-STRIKETHROUGH-COLOR:CAPS" role="constant"/><literal>PANGO_ATTR_STRIKETHROUGH_COLOR</literal></term>
299
304
<listitem><simpara>strikethrough color (<link linkend="PangoAttrColor"><type>PangoAttrColor</type></link>)
300
305
</simpara></listitem>
301
306
</varlistentry>
302
 
<varlistentry id="PANGO-ATTR-ABSOLUTE-SIZE:CAPS" role="constant">
303
 
<term><literal>PANGO_ATTR_ABSOLUTE_SIZE</literal></term>
 
307
<varlistentry>
 
308
<term><anchor id="PANGO-ATTR-ABSOLUTE-SIZE:CAPS" role="constant"/><literal>PANGO_ATTR_ABSOLUTE_SIZE</literal></term>
304
309
<listitem><simpara>font size in pixels scaled by <link linkend="PANGO-SCALE:CAPS"><literal>PANGO_SCALE</literal></link> (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
305
310
</simpara></listitem>
306
311
</varlistentry>
307
 
<varlistentry id="PANGO-ATTR-GRAVITY:CAPS" role="constant">
308
 
<term><literal>PANGO_ATTR_GRAVITY</literal></term>
 
312
<varlistentry>
 
313
<term><anchor id="PANGO-ATTR-GRAVITY:CAPS" role="constant"/><literal>PANGO_ATTR_GRAVITY</literal></term>
309
314
<listitem><simpara>base text gravity (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
310
315
</simpara></listitem>
311
316
</varlistentry>
312
 
<varlistentry id="PANGO-ATTR-GRAVITY-HINT:CAPS" role="constant">
313
 
<term><literal>PANGO_ATTR_GRAVITY_HINT</literal></term>
 
317
<varlistentry>
 
318
<term><anchor id="PANGO-ATTR-GRAVITY-HINT:CAPS" role="constant"/><literal>PANGO_ATTR_GRAVITY_HINT</literal></term>
314
319
<listitem><simpara>gravity hint (<link linkend="PangoAttrInt"><type>PangoAttrInt</type></link>)
315
320
 
316
321
</simpara></listitem>
317
322
</varlistentry>
318
323
</variablelist></refsect2>
319
 
<refsect2 id="PANGO-TYPE-ATTR-TYPE:CAPS" role="macro">
320
 
<title>PANGO_TYPE_ATTR_TYPE</title>
321
 
<indexterm zone="PANGO-TYPE-ATTR-TYPE:CAPS"><primary>PANGO_TYPE_ATTR_TYPE</primary></indexterm><programlisting>#define PANGO_TYPE_ATTR_TYPE (pango_attr_type_get_type())
 
324
<refsect2>
 
325
<title><anchor id="PANGO-TYPE-ATTR-TYPE:CAPS" role="macro"/>PANGO_TYPE_ATTR_TYPE</title>
 
326
<indexterm><primary>PANGO_TYPE_ATTR_TYPE</primary></indexterm><programlisting>#define PANGO_TYPE_ATTR_TYPE (pango_attr_type_get_type())
322
327
</programlisting>
323
328
<para>
324
329
The <link linkend="GObject"><type>GObject</type></link> type for <link linkend="PangoAttrType"><type>PangoAttrType</type></link>.
325
330
</para></refsect2>
326
 
<refsect2 id="PangoAttrClass" role="struct">
327
 
<title>PangoAttrClass</title>
328
 
<indexterm zone="PangoAttrClass"><primary>PangoAttrClass</primary></indexterm><programlisting>typedef struct {
 
331
<refsect2>
 
332
<title><anchor id="PangoAttrClass" role="struct"/>PangoAttrClass</title>
 
333
<indexterm><primary>PangoAttrClass</primary></indexterm><programlisting>typedef struct {
329
334
  PangoAttrType type;
330
335
  PangoAttribute * (*copy) (const PangoAttribute *attr);
331
336
  void             (*destroy) (PangoAttribute *attr);
360
365
</simpara></listitem>
361
366
</varlistentry>
362
367
</variablelist></refsect2>
363
 
<refsect2 id="PangoAttribute" role="struct">
364
 
<title>PangoAttribute</title>
365
 
<indexterm zone="PangoAttribute"><primary>PangoAttribute</primary></indexterm><programlisting>typedef struct {
 
368
<refsect2>
 
369
<title><anchor id="PangoAttribute" role="struct"/>PangoAttribute</title>
 
370
<indexterm><primary>PangoAttribute</primary></indexterm><programlisting>typedef struct {
366
371
  const PangoAttrClass *klass;
367
372
  guint start_index;    /* in bytes */
368
373
  guint end_index;      /* in bytes. The character at this index is not included */
394
399
</simpara></listitem>
395
400
</varlistentry>
396
401
</variablelist></refsect2>
397
 
<refsect2 id="PangoAttrString" role="struct">
398
 
<title>PangoAttrString</title>
399
 
<indexterm zone="PangoAttrString"><primary>PangoAttrString</primary></indexterm><programlisting>typedef struct {
 
402
<refsect2>
 
403
<title><anchor id="PangoAttrString" role="struct"/>PangoAttrString</title>
 
404
<indexterm><primary>PangoAttrString</primary></indexterm><programlisting>typedef struct {
400
405
  PangoAttribute attr;
401
406
  char *value;
402
407
} PangoAttrString;
417
422
</simpara></listitem>
418
423
</varlistentry>
419
424
</variablelist></refsect2>
420
 
<refsect2 id="PangoAttrLanguage" role="struct">
421
 
<title>PangoAttrLanguage</title>
422
 
<indexterm zone="PangoAttrLanguage"><primary>PangoAttrLanguage</primary></indexterm><programlisting>typedef struct {
 
425
<refsect2>
 
426
<title><anchor id="PangoAttrLanguage" role="struct"/>PangoAttrLanguage</title>
 
427
<indexterm><primary>PangoAttrLanguage</primary></indexterm><programlisting>typedef struct {
423
428
  PangoAttribute attr;
424
429
  PangoLanguage *value;
425
430
} PangoAttrLanguage;
440
445
</simpara></listitem>
441
446
</varlistentry>
442
447
</variablelist></refsect2>
443
 
<refsect2 id="PangoAttrColor" role="struct">
444
 
<title>PangoAttrColor</title>
445
 
<indexterm zone="PangoAttrColor"><primary>PangoAttrColor</primary></indexterm><programlisting>typedef struct {
 
448
<refsect2>
 
449
<title><anchor id="PangoAttrColor" role="struct"/>PangoAttrColor</title>
 
450
<indexterm><primary>PangoAttrColor</primary></indexterm><programlisting>typedef struct {
446
451
  PangoAttribute attr;
447
452
  PangoColor color;
448
453
} PangoAttrColor;
463
468
</simpara></listitem>
464
469
</varlistentry>
465
470
</variablelist></refsect2>
466
 
<refsect2 id="PangoAttrInt" role="struct">
467
 
<title>PangoAttrInt</title>
468
 
<indexterm zone="PangoAttrInt"><primary>PangoAttrInt</primary></indexterm><programlisting>typedef struct {
 
471
<refsect2>
 
472
<title><anchor id="PangoAttrInt" role="struct"/>PangoAttrInt</title>
 
473
<indexterm><primary>PangoAttrInt</primary></indexterm><programlisting>typedef struct {
469
474
  PangoAttribute attr;
470
475
  int value;
471
476
} PangoAttrInt;
486
491
</simpara></listitem>
487
492
</varlistentry>
488
493
</variablelist></refsect2>
489
 
<refsect2 id="PangoAttrFloat" role="struct">
490
 
<title>PangoAttrFloat</title>
491
 
<indexterm zone="PangoAttrFloat"><primary>PangoAttrFloat</primary></indexterm><programlisting>typedef struct {
 
494
<refsect2>
 
495
<title><anchor id="PangoAttrFloat" role="struct"/>PangoAttrFloat</title>
 
496
<indexterm><primary>PangoAttrFloat</primary></indexterm><programlisting>typedef struct {
492
497
  PangoAttribute attr;
493
498
  double value;
494
499
} PangoAttrFloat;
509
514
</simpara></listitem>
510
515
</varlistentry>
511
516
</variablelist></refsect2>
512
 
<refsect2 id="PangoAttrFontDesc" role="struct">
513
 
<title>PangoAttrFontDesc</title>
514
 
<indexterm zone="PangoAttrFontDesc"><primary>PangoAttrFontDesc</primary></indexterm><programlisting>typedef struct {
 
517
<refsect2>
 
518
<title><anchor id="PangoAttrFontDesc" role="struct"/>PangoAttrFontDesc</title>
 
519
<indexterm><primary>PangoAttrFontDesc</primary></indexterm><programlisting>typedef struct {
515
520
  PangoAttribute attr;
516
521
  PangoFontDescription *desc;
517
522
} PangoAttrFontDesc;
532
537
</simpara></listitem>
533
538
</varlistentry>
534
539
</variablelist></refsect2>
535
 
<refsect2 id="PangoAttrShape" role="struct">
536
 
<title>PangoAttrShape</title>
537
 
<indexterm zone="PangoAttrShape"><primary>PangoAttrShape</primary></indexterm><programlisting>typedef struct {
 
540
<refsect2>
 
541
<title><anchor id="PangoAttrShape" role="struct"/>PangoAttrShape</title>
 
542
<indexterm><primary>PangoAttrShape</primary></indexterm><programlisting>typedef struct {
538
543
  PangoAttribute attr;
539
544
  PangoRectangle ink_rect;
540
545
  PangoRectangle logical_rect;
580
585
</simpara></listitem>
581
586
</varlistentry>
582
587
</variablelist></refsect2>
583
 
<refsect2 id="PangoAttrSize" role="struct">
584
 
<title>PangoAttrSize</title>
585
 
<indexterm zone="PangoAttrSize"><primary>PangoAttrSize</primary></indexterm><programlisting>typedef struct {
 
588
<refsect2>
 
589
<title><anchor id="PangoAttrSize" role="struct"/>PangoAttrSize</title>
 
590
<indexterm><primary>PangoAttrSize</primary></indexterm><programlisting>typedef struct {
586
591
  PangoAttribute attr;
587
592
  int size;
588
593
  guint absolute : 1;
613
618
</simpara></listitem>
614
619
</varlistentry>
615
620
</variablelist></refsect2>
616
 
<refsect2 id="pango-parse-markup" role="function">
617
 
<title>pango_parse_markup ()</title>
618
 
<indexterm zone="pango-parse-markup"><primary>pango_parse_markup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_parse_markup                  (const <link linkend="char">char</link> *markup_text,
 
621
<refsect2>
 
622
<title><anchor id="pango-parse-markup" role="function"/>pango_parse_markup ()</title>
 
623
<indexterm><primary>pango_parse_markup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_parse_markup                  (const <link linkend="char">char</link> *markup_text,
619
624
                                                         <link linkend="int">int</link> length,
620
625
                                                         <link linkend="gunichar">gunichar</link> accel_marker,
621
626
                                                         <link linkend="PangoAttrList">PangoAttrList</link> **attr_list,
666
671
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if <parameter>error</parameter> is set, otherwise <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
667
672
</simpara></listitem></varlistentry>
668
673
</variablelist></refsect2>
669
 
<refsect2 id="pango-attr-type-register" role="function">
670
 
<title>pango_attr_type_register ()</title>
671
 
<indexterm zone="pango-attr-type-register"><primary>pango_attr_type_register</primary></indexterm><programlisting><link linkend="PangoAttrType">PangoAttrType</link>       pango_attr_type_register            (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
674
<refsect2>
 
675
<title><anchor id="pango-attr-type-register" role="function"/>pango_attr_type_register ()</title>
 
676
<indexterm><primary>pango_attr_type_register</primary></indexterm><programlisting><link linkend="PangoAttrType">PangoAttrType</link>       pango_attr_type_register            (const <link linkend="gchar">gchar</link> *name);</programlisting>
672
677
<para>
673
 
Allocate a new attribute type ID.</para>
 
678
Allocate a new attribute type ID.  The attribute type name can be accessed
 
679
later by using <link linkend="pango-attr-type-get-name"><function>pango_attr_type_get_name()</function></link>.</para>
674
680
<para>
675
681
 
676
682
</para><variablelist role="params">
677
683
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
678
 
<listitem><simpara> an identifier for the type (currently unused.)
 
684
<listitem><simpara> an identifier for the type
679
685
</simpara></listitem></varlistentry>
680
686
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new type ID.
681
687
</simpara></listitem></varlistentry>
682
688
</variablelist></refsect2>
683
 
<refsect2 id="pango-attribute-init" role="function" condition="since:1.20">
684
 
<title>pango_attribute_init ()</title>
685
 
<indexterm zone="pango-attribute-init" role="1.20"><primary>pango_attribute_init</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attribute_init                (<link linkend="PangoAttribute">PangoAttribute</link> *attr,
 
689
<refsect2>
 
690
<title><anchor id="pango-attr-type-get-name" role="function" condition="since:1.22"/>pango_attr_type_get_name ()</title>
 
691
<indexterm role="1.22"><primary>pango_attr_type_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>*         pango_attr_type_get_name            (<link linkend="PangoAttrType">PangoAttrType</link> type);</programlisting>
 
692
<para>
 
693
Fetches the attribute type name passed in when registering the type using
 
694
<link linkend="pango-attr-type-register"><function>pango_attr_type_register()</function></link>.
 
695
</para>
 
696
<para>
 
697
The returned value is an interned string (see <link linkend="g-intern-string"><function>g_intern_string()</function></link> for what
 
698
that means) that should not be modified or freed.</para>
 
699
<para>
 
700
 
 
701
</para><variablelist role="params">
 
702
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 
703
<listitem><simpara> an attribute type ID to fetch the name for
 
704
</simpara></listitem></varlistentry>
 
705
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the type ID name (which may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>), or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>type</parameter> is
 
706
a built-in Pango attribute type or invalid. 
 
707
 
 
708
</simpara></listitem></varlistentry>
 
709
</variablelist><para role="since">Since  1.22
 
710
</para></refsect2>
 
711
<refsect2>
 
712
<title><anchor id="pango-attribute-init" role="function" condition="since:1.20"/>pango_attribute_init ()</title>
 
713
<indexterm role="1.20"><primary>pango_attribute_init</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attribute_init                (<link linkend="PangoAttribute">PangoAttribute</link> *attr,
686
714
                                                         const <link linkend="PangoAttrClass">PangoAttrClass</link> *klass);</programlisting>
687
715
<para>
688
716
Initializes <parameter>attr</parameter>'s klass to <parameter>klass</parameter>, it's start_index to zero,
699
727
</simpara></listitem></varlistentry>
700
728
</variablelist><para role="since">Since  1.20
701
729
</para></refsect2>
702
 
<refsect2 id="pango-attribute-copy" role="function">
703
 
<title>pango_attribute_copy ()</title>
704
 
<indexterm zone="pango-attribute-copy"><primary>pango_attribute_copy</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attribute_copy                (const <link linkend="PangoAttribute">PangoAttribute</link> *attr);</programlisting>
 
730
<refsect2>
 
731
<title><anchor id="pango-attribute-copy" role="function"/>pango_attribute_copy ()</title>
 
732
<indexterm><primary>pango_attribute_copy</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attribute_copy                (const <link linkend="PangoAttribute">PangoAttribute</link> *attr);</programlisting>
705
733
<para>
706
734
Make a copy of an attribute.</para>
707
735
<para>
714
742
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
715
743
</simpara></listitem></varlistentry>
716
744
</variablelist></refsect2>
717
 
<refsect2 id="pango-attribute-equal" role="function">
718
 
<title>pango_attribute_equal ()</title>
719
 
<indexterm zone="pango-attribute-equal"><primary>pango_attribute_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_attribute_equal               (const <link linkend="PangoAttribute">PangoAttribute</link> *attr1,
 
745
<refsect2>
 
746
<title><anchor id="pango-attribute-equal" role="function"/>pango_attribute_equal ()</title>
 
747
<indexterm><primary>pango_attribute_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_attribute_equal               (const <link linkend="PangoAttribute">PangoAttribute</link> *attr1,
720
748
                                                         const <link linkend="PangoAttribute">PangoAttribute</link> *attr2);</programlisting>
721
749
<para>
722
750
Compare two attributes for equality. This compares only the
734
762
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the two attributes have the same value.
735
763
</simpara></listitem></varlistentry>
736
764
</variablelist></refsect2>
737
 
<refsect2 id="pango-attribute-destroy" role="function">
738
 
<title>pango_attribute_destroy ()</title>
739
 
<indexterm zone="pango-attribute-destroy"><primary>pango_attribute_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attribute_destroy             (<link linkend="PangoAttribute">PangoAttribute</link> *attr);</programlisting>
 
765
<refsect2>
 
766
<title><anchor id="pango-attribute-destroy" role="function"/>pango_attribute_destroy ()</title>
 
767
<indexterm><primary>pango_attribute_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attribute_destroy             (<link linkend="PangoAttribute">PangoAttribute</link> *attr);</programlisting>
740
768
<para>
741
769
Destroy a <link linkend="PangoAttribute"><type>PangoAttribute</type></link> and free all associated memory.</para>
742
770
<para>
746
774
<listitem><simpara> a <link linkend="PangoAttribute"><type>PangoAttribute</type></link>.
747
775
</simpara></listitem></varlistentry>
748
776
</variablelist></refsect2>
749
 
<refsect2 id="pango-attr-language-new" role="function">
750
 
<title>pango_attr_language_new ()</title>
751
 
<indexterm zone="pango-attr-language-new"><primary>pango_attr_language_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_language_new             (<link linkend="PangoLanguage">PangoLanguage</link> *language);</programlisting>
 
777
<refsect2>
 
778
<title><anchor id="pango-attr-language-new" role="function"/>pango_attr_language_new ()</title>
 
779
<indexterm><primary>pango_attr_language_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_language_new             (<link linkend="PangoLanguage">PangoLanguage</link> *language);</programlisting>
752
780
<para>
753
781
Create a new language tag attribute.</para>
754
782
<para>
761
789
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
762
790
</simpara></listitem></varlistentry>
763
791
</variablelist></refsect2>
764
 
<refsect2 id="pango-attr-family-new" role="function">
765
 
<title>pango_attr_family_new ()</title>
766
 
<indexterm zone="pango-attr-family-new"><primary>pango_attr_family_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_family_new               (const <link linkend="char">char</link> *family);</programlisting>
 
792
<refsect2>
 
793
<title><anchor id="pango-attr-family-new" role="function"/>pango_attr_family_new ()</title>
 
794
<indexterm><primary>pango_attr_family_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_family_new               (const <link linkend="char">char</link> *family);</programlisting>
767
795
<para>
768
796
Create a new font family attribute.</para>
769
797
<para>
776
804
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
777
805
</simpara></listitem></varlistentry>
778
806
</variablelist></refsect2>
779
 
<refsect2 id="pango-attr-style-new" role="function">
780
 
<title>pango_attr_style_new ()</title>
781
 
<indexterm zone="pango-attr-style-new"><primary>pango_attr_style_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_style_new                (<link linkend="PangoStyle">PangoStyle</link> style);</programlisting>
 
807
<refsect2>
 
808
<title><anchor id="pango-attr-style-new" role="function"/>pango_attr_style_new ()</title>
 
809
<indexterm><primary>pango_attr_style_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_style_new                (<link linkend="PangoStyle">PangoStyle</link> style);</programlisting>
782
810
<para>
783
811
Create a new font slant style attribute.</para>
784
812
<para>
791
819
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
792
820
</simpara></listitem></varlistentry>
793
821
</variablelist></refsect2>
794
 
<refsect2 id="pango-attr-variant-new" role="function">
795
 
<title>pango_attr_variant_new ()</title>
796
 
<indexterm zone="pango-attr-variant-new"><primary>pango_attr_variant_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_variant_new              (<link linkend="PangoVariant">PangoVariant</link> variant);</programlisting>
 
822
<refsect2>
 
823
<title><anchor id="pango-attr-variant-new" role="function"/>pango_attr_variant_new ()</title>
 
824
<indexterm><primary>pango_attr_variant_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_variant_new              (<link linkend="PangoVariant">PangoVariant</link> variant);</programlisting>
797
825
<para>
798
826
Create a new font variant attribute (normal or small caps)</para>
799
827
<para>
806
834
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
807
835
</simpara></listitem></varlistentry>
808
836
</variablelist></refsect2>
809
 
<refsect2 id="pango-attr-stretch-new" role="function">
810
 
<title>pango_attr_stretch_new ()</title>
811
 
<indexterm zone="pango-attr-stretch-new"><primary>pango_attr_stretch_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_stretch_new              (<link linkend="PangoStretch">PangoStretch</link> stretch);</programlisting>
 
837
<refsect2>
 
838
<title><anchor id="pango-attr-stretch-new" role="function"/>pango_attr_stretch_new ()</title>
 
839
<indexterm><primary>pango_attr_stretch_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_stretch_new              (<link linkend="PangoStretch">PangoStretch</link> stretch);</programlisting>
812
840
<para>
813
841
Create a new font stretch attribute</para>
814
842
<para>
821
849
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
822
850
</simpara></listitem></varlistentry>
823
851
</variablelist></refsect2>
824
 
<refsect2 id="pango-attr-weight-new" role="function">
825
 
<title>pango_attr_weight_new ()</title>
826
 
<indexterm zone="pango-attr-weight-new"><primary>pango_attr_weight_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_weight_new               (<link linkend="PangoWeight">PangoWeight</link> weight);</programlisting>
 
852
<refsect2>
 
853
<title><anchor id="pango-attr-weight-new" role="function"/>pango_attr_weight_new ()</title>
 
854
<indexterm><primary>pango_attr_weight_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_weight_new               (<link linkend="PangoWeight">PangoWeight</link> weight);</programlisting>
827
855
<para>
828
856
Create a new font weight attribute.</para>
829
857
<para>
836
864
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
837
865
</simpara></listitem></varlistentry>
838
866
</variablelist></refsect2>
839
 
<refsect2 id="pango-attr-size-new" role="function">
840
 
<title>pango_attr_size_new ()</title>
841
 
<indexterm zone="pango-attr-size-new"><primary>pango_attr_size_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_size_new                 (<link linkend="int">int</link> size);</programlisting>
 
867
<refsect2>
 
868
<title><anchor id="pango-attr-size-new" role="function"/>pango_attr_size_new ()</title>
 
869
<indexterm><primary>pango_attr_size_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_size_new                 (<link linkend="int">int</link> size);</programlisting>
842
870
<para>
843
871
Create a new font-size attribute in fractional points.</para>
844
872
<para>
851
879
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
852
880
</simpara></listitem></varlistentry>
853
881
</variablelist></refsect2>
854
 
<refsect2 id="pango-attr-size-new-absolute" role="function" condition="since:1.8">
855
 
<title>pango_attr_size_new_absolute ()</title>
856
 
<indexterm zone="pango-attr-size-new-absolute" role="1.8"><primary>pango_attr_size_new_absolute</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_size_new_absolute        (<link linkend="int">int</link> size);</programlisting>
 
882
<refsect2>
 
883
<title><anchor id="pango-attr-size-new-absolute" role="function" condition="since:1.8"/>pango_attr_size_new_absolute ()</title>
 
884
<indexterm role="1.8"><primary>pango_attr_size_new_absolute</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_size_new_absolute        (<link linkend="int">int</link> size);</programlisting>
857
885
<para>
858
886
Create a new font-size attribute in device units.</para>
859
887
<para>
868
896
</simpara></listitem></varlistentry>
869
897
</variablelist><para role="since">Since  1.8
870
898
</para></refsect2>
871
 
<refsect2 id="pango-attr-font-desc-new" role="function">
872
 
<title>pango_attr_font_desc_new ()</title>
873
 
<indexterm zone="pango-attr-font-desc-new"><primary>pango_attr_font_desc_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_font_desc_new            (const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc);</programlisting>
 
899
<refsect2>
 
900
<title><anchor id="pango-attr-font-desc-new" role="function"/>pango_attr_font_desc_new ()</title>
 
901
<indexterm><primary>pango_attr_font_desc_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_font_desc_new            (const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc);</programlisting>
874
902
<para>
875
903
Create a new font description attribute. This attribute
876
904
allows setting family, style, weight, variant, stretch,
885
913
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
886
914
</simpara></listitem></varlistentry>
887
915
</variablelist></refsect2>
888
 
<refsect2 id="pango-attr-foreground-new" role="function">
889
 
<title>pango_attr_foreground_new ()</title>
890
 
<indexterm zone="pango-attr-foreground-new"><primary>pango_attr_foreground_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_foreground_new           (<link linkend="guint16">guint16</link> red,
 
916
<refsect2>
 
917
<title><anchor id="pango-attr-foreground-new" role="function"/>pango_attr_foreground_new ()</title>
 
918
<indexterm><primary>pango_attr_foreground_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_foreground_new           (<link linkend="guint16">guint16</link> red,
891
919
                                                         <link linkend="guint16">guint16</link> green,
892
920
                                                         <link linkend="guint16">guint16</link> blue);</programlisting>
893
921
<para>
908
936
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
909
937
</simpara></listitem></varlistentry>
910
938
</variablelist></refsect2>
911
 
<refsect2 id="pango-attr-background-new" role="function">
912
 
<title>pango_attr_background_new ()</title>
913
 
<indexterm zone="pango-attr-background-new"><primary>pango_attr_background_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_background_new           (<link linkend="guint16">guint16</link> red,
 
939
<refsect2>
 
940
<title><anchor id="pango-attr-background-new" role="function"/>pango_attr_background_new ()</title>
 
941
<indexterm><primary>pango_attr_background_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_background_new           (<link linkend="guint16">guint16</link> red,
914
942
                                                         <link linkend="guint16">guint16</link> green,
915
943
                                                         <link linkend="guint16">guint16</link> blue);</programlisting>
916
944
<para>
931
959
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
932
960
</simpara></listitem></varlistentry>
933
961
</variablelist></refsect2>
934
 
<refsect2 id="pango-attr-strikethrough-new" role="function">
935
 
<title>pango_attr_strikethrough_new ()</title>
936
 
<indexterm zone="pango-attr-strikethrough-new"><primary>pango_attr_strikethrough_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_strikethrough_new        (<link linkend="gboolean">gboolean</link> strikethrough);</programlisting>
 
962
<refsect2>
 
963
<title><anchor id="pango-attr-strikethrough-new" role="function"/>pango_attr_strikethrough_new ()</title>
 
964
<indexterm><primary>pango_attr_strikethrough_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_strikethrough_new        (<link linkend="gboolean">gboolean</link> strikethrough);</programlisting>
937
965
<para>
938
966
Create a new strike-through attribute.</para>
939
967
<para>
946
974
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
947
975
</simpara></listitem></varlistentry>
948
976
</variablelist></refsect2>
949
 
<refsect2 id="pango-attr-strikethrough-color-new" role="function" condition="since:1.8">
950
 
<title>pango_attr_strikethrough_color_new ()</title>
951
 
<indexterm zone="pango-attr-strikethrough-color-new" role="1.8"><primary>pango_attr_strikethrough_color_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_strikethrough_color_new  (<link linkend="guint16">guint16</link> red,
 
977
<refsect2>
 
978
<title><anchor id="pango-attr-strikethrough-color-new" role="function" condition="since:1.8"/>pango_attr_strikethrough_color_new ()</title>
 
979
<indexterm role="1.8"><primary>pango_attr_strikethrough_color_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_strikethrough_color_new  (<link linkend="guint16">guint16</link> red,
952
980
                                                         <link linkend="guint16">guint16</link> green,
953
981
                                                         <link linkend="guint16">guint16</link> blue);</programlisting>
954
982
<para>
973
1001
</simpara></listitem></varlistentry>
974
1002
</variablelist><para role="since">Since  1.8
975
1003
</para></refsect2>
976
 
<refsect2 id="pango-attr-underline-new" role="function">
977
 
<title>pango_attr_underline_new ()</title>
978
 
<indexterm zone="pango-attr-underline-new"><primary>pango_attr_underline_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_underline_new            (<link linkend="PangoUnderline">PangoUnderline</link> underline);</programlisting>
 
1004
<refsect2>
 
1005
<title><anchor id="pango-attr-underline-new" role="function"/>pango_attr_underline_new ()</title>
 
1006
<indexterm><primary>pango_attr_underline_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_underline_new            (<link linkend="PangoUnderline">PangoUnderline</link> underline);</programlisting>
979
1007
<para>
980
1008
Create a new underline-style attribute.</para>
981
1009
<para>
988
1016
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
989
1017
</simpara></listitem></varlistentry>
990
1018
</variablelist></refsect2>
991
 
<refsect2 id="pango-attr-underline-color-new" role="function" condition="since:1.8">
992
 
<title>pango_attr_underline_color_new ()</title>
993
 
<indexterm zone="pango-attr-underline-color-new" role="1.8"><primary>pango_attr_underline_color_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_underline_color_new      (<link linkend="guint16">guint16</link> red,
 
1019
<refsect2>
 
1020
<title><anchor id="pango-attr-underline-color-new" role="function" condition="since:1.8"/>pango_attr_underline_color_new ()</title>
 
1021
<indexterm role="1.8"><primary>pango_attr_underline_color_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_underline_color_new      (<link linkend="guint16">guint16</link> red,
994
1022
                                                         <link linkend="guint16">guint16</link> green,
995
1023
                                                         <link linkend="guint16">guint16</link> blue);</programlisting>
996
1024
<para>
1015
1043
</simpara></listitem></varlistentry>
1016
1044
</variablelist><para role="since">Since  1.8
1017
1045
</para></refsect2>
1018
 
<refsect2 id="PangoUnderline" role="enum">
1019
 
<title>enum PangoUnderline</title>
1020
 
<indexterm zone="PangoUnderline"><primary>PangoUnderline</primary></indexterm><programlisting>typedef enum {
 
1046
<refsect2>
 
1047
<title><anchor id="PangoUnderline" role="enum"/>enum PangoUnderline</title>
 
1048
<indexterm><primary>PangoUnderline</primary></indexterm><programlisting>typedef enum {
1021
1049
  PANGO_UNDERLINE_NONE,
1022
1050
  PANGO_UNDERLINE_SINGLE,
1023
1051
  PANGO_UNDERLINE_DOUBLE,
1030
1058
whether text should be underlined, and if so, the type
1031
1059
of underlining.
1032
1060
</para><variablelist role="enum">
1033
 
<varlistentry id="PANGO-UNDERLINE-NONE:CAPS" role="constant">
1034
 
<term><literal>PANGO_UNDERLINE_NONE</literal></term>
 
1061
<varlistentry>
 
1062
<term><anchor id="PANGO-UNDERLINE-NONE:CAPS" role="constant"/><literal>PANGO_UNDERLINE_NONE</literal></term>
1035
1063
<listitem><simpara>no underline should be drawn
1036
1064
</simpara></listitem>
1037
1065
</varlistentry>
1038
 
<varlistentry id="PANGO-UNDERLINE-SINGLE:CAPS" role="constant">
1039
 
<term><literal>PANGO_UNDERLINE_SINGLE</literal></term>
 
1066
<varlistentry>
 
1067
<term><anchor id="PANGO-UNDERLINE-SINGLE:CAPS" role="constant"/><literal>PANGO_UNDERLINE_SINGLE</literal></term>
1040
1068
<listitem><simpara>a single underline should be drawn
1041
1069
</simpara></listitem>
1042
1070
</varlistentry>
1043
 
<varlistentry id="PANGO-UNDERLINE-DOUBLE:CAPS" role="constant">
1044
 
<term><literal>PANGO_UNDERLINE_DOUBLE</literal></term>
 
1071
<varlistentry>
 
1072
<term><anchor id="PANGO-UNDERLINE-DOUBLE:CAPS" role="constant"/><literal>PANGO_UNDERLINE_DOUBLE</literal></term>
1045
1073
<listitem><simpara>a double underline should be drawn
1046
1074
</simpara></listitem>
1047
1075
</varlistentry>
1048
 
<varlistentry id="PANGO-UNDERLINE-LOW:CAPS" role="constant">
1049
 
<term><literal>PANGO_UNDERLINE_LOW</literal></term>
 
1076
<varlistentry>
 
1077
<term><anchor id="PANGO-UNDERLINE-LOW:CAPS" role="constant"/><literal>PANGO_UNDERLINE_LOW</literal></term>
1050
1078
<listitem><simpara>a single underline should be drawn at a position
1051
1079
                      beneath the ink extents of the text being
1052
1080
                      underlined. This should be used only for underlining
1055
1083
                      be used for extended portions of text.
1056
1084
</simpara></listitem>
1057
1085
</varlistentry>
1058
 
<varlistentry id="PANGO-UNDERLINE-ERROR:CAPS" role="constant">
1059
 
<term><literal>PANGO_UNDERLINE_ERROR</literal></term>
 
1086
<varlistentry>
 
1087
<term><anchor id="PANGO-UNDERLINE-ERROR:CAPS" role="constant"/><literal>PANGO_UNDERLINE_ERROR</literal></term>
1060
1088
<listitem><simpara>a wavy underline should be drawn below.
1061
1089
                      This underline is typically used to indicate
1062
1090
                      an error such as a possilble mispelling; in some
1067
1095
</simpara></listitem>
1068
1096
</varlistentry>
1069
1097
</variablelist></refsect2>
1070
 
<refsect2 id="PANGO-TYPE-UNDERLINE:CAPS" role="macro">
1071
 
<title>PANGO_TYPE_UNDERLINE</title>
1072
 
<indexterm zone="PANGO-TYPE-UNDERLINE:CAPS"><primary>PANGO_TYPE_UNDERLINE</primary></indexterm><programlisting>#define PANGO_TYPE_UNDERLINE (pango_underline_get_type())
 
1098
<refsect2>
 
1099
<title><anchor id="PANGO-TYPE-UNDERLINE:CAPS" role="macro"/>PANGO_TYPE_UNDERLINE</title>
 
1100
<indexterm><primary>PANGO_TYPE_UNDERLINE</primary></indexterm><programlisting>#define PANGO_TYPE_UNDERLINE (pango_underline_get_type())
1073
1101
</programlisting>
1074
1102
<para>
1075
1103
The <link linkend="GObject"><type>GObject</type></link> type for <link linkend="PangoUnderline"><type>PangoUnderline</type></link>.
1076
1104
</para></refsect2>
1077
 
<refsect2 id="pango-attr-shape-new" role="function">
1078
 
<title>pango_attr_shape_new ()</title>
1079
 
<indexterm zone="pango-attr-shape-new"><primary>pango_attr_shape_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_shape_new                (const <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
 
1105
<refsect2>
 
1106
<title><anchor id="pango-attr-shape-new" role="function"/>pango_attr_shape_new ()</title>
 
1107
<indexterm><primary>pango_attr_shape_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_shape_new                (const <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
1080
1108
                                                         const <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);</programlisting>
1081
1109
<para>
1082
1110
Create a new shape attribute. A shape is used to impose a
1096
1124
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
1097
1125
</simpara></listitem></varlistentry>
1098
1126
</variablelist></refsect2>
1099
 
<refsect2 id="pango-attr-shape-new-with-data" role="function" condition="since:1.8">
1100
 
<title>pango_attr_shape_new_with_data ()</title>
1101
 
<indexterm zone="pango-attr-shape-new-with-data" role="1.8"><primary>pango_attr_shape_new_with_data</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_shape_new_with_data      (const <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
 
1127
<refsect2>
 
1128
<title><anchor id="pango-attr-shape-new-with-data" role="function" condition="since:1.8"/>pango_attr_shape_new_with_data ()</title>
 
1129
<indexterm role="1.8"><primary>pango_attr_shape_new_with_data</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_shape_new_with_data      (const <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
1102
1130
                                                         const <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect,
1103
1131
                                                         <link linkend="gpointer">gpointer</link> data,
1104
1132
                                                         <link linkend="PangoAttrDataCopyFunc">PangoAttrDataCopyFunc</link> copy_func,
1134
1162
</simpara></listitem></varlistentry>
1135
1163
</variablelist><para role="since">Since  1.8
1136
1164
</para></refsect2>
1137
 
<refsect2 id="PangoAttrDataCopyFunc" role="function">
1138
 
<title>PangoAttrDataCopyFunc ()</title>
1139
 
<indexterm zone="PangoAttrDataCopyFunc"><primary>PangoAttrDataCopyFunc</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            (*PangoAttrDataCopyFunc)            (<link linkend="gconstpointer">gconstpointer</link> data);</programlisting>
 
1165
<refsect2>
 
1166
<title><anchor id="PangoAttrDataCopyFunc" role="function"/>PangoAttrDataCopyFunc ()</title>
 
1167
<indexterm><primary>PangoAttrDataCopyFunc</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            (*PangoAttrDataCopyFunc)            (<link linkend="gconstpointer">gconstpointer</link> data);</programlisting>
1140
1168
<para>
1141
1169
A copy function passed to attribute new functions that take
1142
1170
user data.
1149
1177
 
1150
1178
</simpara></listitem></varlistentry>
1151
1179
</variablelist></refsect2>
1152
 
<refsect2 id="pango-attr-scale-new" role="function">
1153
 
<title>pango_attr_scale_new ()</title>
1154
 
<indexterm zone="pango-attr-scale-new"><primary>pango_attr_scale_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_scale_new                (<link linkend="double">double</link> scale_factor);</programlisting>
 
1180
<refsect2>
 
1181
<title><anchor id="pango-attr-scale-new" role="function"/>pango_attr_scale_new ()</title>
 
1182
<indexterm><primary>pango_attr_scale_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_scale_new                (<link linkend="double">double</link> scale_factor);</programlisting>
1155
1183
<para>
1156
1184
Create a new font size scale attribute. The base font for the
1157
1185
affected text will have its size multiplied by <parameter>scale_factor</parameter>.</para>
1165
1193
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
1166
1194
</simpara></listitem></varlistentry>
1167
1195
</variablelist></refsect2>
1168
 
<refsect2 id="PANGO-SCALE-XX-SMALL:CAPS" role="macro">
1169
 
<title>PANGO_SCALE_XX_SMALL</title>
1170
 
<indexterm zone="PANGO-SCALE-XX-SMALL:CAPS"><primary>PANGO_SCALE_XX_SMALL</primary></indexterm><programlisting>#define PANGO_SCALE_XX_SMALL ((double)0.5787037037037)
 
1196
<refsect2>
 
1197
<title><anchor id="PANGO-SCALE-XX-SMALL:CAPS" role="macro"/>PANGO_SCALE_XX_SMALL</title>
 
1198
<indexterm><primary>PANGO_SCALE_XX_SMALL</primary></indexterm><programlisting>#define PANGO_SCALE_XX_SMALL ((double)0.5787037037037)
1171
1199
</programlisting>
1172
1200
<para>
1173
1201
The scale factor for three shrinking steps (1 / (1.2 * 1.2 * 1.2)).
1174
1202
</para></refsect2>
1175
 
<refsect2 id="PANGO-SCALE-X-SMALL:CAPS" role="macro">
1176
 
<title>PANGO_SCALE_X_SMALL</title>
1177
 
<indexterm zone="PANGO-SCALE-X-SMALL:CAPS"><primary>PANGO_SCALE_X_SMALL</primary></indexterm><programlisting>#define PANGO_SCALE_X_SMALL  ((double)0.6444444444444)
 
1203
<refsect2>
 
1204
<title><anchor id="PANGO-SCALE-X-SMALL:CAPS" role="macro"/>PANGO_SCALE_X_SMALL</title>
 
1205
<indexterm><primary>PANGO_SCALE_X_SMALL</primary></indexterm><programlisting>#define PANGO_SCALE_X_SMALL  ((double)0.6444444444444)
1178
1206
</programlisting>
1179
1207
<para>
1180
1208
The scale factor for two shrinking steps (1 / (1.2 * 1.2)).
1181
1209
</para></refsect2>
1182
 
<refsect2 id="PANGO-SCALE-SMALL:CAPS" role="macro">
1183
 
<title>PANGO_SCALE_SMALL</title>
1184
 
<indexterm zone="PANGO-SCALE-SMALL:CAPS"><primary>PANGO_SCALE_SMALL</primary></indexterm><programlisting>#define PANGO_SCALE_SMALL    ((double)0.8333333333333)
 
1210
<refsect2>
 
1211
<title><anchor id="PANGO-SCALE-SMALL:CAPS" role="macro"/>PANGO_SCALE_SMALL</title>
 
1212
<indexterm><primary>PANGO_SCALE_SMALL</primary></indexterm><programlisting>#define PANGO_SCALE_SMALL    ((double)0.8333333333333)
1185
1213
</programlisting>
1186
1214
<para>
1187
1215
The scale factor for one shrinking step (1 / 1.2).
1188
1216
</para></refsect2>
1189
 
<refsect2 id="PANGO-SCALE-MEDIUM:CAPS" role="macro">
1190
 
<title>PANGO_SCALE_MEDIUM</title>
1191
 
<indexterm zone="PANGO-SCALE-MEDIUM:CAPS"><primary>PANGO_SCALE_MEDIUM</primary></indexterm><programlisting>#define PANGO_SCALE_MEDIUM   ((double)1.0)
 
1217
<refsect2>
 
1218
<title><anchor id="PANGO-SCALE-MEDIUM:CAPS" role="macro"/>PANGO_SCALE_MEDIUM</title>
 
1219
<indexterm><primary>PANGO_SCALE_MEDIUM</primary></indexterm><programlisting>#define PANGO_SCALE_MEDIUM   ((double)1.0)
1192
1220
</programlisting>
1193
1221
<para>
1194
1222
The scale factor for normal size (1.0).
1195
1223
</para></refsect2>
1196
 
<refsect2 id="PANGO-SCALE-LARGE:CAPS" role="macro">
1197
 
<title>PANGO_SCALE_LARGE</title>
1198
 
<indexterm zone="PANGO-SCALE-LARGE:CAPS"><primary>PANGO_SCALE_LARGE</primary></indexterm><programlisting>#define PANGO_SCALE_LARGE    ((double)1.2)
 
1224
<refsect2>
 
1225
<title><anchor id="PANGO-SCALE-LARGE:CAPS" role="macro"/>PANGO_SCALE_LARGE</title>
 
1226
<indexterm><primary>PANGO_SCALE_LARGE</primary></indexterm><programlisting>#define PANGO_SCALE_LARGE    ((double)1.2)
1199
1227
</programlisting>
1200
1228
<para>
1201
1229
The scale factor for one magnification step (1.2).
1202
1230
</para></refsect2>
1203
 
<refsect2 id="PANGO-SCALE-X-LARGE:CAPS" role="macro">
1204
 
<title>PANGO_SCALE_X_LARGE</title>
1205
 
<indexterm zone="PANGO-SCALE-X-LARGE:CAPS"><primary>PANGO_SCALE_X_LARGE</primary></indexterm><programlisting>#define PANGO_SCALE_X_LARGE  ((double)1.4399999999999)
 
1231
<refsect2>
 
1232
<title><anchor id="PANGO-SCALE-X-LARGE:CAPS" role="macro"/>PANGO_SCALE_X_LARGE</title>
 
1233
<indexterm><primary>PANGO_SCALE_X_LARGE</primary></indexterm><programlisting>#define PANGO_SCALE_X_LARGE  ((double)1.4399999999999)
1206
1234
</programlisting>
1207
1235
<para>
1208
1236
The scale factor for two magnification steps (1.2 * 1.2).
1209
1237
</para></refsect2>
1210
 
<refsect2 id="PANGO-SCALE-XX-LARGE:CAPS" role="macro">
1211
 
<title>PANGO_SCALE_XX_LARGE</title>
1212
 
<indexterm zone="PANGO-SCALE-XX-LARGE:CAPS"><primary>PANGO_SCALE_XX_LARGE</primary></indexterm><programlisting>#define PANGO_SCALE_XX_LARGE ((double)1.728)
 
1238
<refsect2>
 
1239
<title><anchor id="PANGO-SCALE-XX-LARGE:CAPS" role="macro"/>PANGO_SCALE_XX_LARGE</title>
 
1240
<indexterm><primary>PANGO_SCALE_XX_LARGE</primary></indexterm><programlisting>#define PANGO_SCALE_XX_LARGE ((double)1.728)
1213
1241
</programlisting>
1214
1242
<para>
1215
1243
The scale factor for three magnification steps (1.2 * 1.2 * 1.2).
1216
1244
</para></refsect2>
1217
 
<refsect2 id="pango-attr-rise-new" role="function">
1218
 
<title>pango_attr_rise_new ()</title>
1219
 
<indexterm zone="pango-attr-rise-new"><primary>pango_attr_rise_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_rise_new                 (<link linkend="int">int</link> rise);</programlisting>
 
1245
<refsect2>
 
1246
<title><anchor id="pango-attr-rise-new" role="function"/>pango_attr_rise_new ()</title>
 
1247
<indexterm><primary>pango_attr_rise_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_rise_new                 (<link linkend="int">int</link> rise);</programlisting>
1220
1248
<para>
1221
1249
Create a new baseline displacement attribute.</para>
1222
1250
<para>
1230
1258
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
1231
1259
</simpara></listitem></varlistentry>
1232
1260
</variablelist></refsect2>
1233
 
<refsect2 id="pango-attr-letter-spacing-new" role="function" condition="since:1.6">
1234
 
<title>pango_attr_letter_spacing_new ()</title>
1235
 
<indexterm zone="pango-attr-letter-spacing-new" role="1.6"><primary>pango_attr_letter_spacing_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_letter_spacing_new       (<link linkend="int">int</link> letter_spacing);</programlisting>
 
1261
<refsect2>
 
1262
<title><anchor id="pango-attr-letter-spacing-new" role="function" condition="since:1.6"/>pango_attr_letter_spacing_new ()</title>
 
1263
<indexterm role="1.6"><primary>pango_attr_letter_spacing_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_letter_spacing_new       (<link linkend="int">int</link> letter_spacing);</programlisting>
1236
1264
<para>
1237
1265
Create a new letter-spacing attribute.</para>
1238
1266
<para>
1248
1276
</simpara></listitem></varlistentry>
1249
1277
</variablelist><para role="since">Since  1.6
1250
1278
</para></refsect2>
1251
 
<refsect2 id="pango-attr-fallback-new" role="function" condition="since:1.4">
1252
 
<title>pango_attr_fallback_new ()</title>
1253
 
<indexterm zone="pango-attr-fallback-new" role="1.4"><primary>pango_attr_fallback_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_fallback_new             (<link linkend="gboolean">gboolean</link> enable_fallback);</programlisting>
 
1279
<refsect2>
 
1280
<title><anchor id="pango-attr-fallback-new" role="function" condition="since:1.4"/>pango_attr_fallback_new ()</title>
 
1281
<indexterm role="1.4"><primary>pango_attr_fallback_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_fallback_new             (<link linkend="gboolean">gboolean</link> enable_fallback);</programlisting>
1254
1282
<para>
1255
1283
Create a new font fallback attribute.
1256
1284
</para>
1272
1300
</simpara></listitem></varlistentry>
1273
1301
</variablelist><para role="since">Since  1.4
1274
1302
</para></refsect2>
1275
 
<refsect2 id="pango-attr-gravity-new" role="function" condition="since:1.16">
1276
 
<title>pango_attr_gravity_new ()</title>
1277
 
<indexterm zone="pango-attr-gravity-new" role="1.16"><primary>pango_attr_gravity_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_gravity_new              (<link linkend="PangoGravity">PangoGravity</link> gravity);</programlisting>
 
1303
<refsect2>
 
1304
<title><anchor id="pango-attr-gravity-new" role="function" condition="since:1.16"/>pango_attr_gravity_new ()</title>
 
1305
<indexterm role="1.16"><primary>pango_attr_gravity_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_gravity_new              (<link linkend="PangoGravity">PangoGravity</link> gravity);</programlisting>
1278
1306
<para>
1279
1307
Create a new gravity attribute.</para>
1280
1308
<para>
1289
1317
</simpara></listitem></varlistentry>
1290
1318
</variablelist><para role="since">Since  1.16
1291
1319
</para></refsect2>
1292
 
<refsect2 id="pango-attr-gravity-hint-new" role="function" condition="since:1.16">
1293
 
<title>pango_attr_gravity_hint_new ()</title>
1294
 
<indexterm zone="pango-attr-gravity-hint-new" role="1.16"><primary>pango_attr_gravity_hint_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_gravity_hint_new         (<link linkend="PangoGravityHint">PangoGravityHint</link> hint);</programlisting>
 
1320
<refsect2>
 
1321
<title><anchor id="pango-attr-gravity-hint-new" role="function" condition="since:1.16"/>pango_attr_gravity_hint_new ()</title>
 
1322
<indexterm role="1.16"><primary>pango_attr_gravity_hint_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_gravity_hint_new         (<link linkend="PangoGravityHint">PangoGravityHint</link> hint);</programlisting>
1295
1323
<para>
1296
1324
Create a new gravity hint attribute.</para>
1297
1325
<para>
1306
1334
</simpara></listitem></varlistentry>
1307
1335
</variablelist><para role="since">Since  1.16
1308
1336
</para></refsect2>
1309
 
<refsect2 id="PangoColor" role="struct">
1310
 
<title>PangoColor</title>
1311
 
<indexterm zone="PangoColor"><primary>PangoColor</primary></indexterm><programlisting>typedef struct {
 
1337
<refsect2>
 
1338
<title><anchor id="PangoColor" role="struct"/>PangoColor</title>
 
1339
<indexterm><primary>PangoColor</primary></indexterm><programlisting>typedef struct {
1312
1340
  guint16 red;
1313
1341
  guint16 green;
1314
1342
  guint16 blue;
1338
1366
</simpara></listitem>
1339
1367
</varlistentry>
1340
1368
</variablelist></refsect2>
1341
 
<refsect2 id="PANGO-TYPE-COLOR:CAPS" role="macro">
1342
 
<title>PANGO_TYPE_COLOR</title>
1343
 
<indexterm zone="PANGO-TYPE-COLOR:CAPS"><primary>PANGO_TYPE_COLOR</primary></indexterm><programlisting>#define PANGO_TYPE_COLOR pango_color_get_type ()
 
1369
<refsect2>
 
1370
<title><anchor id="PANGO-TYPE-COLOR:CAPS" role="macro"/>PANGO_TYPE_COLOR</title>
 
1371
<indexterm><primary>PANGO_TYPE_COLOR</primary></indexterm><programlisting>#define PANGO_TYPE_COLOR pango_color_get_type ()
1344
1372
</programlisting>
1345
1373
<para>
1346
1374
The <link linkend="GObject"><type>GObject</type></link> type for <link linkend="PangoColor"><type>PangoColor</type></link>.
1347
1375
</para></refsect2>
1348
 
<refsect2 id="pango-color-parse" role="function">
1349
 
<title>pango_color_parse ()</title>
1350
 
<indexterm zone="pango-color-parse"><primary>pango_color_parse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_color_parse                   (<link linkend="PangoColor">PangoColor</link> *color,
 
1376
<refsect2>
 
1377
<title><anchor id="pango-color-parse" role="function"/>pango_color_parse ()</title>
 
1378
<indexterm><primary>pango_color_parse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_color_parse                   (<link linkend="PangoColor">PangoColor</link> *color,
1351
1379
                                                         const <link linkend="char">char</link> *spec);</programlisting>
1352
1380
<para>
1353
1381
Fill in the fields of a color from a string specification. The
1370
1398
  otherwise false.
1371
1399
</simpara></listitem></varlistentry>
1372
1400
</variablelist></refsect2>
1373
 
<refsect2 id="pango-color-copy" role="function">
1374
 
<title>pango_color_copy ()</title>
1375
 
<indexterm zone="pango-color-copy"><primary>pango_color_copy</primary></indexterm><programlisting><link linkend="PangoColor">PangoColor</link>*         pango_color_copy                    (const <link linkend="PangoColor">PangoColor</link> *src);</programlisting>
 
1401
<refsect2>
 
1402
<title><anchor id="pango-color-copy" role="function"/>pango_color_copy ()</title>
 
1403
<indexterm><primary>pango_color_copy</primary></indexterm><programlisting><link linkend="PangoColor">PangoColor</link>*         pango_color_copy                    (const <link linkend="PangoColor">PangoColor</link> *src);</programlisting>
1376
1404
<para>
1377
1405
Creates a copy of <parameter>src</parameter>, which should be freed with
1378
1406
<link linkend="pango-color-free"><function>pango_color_free()</function></link>. Primarily used by language bindings,
1389
1417
              if <parameter>src</parameter> was <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
1390
1418
</simpara></listitem></varlistentry>
1391
1419
</variablelist></refsect2>
1392
 
<refsect2 id="pango-color-free" role="function">
1393
 
<title>pango_color_free ()</title>
1394
 
<indexterm zone="pango-color-free"><primary>pango_color_free</primary></indexterm><programlisting><link linkend="void">void</link>                pango_color_free                    (<link linkend="PangoColor">PangoColor</link> *color);</programlisting>
 
1420
<refsect2>
 
1421
<title><anchor id="pango-color-free" role="function"/>pango_color_free ()</title>
 
1422
<indexterm><primary>pango_color_free</primary></indexterm><programlisting><link linkend="void">void</link>                pango_color_free                    (<link linkend="PangoColor">PangoColor</link> *color);</programlisting>
1395
1423
<para>
1396
1424
Frees a color allocated by <link linkend="pango-color-copy"><function>pango_color_copy()</function></link>.</para>
1397
1425
<para>
1401
1429
<listitem><simpara> an allocated <link linkend="PangoColor"><type>PangoColor</type></link>, may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>
1402
1430
</simpara></listitem></varlistentry>
1403
1431
</variablelist></refsect2>
1404
 
<refsect2 id="pango-color-to-string" role="function" condition="since:1.16">
1405
 
<title>pango_color_to_string ()</title>
1406
 
<indexterm zone="pango-color-to-string" role="1.16"><primary>pango_color_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              pango_color_to_string               (const <link linkend="PangoColor">PangoColor</link> *color);</programlisting>
 
1432
<refsect2>
 
1433
<title><anchor id="pango-color-to-string" role="function" condition="since:1.16"/>pango_color_to_string ()</title>
 
1434
<indexterm role="1.16"><primary>pango_color_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              pango_color_to_string               (const <link linkend="PangoColor">PangoColor</link> *color);</programlisting>
1407
1435
<para>
1408
1436
Returns a textual specification of <parameter>color</parameter> in the hexadecimal form
1409
1437
<literal>&num;rrrrggggbbbb</literal>, where <literal>r</literal>,
1420
1448
</simpara></listitem></varlistentry>
1421
1449
</variablelist><para role="since">Since  1.16
1422
1450
</para></refsect2>
1423
 
<refsect2 id="PangoLanguage" role="struct">
1424
 
<title>PangoLanguage</title>
1425
 
<indexterm zone="PangoLanguage"><primary>PangoLanguage</primary></indexterm><programlisting>typedef struct _PangoLanguage PangoLanguage;</programlisting>
 
1451
<refsect2>
 
1452
<title><anchor id="PangoLanguage" role="struct"/>PangoLanguage</title>
 
1453
<indexterm><primary>PangoLanguage</primary></indexterm><programlisting>typedef struct _PangoLanguage PangoLanguage;</programlisting>
1426
1454
<para>
1427
1455
The <link linkend="PangoLanguage"><type>PangoLanguage</type></link> structure is used to
1428
1456
represent a language.
1431
1459
<link linkend="PangoLanguage"><type>PangoLanguage</type></link> pointers can be efficiently 
1432
1460
copied and compared with each other.
1433
1461
</para></refsect2>
1434
 
<refsect2 id="PANGO-TYPE-LANGUAGE:CAPS" role="macro">
1435
 
<title>PANGO_TYPE_LANGUAGE</title>
1436
 
<indexterm zone="PANGO-TYPE-LANGUAGE:CAPS"><primary>PANGO_TYPE_LANGUAGE</primary></indexterm><programlisting>#define PANGO_TYPE_LANGUAGE (pango_language_get_type ())
 
1462
<refsect2>
 
1463
<title><anchor id="PANGO-TYPE-LANGUAGE:CAPS" role="macro"/>PANGO_TYPE_LANGUAGE</title>
 
1464
<indexterm><primary>PANGO_TYPE_LANGUAGE</primary></indexterm><programlisting>#define PANGO_TYPE_LANGUAGE (pango_language_get_type ())
1437
1465
</programlisting>
1438
1466
<para>
1439
1467
The <link linkend="GObject"><type>GObject</type></link> type for <link linkend="PangoLanguage"><type>PangoLanguage</type></link>. 
1440
1468
</para></refsect2>
1441
 
<refsect2 id="pango-language-from-string" role="function">
1442
 
<title>pango_language_from_string ()</title>
1443
 
<indexterm zone="pango-language-from-string"><primary>pango_language_from_string</primary></indexterm><programlisting><link linkend="PangoLanguage">PangoLanguage</link>*      pango_language_from_string          (const <link linkend="char">char</link> *language);</programlisting>
 
1469
<refsect2>
 
1470
<title><anchor id="pango-language-from-string" role="function"/>pango_language_from_string ()</title>
 
1471
<indexterm><primary>pango_language_from_string</primary></indexterm><programlisting><link linkend="PangoLanguage">PangoLanguage</link>*      pango_language_from_string          (const <link linkend="char">char</link> *language);</programlisting>
1444
1472
<para>
1445
1473
Take a RFC-3066 format language tag as a string and convert it to a
1446
1474
<link linkend="PangoLanguage"><type>PangoLanguage</type></link> pointer that can be efficiently copied (copy the
1459
1487
 
1460
1488
</para><variablelist role="params">
1461
1489
<varlistentry><term><parameter>language</parameter>&nbsp;:</term>
1462
 
<listitem><simpara> a string representing a language tag
 
1490
<listitem><simpara> a string representing a language tag, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
1463
1491
</simpara></listitem></varlistentry>
1464
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an opaque pointer to a <link linkend="PangoLanguage"><type>PangoLanguage</type></link> structure.
1465
 
              this will be valid forever after.
 
1492
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an opaque pointer to a <link linkend="PangoLanguage"><type>PangoLanguage</type></link> structure, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1493
              if <parameter>language</parameter> was <link linkend="NULL:CAPS"><literal>NULL</literal></link>.  The returned pointer will be valid
 
1494
              forever after, and should not be freed.
1466
1495
</simpara></listitem></varlistentry>
1467
1496
</variablelist></refsect2>
1468
 
<refsect2 id="pango-language-to-string" role="macro">
1469
 
<title>pango_language_to_string()</title>
1470
 
<indexterm zone="pango-language-to-string"><primary>pango_language_to_string</primary></indexterm><programlisting>#define pango_language_to_string(language) ((const char *)language)
1471
 
</programlisting>
 
1497
<refsect2>
 
1498
<title><anchor id="pango-language-to-string" role="function"/>pango_language_to_string ()</title>
 
1499
<indexterm><primary>pango_language_to_string</primary></indexterm><programlisting>const <link linkend="char">char</link>*         pango_language_to_string            (<link linkend="PangoLanguage">PangoLanguage</link> *language);</programlisting>
 
1500
<para>
 
1501
Gets the RFC-3066 format string representing the given language tag.</para>
1472
1502
<para>
1473
1503
Returns a RFC-3066 format string representing the given language tag. 
1474
1504
</para><variablelist role="params">
1475
1505
<varlistentry><term><parameter>language</parameter>&nbsp;:</term>
1476
 
<listitem><simpara>a language tag.
 
1506
<listitem><simpara> a language tag.
1477
1507
</simpara></listitem></varlistentry>
1478
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a string representing the language tag.
1479
 
 
1480
 
 
 
1508
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a string representing the language tag.  This is owned by
 
1509
         Pango and should not be freed.
1481
1510
</simpara></listitem></varlistentry>
1482
1511
</variablelist></refsect2>
1483
 
<refsect2 id="pango-language-matches" role="function">
1484
 
<title>pango_language_matches ()</title>
1485
 
<indexterm zone="pango-language-matches"><primary>pango_language_matches</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_language_matches              (<link linkend="PangoLanguage">PangoLanguage</link> *language,
 
1512
<refsect2>
 
1513
<title><anchor id="pango-language-matches" role="function"/>pango_language_matches ()</title>
 
1514
<indexterm><primary>pango_language_matches</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_language_matches              (<link linkend="PangoLanguage">PangoLanguage</link> *language,
1486
1515
                                                         const <link linkend="char">char</link> *range_list);</programlisting>
1487
1516
<para>
1488
1517
Checks if a language tag matches one of the elements in a list of
1506
1535
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a match was found.
1507
1536
</simpara></listitem></varlistentry>
1508
1537
</variablelist></refsect2>
1509
 
<refsect2 id="PangoAttrList" role="struct">
1510
 
<title>PangoAttrList</title>
1511
 
<indexterm zone="PangoAttrList"><primary>PangoAttrList</primary></indexterm><programlisting>typedef struct _PangoAttrList PangoAttrList;</programlisting>
 
1538
<refsect2>
 
1539
<title><anchor id="PangoAttrList" role="struct"/>PangoAttrList</title>
 
1540
<indexterm><primary>PangoAttrList</primary></indexterm><programlisting>typedef struct _PangoAttrList PangoAttrList;</programlisting>
1512
1541
<para>
1513
1542
The <link linkend="PangoAttrList"><type>PangoAttrList</type></link> structure represents a list of attributes
1514
1543
that apply to a section of text. The attributes are, in general,
1522
1551
of text. In general, you should not use a single <link linkend="PangoAttrList"><type>PangoAttrList</type></link>
1523
1552
for more than one paragraph of text.
1524
1553
</para></refsect2>
1525
 
<refsect2 id="PANGO-TYPE-ATTR-LIST:CAPS" role="macro">
1526
 
<title>PANGO_TYPE_ATTR_LIST</title>
1527
 
<indexterm zone="PANGO-TYPE-ATTR-LIST:CAPS"><primary>PANGO_TYPE_ATTR_LIST</primary></indexterm><programlisting>#define PANGO_TYPE_ATTR_LIST pango_attr_list_get_type ()
 
1554
<refsect2>
 
1555
<title><anchor id="PANGO-TYPE-ATTR-LIST:CAPS" role="macro"/>PANGO_TYPE_ATTR_LIST</title>
 
1556
<indexterm><primary>PANGO_TYPE_ATTR_LIST</primary></indexterm><programlisting>#define PANGO_TYPE_ATTR_LIST pango_attr_list_get_type ()
1528
1557
</programlisting>
1529
1558
<para>
1530
1559
The <link linkend="GObject"><type>GObject</type></link> type for <link linkend="PangoAttrList"><type>PangoAttrList</type></link>.
1531
1560
</para></refsect2>
1532
 
<refsect2 id="pango-attr-list-new" role="function">
1533
 
<title>pango_attr_list_new ()</title>
1534
 
<indexterm zone="pango-attr-list-new"><primary>pango_attr_list_new</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_attr_list_new                 (void);</programlisting>
 
1561
<refsect2>
 
1562
<title><anchor id="pango-attr-list-new" role="function"/>pango_attr_list_new ()</title>
 
1563
<indexterm><primary>pango_attr_list_new</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_attr_list_new                 (void);</programlisting>
1535
1564
<para>
1536
1565
Create a new empty attribute list with a reference count of one.</para>
1537
1566
<para>
1541
1570
              be freed with <link linkend="pango-attr-list-unref"><function>pango_attr_list_unref()</function></link>.
1542
1571
</simpara></listitem></varlistentry>
1543
1572
</variablelist></refsect2>
1544
 
<refsect2 id="pango-attr-list-ref" role="function" condition="since:1.10">
1545
 
<title>pango_attr_list_ref ()</title>
1546
 
<indexterm zone="pango-attr-list-ref" role="1.10"><primary>pango_attr_list_ref</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_attr_list_ref                 (<link linkend="PangoAttrList">PangoAttrList</link> *list);</programlisting>
 
1573
<refsect2>
 
1574
<title><anchor id="pango-attr-list-ref" role="function" condition="since:1.10"/>pango_attr_list_ref ()</title>
 
1575
<indexterm role="1.10"><primary>pango_attr_list_ref</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_attr_list_ref                 (<link linkend="PangoAttrList">PangoAttrList</link> *list);</programlisting>
1547
1576
<para>
1548
1577
Increase the reference count of the given attribute list by one.</para>
1549
1578
<para>
1557
1586
</simpara></listitem></varlistentry>
1558
1587
</variablelist><para role="since">Since  1.10
1559
1588
</para></refsect2>
1560
 
<refsect2 id="pango-attr-list-unref" role="function">
1561
 
<title>pango_attr_list_unref ()</title>
1562
 
<indexterm zone="pango-attr-list-unref"><primary>pango_attr_list_unref</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_unref               (<link linkend="PangoAttrList">PangoAttrList</link> *list);</programlisting>
 
1589
<refsect2>
 
1590
<title><anchor id="pango-attr-list-unref" role="function"/>pango_attr_list_unref ()</title>
 
1591
<indexterm><primary>pango_attr_list_unref</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_unref               (<link linkend="PangoAttrList">PangoAttrList</link> *list);</programlisting>
1563
1592
<para>
1564
1593
Decrease the reference count of the given attribute list by one.
1565
1594
If the result is zero, free the attribute list and the attributes
1571
1600
<listitem><simpara> a <link linkend="PangoAttrList"><type>PangoAttrList</type></link>, may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>
1572
1601
</simpara></listitem></varlistentry>
1573
1602
</variablelist></refsect2>
1574
 
<refsect2 id="pango-attr-list-copy" role="function">
1575
 
<title>pango_attr_list_copy ()</title>
1576
 
<indexterm zone="pango-attr-list-copy"><primary>pango_attr_list_copy</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_attr_list_copy                (<link linkend="PangoAttrList">PangoAttrList</link> *list);</programlisting>
 
1603
<refsect2>
 
1604
<title><anchor id="pango-attr-list-copy" role="function"/>pango_attr_list_copy ()</title>
 
1605
<indexterm><primary>pango_attr_list_copy</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_attr_list_copy                (<link linkend="PangoAttrList">PangoAttrList</link> *list);</programlisting>
1577
1606
<para>
1578
1607
Copy <parameter>list</parameter> and return an identical new list.</para>
1579
1608
<para>
1588
1617
              Returns <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>list</parameter> was <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
1589
1618
</simpara></listitem></varlistentry>
1590
1619
</variablelist></refsect2>
1591
 
<refsect2 id="pango-attr-list-insert" role="function">
1592
 
<title>pango_attr_list_insert ()</title>
1593
 
<indexterm zone="pango-attr-list-insert"><primary>pango_attr_list_insert</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_insert              (<link linkend="PangoAttrList">PangoAttrList</link> *list,
 
1620
<refsect2>
 
1621
<title><anchor id="pango-attr-list-insert" role="function"/>pango_attr_list_insert ()</title>
 
1622
<indexterm><primary>pango_attr_list_insert</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_insert              (<link linkend="PangoAttrList">PangoAttrList</link> *list,
1594
1623
                                                         <link linkend="PangoAttribute">PangoAttribute</link> *attr);</programlisting>
1595
1624
<para>
1596
1625
Insert the given attribute into the <link linkend="PangoAttrList"><type>PangoAttrList</type></link>. It will
1607
1636
       assumed by the list.
1608
1637
</simpara></listitem></varlistentry>
1609
1638
</variablelist></refsect2>
1610
 
<refsect2 id="pango-attr-list-insert-before" role="function">
1611
 
<title>pango_attr_list_insert_before ()</title>
1612
 
<indexterm zone="pango-attr-list-insert-before"><primary>pango_attr_list_insert_before</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_insert_before       (<link linkend="PangoAttrList">PangoAttrList</link> *list,
 
1639
<refsect2>
 
1640
<title><anchor id="pango-attr-list-insert-before" role="function"/>pango_attr_list_insert_before ()</title>
 
1641
<indexterm><primary>pango_attr_list_insert_before</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_insert_before       (<link linkend="PangoAttrList">PangoAttrList</link> *list,
1613
1642
                                                         <link linkend="PangoAttribute">PangoAttribute</link> *attr);</programlisting>
1614
1643
<para>
1615
1644
Insert the given attribute into the <link linkend="PangoAttrList"><type>PangoAttrList</type></link>. It will
1626
1655
       assumed by the list.
1627
1656
</simpara></listitem></varlistentry>
1628
1657
</variablelist></refsect2>
1629
 
<refsect2 id="pango-attr-list-change" role="function">
1630
 
<title>pango_attr_list_change ()</title>
1631
 
<indexterm zone="pango-attr-list-change"><primary>pango_attr_list_change</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_change              (<link linkend="PangoAttrList">PangoAttrList</link> *list,
 
1658
<refsect2>
 
1659
<title><anchor id="pango-attr-list-change" role="function"/>pango_attr_list_change ()</title>
 
1660
<indexterm><primary>pango_attr_list_change</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_change              (<link linkend="PangoAttrList">PangoAttrList</link> *list,
1632
1661
                                                         <link linkend="PangoAttribute">PangoAttribute</link> *attr);</programlisting>
1633
1662
<para>
1634
1663
Insert the given attribute into the <link linkend="PangoAttrList"><type>PangoAttrList</type></link>. It will
1652
1681
       assumed by the list.
1653
1682
</simpara></listitem></varlistentry>
1654
1683
</variablelist></refsect2>
1655
 
<refsect2 id="pango-attr-list-splice" role="function">
1656
 
<title>pango_attr_list_splice ()</title>
1657
 
<indexterm zone="pango-attr-list-splice"><primary>pango_attr_list_splice</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_splice              (<link linkend="PangoAttrList">PangoAttrList</link> *list,
 
1684
<refsect2>
 
1685
<title><anchor id="pango-attr-list-splice" role="function"/>pango_attr_list_splice ()</title>
 
1686
<indexterm><primary>pango_attr_list_splice</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_list_splice              (<link linkend="PangoAttrList">PangoAttrList</link> *list,
1658
1687
                                                         <link linkend="PangoAttrList">PangoAttrList</link> *other,
1659
1688
                                                         <link linkend="gint">gint</link> pos,
1660
1689
                                                         <link linkend="gint">gint</link> len);</programlisting>
1689
1718
      may only be present at some subsection of this range)
1690
1719
</simpara></listitem></varlistentry>
1691
1720
</variablelist></refsect2>
1692
 
<refsect2 id="pango-attr-list-filter" role="function" condition="since:1.2">
1693
 
<title>pango_attr_list_filter ()</title>
1694
 
<indexterm zone="pango-attr-list-filter" role="1.2"><primary>pango_attr_list_filter</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_attr_list_filter              (<link linkend="PangoAttrList">PangoAttrList</link> *list,
 
1721
<refsect2>
 
1722
<title><anchor id="pango-attr-list-filter" role="function" condition="since:1.2"/>pango_attr_list_filter ()</title>
 
1723
<indexterm role="1.2"><primary>pango_attr_list_filter</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_attr_list_filter              (<link linkend="PangoAttrList">PangoAttrList</link> *list,
1695
1724
                                                         <link linkend="PangoAttrFilterFunc">PangoAttrFilterFunc</link> func,
1696
1725
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
1697
1726
<para>
1717
1746
</simpara></listitem></varlistentry>
1718
1747
</variablelist><para role="since">Since  1.2
1719
1748
</para></refsect2>
1720
 
<refsect2 id="PangoAttrFilterFunc" role="function">
1721
 
<title>PangoAttrFilterFunc ()</title>
1722
 
<indexterm zone="PangoAttrFilterFunc"><primary>PangoAttrFilterFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*PangoAttrFilterFunc)              (<link linkend="PangoAttribute">PangoAttribute</link> *attribute,
 
1749
<refsect2>
 
1750
<title><anchor id="PangoAttrFilterFunc" role="function"/>PangoAttrFilterFunc ()</title>
 
1751
<indexterm><primary>PangoAttrFilterFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*PangoAttrFilterFunc)              (<link linkend="PangoAttribute">PangoAttribute</link> *attribute,
1723
1752
                                                         <link linkend="gpointer">gpointer</link> data);</programlisting>
1724
1753
<para>
1725
1754
A predicate function used by <link linkend="pango-attr-list-filter"><function>pango_attr_list_filter()</function></link>
1736
1765
 
1737
1766
</simpara></listitem></varlistentry>
1738
1767
</variablelist></refsect2>
1739
 
<refsect2 id="pango-attr-list-get-iterator" role="function">
1740
 
<title>pango_attr_list_get_iterator ()</title>
1741
 
<indexterm zone="pango-attr-list-get-iterator"><primary>pango_attr_list_get_iterator</primary></indexterm><programlisting><link linkend="PangoAttrIterator">PangoAttrIterator</link>*  pango_attr_list_get_iterator        (<link linkend="PangoAttrList">PangoAttrList</link> *list);</programlisting>
 
1768
<refsect2>
 
1769
<title><anchor id="pango-attr-list-get-iterator" role="function"/>pango_attr_list_get_iterator ()</title>
 
1770
<indexterm><primary>pango_attr_list_get_iterator</primary></indexterm><programlisting><link linkend="PangoAttrIterator">PangoAttrIterator</link>*  pango_attr_list_get_iterator        (<link linkend="PangoAttrList">PangoAttrList</link> *list);</programlisting>
1742
1771
<para>
1743
1772
Create a iterator initialized to the beginning of the list.
1744
1773
<parameter>list</parameter> must not be modified until this iterator is freed.</para>
1752
1781
              be freed with <link linkend="pango-attr-iterator-destroy"><function>pango_attr_iterator_destroy()</function></link>.
1753
1782
</simpara></listitem></varlistentry>
1754
1783
</variablelist></refsect2>
1755
 
<refsect2 id="PangoAttrIterator" role="struct">
1756
 
<title>PangoAttrIterator</title>
1757
 
<indexterm zone="PangoAttrIterator"><primary>PangoAttrIterator</primary></indexterm><programlisting>typedef struct _PangoAttrIterator PangoAttrIterator;</programlisting>
 
1784
<refsect2>
 
1785
<title><anchor id="PangoAttrIterator" role="struct"/>PangoAttrIterator</title>
 
1786
<indexterm><primary>PangoAttrIterator</primary></indexterm><programlisting>typedef struct _PangoAttrIterator PangoAttrIterator;</programlisting>
1758
1787
<para>
1759
1788
The <link linkend="PangoAttrIterator"><type>PangoAttrIterator</type></link> structure is used to represent an
1760
1789
iterator through a <link linkend="PangoAttrList"><type>PangoAttrList</type></link>. A new iterator is created
1764
1793
style change, the range of the current style segment and the
1765
1794
attributes currently in effect can be queried.
1766
1795
</para></refsect2>
1767
 
<refsect2 id="pango-attr-iterator-copy" role="function">
1768
 
<title>pango_attr_iterator_copy ()</title>
1769
 
<indexterm zone="pango-attr-iterator-copy"><primary>pango_attr_iterator_copy</primary></indexterm><programlisting><link linkend="PangoAttrIterator">PangoAttrIterator</link>*  pango_attr_iterator_copy            (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);</programlisting>
 
1796
<refsect2>
 
1797
<title><anchor id="pango-attr-iterator-copy" role="function"/>pango_attr_iterator_copy ()</title>
 
1798
<indexterm><primary>pango_attr_iterator_copy</primary></indexterm><programlisting><link linkend="PangoAttrIterator">PangoAttrIterator</link>*  pango_attr_iterator_copy            (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);</programlisting>
1770
1799
<para>
1771
1800
Copy a <link linkend="PangoAttrIterator"><type>PangoAttrIterator</type></link></para>
1772
1801
<para>
1779
1808
              be freed with <link linkend="pango-attr-iterator-destroy"><function>pango_attr_iterator_destroy()</function></link>.
1780
1809
</simpara></listitem></varlistentry>
1781
1810
</variablelist></refsect2>
1782
 
<refsect2 id="pango-attr-iterator-next" role="function">
1783
 
<title>pango_attr_iterator_next ()</title>
1784
 
<indexterm zone="pango-attr-iterator-next"><primary>pango_attr_iterator_next</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_attr_iterator_next            (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);</programlisting>
 
1811
<refsect2>
 
1812
<title><anchor id="pango-attr-iterator-next" role="function"/>pango_attr_iterator_next ()</title>
 
1813
<indexterm><primary>pango_attr_iterator_next</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_attr_iterator_next            (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);</programlisting>
1785
1814
<para>
1786
1815
Advance the iterator until the next change of style.</para>
1787
1816
<para>
1793
1822
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if the iterator is at the end of the list, otherwise <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
1794
1823
</simpara></listitem></varlistentry>
1795
1824
</variablelist></refsect2>
1796
 
<refsect2 id="pango-attr-iterator-range" role="function">
1797
 
<title>pango_attr_iterator_range ()</title>
1798
 
<indexterm zone="pango-attr-iterator-range"><primary>pango_attr_iterator_range</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_iterator_range           (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator,
 
1825
<refsect2>
 
1826
<title><anchor id="pango-attr-iterator-range" role="function"/>pango_attr_iterator_range ()</title>
 
1827
<indexterm><primary>pango_attr_iterator_range</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_iterator_range           (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator,
1799
1828
                                                         <link linkend="gint">gint</link> *start,
1800
1829
                                                         <link linkend="gint">gint</link> *end);</programlisting>
1801
1830
<para>
1817
1846
<listitem><simpara> location to store the end of the range
1818
1847
</simpara></listitem></varlistentry>
1819
1848
</variablelist></refsect2>
1820
 
<refsect2 id="pango-attr-iterator-get" role="function">
1821
 
<title>pango_attr_iterator_get ()</title>
1822
 
<indexterm zone="pango-attr-iterator-get"><primary>pango_attr_iterator_get</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_iterator_get             (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator,
 
1849
<refsect2>
 
1850
<title><anchor id="pango-attr-iterator-get" role="function"/>pango_attr_iterator_get ()</title>
 
1851
<indexterm><primary>pango_attr_iterator_get</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>*     pango_attr_iterator_get             (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator,
1823
1852
                                                         <link linkend="PangoAttrType">PangoAttrType</link> type);</programlisting>
1824
1853
<para>
1825
1854
Find the current attribute of a particular type at the iterator
1840
1869
              location.
1841
1870
</simpara></listitem></varlistentry>
1842
1871
</variablelist></refsect2>
1843
 
<refsect2 id="pango-attr-iterator-get-font" role="function">
1844
 
<title>pango_attr_iterator_get_font ()</title>
1845
 
<indexterm zone="pango-attr-iterator-get-font"><primary>pango_attr_iterator_get_font</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_iterator_get_font        (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator,
 
1872
<refsect2>
 
1873
<title><anchor id="pango-attr-iterator-get-font" role="function"/>pango_attr_iterator_get_font ()</title>
 
1874
<indexterm><primary>pango_attr_iterator_get_font</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_iterator_get_font        (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator,
1846
1875
                                                         <link linkend="PangoFontDescription">PangoFontDescription</link> *desc,
1847
1876
                                                         <link linkend="PangoLanguage">PangoLanguage</link> **language,
1848
1877
                                                         <link linkend="GSList">GSList</link> **extra_attrs);</programlisting>
1874
1903
          each member.
1875
1904
</simpara></listitem></varlistentry>
1876
1905
</variablelist></refsect2>
1877
 
<refsect2 id="pango-attr-iterator-get-attrs" role="function" condition="since:1.2">
1878
 
<title>pango_attr_iterator_get_attrs ()</title>
1879
 
<indexterm zone="pango-attr-iterator-get-attrs" role="1.2"><primary>pango_attr_iterator_get_attrs</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*             pango_attr_iterator_get_attrs       (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);</programlisting>
 
1906
<refsect2>
 
1907
<title><anchor id="pango-attr-iterator-get-attrs" role="function" condition="since:1.2"/>pango_attr_iterator_get_attrs ()</title>
 
1908
<indexterm role="1.2"><primary>pango_attr_iterator_get_attrs</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*             pango_attr_iterator_get_attrs       (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);</programlisting>
1880
1909
<para>
1881
1910
Gets a list of all attributes at the current position of the
1882
1911
iterator.</para>
1893
1922
</simpara></listitem></varlistentry>
1894
1923
</variablelist><para role="since">Since  1.2
1895
1924
</para></refsect2>
1896
 
<refsect2 id="pango-attr-iterator-destroy" role="function">
1897
 
<title>pango_attr_iterator_destroy ()</title>
1898
 
<indexterm zone="pango-attr-iterator-destroy"><primary>pango_attr_iterator_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_iterator_destroy         (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);</programlisting>
 
1925
<refsect2>
 
1926
<title><anchor id="pango-attr-iterator-destroy" role="function"/>pango_attr_iterator_destroy ()</title>
 
1927
<indexterm><primary>pango_attr_iterator_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                pango_attr_iterator_destroy         (<link linkend="PangoAttrIterator">PangoAttrIterator</link> *iterator);</programlisting>
1899
1928
<para>
1900
1929
Destroy a <link linkend="PangoAttrIterator"><type>PangoAttrIterator</type></link> and free all associated memory.</para>
1901
1930
<para>
1911
1940
 
1912
1941
 
1913
1942
 
 
1943
 
 
1944
<refsect1><refsect2 /><refsect2 /></refsect1>
1914
1945
</refentry>