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
|
<refentry id="xmlroff-FoLayout">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-FoLayout.top_of_page">FoLayout</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoLayout</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-FoLayout.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoLayout">FoLayout</link>;
<link linkend="FoLayoutClass">FoLayoutClass</link>;
#define <link linkend="FO-LAYOUT-ERROR:CAPS">FO_LAYOUT_ERROR</link>
<link linkend="GQuark">GQuark</link> <link linkend="fo-layout-error-quark">fo_layout_error_quark</link> (void);
enum <link linkend="FoLayoutError">FoLayoutError</link>;
<link linkend="FoRectangle">FoRectangle</link>;
<link linkend="FoLayout">FoLayout</link>* <link linkend="fo-layout-new">fo_layout_new</link> (void);
<link linkend="FoLayout">FoLayout</link>* <link linkend="fo-layout-new-from-fo-doc">fo_layout_new_from_fo_doc</link> (<link linkend="FoDoc">FoDoc</link> *fo_doc);
<link linkend="FoLayout">FoLayout</link>* <link linkend="fo-layout-copy">fo_layout_copy</link> (<link linkend="FoLayout">FoLayout</link> *src);
<link linkend="void">void</link> <link linkend="fo-layout-set-attributes">fo_layout_set_attributes</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="GList">GList</link> *attr_glist);
<link linkend="void">void</link> <link linkend="fo-layout-set-text">fo_layout_set_text</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="GString">GString</link> *text);
<link linkend="void">void</link> <link linkend="fo-layout-set-width">fo_layout_set_width</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gfloat">gfloat</link> width);
<link linkend="void">void</link> <link linkend="fo-layout-set-font-desc">fo_layout_set_font_desc</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
const <link linkend="FoFontDesc">FoFontDesc</link> *desc);
<link linkend="void">void</link> <link linkend="fo-layout-set-alignment">fo_layout_set_alignment</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="FoEnumAreaDirection">FoEnumAreaDirection</link> alignment);
<link linkend="void">void</link> <link linkend="fo-layout-set-indent">fo_layout_set_indent</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gfloat">gfloat</link> indent);
<link linkend="void">void</link> <link linkend="fo-layout-set-justify">fo_layout_set_justify</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gboolean">gboolean</link> justify);
<link linkend="gint">gint</link> <link linkend="fo-layout-get-line-count">fo_layout_get_line_count</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout);
<link linkend="void">void</link> <link linkend="fo-layout-get-extents">fo_layout_get_extents</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="FoRectangle">FoRectangle</link> *logical_rect);
<link linkend="void">void</link> <link linkend="fo-layout-get-line-extents">fo_layout_get_line_extents</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gint">gint</link> line_index,
<link linkend="FoRectangle">FoRectangle</link> *logical_rect);
<link linkend="void">void</link> <link linkend="fo-layout-set-line-height">fo_layout_set_line_height</link> (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gfloat">gfloat</link> line_height);
<link linkend="void">void</link> <link linkend="fo-layout-set-line-stacking-strategy">fo_layout_set_line_stacking_strategy</link>
(<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="FoEnumEnum">FoEnumEnum</link> line_stacking_strategy);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-FoLayout.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-FoLayout.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoLayout" role="struct">
<title>FoLayout</title>
<indexterm zone="FoLayout"><primary>FoLayout</primary></indexterm><programlisting>typedef struct _FoLayout FoLayout;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoLayoutClass" role="struct">
<title>FoLayoutClass</title>
<indexterm zone="FoLayoutClass"><primary>FoLayoutClass</primary></indexterm><programlisting>typedef struct _FoLayoutClass FoLayoutClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FO-LAYOUT-ERROR:CAPS" role="macro">
<title>FO_LAYOUT_ERROR</title>
<indexterm zone="FO-LAYOUT-ERROR:CAPS"><primary>FO_LAYOUT_ERROR</primary></indexterm><programlisting>#define FO_LAYOUT_ERROR fo_layout_error_quark ()
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-layout-error-quark" role="function">
<title>fo_layout_error_quark ()</title>
<indexterm zone="fo-layout-error-quark"><primary>fo_layout_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> fo_layout_error_quark (void);</programlisting>
<para>
Get the error quark for <link linkend="FoLayout"><type>FoLayout</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> <link linkend="GQuark"><type>GQuark</type></link> associated with <link linkend="FoLayout"><type>FoLayout</type></link> errors.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoLayoutError" role="enum">
<title>enum FoLayoutError</title>
<indexterm zone="FoLayoutError"><primary>FoLayoutError</primary></indexterm><programlisting>typedef enum
{
FO_LAYOUT_ERROR_FAILED
} FoLayoutError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoRectangle" role="struct">
<title>FoRectangle</title>
<indexterm zone="FoRectangle"><primary>FoRectangle</primary></indexterm><programlisting>typedef struct {
int x;
int y;
int width;
int height;
} FoRectangle;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-layout-new" role="function">
<title>fo_layout_new ()</title>
<indexterm zone="fo-layout-new"><primary>fo_layout_new</primary></indexterm><programlisting><link linkend="FoLayout">FoLayout</link>* fo_layout_new (void);</programlisting>
<para>
Creates a new <link linkend="FoLayout"><type>FoLayout</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoLayout"><type>FoLayout</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-new-from-fo-doc" role="function">
<title>fo_layout_new_from_fo_doc ()</title>
<indexterm zone="fo-layout-new-from-fo-doc"><primary>fo_layout_new_from_fo_doc</primary></indexterm><programlisting><link linkend="FoLayout">FoLayout</link>* fo_layout_new_from_fo_doc (<link linkend="FoDoc">FoDoc</link> *fo_doc);</programlisting>
<para>
Creates a new <link linkend="FoLayout"><type>FoLayout</type></link>.</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> the newly created <link linkend="FoLayout"><type>FoLayout</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-copy" role="function">
<title>fo_layout_copy ()</title>
<indexterm zone="fo-layout-copy"><primary>fo_layout_copy</primary></indexterm><programlisting><link linkend="FoLayout">FoLayout</link>* fo_layout_copy (<link linkend="FoLayout">FoLayout</link> *src);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-attributes" role="function">
<title>fo_layout_set_attributes ()</title>
<indexterm zone="fo-layout-set-attributes"><primary>fo_layout_set_attributes</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_attributes (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="GList">GList</link> *attr_glist);</programlisting>
<para>
Sets the attributes of <parameter>fo_layout</parameter> to <parameter>attr_glist</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to set attributes.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attr_glist</parameter> :</term>
<listitem><simpara> Attributes to apply to <parameter>fo_layout</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-text" role="function">
<title>fo_layout_set_text ()</title>
<indexterm zone="fo-layout-set-text"><primary>fo_layout_set_text</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_text (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="GString">GString</link> *text);</programlisting>
<para>
Sets the text of <parameter>fo_layout</parameter> to <parameter>text</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to set text.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> New text of <parameter>fo_layout</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-width" role="function">
<title>fo_layout_set_width ()</title>
<indexterm zone="fo-layout-set-width"><primary>fo_layout_set_width</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_width (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gfloat">gfloat</link> width);</programlisting>
<para>
Sets the width of <parameter>fo_layout</parameter> to <parameter>width</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to set width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> New width, in points, of <parameter>fo_layout</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-font-desc" role="function">
<title>fo_layout_set_font_desc ()</title>
<indexterm zone="fo-layout-set-font-desc"><primary>fo_layout_set_font_desc</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_font_desc (<link linkend="FoLayout">FoLayout</link> *fo_layout,
const <link linkend="FoFontDesc">FoFontDesc</link> *desc);</programlisting>
<para>
Sets the <link linkend="FoFontDesc"><type>FoFontDesc</type></link> of <parameter>fo_layout</parameter> to <parameter>desc</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to set font desc.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>desc</parameter> :</term>
<listitem><simpara> New <link linkend="FoFontDesc"><type>FoFontDesc</type></link> of <parameter>fo_layout</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-alignment" role="function">
<title>fo_layout_set_alignment ()</title>
<indexterm zone="fo-layout-set-alignment"><primary>fo_layout_set_alignment</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_alignment (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="FoEnumAreaDirection">FoEnumAreaDirection</link> alignment);</programlisting>
<para>
Sets the alignment of <parameter>fo_layout</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> to have alignment set.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>alignment</parameter> :</term>
<listitem><simpara> <link linkend="FoEnumAreaDirection"><type>FoEnumAreaDirection</type></link> value indicating new alignment.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-indent" role="function">
<title>fo_layout_set_indent ()</title>
<indexterm zone="fo-layout-set-indent"><primary>fo_layout_set_indent</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_indent (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gfloat">gfloat</link> indent);</programlisting>
<para>
Sets the indent of <parameter>fo_layout</parameter> to <parameter>indent</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to set indent.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>indent</parameter> :</term>
<listitem><simpara> New indent, in points, of <parameter>fo_layout</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-justify" role="function">
<title>fo_layout_set_justify ()</title>
<indexterm zone="fo-layout-set-justify"><primary>fo_layout_set_justify</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_justify (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gboolean">gboolean</link> justify);</programlisting>
<para>
Sets whether or not to justify <parameter>fo_layout</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to set justify.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>justify</parameter> :</term>
<listitem><simpara> Sets whether or not to justify <parameter>fo_layout</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-get-line-count" role="function">
<title>fo_layout_get_line_count ()</title>
<indexterm zone="fo-layout-get-line-count"><primary>fo_layout_get_line_count</primary></indexterm><programlisting><link linkend="gint">gint</link> fo_layout_get_line_count (<link linkend="FoLayout">FoLayout</link> *fo_layout);</programlisting>
<para>
Gets the number of lines in <parameter>fo_layout</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to get line count.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Number of lines in <parameter>fo_layout</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-get-extents" role="function">
<title>fo_layout_get_extents ()</title>
<indexterm zone="fo-layout-get-extents"><primary>fo_layout_get_extents</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_get_extents (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="FoRectangle">FoRectangle</link> *logical_rect);</programlisting>
<para>
Gets the extents of <parameter>fo_layout</parameter> and puts them in <parameter>logical_rect</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to get extents
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>logical_rect</parameter> :</term>
<listitem><simpara> <link linkend="FoRectangle"><type>FoRectangle</type></link> to hold extents
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-get-line-extents" role="function">
<title>fo_layout_get_line_extents ()</title>
<indexterm zone="fo-layout-get-line-extents"><primary>fo_layout_get_line_extents</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_get_line_extents (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gint">gint</link> line_index,
<link linkend="FoRectangle">FoRectangle</link> *logical_rect);</programlisting>
<para>
Puts the extents of the line of <parameter>fo_layout</parameter> given by <parameter>line_index</parameter> in
<parameter>logical_rect</parameter>.
</para>
<para>
The first line has <parameter>line_index</parameter> value of 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> for which to get line extents.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>line_index</parameter> :</term>
<listitem><simpara> Number of line for which to get extents.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>logical_rect</parameter> :</term>
<listitem><simpara> Holds result.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-line-height" role="function">
<title>fo_layout_set_line_height ()</title>
<indexterm zone="fo-layout-set-line-height"><primary>fo_layout_set_line_height</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_line_height (<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="gfloat">gfloat</link> line_height);</programlisting>
<para>
Set the 'line-height' of <parameter>fo_layout</parameter> to <parameter>line_height</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>line_height</parameter> :</term>
<listitem><simpara> 'line-height' in points.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-layout-set-line-stacking-strategy" role="function">
<title>fo_layout_set_line_stacking_strategy ()</title>
<indexterm zone="fo-layout-set-line-stacking-strategy"><primary>fo_layout_set_line_stacking_strategy</primary></indexterm><programlisting><link linkend="void">void</link> fo_layout_set_line_stacking_strategy
(<link linkend="FoLayout">FoLayout</link> *fo_layout,
<link linkend="FoEnumEnum">FoEnumEnum</link> line_stacking_strategy);</programlisting>
<para>
Set the 'line-stacking-strategy' property of <parameter>fo_layout</parameter> to
<parameter>line_stacking_strategy</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>line_stacking_strategy</parameter> :</term>
<listitem><simpara> Line stacking strategy to use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
