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
|
<refentry id="xmlroff-FoDoc">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-FoDoc.top_of_page">FoDoc</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoDoc</refname>
<refpurpose>Abstract output document type</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-FoDoc.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoDoc">FoDoc</link>;
<link linkend="FoDocClass">FoDocClass</link>;
#define <link linkend="FO-DOC-ERROR:CAPS">FO_DOC_ERROR</link>
<link linkend="GQuark">GQuark</link> <link linkend="fo-doc-error-quark">fo_doc_error_quark</link> (void);
enum <link linkend="FoDocError">FoDocError</link>;
enum <link linkend="FoDocLineCap">FoDocLineCap</link>;
enum <link linkend="FoDocLineJoin">FoDocLineJoin</link>;
<link linkend="FoDoc">FoDoc</link>* <link linkend="fo-doc-new">fo_doc_new</link> (void);
<link linkend="FoDoc">FoDoc</link>* <link linkend="fo-doc-new-from-type">fo_doc_new_from_type</link> (const <link linkend="gchar">gchar</link> *type);
<link linkend="FoFlagsFormat">FoFlagsFormat</link> <link linkend="fo-doc-formats-from-name">fo_doc_formats_from_name</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="void">void</link> <link linkend="fo-doc-open-file">fo_doc_open_file</link> (<link linkend="FoDoc">FoDoc</link> *fo_doc,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="FoLibfoContext">FoLibfoContext</link> *libfo_context,
<link linkend="GError">GError</link> **error);
<link linkend="FoLayout">FoLayout</link>* <link linkend="fo-doc-get-new-layout">fo_doc_get_new_layout</link> (<link linkend="FoDoc">FoDoc</link> *fo_doc);
const <link linkend="gchar">gchar</link>* <link linkend="fo-doc-get-language">fo_doc_get_language</link> (<link linkend="FoDoc">FoDoc</link> *fo_doc);
<link linkend="void">void</link> <link linkend="fo-doc-set-language">fo_doc_set_language</link> (<link linkend="FoDoc">FoDoc</link> *fo_doc,
const <link linkend="gchar">gchar</link> *language);
<link linkend="FoEnumAreaDirection">FoEnumAreaDirection</link> <link linkend="fo-doc-get-base-dir">fo_doc_get_base_dir</link> (<link linkend="FoDoc">FoDoc</link> *fo_doc);
<link linkend="void">void</link> <link linkend="fo-doc-set-base-dir">fo_doc_set_base_dir</link> (<link linkend="FoDoc">FoDoc</link> *fo_doc,
<link linkend="FoEnumAreaDirection">FoEnumAreaDirection</link> base_dir);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-FoDoc.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="FoDoc"><type>FoDoc</type></link> provides the primitives for writing text, lines, rectangles,
etc., to the output.
</para>
<para>
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.</para>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-FoDoc.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoDoc" role="struct">
<title>FoDoc</title>
<indexterm zone="FoDoc"><primary>FoDoc</primary></indexterm><programlisting>typedef struct _FoDoc FoDoc;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoDocClass" role="struct">
<title>FoDocClass</title>
<indexterm zone="FoDocClass"><primary>FoDocClass</primary></indexterm><programlisting>typedef struct _FoDocClass FoDocClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FO-DOC-ERROR:CAPS" role="macro">
<title>FO_DOC_ERROR</title>
<indexterm zone="FO-DOC-ERROR:CAPS"><primary>FO_DOC_ERROR</primary></indexterm><programlisting>#define FO_DOC_ERROR fo_doc_error_quark ()
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-doc-error-quark" role="function">
<title>fo_doc_error_quark ()</title>
<indexterm zone="fo-doc-error-quark"><primary>fo_doc_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> fo_doc_error_quark (void);</programlisting>
<para>
Get the error quark for <link linkend="FoDoc"><type>FoDoc</type></link>.
</para>
<para>
If the quark does not yet exist, create it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Quark associated with <link linkend="FoDoc"><type>FoDoc</type></link> errors.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoDocError" role="enum">
<title>enum FoDocError</title>
<indexterm zone="FoDocError"><primary>FoDocError</primary></indexterm><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;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoDocLineCap" role="enum">
<title>enum FoDocLineCap</title>
<indexterm zone="FoDocLineCap"><primary>FoDocLineCap</primary></indexterm><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;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoDocLineJoin" role="enum">
<title>enum FoDocLineJoin</title>
<indexterm zone="FoDocLineJoin"><primary>FoDocLineJoin</primary></indexterm><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;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-doc-new" role="function">
<title>fo_doc_new ()</title>
<indexterm zone="fo-doc-new"><primary>fo_doc_new</primary></indexterm><programlisting><link linkend="FoDoc">FoDoc</link>* fo_doc_new (void);</programlisting>
<para>
Creates a new <link linkend="FoDoc"><type>FoDoc</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoDoc"><type>FoDoc</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-doc-new-from-type" role="function">
<title>fo_doc_new_from_type ()</title>
<indexterm zone="fo-doc-new-from-type"><primary>fo_doc_new_from_type</primary></indexterm><programlisting><link linkend="FoDoc">FoDoc</link>* fo_doc_new_from_type (const <link linkend="gchar">gchar</link> *type);</programlisting>
<para>
Creates a new <link linkend="FoDoc"><type>FoDoc</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> Type of the new <link linkend="FoDoc"><type>FoDoc</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoDoc"><type>FoDoc</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-doc-formats-from-name" role="function">
<title>fo_doc_formats_from_name ()</title>
<indexterm zone="fo-doc-formats-from-name"><primary>fo_doc_formats_from_name</primary></indexterm><programlisting><link linkend="FoFlagsFormat">FoFlagsFormat</link> fo_doc_formats_from_name (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Gets the output formats supported by <parameter>name</parameter> class.
</para>
<para>
<parameter>name</parameter> should not be <link linkend="NULL:CAPS"><type>NULL</type></link>.
</para>
<para>
If <parameter>name</parameter> does not implement any formats, returns
<link linkend="FO-FLAG-FORMAT-UNKNOWN:CAPS"><type>FO_FLAG_FORMAT_UNKNOWN</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> Registered <link linkend="FoObject"><type>FoObject</type></link> type name, e.g., "FoDocCairo"
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="FoFlagsFormat"><type>FoFlagsFormat</type></link> with zero or more bits set for the
supported formats.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-doc-open-file" role="function">
<title>fo_doc_open_file ()</title>
<indexterm zone="fo-doc-open-file"><primary>fo_doc_open_file</primary></indexterm><programlisting><link linkend="void">void</link> fo_doc_open_file (<link linkend="FoDoc">FoDoc</link> *fo_doc,
const <link linkend="gchar">gchar</link> *filename,
<link linkend="FoLibfoContext">FoLibfoContext</link> *libfo_context,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
No reference to <parameter>libfo_context</parameter> is kept.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_doc</parameter> :</term>
<listitem><simpara> <link linkend="FoDoc"><type>FoDoc</type></link> for which to open an output file.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> Name of output file.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>libfo_context</parameter> :</term>
<listitem><simpara> <link linkend="FoLibfoContext"><type>FoLibfoContext</type></link> containing extra info.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Information about any error that occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-doc-get-new-layout" role="function">
<title>fo_doc_get_new_layout ()</title>
<indexterm zone="fo-doc-get-new-layout"><primary>fo_doc_get_new_layout</primary></indexterm><programlisting><link linkend="FoLayout">FoLayout</link>* fo_doc_get_new_layout (<link linkend="FoDoc">FoDoc</link> *fo_doc);</programlisting>
<para>
Get a new <link linkend="FoLayout"><type>FoLayout</type></link> for use with <parameter>fo_doc</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_doc</parameter> :</term>
<listitem><simpara> <link linkend="FoDoc"><type>FoDoc</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> New <link linkend="FoLayout"><type>FoLayout</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-doc-get-language" role="function">
<title>fo_doc_get_language ()</title>
<indexterm zone="fo-doc-get-language"><primary>fo_doc_get_language</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* fo_doc_get_language (<link linkend="FoDoc">FoDoc</link> *fo_doc);</programlisting>
<para>
Get the language in <parameter>fo_doc</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_doc</parameter> :</term>
<listitem><simpara> <link linkend="FoDoc"><type>FoDoc</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Language of file parsed to make <parameter>fo_doc</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-doc-set-language" role="function">
<title>fo_doc_set_language ()</title>
<indexterm zone="fo-doc-set-language"><primary>fo_doc_set_language</primary></indexterm><programlisting><link linkend="void">void</link> fo_doc_set_language (<link linkend="FoDoc">FoDoc</link> *fo_doc,
const <link linkend="gchar">gchar</link> *language);</programlisting>
<para>
Set the language in <parameter>fo_doc</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_doc</parameter> :</term>
<listitem><simpara> <link linkend="FoDoc"><type>FoDoc</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>language</parameter> :</term>
<listitem><simpara> Language.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-doc-get-base-dir" role="function">
<title>fo_doc_get_base_dir ()</title>
<indexterm zone="fo-doc-get-base-dir"><primary>fo_doc_get_base_dir</primary></indexterm><programlisting><link linkend="FoEnumAreaDirection">FoEnumAreaDirection</link> fo_doc_get_base_dir (<link linkend="FoDoc">FoDoc</link> *fo_doc);</programlisting>
<para>
Get the <link linkend="FoEnumAreaDirection"><type>FoEnumAreaDirection</type></link> used as input to <parameter>fo_doc</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_doc</parameter> :</term>
<listitem><simpara> <link linkend="FoDoc"><type>FoDoc</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="FoEnumAreaDirection"><type>FoEnumAreaDirection</type></link> used as input to <parameter>fo_doc</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-doc-set-base-dir" role="function">
<title>fo_doc_set_base_dir ()</title>
<indexterm zone="fo-doc-set-base-dir"><primary>fo_doc_set_base_dir</primary></indexterm><programlisting><link linkend="void">void</link> fo_doc_set_base_dir (<link linkend="FoDoc">FoDoc</link> *fo_doc,
<link linkend="FoEnumAreaDirection">FoEnumAreaDirection</link> base_dir);</programlisting>
<para>
Set the <link linkend="FoEnumAreaDirection"><type>FoEnumAreaDirection</type></link> in <parameter>fo_doc</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_doc</parameter> :</term>
<listitem><simpara> <link linkend="FoDoc"><type>FoDoc</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>base_dir</parameter> :</term>
<listitem><simpara> <link linkend="FoEnumAreaDirection"><type>FoEnumAreaDirection</type></link> value for new base direction.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
