~ubuntu-branches/ubuntu/saucy/pango1.0/saucy-proposed

« back to all changes in this revision

Viewing changes to docs/html/pango-Modules.html

  • Committer: Bazaar Package Importer
  • Author(s): Josselin Mouette
  • Date: 2010-10-19 23:37:45 UTC
  • mfrom: (1.5.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20101019233745-xey8xlf91rpkth51
Tags: 1.28.3-1
* New upstream stable release.
  + Fixes SIGFPE in opentype renderer. Closes: #598166.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="lowlevel.html" title="Low Level Functionality">
9
9
<link rel="prev" href="PangoEngineShape.html" title="PangoEngineShape">
10
10
<link rel="next" href="pango-Miscellaneous-Utilities.html" title="Miscellaneous Utilities">
11
 
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="chapter" href="pango.html" title="Basic Pango Interfaces">
14
 
<link rel="chapter" href="rendering.html" title="Rendering with Pango">
15
 
<link rel="chapter" href="lowlevel.html" title="Low Level Functionality">
16
 
<link rel="chapter" href="tools.html" title="Pango Tools">
17
 
<link rel="chapter" href="pango-hierarchy.html" title="Object Hierarchy">
18
 
<link rel="index" href="index-all.html" title="Index">
19
 
<link rel="index" href="index-deprecated.html" title="Index of deprecated symbols">
20
 
<link rel="index" href="index-1.2.html" title="Index of new symbols in 1.2">
21
 
<link rel="index" href="index-1.4.html" title="Index of new symbols in 1.4">
22
 
<link rel="index" href="index-1.6.html" title="Index of new symbols in 1.6">
23
 
<link rel="index" href="index-1.8.html" title="Index of new symbols in 1.8">
24
 
<link rel="index" href="index-1.10.html" title="Index of new symbols in 1.10">
25
 
<link rel="index" href="index-1.12.html" title="Index of new symbols in 1.12">
26
 
<link rel="index" href="index-1.14.html" title="Index of new symbols in 1.14">
27
 
<link rel="index" href="index-1.16.html" title="Index of new symbols in 1.16">
28
 
<link rel="index" href="index-1.18.html" title="Index of new symbols in 1.18">
29
 
<link rel="index" href="index-1.20.html" title="Index of new symbols in 1.20">
30
 
<link rel="index" href="index-1.22.html" title="Index of new symbols in 1.22">
31
 
<link rel="index" href="index-1.24.html" title="Index of new symbols in 1.24">
32
 
<link rel="index" href="index-1.26.html" title="Index of new symbols in 1.26">
33
 
<link rel="index" href="index-1.28.html" title="Index of new symbols in 1.26">
34
13
</head>
35
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
36
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
47
26
                  <a href="#pango-Modules.description" class="shortcut">Description</a>
48
27
</td></tr>
49
28
</table>
50
 
<div class="refentry" title="Modules">
 
29
<div class="refentry">
51
30
<a name="pango-Modules"></a><div class="titlepage"></div>
52
31
<div class="refnamediv"><table width="100%"><tr>
53
32
<td valign="top">
56
35
</td>
57
36
<td valign="top" align="right"></td>
58
37
</tr></table></div>
59
 
<div class="refsynopsisdiv" title="Synopsis">
 
38
<div class="refsynopsisdiv">
60
39
<a name="pango-Modules.synopsis"></a><h2>Synopsis</h2>
61
 
<pre class="synopsis">                    <a class="link" href="pango-Modules.html#PangoIncludedModule" title="PangoIncludedModule">PangoIncludedModule</a>;
 
40
<pre class="synopsis">struct              <a class="link" href="pango-Modules.html#PangoIncludedModule" title="struct PangoIncludedModule">PangoIncludedModule</a>;
62
41
                    <a class="link" href="pango-Modules.html#PangoMap" title="PangoMap">PangoMap</a>;
63
42
                    <a class="link" href="pango-Modules.html#PangoMapEntry" title="PangoMapEntry">PangoMapEntry</a>;
64
 
<a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="returnvalue">PangoMap</span></a> *          <a class="link" href="pango-Modules.html#pango-find-map" title="pango_find_map ()">pango_find_map</a>                      (<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="returnvalue">PangoLanguage</span></a> *language,
65
 
                                                         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> engine_type_id,
66
 
                                                         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> render_type_id);
67
 
<a class="link" href="pango-Engines.html#PangoEngine"><span class="returnvalue">PangoEngine</span></a> *       <a class="link" href="pango-Modules.html#pango-map-get-engine" title="pango_map_get_engine ()">pango_map_get_engine</a>                (<a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="returnvalue">PangoMap</span></a> *map,
68
 
                                                         <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="returnvalue">PangoScript</span></a> script);
69
 
<span class="returnvalue">void</span>                <a class="link" href="pango-Modules.html#pango-map-get-engines" title="pango_map_get_engines ()">pango_map_get_engines</a>               (<a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="returnvalue">PangoMap</span></a> *map,
70
 
                                                         <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="returnvalue">PangoScript</span></a> script,
71
 
                                                         <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> **exact_engines,
72
 
                                                         <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> **fallback_engines);
73
 
<span class="returnvalue">void</span>                <a class="link" href="pango-Modules.html#pango-module-register" title="pango_module_register ()">pango_module_register</a>               (<a class="link" href="pango-Modules.html#PangoIncludedModule" title="PangoIncludedModule"><span class="returnvalue">PangoIncludedModule</span></a> *module);
 
43
<a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="returnvalue">PangoMap</span></a> *          <a class="link" href="pango-Modules.html#pango-find-map" title="pango_find_map ()">pango_find_map</a>                      (<em class="parameter"><code><a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="type">PangoLanguage</span></a> *language</code></em>,
 
44
                                                         <em class="parameter"><code><span class="type">guint</span> engine_type_id</code></em>,
 
45
                                                         <em class="parameter"><code><span class="type">guint</span> render_type_id</code></em>);
 
46
<a class="link" href="pango-Engines.html#PangoEngine"><span class="returnvalue">PangoEngine</span></a> *       <a class="link" href="pango-Modules.html#pango-map-get-engine" title="pango_map_get_engine ()">pango_map_get_engine</a>                (<em class="parameter"><code><a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a> *map</code></em>,
 
47
                                                         <em class="parameter"><code><a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a> script</code></em>);
 
48
<span class="returnvalue">void</span>                <a class="link" href="pango-Modules.html#pango-map-get-engines" title="pango_map_get_engines ()">pango_map_get_engines</a>               (<em class="parameter"><code><a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a> *map</code></em>,
 
49
                                                         <em class="parameter"><code><a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a> script</code></em>,
 
50
                                                         <em class="parameter"><code><span class="type">GSList</span> **exact_engines</code></em>,
 
51
                                                         <em class="parameter"><code><span class="type">GSList</span> **fallback_engines</code></em>);
 
52
<span class="returnvalue">void</span>                <a class="link" href="pango-Modules.html#pango-module-register" title="pango_module_register ()">pango_module_register</a>               (<em class="parameter"><code><a class="link" href="pango-Modules.html#PangoIncludedModule" title="struct PangoIncludedModule"><span class="type">PangoIncludedModule</span></a> *module</code></em>);
74
53
</pre>
75
54
</div>
76
 
<div class="refsect1" title="Description">
 
55
<div class="refsect1">
77
56
<a name="pango-Modules.description"></a><h2>Description</h2>
78
57
<p>
79
58
Functions and macros in this section are used to support loading dynamic
80
59
modules that add engines to Pango at run time.
81
60
</p>
82
61
</div>
83
 
<div class="refsect1" title="Details">
 
62
<div class="refsect1">
84
63
<a name="pango-Modules.details"></a><h2>Details</h2>
85
 
<div class="refsect2" title="PangoIncludedModule">
86
 
<a name="PangoIncludedModule"></a><h3>PangoIncludedModule</h3>
87
 
<pre class="programlisting">typedef struct {
 
64
<div class="refsect2">
 
65
<a name="PangoIncludedModule"></a><h3>struct PangoIncludedModule</h3>
 
66
<pre class="programlisting">struct PangoIncludedModule {
88
67
  void (*list) (PangoEngineInfo **engines,
89
68
                int              *n_engines);
90
69
  void (*init) (GTypeModule      *module);
91
70
  void (*exit) (void);
92
71
  PangoEngine *(*create) (const char       *id);
93
 
} PangoIncludedModule;
 
72
};
94
73
</pre>
95
74
<p>
96
 
The <a class="link" href="pango-Modules.html#PangoIncludedModule" title="PangoIncludedModule"><span class="type">PangoIncludedModule</span></a> structure for a statically linked module
 
75
The <a class="link" href="pango-Modules.html#PangoIncludedModule" title="struct PangoIncludedModule"><span class="type">PangoIncludedModule</span></a> structure for a statically linked module
97
76
contains the functions that would otherwise be loaded from a dynamically
98
77
loaded module.
99
78
</p>
124
103
</table></div>
125
104
</div>
126
105
<hr>
127
 
<div class="refsect2" title="PangoMap">
 
106
<div class="refsect2">
128
107
<a name="PangoMap"></a><h3>PangoMap</h3>
129
108
<pre class="programlisting">typedef struct _PangoMap PangoMap;</pre>
130
109
<p>
133
112
</p>
134
113
</div>
135
114
<hr>
136
 
<div class="refsect2" title="PangoMapEntry">
 
115
<div class="refsect2">
137
116
<a name="PangoMapEntry"></a><h3>PangoMapEntry</h3>
138
117
<pre class="programlisting">typedef struct _PangoMapEntry PangoMapEntry;</pre>
139
118
<p>
143
122
</p>
144
123
</div>
145
124
<hr>
146
 
<div class="refsect2" title="pango_find_map ()">
 
125
<div class="refsect2">
147
126
<a name="pango-find-map"></a><h3>pango_find_map ()</h3>
148
 
<pre class="programlisting"><a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="returnvalue">PangoMap</span></a> *          pango_find_map                      (<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="returnvalue">PangoLanguage</span></a> *language,
149
 
                                                         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> engine_type_id,
150
 
                                                         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> render_type_id);</pre>
 
127
<pre class="programlisting"><a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="returnvalue">PangoMap</span></a> *          pango_find_map                      (<em class="parameter"><code><a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="type">PangoLanguage</span></a> *language</code></em>,
 
128
                                                         <em class="parameter"><code><span class="type">guint</span> engine_type_id</code></em>,
 
129
                                                         <em class="parameter"><code><span class="type">guint</span> render_type_id</code></em>);</pre>
151
130
<p>
152
131
Locate a <a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a> for a particular engine type and render
153
132
type. The resulting map can be used to determine the engine
154
 
for each character.</p>
 
133
for each character.
 
134
</p>
155
135
<div class="variablelist"><table border="0">
156
136
<col align="left" valign="top">
157
137
<tbody>
158
138
<tr>
159
139
<td><p><span class="term"><em class="parameter"><code>language</code></em> :</span></p></td>
160
 
<td> the language tag for which to find the map
 
140
<td>the language tag for which to find the map
161
141
</td>
162
142
</tr>
163
143
<tr>
164
144
<td><p><span class="term"><em class="parameter"><code>engine_type_id</code></em> :</span></p></td>
165
 
<td> the engine type for the map to find
 
145
<td>the engine type for the map to find
166
146
</td>
167
147
</tr>
168
148
<tr>
169
149
<td><p><span class="term"><em class="parameter"><code>render_type_id</code></em> :</span></p></td>
170
 
<td> the render type for the map to find
 
150
<td>the render type for the map to find
171
151
</td>
172
152
</tr>
173
153
<tr>
179
159
</table></div>
180
160
</div>
181
161
<hr>
182
 
<div class="refsect2" title="pango_map_get_engine ()">
 
162
<div class="refsect2">
183
163
<a name="pango-map-get-engine"></a><h3>pango_map_get_engine ()</h3>
184
 
<pre class="programlisting"><a class="link" href="pango-Engines.html#PangoEngine"><span class="returnvalue">PangoEngine</span></a> *       pango_map_get_engine                (<a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="returnvalue">PangoMap</span></a> *map,
185
 
                                                         <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="returnvalue">PangoScript</span></a> script);</pre>
 
164
<pre class="programlisting"><a class="link" href="pango-Engines.html#PangoEngine"><span class="returnvalue">PangoEngine</span></a> *       pango_map_get_engine                (<em class="parameter"><code><a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a> *map</code></em>,
 
165
                                                         <em class="parameter"><code><a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a> script</code></em>);</pre>
186
166
<p>
187
 
Returns the best engine listed in the map for a given script</p>
 
167
Returns the best engine listed in the map for a given script
 
168
</p>
188
169
<div class="variablelist"><table border="0">
189
170
<col align="left" valign="top">
190
171
<tbody>
191
172
<tr>
192
173
<td><p><span class="term"><em class="parameter"><code>map</code></em> :</span></p></td>
193
 
<td> a <a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a>
 
174
<td>a <a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a>
194
175
</td>
195
176
</tr>
196
177
<tr>
197
178
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
198
 
<td> a <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a>
 
179
<td>a <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a>
199
180
</td>
200
181
</tr>
201
182
<tr>
202
183
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
203
184
<td> the best engine, if one is listed for the script,
204
 
   or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. The lookup may cause the engine to be loaded;
 
185
   or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. The lookup may cause the engine to be loaded;
205
186
   once an engine is loaded, it won't be unloaded. If multiple
206
187
   engines are exact for the script, the choice of which is
207
188
   returned is arbitrary.
211
192
</table></div>
212
193
</div>
213
194
<hr>
214
 
<div class="refsect2" title="pango_map_get_engines ()">
 
195
<div class="refsect2">
215
196
<a name="pango-map-get-engines"></a><h3>pango_map_get_engines ()</h3>
216
 
<pre class="programlisting"><span class="returnvalue">void</span>                pango_map_get_engines               (<a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="returnvalue">PangoMap</span></a> *map,
217
 
                                                         <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="returnvalue">PangoScript</span></a> script,
218
 
                                                         <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> **exact_engines,
219
 
                                                         <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> **fallback_engines);</pre>
 
197
<pre class="programlisting"><span class="returnvalue">void</span>                pango_map_get_engines               (<em class="parameter"><code><a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a> *map</code></em>,
 
198
                                                         <em class="parameter"><code><a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a> script</code></em>,
 
199
                                                         <em class="parameter"><code><span class="type">GSList</span> **exact_engines</code></em>,
 
200
                                                         <em class="parameter"><code><span class="type">GSList</span> **fallback_engines</code></em>);</pre>
220
201
<p>
221
202
Finds engines in the map that handle the given script. The returned
222
203
lists should be freed with g_slist_free, but the engines in the
223
204
lists are owned by GLib and will be kept around permanently, so
224
 
they should not be unref'ed.</p>
 
205
they should not be unref'ed.
 
206
</p>
225
207
<div class="variablelist"><table border="0">
226
208
<col align="left" valign="top">
227
209
<tbody>
228
210
<tr>
229
211
<td><p><span class="term"><em class="parameter"><code>map</code></em> :</span></p></td>
230
 
<td> a <a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a>
 
212
<td>a <a class="link" href="pango-Modules.html#PangoMap" title="PangoMap"><span class="type">PangoMap</span></a>
231
213
</td>
232
214
</tr>
233
215
<tr>
234
216
<td><p><span class="term"><em class="parameter"><code>script</code></em> :</span></p></td>
235
 
<td> a <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a>
 
217
<td>a <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a>
236
218
</td>
237
219
</tr>
238
220
<tr>
239
221
<td><p><span class="term"><em class="parameter"><code>exact_engines</code></em> :</span></p></td>
240
 
<td> location to store list of engines that exactly
 
222
<td>location to store list of engines that exactly
241
223
 handle this script.
242
224
</td>
243
225
</tr>
244
226
<tr>
245
227
<td><p><span class="term"><em class="parameter"><code>fallback_engines</code></em> :</span></p></td>
246
 
<td> location to store list of engines that approximately
 
228
<td>location to store list of engines that approximately
247
229
 handle this script.
248
230
</td>
249
231
</tr>
252
234
<p class="since">Since 1.4</p>
253
235
</div>
254
236
<hr>
255
 
<div class="refsect2" title="pango_module_register ()">
 
237
<div class="refsect2">
256
238
<a name="pango-module-register"></a><h3>pango_module_register ()</h3>
257
 
<pre class="programlisting"><span class="returnvalue">void</span>                pango_module_register               (<a class="link" href="pango-Modules.html#PangoIncludedModule" title="PangoIncludedModule"><span class="returnvalue">PangoIncludedModule</span></a> *module);</pre>
 
239
<pre class="programlisting"><span class="returnvalue">void</span>                pango_module_register               (<em class="parameter"><code><a class="link" href="pango-Modules.html#PangoIncludedModule" title="struct PangoIncludedModule"><span class="type">PangoIncludedModule</span></a> *module</code></em>);</pre>
258
240
<p>
259
241
Registers a statically linked module with Pango. The
260
 
<a class="link" href="pango-Modules.html#PangoIncludedModule" title="PangoIncludedModule"><span class="type">PangoIncludedModule</span></a> structure that is passed in contains the
 
242
<a class="link" href="pango-Modules.html#PangoIncludedModule" title="struct PangoIncludedModule"><span class="type">PangoIncludedModule</span></a> structure that is passed in contains the
261
243
functions that would otherwise be loaded from a dynamically loaded
262
 
module.</p>
 
244
module.
 
245
</p>
263
246
<div class="variablelist"><table border="0">
264
247
<col align="left" valign="top">
265
248
<tbody><tr>
266
249
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
267
 
<td> a <a class="link" href="pango-Modules.html#PangoIncludedModule" title="PangoIncludedModule"><span class="type">PangoIncludedModule</span></a>
 
250
<td>a <a class="link" href="pango-Modules.html#PangoIncludedModule" title="struct PangoIncludedModule"><span class="type">PangoIncludedModule</span></a>
268
251
</td>
269
252
</tr></tbody>
270
253
</table></div>
273
256
</div>
274
257
<div class="footer">
275
258
<hr>
276
 
          Generated by GTK-Doc V1.13</div>
 
259
          Generated by GTK-Doc V1.15.1</div>
277
260
</body>
278
261
</html>
 
 
b'\\ No newline at end of file'