← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2014-03-20 18:01:45 UTC
  • mfrom: (1.9.3)
  • Revision ID: package-import@ubuntu.com-20140320180145-y2zs0pzp6390a6y9
Tags: 1.36.3-1
* Add xauth test-dep, needed for xvfb-run
* New upstream release
  - Fix builddir != srdir builds
    + Drop 0001-Fix-tests-for-builddir-srcdir-by-setting-G_TEST_-SRC.patch,
      which was a cherry-pick of this fix.
  - Avoid a crash when FT_Face is NULL
  - Update pango_color_parse docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/pango-Engines.html
8
8
<link rel="up" href="lowlevel.html" title="Low Level Functionality">
9
9
<link rel="prev" href="pango-Coverage-Maps.html" title="Coverage Maps">
10
10
<link rel="next" href="PangoEngineLang.html" title="PangoEngineLang">
11
 
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
 
<td width="100%" align="left">
17
 
<a href="#" class="shortcut">Top</a>
18
 
                   | 
19
 
                  <a href="#pango-Engines.description" class="shortcut">Description</a>
20
 
                   | 
21
 
                  <a href="#pango-Engines.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
 
18
                  <a href="#pango-Engines.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#pango-Engines.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
22
20
</td>
23
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24
22
<td><a accesskey="u" href="lowlevel.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
32
30
<h2><span class="refentrytitle"><a name="pango-Engines.top_of_page"></a>Engines</span></h2>
33
31
<p>Engines — Language-specific and rendering-system-specific processing</p>
34
32
</td>
35
 
<td valign="top" align="right"></td>
 
33
<td class="gallery_image" valign="top" align="right"></td>
36
34
</tr></table></div>
37
 
<div class="refsynopsisdiv">
38
 
<a name="pango-Engines.synopsis"></a><h2>Synopsis</h2>
39
 
<a name="PangoEngine"></a><pre class="synopsis">struct              <a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo">PangoEngineInfo</a>;
40
 
struct              <a class="link" href="pango-Engines.html#PangoEngineScriptInfo" title="struct PangoEngineScriptInfo">PangoEngineScriptInfo</a>;
41
 
struct              <a class="link" href="pango-Engines.html#PangoEngine-struct" title="struct PangoEngine">PangoEngine</a>;
42
 
struct              <a class="link" href="pango-Engines.html#PangoEngineClass" title="struct PangoEngineClass">PangoEngineClass</a>;
43
 
#define             <a class="link" href="pango-Engines.html#PANGO-RENDER-TYPE-NONE:CAPS" title="PANGO_RENDER_TYPE_NONE">PANGO_RENDER_TYPE_NONE</a>
44
 
<span class="returnvalue">void</span>                <a class="link" href="pango-Engines.html#script-engine-list" title="script_engine_list ()">script_engine_list</a>                  (<em class="parameter"><code><a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo"><span class="type">PangoEngineInfo</span></a> **engines</code></em>,
45
 
                                                         <em class="parameter"><code><span class="type">int</span> *n_engines</code></em>);
46
 
<span class="returnvalue">void</span>                <a class="link" href="pango-Engines.html#script-engine-init" title="script_engine_init ()">script_engine_init</a>                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> *module</code></em>);
47
 
<span class="returnvalue">void</span>                <a class="link" href="pango-Engines.html#script-engine-exit" title="script_engine_exit ()">script_engine_exit</a>                  (<em class="parameter"><code><span class="type">void</span></code></em>);
48
 
<a class="link" href="pango-Engines.html#PangoEngine"><span class="returnvalue">PangoEngine</span></a> *       <a class="link" href="pango-Engines.html#script-engine-create" title="script_engine_create ()">script_engine_create</a>                (<em class="parameter"><code>const <span class="type">char</span> *id</code></em>);
49
 
</pre>
 
35
<div class="refsect1">
 
36
<a name="pango-Engines.functions"></a><h2>Functions</h2>
 
37
<div class="informaltable"><table width="100%" border="0">
 
38
<colgroup>
 
39
<col width="150px" class="functions_return">
 
40
<col class="functions_name">
 
41
</colgroup>
 
42
<tbody>
 
43
<tr>
 
44
<td class="function_type">
 
