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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FoDoc</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="other-objects.html" title="Other Objects">
<link rel="prev" href="other-objects.html" title="Other Objects">
<link rel="next" href="xmlroff-fo-doc-commands.html" title="fo-doc-commands">
<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="other-objects.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="other-objects.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-fo-doc-commands.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-FoDoc.synopsis" class="shortcut">Top</a>
|
<a href="#xmlroff-FoDoc.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="xmlroff-FoDoc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="xmlroff-FoDoc.top_of_page"></a>FoDoc</span></h2>
<p>FoDoc — Abstract output document type</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="xmlroff-FoDoc.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a>;
<a class="link" href="xmlroff-FoDoc.html#FoDocClass" title="FoDocClass">FoDocClass</a>;
#define <a class="link" href="xmlroff-FoDoc.html#FO-DOC-ERROR:CAPS" title="FO_DOC_ERROR">FO_DOC_ERROR</a>
<a
href="../glib/glib-Quarks.html#GQuark"
>GQuark</a> <a class="link" href="xmlroff-FoDoc.html#fo-doc-error-quark" title="fo_doc_error_quark ()">fo_doc_error_quark</a> (void);
enum <a class="link" href="xmlroff-FoDoc.html#FoDocError" title="enum FoDocError">FoDocError</a>;
enum <a class="link" href="xmlroff-FoDoc.html#FoDocLineCap" title="enum FoDocLineCap">FoDocLineCap</a>;
enum <a class="link" href="xmlroff-FoDoc.html#FoDocLineJoin" title="enum FoDocLineJoin">FoDocLineJoin</a>;
<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a>* <a class="link" href="xmlroff-FoDoc.html#fo-doc-new" title="fo_doc_new ()">fo_doc_new</a> (void);
<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a>* <a class="link" href="xmlroff-FoDoc.html#fo-doc-new-from-type" title="fo_doc_new_from_type ()">fo_doc_new_from_type</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *type);
<a class="link" href="xmlroff-FoLibfoContext.html#FoFlagsFormat" title="enum FoFlagsFormat">FoFlagsFormat</a> <a class="link" href="xmlroff-FoDoc.html#fo-doc-formats-from-name" title="fo_doc_formats_from_name ()">fo_doc_formats_from_name</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
void <a class="link" href="xmlroff-FoDoc.html#fo-doc-open-file" title="fo_doc_open_file ()">fo_doc_open_file</a> (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename,
<a class="link" href="xmlroff-fo-libfo-basic.html#FoLibfoContext" title="FoLibfoContext">FoLibfoContext</a> *libfo_context,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a class="link" href="xmlroff-FoLayout.html#FoLayout" title="FoLayout">FoLayout</a>* <a class="link" href="xmlroff-FoDoc.html#fo-doc-get-new-layout" title="fo_doc_get_new_layout ()">fo_doc_get_new_layout</a> (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="xmlroff-FoDoc.html#fo-doc-get-language" title="fo_doc_get_language ()">fo_doc_get_language</a> (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc);
void <a class="link" href="xmlroff-FoDoc.html#fo-doc-set-language" title="fo_doc_set_language ()">fo_doc_set_language</a> (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *language);
<a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection">FoEnumAreaDirection</a> <a class="link" href="xmlroff-FoDoc.html#fo-doc-get-base-dir" title="fo_doc_get_base_dir ()">fo_doc_get_base_dir</a> (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc);
void <a class="link" href="xmlroff-FoDoc.html#fo-doc-set-base-dir" title="fo_doc_set_base_dir ()">fo_doc_set_base_dir</a> (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc,
<a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection">FoEnumAreaDirection</a> base_dir);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="xmlroff-FoDoc.description"></a><h2>Description</h2>
<p>
<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a> provides the primitives for writing text, lines, rectangles,
etc., to the output.
</p>
<p>
It is generalised so that libfo can support multiple backend
implementations (and add and remove backend implementations)
without having to restructure the rest of libfo.</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="xmlroff-FoDoc.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="FoDoc"></a><h3>FoDoc</h3>
<pre class="programlisting">typedef struct _FoDoc FoDoc;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="FoDocClass"></a><h3>FoDocClass</h3>
<pre class="programlisting">typedef struct _FoDocClass FoDocClass;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="FO-DOC-ERROR:CAPS"></a><h3>FO_DOC_ERROR</h3>
<pre class="programlisting">#define FO_DOC_ERROR fo_doc_error_quark ()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-error-quark"></a><h3>fo_doc_error_quark ()</h3>
<pre class="programlisting"><a
href="../glib/glib-Quarks.html#GQuark"
>GQuark</a> fo_doc_error_quark (void);</pre>
<p>
Get the error quark for <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.
</p>
<p>
If the quark does not yet exist, create it.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Quark associated with <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a> errors.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="FoDocError"></a><h3>enum FoDocError</h3>
<pre class="programlisting">typedef enum
{
FO_DOC_ERROR_FAILED,
FO_DOC_ERROR_OPEN_FAILED, /* Cannot open output document */
FO_DOC_ERROR_UNSUPPORTED_FORMAT, /* Unsupported document format */
FO_DOC_ERROR_LAST
} FoDocError;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="FoDocLineCap"></a><h3>enum FoDocLineCap</h3>
<pre class="programlisting">typedef enum
{
FO_DOC_LINE_CAP_INVALID,
FO_DOC_LINE_CAP_BUTT,
FO_DOC_LINE_CAP_ROUND,
FO_DOC_LINE_CAP_SQUARE,
FO_DOC_LINE_CAP_LIMIT
} FoDocLineCap;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="FoDocLineJoin"></a><h3>enum FoDocLineJoin</h3>
<pre class="programlisting">typedef enum
{
FO_DOC_LINE_JOIN_INVALID,
FO_DOC_LINE_JOIN_MITER,
FO_DOC_LINE_JOIN_ROUND,
FO_DOC_LINE_JOIN_BEVEL,
FO_DOC_LINE_JOIN_LIMIT
} FoDocLineJoin;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-new"></a><h3>fo_doc_new ()</h3>
<pre class="programlisting"><a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a>* fo_doc_new (void);</pre>
<p>
Creates a new <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly created <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-new-from-type"></a><h3>fo_doc_new_from_type ()</h3>
<pre class="programlisting"><a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a>* fo_doc_new_from_type (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *type);</pre>
<p>
Creates a new <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Type of the new <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly created <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-formats-from-name"></a><h3>fo_doc_formats_from_name ()</h3>
<pre class="programlisting"><a class="link" href="xmlroff-FoLibfoContext.html#FoFlagsFormat" title="enum FoFlagsFormat">FoFlagsFormat</a> fo_doc_formats_from_name (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Gets the output formats supported by <em class="parameter"><code>name</code></em> class.
</p>
<p>
<em class="parameter"><code>name</code></em> should not be <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><span class="type">NULL</span></a>.
</p>
<p>
If <em class="parameter"><code>name</code></em> does not implement any formats, returns
<a class="link" href="xmlroff-FoLibfoContext.html#FO-FLAG-FORMAT-UNKNOWN:CAPS"><span class="type">FO_FLAG_FORMAT_UNKNOWN</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> Registered <a class="link" href="FoObject.html" title="FoObject"><span class="type">FoObject</span></a> type name, e.g., "FoDocCairo"
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a class="link" href="xmlroff-FoLibfoContext.html#FoFlagsFormat" title="enum FoFlagsFormat"><span class="type">FoFlagsFormat</span></a> with zero or more bits set for the
supported formats.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-open-file"></a><h3>fo_doc_open_file ()</h3>
<pre class="programlisting">void fo_doc_open_file (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename,
<a class="link" href="xmlroff-fo-libfo-basic.html#FoLibfoContext" title="FoLibfoContext">FoLibfoContext</a> *libfo_context,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
No reference to <em class="parameter"><code>libfo_context</code></em> is kept.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fo_doc</code></em> :</span></p></td>
<td> <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a> for which to open an output file.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td> Name of output file.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>libfo_context</code></em> :</span></p></td>
<td> <a class="link" href="xmlroff-fo-libfo-basic.html#FoLibfoContext" title="FoLibfoContext"><span class="type">FoLibfoContext</span></a> containing extra info.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Information about any error that occurred.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-get-new-layout"></a><h3>fo_doc_get_new_layout ()</h3>
<pre class="programlisting"><a class="link" href="xmlroff-FoLayout.html#FoLayout" title="FoLayout">FoLayout</a>* fo_doc_get_new_layout (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc);</pre>
<p>
Get a new <a class="link" href="xmlroff-FoLayout.html#FoLayout" title="FoLayout"><span class="type">FoLayout</span></a> for use with <em class="parameter"><code>fo_doc</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fo_doc</code></em> :</span></p></td>
<td> <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New <a class="link" href="xmlroff-FoLayout.html#FoLayout" title="FoLayout"><span class="type">FoLayout</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-get-language"></a><h3>fo_doc_get_language ()</h3>
<pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* fo_doc_get_language (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc);</pre>
<p>
Get the language in <em class="parameter"><code>fo_doc</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fo_doc</code></em> :</span></p></td>
<td> <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Language of file parsed to make <em class="parameter"><code>fo_doc</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-set-language"></a><h3>fo_doc_set_language ()</h3>
<pre class="programlisting">void fo_doc_set_language (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *language);</pre>
<p>
Set the language in <em class="parameter"><code>fo_doc</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fo_doc</code></em> :</span></p></td>
<td> <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>language</code></em> :</span></p></td>
<td> Language.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-get-base-dir"></a><h3>fo_doc_get_base_dir ()</h3>
<pre class="programlisting"><a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection">FoEnumAreaDirection</a> fo_doc_get_base_dir (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc);</pre>
<p>
Get the <a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection"><span class="type">FoEnumAreaDirection</span></a> used as input to <em class="parameter"><code>fo_doc</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fo_doc</code></em> :</span></p></td>
<td> <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection"><span class="type">FoEnumAreaDirection</span></a> used as input to <em class="parameter"><code>fo_doc</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="fo-doc-set-base-dir"></a><h3>fo_doc_set_base_dir ()</h3>
<pre class="programlisting">void fo_doc_set_base_dir (<a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc">FoDoc</a> *fo_doc,
<a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection">FoEnumAreaDirection</a> base_dir);</pre>
<p>
Set the <a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection"><span class="type">FoEnumAreaDirection</span></a> in <em class="parameter"><code>fo_doc</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fo_doc</code></em> :</span></p></td>
<td> <a class="link" href="xmlroff-FoDoc.html#FoDoc" title="FoDoc"><span class="type">FoDoc</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>base_dir</code></em> :</span></p></td>
<td> <a class="link" href="xmlroff-fo-utils.html#FoEnumAreaDirection" title="enum FoEnumAreaDirection"><span class="type">FoEnumAreaDirection</span></a> value for new base direction.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
