1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>fo-utils</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="xmlroff Reference Manual">
<link rel="up" href="utility-modules.html" title="Utility Modules">
<link rel="prev" href="utility-modules.html" title="Utility Modules">
<link rel="next" href="xmlroff-LibFO-compatibility-stylesheet.html" title="LibFO compatibility stylesheet">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="users.html" title="Users' Guide">
<link rel="chapter" href="developers.html" title="Developers' Guide">
<link rel="chapter" href="object-hierarchy.html" title="Object Hierarchy">
<link rel="chapter" href="object.html" title="FoObject is wonderful">
<link rel="chapter" href="node.html" title="FoNode is wonderful">
<link rel="chapter" href="interfaces.html" title="Interfaces are truly wonderful">
<link rel="chapter" href="formatting-objects.html" title="Formatting Objects are truly wonderful">
<link rel="chapter" href="properties.html" title="Properties">
<link rel="chapter" href="areas.html" title="Area Objects">
<link rel="chapter" href="datatypes.html" title="Datatype Objects">
<link rel="chapter" href="context.html" title="Property Context Object">
<link rel="chapter" href="other-objects.html" title="Other Objects">
<link rel="chapter" href="utility-objects.html" title="Utility Objects">
<link rel="chapter" href="utility-modules.html" title="Utility Modules">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="utility-modules.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="utility-modules.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">xmlroff Reference Manual</th>
<td><a accesskey="n" href="xmlroff-LibFO-compatibility-stylesheet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#xmlroff-fo-utils.synopsis" class="shortcut">Top</a>
|
<a href="#xmlroff-fo-utils.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="xmlroff-fo-utils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="xmlroff-fo-utils.top_of_page"></a>fo-utils</span></h2>
<p>fo-utils</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="xmlroff-fo-utils.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define <a class="link" href="xmlroff-fo-utils.html#GETTEXT-PACKAGE:CAPS" title="GETTEXT_PACKAGE">GETTEXT_PACKAGE</a>
#define <a class="link" href="xmlroff-fo-utils.html#fo-propagate-and-return-if-error" title="fo_propagate_and_return_if_error()">fo_propagate_and_return_if_error</a> (src, dest)
#define <a class="link" href="xmlroff-fo-utils.html#fo-propagate-and-return-val-if-error" title="fo_propagate_and_return_val_if_error()">fo_propagate_and_return_val_if_error</a>(src, dest, val)
enum <a class="link" href="xmlroff-fo-utils.html#FoDebugFlag" title="enum FoDebugFlag">FoDebugFlag</a>;
enum <a class="link" href="xmlroff-fo-utils.html#FoWarningFlag" title="enum FoWarningFlag">FoWarningFlag</a>;
enum <a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection">FoEnumAreaDirection</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="xmlroff-fo-utils.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="xmlroff-fo-utils.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GETTEXT-PACKAGE:CAPS"></a><h3>GETTEXT_PACKAGE</h3>
<pre class="programlisting">#define GETTEXT_PACKAGE "libfo"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-propagate-and-return-if-error"></a><h3>fo_propagate_and_return_if_error()</h3>
<pre class="programlisting">#define fo_propagate_and_return_if_error(src, dest)</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-propagate-and-return-val-if-error"></a><h3>fo_propagate_and_return_val_if_error()</h3>
<pre class="programlisting">#define fo_propagate_and_return_val_if_error(src, dest, val)</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="FoDebugFlag"></a><h3>enum FoDebugFlag</h3>
<pre class="programlisting">typedef enum {
FO_DEBUG_NONE = 0,
FO_DEBUG_RESULT = 1 << 0,
FO_DEBUG_FO = 1 << 1,
FO_DEBUG_AREA = 1 << 2,
FO_DEBUG_PANGO = 1 << 3,
FO_DEBUG_MAX = ((1 << 4) - 1)
} FoDebugFlag;
</pre>
<p>
Debugging flags.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="FO-DEBUG-NONE:CAPS"></a><span class="term"><code class="literal">FO_DEBUG_NONE</code></span></p></td>
<td> No debugging enabled
</td>
</tr>
<tr>
<td><p><a name="FO-DEBUG-RESULT:CAPS"></a><span class="term"><code class="literal">FO_DEBUG_RESULT</code></span></p></td>
<td> Debug result tree
</td>
</tr>
<tr>
<td><p><a name="FO-DEBUG-FO:CAPS"></a><span class="term"><code class="literal">FO_DEBUG_FO</code></span></p></td>
<td> Debug FO tree
</td>
</tr>
<tr>
<td><p><a name="FO-DEBUG-AREA:CAPS"></a><span class="term"><code class="literal">FO_DEBUG_AREA</code></span></p></td>
<td> Debug area tree
</td>
</tr>
<tr>
<td><p><a name="FO-DEBUG-PANGO:CAPS"></a><span class="term"><code class="literal">FO_DEBUG_PANGO</code></span></p></td>
<td> Debug Pango layouts
</td>
</tr>
<tr>
<td><p><a name="FO-DEBUG-MAX:CAPS"></a><span class="term"><code class="literal">FO_DEBUG_MAX</code></span></p></td>
<td> Maximum possible value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="FoWarningFlag"></a><h3>enum FoWarningFlag</h3>
<pre class="programlisting">typedef enum {
FO_WARNING_NONE = 0,
FO_WARNING_FO = 1 << 0,
FO_WARNING_PROPERTY = 1 << 1,
FO_WARNING_UNSUPPORTED_PROPERTY = 1 << 2,
FO_WARNING_MAX = ((1 << 3) - 1)
} FoWarningFlag;
</pre>
<p>
Warning flags.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="FO-WARNING-NONE:CAPS"></a><span class="term"><code class="literal">FO_WARNING_NONE</code></span></p></td>
<td> No explicit control over warning message output
</td>
</tr>
<tr>
<td><p><a name="FO-WARNING-FO:CAPS"></a><span class="term"><code class="literal">FO_WARNING_FO</code></span></p></td>
<td> Do not warn about FO errors
</td>
</tr>
<tr>
<td><p><a name="FO-WARNING-PROPERTY:CAPS"></a><span class="term"><code class="literal">FO_WARNING_PROPERTY</code></span></p></td>
<td> Do not warn about property errors
</td>
</tr>
<tr>
<td><p><a name="FO-WARNING-UNSUPPORTED-PROPERTY:CAPS"></a><span class="term"><code class="literal">FO_WARNING_UNSUPPORTED_PROPERTY</code></span></p></td>
<td> Do not warn about unsupported properties
</td>
</tr>
<tr>
<td><p><a name="FO-WARNING-MAX:CAPS"></a><span class="term"><code class="literal">FO_WARNING_MAX</code></span></p></td>
<td> Maximum possible value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="FoEnumAreaDirection"></a><h3>enum FoEnumAreaDirection</h3>
<pre class="programlisting">typedef enum {
FO_ENUM_AREA_DIRECTION_UNKNOWN,
FO_ENUM_AREA_DIRECTION_LR,
FO_ENUM_AREA_DIRECTION_RL,
FO_ENUM_AREA_DIRECTION_TB,
FO_ENUM_AREA_DIRECTION_BT
} FoEnumAreaDirection;
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