45
<span class="returnvalue">void</span>
 
46
</td>
 
47
<td class="function_name">
 
48
<a class="link" href="pango-Engines.html#script-engine-list" title="script_engine_list ()">script_engine_list</a> <span class="c_punctuation">()</span>
 
49
</td>
 
50
</tr>
 
51
<tr>
 
52
<td class="function_type">
 
53
<span class="returnvalue">void</span>
 
54
</td>
 
55
<td class="function_name">
 
56
<a class="link" href="pango-Engines.html#script-engine-init" title="script_engine_init ()">script_engine_init</a> <span class="c_punctuation">()</span>
 
57
</td>
 
58
</tr>
 
59
<tr>
 
60
<td class="function_type">
 
61
<span class="returnvalue">void</span>
 
62
</td>
 
63
<td class="function_name">
 
64
<a class="link" href="pango-Engines.html#script-engine-exit" title="script_engine_exit ()">script_engine_exit</a> <span class="c_punctuation">()</span>
 
65
</td>
 
66
</tr>
 
67
<tr>
 
68
<td class="function_type">
 
69
<a class="link" href="pango-Engines.html#PangoEngine"><span class="returnvalue">PangoEngine</span></a> *
 
70
</td>
 
71
<td class="function_name">
 
72
<a class="link" href="pango-Engines.html#script-engine-create" title="script_engine_create ()">script_engine_create</a> <span class="c_punctuation">()</span>
 
73
</td>
 
74
</tr>
 
75
</tbody>
 
76
</table></div>
 
77
</div>
 
78
<a name="PangoEngine"></a><div class="refsect1">
 
79
<a name="pango-Engines.other"></a><h2>Types and Values</h2>
 
80
<div class="informaltable"><table width="100%" border="0">
 
81
<colgroup>
 
82
<col width="150px" class="name">
 
83
<col class="description">
 
84
</colgroup>
 
85
<tbody>
 
86
<tr>
 
87
<td class="datatype_keyword">struct</td>
 
88
<td class="function_name"><a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo">PangoEngineInfo</a></td>
 
89
</tr>
 
90
<tr>
 
91
<td class="datatype_keyword">struct</td>
 
92
<td class="function_name"><a class="link" href="pango-Engines.html#PangoEngineScriptInfo" title="struct PangoEngineScriptInfo">PangoEngineScriptInfo</a></td>
 
93
</tr>
 
94
<tr>
 
95
<td class="datatype_keyword">struct</td>
 
96
<td class="function_name"><a class="link" href="pango-Engines.html#PangoEngine-struct" title="struct PangoEngine">PangoEngine</a></td>
 
97
</tr>
 
98
<tr>
 
99
<td class="datatype_keyword">struct</td>
 
100
<td class="function_name"><a class="link" href="pango-Engines.html#PangoEngineClass" title="struct PangoEngineClass">PangoEngineClass</a></td>
 
101
</tr>
 
102
<tr>
 
103
<td class="define_keyword">#define</td>
 
104
<td class="function_name"><a class="link" href="pango-Engines.html#PANGO-RENDER-TYPE-NONE:CAPS" title="PANGO_RENDER_TYPE_NONE">PANGO_RENDER_TYPE_NONE</a></td>
 
105
</tr>
 
106
</tbody>
 
107
</table></div>
50
108
</div>
51
109
<div class="refsect1">
52
110
<a name="pango-Engines.object-hierarchy"></a><h2>Object Hierarchy</h2>
53
 
<pre class="synopsis">
54
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
55
 
   +----PangoEngine
56
 
         +----<a class="link" href="PangoEngineLang.html" title="PangoEngineLang">PangoEngineLang</a>
57
 
         +----<a class="link" href="PangoEngineShape.html" title="PangoEngineShape">PangoEngineShape</a>
 
111
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
112
    <span class="lineart">╰──</span> PangoEngine
 
113
        <span class="lineart">├──</span> <a class="link" href="PangoEngineLang.html" title="PangoEngineLang">PangoEngineLang</a>
 
114
        <span class="lineart">╰──</span> <a class="link" href="PangoEngineShape.html" title="PangoEngineShape">PangoEngineShape</a>
