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
|
<refentry id="FoSpace">
<refmeta>
<refentrytitle role="top_of_page" id="FoSpace.top_of_page">FoSpace</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoSpace</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoSpace.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoSpace-struct">FoSpace</link>;
<link linkend="FoSpaceClass">FoSpaceClass</link>;
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-space-new">fo_space_new</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-space-new-from-length">fo_space_new_from_length</link> (<link linkend="FoDatatype">FoDatatype</link> *length);
<link linkend="void">void</link> <link linkend="fo-space-set-minimum">fo_space_set_minimum</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gfloat">gfloat</link> new_minimum);
<link linkend="gfloat">gfloat</link> <link linkend="fo-space-get-minimum">fo_space_get_minimum</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="void">void</link> <link linkend="fo-space-set-optimum">fo_space_set_optimum</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gfloat">gfloat</link> new_optimum);
<link linkend="gfloat">gfloat</link> <link linkend="fo-space-get-optimum">fo_space_get_optimum</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="void">void</link> <link linkend="fo-space-set-maximum">fo_space_set_maximum</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gfloat">gfloat</link> new_maximum);
<link linkend="gfloat">gfloat</link> <link linkend="fo-space-get-maximum">fo_space_get_maximum</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="void">void</link> <link linkend="fo-space-set-precedence">fo_space_set_precedence</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gint">gint</link> new_precedence);
<link linkend="gint">gint</link> <link linkend="fo-space-get-precedence">fo_space_get_precedence</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="void">void</link> <link linkend="fo-space-set-condity">fo_space_set_condity</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gboolean">gboolean</link> new_condity);
<link linkend="gboolean">gboolean</link> <link linkend="fo-space-get-condity">fo_space_get_condity</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-space-get-space-0pt">fo_space_get_space_0pt</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-space-resolve">fo_space_resolve</link> (<link linkend="FoDatatype">FoDatatype</link> *shortform,
<link linkend="FoDatatype">FoDatatype</link> *minimum,
<link linkend="FoDatatype">FoDatatype</link> *optimum,
<link linkend="FoDatatype">FoDatatype</link> *maximum,
<link linkend="FoDatatype">FoDatatype</link> *precedence,
<link linkend="FoDatatype">FoDatatype</link> *condity,
<link linkend="gfloat">gfloat</link> hundred_percent,
<link linkend="GError">GError</link> **error);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoSpace.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="FoObject">FoObject</link>
+----<link linkend="FoDatatype">FoDatatype</link>
+----FoSpace
</synopsis>
</refsect1>
<refsect1 id="FoSpace.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoSpace--conditionality">conditionality</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct Only
"<link linkend="FoSpace--maximum">maximum</link>" <link linkend="gfloat">gfloat</link> : Read / Write / Construct Only
"<link linkend="FoSpace--minimum">minimum</link>" <link linkend="gfloat">gfloat</link> : Read / Write / Construct Only
"<link linkend="FoSpace--optimum">optimum</link>" <link linkend="gfloat">gfloat</link> : Read / Write / Construct Only
"<link linkend="FoSpace--precedence">precedence</link>" <link linkend="gint">gint</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="FoSpace.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="FoSpace.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoSpace-struct" role="struct">
<title>FoSpace</title>
<indexterm zone="FoSpace-struct"><primary>FoSpace</primary></indexterm><programlisting>typedef struct _FoSpace FoSpace;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoSpaceClass" role="struct">
<title>FoSpaceClass</title>
<indexterm zone="FoSpaceClass"><primary>FoSpaceClass</primary></indexterm><programlisting>typedef struct _FoSpaceClass FoSpaceClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-space-new" role="function">
<title>fo_space_new ()</title>
<indexterm zone="fo-space-new"><primary>fo_space_new</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_space_new (void);</programlisting>
<para>
Creates a new <link linkend="FoSpace"><type>FoSpace</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-new-from-length" role="function">
<title>fo_space_new_from_length ()</title>
<indexterm zone="fo-space-new-from-length"><primary>fo_space_new_from_length</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_space_new_from_length (<link linkend="FoDatatype">FoDatatype</link> *length);</programlisting>
<para>
Creates a new <link linkend="FoSpace"><type>FoSpace</type></link> with .minimum, .optimum, and .maximum
components set to <parameter>length</parameter> and .conditionality and .precedence
components set to default values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> <link linkend="FoLength"><type>FoLength</type></link> to use as initial value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> New <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-set-minimum" role="function">
<title>fo_space_set_minimum ()</title>
<indexterm zone="fo-space-set-minimum"><primary>fo_space_set_minimum</primary></indexterm><programlisting><link linkend="void">void</link> fo_space_set_minimum (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gfloat">gfloat</link> new_minimum);</programlisting>
<para>
Sets the .minimum component of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_minimum</parameter> :</term>
<listitem><simpara> New .minimum value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-get-minimum" role="function">
<title>fo_space_get_minimum ()</title>
<indexterm zone="fo-space-get-minimum"><primary>fo_space_get_minimum</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link> fo_space_get_minimum (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .minimum component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .minimum value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-set-optimum" role="function">
<title>fo_space_set_optimum ()</title>
<indexterm zone="fo-space-set-optimum"><primary>fo_space_set_optimum</primary></indexterm><programlisting><link linkend="void">void</link> fo_space_set_optimum (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gfloat">gfloat</link> new_optimum);</programlisting>
<para>
Sets the .optimum component of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_optimum</parameter> :</term>
<listitem><simpara> New .optimum value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-get-optimum" role="function">
<title>fo_space_get_optimum ()</title>
<indexterm zone="fo-space-get-optimum"><primary>fo_space_get_optimum</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link> fo_space_get_optimum (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .optimum component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .optimum value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-set-maximum" role="function">
<title>fo_space_set_maximum ()</title>
<indexterm zone="fo-space-set-maximum"><primary>fo_space_set_maximum</primary></indexterm><programlisting><link linkend="void">void</link> fo_space_set_maximum (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gfloat">gfloat</link> new_maximum);</programlisting>
<para>
Sets the .maximum component of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_maximum</parameter> :</term>
<listitem><simpara> New .maximum value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-get-maximum" role="function">
<title>fo_space_get_maximum ()</title>
<indexterm zone="fo-space-get-maximum"><primary>fo_space_get_maximum</primary></indexterm><programlisting><link linkend="gfloat">gfloat</link> fo_space_get_maximum (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .maximum component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .maximum value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-set-precedence" role="function">
<title>fo_space_set_precedence ()</title>
<indexterm zone="fo-space-set-precedence"><primary>fo_space_set_precedence</primary></indexterm><programlisting><link linkend="void">void</link> fo_space_set_precedence (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gint">gint</link> new_precedence);</programlisting>
<para>
Sets the .precedence component of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_precedence</parameter> :</term>
<listitem><simpara> New .precedence value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-get-precedence" role="function">
<title>fo_space_get_precedence ()</title>
<indexterm zone="fo-space-get-precedence"><primary>fo_space_get_precedence</primary></indexterm><programlisting><link linkend="gint">gint</link> fo_space_get_precedence (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .precedence component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .precedence value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-set-condity" role="function">
<title>fo_space_set_condity ()</title>
<indexterm zone="fo-space-set-condity"><primary>fo_space_set_condity</primary></indexterm><programlisting><link linkend="void">void</link> fo_space_set_condity (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gboolean">gboolean</link> new_condity);</programlisting>
<para>
Sets the .conditionality component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_condity</parameter> :</term>
<listitem><simpara> New .conditionality component value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-get-condity" role="function">
<title>fo_space_get_condity ()</title>
<indexterm zone="fo-space-get-condity"><primary>fo_space_get_condity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_space_get_condity (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .conditionality component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .conditionality value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-get-space-0pt" role="function">
<title>fo_space_get_space_0pt ()</title>
<indexterm zone="fo-space-get-space-0pt"><primary>fo_space_get_space_0pt</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_space_get_space_0pt (void);</programlisting>
<para>
Create and return an <link linkend="FoSpace"><type>FoSpace</type></link> with the well-known value 0pt.
</para>
<para>
This saves creation of multiple <link linkend="FoSpace"><type>FoSpace</type></link> objects that all have the
value 0pt.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="FoSpace"><type>FoSpace</type></link> with value 0pt.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-space-resolve" role="function">
<title>fo_space_resolve ()</title>
<indexterm zone="fo-space-resolve"><primary>fo_space_resolve</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_space_resolve (<link linkend="FoDatatype">FoDatatype</link> *shortform,
<link linkend="FoDatatype">FoDatatype</link> *minimum,
<link linkend="FoDatatype">FoDatatype</link> *optimum,
<link linkend="FoDatatype">FoDatatype</link> *maximum,
<link linkend="FoDatatype">FoDatatype</link> *precedence,
<link linkend="FoDatatype">FoDatatype</link> *condity,
<link linkend="gfloat">gfloat</link> hundred_percent,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Resolve the shortform and components of the space in accordance
with Section 5.11, Datatypes, of the XSL 1.0 Recommendation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>shortform</parameter> :</term>
<listitem><simpara> Single-value short form of the space, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minimum</parameter> :</term>
<listitem><simpara> .minimum component of the space, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>optimum</parameter> :</term>
<listitem><simpara> .optimum component of the space, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>maximum</parameter> :</term>
<listitem><simpara> .maximum component of the space, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>precedence</parameter> :</term>
<listitem><simpara> .precedence component of the space, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>condity</parameter> :</term>
<listitem><simpara> .conditionality component of the space, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hundred_percent</parameter> :</term>
<listitem><simpara> Length to use as 100% when components expressed as
percentages
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> GError used for reporting errors
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Compound space datatype, or NULL if an error occurred
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="FoSpace.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoSpace--conditionality"><title>The <literal>"conditionality"</literal> property</title>
<indexterm zone="FoSpace--conditionality"><primary>FoSpace:conditionality</primary></indexterm><programlisting> "conditionality" <link linkend="gboolean">gboolean</link> : Read / Write / Construct Only</programlisting>
<para>Whether or not the space must always be retained.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="FoSpace--maximum"><title>The <literal>"maximum"</literal> property</title>
<indexterm zone="FoSpace--maximum"><primary>FoSpace:maximum</primary></indexterm><programlisting> "maximum" <link linkend="gfloat">gfloat</link> : Read / Write / Construct Only</programlisting>
<para>Space range maximum value.</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="FoSpace--minimum"><title>The <literal>"minimum"</literal> property</title>
<indexterm zone="FoSpace--minimum"><primary>FoSpace:minimum</primary></indexterm><programlisting> "minimum" <link linkend="gfloat">gfloat</link> : Read / Write / Construct Only</programlisting>
<para>Space range minimum value.</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="FoSpace--optimum"><title>The <literal>"optimum"</literal> property</title>
<indexterm zone="FoSpace--optimum"><primary>FoSpace:optimum</primary></indexterm><programlisting> "optimum" <link linkend="gfloat">gfloat</link> : Read / Write / Construct Only</programlisting>
<para>Space range optimum value.</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="FoSpace--precedence"><title>The <literal>"precedence"</literal> property</title>
<indexterm zone="FoSpace--precedence"><primary>FoSpace:precedence</primary></indexterm><programlisting> "precedence" <link linkend="gint">gint</link> : Read / Write / Construct Only</programlisting>
<para>Precedence of this space compared to others.</para><para>Default value: 0</para>
</refsect2>
</refsect1>
</refentry>
|