58
115
</pre>
59
116
</div>
60
117
<div class="refsect1">
61
118
<a name="pango-Engines.description"></a><h2>Description</h2>
62
 
<p>
63
 
Pango utilizes a module architecture in which the language-specific
 
119
<p>Pango utilizes a module architecture in which the language-specific
64
120
and render-system-specific components are provided by loadable
65
121
modules. Each loadable module supplies one or more
66
122
<em class="firstterm">engines</em>.  Each <em class="firstterm">engine</em>
67
123
has an associated <em class="firstterm">engine type</em> and
68
124
<em class="firstterm">render type</em>. These two types are represented by strings.</p>
69
 
<p>
70
 
Each dynamically-loaded module exports several functions which provide
71
 
the public API. These functions are <a class="link" href="pango-Engines.html#script-engine-list" title="script_engine_list ()"><code class="function">script_engine_list()</code></a>,
72
 
<a class="link" href="pango-Engines.html#script-engine-init" title="script_engine_init ()"><code class="function">script_engine_init()</code></a> and script_engine_exit, and
73
 
<a class="link" href="pango-Engines.html#script-engine-create" title="script_engine_create ()"><code class="function">script_engine_create()</code></a>. The latter three functions are used when
 
125
<p>Each dynamically-loaded module exports several functions which provide
 
126
the public API. These functions are <a class="link" href="pango-Engines.html#script-engine-list" title="script_engine_list ()"><code class="function">script_engine_list()</code></a>,
 
127
<a class="link" href="pango-Engines.html#script-engine-init" title="script_engine_init ()"><code class="function">script_engine_init()</code></a> and script_engine_exit, and
 
128
<a class="link" href="pango-Engines.html#script-engine-create" title="script_engine_create ()"><code class="function">script_engine_create()</code></a>. The latter three functions are used when
74
129
creating engines from the module at run time, while the first
75
130
function is used when building a catalog of all available modules.</p>
76
131
</div>
77
132
<div class="refsect1">
78
 
<a name="pango-Engines.details"></a><h2>Details</h2>
 
133
<a name="pango-Engines.functions_details"></a><h2>Functions</h2>
 
134
<div class="refsect2">
 
135
<a name="script-engine-list"></a><h3>script_engine_list ()</h3>
 
136
<pre class="programlisting"><span class="returnvalue">void</span>
 
137
script_engine_list (<em class="parameter"><code><a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo"><span class="type">PangoEngineInfo</span></a> **engines</code></em>,
 
138
                    <em class="parameter"><code><span class="type">int</span> *n_engines</code></em>);</pre>
 
139
<p>Function to be provided by a module to list the engines that the
 
140
module supplies. The function stores a pointer to an array
 
141
of <a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo"><span class="type">PangoEngineInfo</span></a> structures and the length of that array in
 
142
the given location.</p>
 
143
<p>Note that <a class="link" href="pango-Engines.html#script-engine-init" title="script_engine_init ()"><code class="function">script_engine_init()</code></a> will not be called before this
 
144
function.</p>
 
145
<div class="refsect3">
 
146
<a name="id-1.4.8.8.2.6"></a><h4>Parameters</h4>
 
147
<div class="informaltable"><table width="100%" border="0">
 
148
<colgroup>
 
149
<col width="150px" class="parameters_name">
 
150
<col class="parameters_description">
 
151
<col width="200px" class="parameters_annotations">
 
152
</colgroup>
 
153
<tbody>
 
154
<tr>
 
155
<td class="parameter_name"><p>engines</p></td>
 
156
<td class="parameter_description"><p>location to store a pointer to an array of engines.</p></td>
 
157
<td class="parameter_annotations"> </td>
 
158
</tr>
 
159
<tr>
 
160
<td class="parameter_name"><p>n_engines</p></td>
 
161
<td class="parameter_description"><p>location to store the number of elements in <em class="parameter"><code>engines</code></em>
 
162
.</p></td>
 
163
<td class="parameter_annotations"> </td>
 
164
</tr>
 
165
</tbody>
 
166
</table></div>
 
167
</div>
 
168
</div>
 
169
<hr>
 
170
<div class="refsect2">
 
171
<a name="script-engine-init"></a><h3>script_engine_init ()</h3>
 
172
<pre class="programlisting"><span class="returnvalue">void</span>
 
173
script_engine_init (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> *module</code></em>);</pre>
 
174
<p>Function to be provided by a module to register any
 
175
GObject types in the module.</p>
 
176
<div class="refsect3">
 
177
<a name="id-1.4.8.8.3.5"></a><h4>Parameters</h4>
 
178
<div class="informaltable"><table width="100%" border="0">
 
179
<colgroup>
 
180
<col width="150px" class="parameters_name">
 
181
<col class="parameters_description">
 
182
<col width="200px" class="parameters_annotations">
 
183
</colgroup>
 
184
<tbody><tr>
 
185
<td class="parameter_name"><p>module</p></td>
 
186
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> structure used to associate any
 
187
GObject types created in this module with the module.</p></td>
 
188
<td class="parameter_annotations"> </td>
 
189
</tr></tbody>
 
190
</table></div>
 
191
</div>
 
192
</div>
 
193
<hr>
 
194
<div class="refsect2">
 
195
<a name="script-engine-exit"></a><h3>script_engine_exit ()</h3>
 
196
<pre class="programlisting"><span class="returnvalue">void</span>
 
197
script_engine_exit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
198
<p>Function to be provided by the module that is called
 
199
when the module is unloading. Frequently does nothing.</p>
 
200
</div>
 
201
<hr>
 
202
<div class="refsect2">
 
203
<a name="script-engine-create"></a><h3>script_engine_create ()</h3>
 
204
<pre class="programlisting"><a class="link" href="pango-Engines.html#PangoEngine"><span class="returnvalue">PangoEngine</span></a> *
 
205
script_engine_create (<em class="parameter"><code>const <span class="type">char</span> *id</code></em>);</pre>
 
206
<p>Function to be provided by the module to create an instance
 
207
of one of the engines implemented by the module.</p>
 
208
<div class="refsect3">
 
209
<a name="id-1.4.8.8.5.5"></a><h4>Parameters</h4>
 
210
<div class="informaltable"><table width="100%" border="0">
 
211
<colgroup>
 
212
<col width="150px" class="parameters_name">
 
213
<col class="parameters_description">
 
214
<col width="200px" class="parameters_annotations">
 
215
</colgroup>
 
216
<tbody><tr>
 
217
<td class="parameter_name"><p>id</p></td>
 
218
<td class="parameter_description"><p>the ID of an engine as reported by script_engine_list.</p></td>
 
219
<td class="parameter_annotations"> </td>
 
220
</tr></tbody>
 
221
</table></div>
 
222
</div>
 
223
<div class="refsect3">
 
224
<a name="id-1.4.8.8.5.6"></a><h4>Returns</h4>
 
225
<p> a newly created <a class="link" href="pango-Engines.html#PangoEngine"><span class="type">PangoEngine</span></a> of the specified
 
226
type, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. (In normal operation,
 
227
a module should not return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> return is only
 
228
acceptable in the case where system misconfiguration or
 
229
bugs in the driver routine are encountered.)</p>
 
230
<p></p>
 
231
</div>
 
232
</div>
 
233
</div>
 
234
<div class="refsect1">
 
235
<a name="pango-Engines.other_details"></a><h2>Types and Values</h2>
79
236
<div class="refsect2">
80
237
<a name="PangoEngineInfo"></a><h3>struct PangoEngineInfo</h3>
81
238
<pre class="programlisting">struct PangoEngineInfo {
86
243
  gint n_scripts;
87
244
};
88
245
</pre>
89
 
<p>
90
 
The <a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo"><span class="type">PangoEngineInfo</span></a> structure contains information about a particular
 
246
<p>The <a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo"><span class="type">PangoEngineInfo</span></a> structure contains information about a particular
91
247
engine. It contains the following fields:</p>
92
 
<div class="variablelist"><table border="0" class="variablelist">
 
248
<div class="refsect3">
 
249
<a name="id-1.4.8.9.2.5"></a><h4>Members</h4>
 
250
<div class="informaltable"><table width="100%" border="0">
93
251
<colgroup>
94
 
<col align="left" valign="top">
95
 
<col>
 
252
<col width="300px" class="struct_members_name">
 
253
<col class="struct_members_description">
 
254
<col width="200px" class="struct_members_annotations">
96
255
</colgroup>
97
256
<tbody>
98
257
<tr>
99
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="PangoEngineInfo.id"></a>id</code></em>;</span></p></td>
100
 
<td>a unique string ID for the engine.</td>
101
 
</tr>
102
 
<tr>
103
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="PangoEngineInfo.engine-type"></a>engine_type</code></em>;</span></p></td>
104
 
<td>a string identifying the engine type.</td>
105
 
</tr>
106
 
<tr>
107
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="PangoEngineInfo.render-type"></a>render_type</code></em>;</span></p></td>
108
 
<td>a string identifying the render type.</td>
109
 
</tr>
110
 
<tr>
111
 
<td><p><span class="term"><a class="link" href="pango-Engines.html#PangoEngineScriptInfo" title="struct PangoEngineScriptInfo"><span class="type">PangoEngineScriptInfo</span></a> *<em class="structfield"><code><a name="PangoEngineInfo.scripts"></a>scripts</code></em>;</span></p></td>
112
 
<td>array of scripts this engine supports.</td>
113
 
</tr>
114
 
<tr>
115
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="PangoEngineInfo.n-scripts"></a>n_scripts</code></em>;</span></p></td>
116
 
<td>number of items in <em class="parameter"><code>scripts</code></em>.</td>
 
258
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="PangoEngineInfo.id"></a>id</code></em>;</p></td>
 
259
<td class="struct_member_description"><p>a unique string ID for the engine.</p></td>
 
260
<td class="struct_member_annotations"> </td>
 
261
</tr>
 
262
<tr>
 
263
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="PangoEngineInfo.engine-type"></a>engine_type</code></em>;</p></td>
 
264
<td class="struct_member_description"><p>a string identifying the engine type.</p></td>
 
265
<td class="struct_member_annotations"> </td>
 
266
</tr>
 
267
<tr>
 
268
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="PangoEngineInfo.render-type"></a>render_type</code></em>;</p></td>
 
269
<td class="struct_member_description"><p>a string identifying the render type.</p></td>
 
270
<td class="struct_member_annotations"> </td>
 
271
</tr>
 
272
<tr>
 
273
<td class="struct_member_name"><p><a class="link" href="pango-Engines.html#PangoEngineScriptInfo" title="struct PangoEngineScriptInfo"><span class="type">PangoEngineScriptInfo</span></a> *<em class="structfield"><code><a name="PangoEngineInfo.scripts"></a>scripts</code></em>;</p></td>
 
274
<td class="struct_member_description"><p>array of scripts this engine supports.</p></td>
 
275
<td class="struct_member_annotations"> </td>
 
276
</tr>
 
277
<tr>
 
278
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="PangoEngineInfo.n-scripts"></a>n_scripts</code></em>;</p></td>
 
279
<td class="struct_member_description"><p>number of items in <em class="parameter"><code>scripts</code></em>
 
280
.</p></td>
 
281
<td class="struct_member_annotations"> </td>
117
282
</tr>
118
283
</tbody>
119
284
</table></div>
120
285
</div>
 
286
</div>
121
287
<hr>
122
288
<div class="refsect2">
123
289
<a name="PangoEngineScriptInfo"></a><h3>struct PangoEngineScriptInfo</h3>
126
292
  const gchar *langs;
127
293
};
128
294
</pre>
129
 
<p>
130
 
The <a class="link" href="pango-Engines.html#PangoEngineScriptInfo" title="struct PangoEngineScriptInfo"><span class="type">PangoEngineScriptInfo</span></a> structure contains
 
295
<p>The <a class="link" href="pango-Engines.html#PangoEngineScriptInfo" title="struct PangoEngineScriptInfo"><span class="type">PangoEngineScriptInfo</span></a> structure contains
131
296
information about how the shaper covers a particular script.</p>
132
 
<div class="variablelist"><table border="0" class="variablelist">
 
297
<div class="refsect3">
 
298
<a name="id-1.4.8.9.3.5"></a><h4>Members</h4>
 
299
<div class="informaltable"><table width="100%" border="0">
133
300
<colgroup>
134
 
<col align="left" valign="top">
135
 
<col>
 
301
<col width="300px" class="struct_members_name">
 
302
<col class="struct_members_description">
 
303
<col width="200px" class="struct_members_annotations">
136
304
</colgroup>
137
305
<tbody>
138
306
<tr>
139
 
<td><p><span class="term"><a class="link" href="pango-Scripts-and-Languages.html#PangoScript"><span class="type">PangoScript</span></a> <em class="structfield"><code><a name="PangoEngineScriptInfo.script"></a>script</code></em>;</span></p></td>
140
 
<td>a <a class="link" href="pango-Scripts-and-Languages.html#PangoScript"><span class="type">PangoScript</span></a>. The value <a class="link" href="pango-Scripts-and-Languages.html#PANGO-SCRIPT-COMMON:CAPS"><code class="literal">PANGO_SCRIPT_COMMON</code></a> has
141
 
the special meaning here of "all scripts"</td>
 
307
<td class="struct_member_name"><p><a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a> <em class="structfield"><code><a name="PangoEngineScriptInfo.script"></a>script</code></em>;</p></td>
 
308
<td class="struct_member_description"><p>a <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a>. The value <a class="link" href="pango-Scripts-and-Languages.html#PANGO-SCRIPT-COMMON:CAPS"><code class="literal">PANGO_SCRIPT_COMMON</code></a> has
 
309
the special meaning here of "all scripts"</p></td>
 
310
<td class="struct_member_annotations"> </td>
142
311
</tr>
143
312
<tr>
144
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="PangoEngineScriptInfo.langs"></a>langs</code></em>;</span></p></td>
145
 
<td>a semicolon separated list of languages that this
 
313
<td class="struct_member_name"><p>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="PangoEngineScriptInfo.langs"></a>langs</code></em>;</p></td>
 
314
<td class="struct_member_description"><p>a semicolon separated list of languages that this
146
315
engine handles for this script. This may be empty,
147
316
in which case the engine is saying that it is a
148
317
fallback choice for all languages for this range,
150
319
indicates that it is specific for the language for
151
320
a given code point. An entry in this list of "*"
152
321
indicates that this engine is specific to all
153
 
languages for this range.</td>
 
322
languages for this range.</p></td>
 
323
<td class="struct_member_annotations"> </td>
154
324
</tr>
155
325
</tbody>
156
326
</table></div>
157
327
</div>
 
328
</div>
158
329
<hr>
159
330
<div class="refsect2">
160
331
<a name="PangoEngine-struct"></a><h3>struct PangoEngine</h3>
161
332
<pre class="programlisting">struct PangoEngine;</pre>
162
 
<p>
163
 
<a class="link" href="pango-Engines.html#PangoEngine"><span class="type">PangoEngine</span></a> is the base class for all types of language and
 
333
<p><a class="link" href="pango-Engines.html#PangoEngine"><span class="type">PangoEngine</span></a> is the base class for all types of language and
164
334
script specific engines. It has no functionality by itself.</p>
165
335
</div>
166
336
<hr>
169
339
<pre class="programlisting">struct PangoEngineClass {
170
340
};
171
341
</pre>
172
 
<p>
173
 
Class structure for <a class="link" href="pango-Engines.html#PangoEngine"><span class="type">PangoEngine</span></a></p>
 
342
<p>Class structure for <a class="link" href="pango-Engines.html#PangoEngine"><span class="type">PangoEngine</span></a></p>
174
343
</div>
175
344
<hr>
176
345
<div class="refsect2">
177
346
<a name="PANGO-RENDER-TYPE-NONE:CAPS"></a><h3>PANGO_RENDER_TYPE_NONE</h3>
178
347
<pre class="programlisting">#define PANGO_RENDER_TYPE_NONE "PangoRenderNone"
179
348
</pre>
180
 
<p>
181
 
A string constant defining the render type
 
349
<p>A string constant defining the render type
182
350
for engines that are not rendering-system specific.</p>
183
351
</div>
184
 
<hr>
185
 
<div class="refsect2">
186
 
<a name="script-engine-list"></a><h3>script_engine_list ()</h3>
187
 
<pre class="programlisting"><span class="returnvalue">void</span>                script_engine_list                  (<em class="parameter"><code><a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo"><span class="type">PangoEngineInfo</span></a> **engines</code></em>,
188
 
                                                         <em class="parameter"><code><span class="type">int</span> *n_engines</code></em>);</pre>
189
 
<p>
190
 
Function to be provided by a module to list the engines that the
191
 
module supplies. The function stores a pointer to an array
192
 
of <a class="link" href="pango-Engines.html#PangoEngineInfo" title="struct PangoEngineInfo"><span class="type">PangoEngineInfo</span></a> structures and the length of that array in
193
 
the given location.</p>
194
 
<p>
195
 
Note that <a class="link" href="pango-Engines.html#script-engine-init" title="script_engine_init ()"><code class="function">script_engine_init()</code></a> will not be called before this
196
 
function.</p>
197
 
<div class="variablelist"><table border="0" class="variablelist">
198
 
<colgroup>
199
 
<col align="left" valign="top">
200
 
<col>
201
 
</colgroup>
202
 
<tbody>
203
 
<tr>
204
 
<td><p><span class="term"><em class="parameter"><code>engines</code></em> :</span></p></td>
205
 
<td>location to store a pointer to an array of engines.</td>
206
 
</tr>
207
 
<tr>
208
 
<td><p><span class="term"><em class="parameter"><code>n_engines</code></em> :</span></p></td>
209
 
<td>location to store the number of elements in <em class="parameter"><code>engines</code></em>.</td>
210
 
</tr>
211
 
</tbody>
212
 
</table></div>
213
 
</div>
214
 
<hr>
215
 
<div class="refsect2">
216
 
<a name="script-engine-init"></a><h3>script_engine_init ()</h3>
217
 
<pre class="programlisting"><span class="returnvalue">void</span>                script_engine_init                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> *module</code></em>);</pre>
218
 
<p>
219
 
Function to be provided by a module to register any
220
 
GObject types in the module.</p>
221
 
<div class="variablelist"><table border="0" class="variablelist">
222
 
<colgroup>
223
 
<col align="left" valign="top">
224
 
<col>
225
 
</colgroup>
226
 
<tbody><tr>
227
 
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
228
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> structure used to associate any
229
 
GObject types created in this module with the module.</td>
230
 
</tr></tbody>
231
 
</table></div>
232
 
</div>
233
 
<hr>
234
 
<div class="refsect2">
235
 
<a name="script-engine-exit"></a><h3>script_engine_exit ()</h3>
236
 
<pre class="programlisting"><span class="returnvalue">void</span>                script_engine_exit                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
237
 
<p>
238
 
Function to be provided by the module that is called
239
 
when the module is unloading. Frequently does nothing.</p>
240
 
</div>
241
 
<hr>
242
 
<div class="refsect2">
243
 
<a name="script-engine-create"></a><h3>script_engine_create ()</h3>
244
 
<pre class="programlisting"><a class="link" href="pango-Engines.html#PangoEngine"><span class="returnvalue">PangoEngine</span></a> *       script_engine_create                (<em class="parameter"><code>const <span class="type">char</span> *id</code></em>);</pre>
245
 
<p>
246
 
Function to be provided by the module to create an instance
247
 
of one of the engines implemented by the module.</p>
248
 
<div class="variablelist"><table border="0" class="variablelist">
249
 
<colgroup>
250
 
<col align="left" valign="top">
251
 
<col>
252
 
</colgroup>
253
 
<tbody>
254
 
<tr>
255
 
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
256
 
<td>the ID of an engine as reported by script_engine_list.</td>
257
 
</tr>
258
 
<tr>
259
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
260
 
<td>a newly created <a class="link" href="pango-Engines.html#PangoEngine"><span class="type">PangoEngine</span></a> of the specified
261
 
type, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred. (In normal operation,
262
 
a module should not return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> return is only
263
 
acceptable in the case where system misconfiguration or
264
 
bugs in the driver routine are encountered.)</td>
265
 
</tr>
266
 
</tbody>
267
 
</table></div>
268
 
</div>
269
352
</div>
270
353
</div>
271
354
<div class="footer">
272
355
<hr>
273
 
          Generated by GTK-Doc V1.19.1</div>
 
356
          Generated by GTK-Doc V1.20.1</div>
274
357
</body>
275
358
</html>
 
 
b'\\ No newline at end of file'