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
|
<refentry id="FoLengthCond">
<refmeta>
<refentrytitle role="top_of_page" id="FoLengthCond.top_of_page">FoLengthCond</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoLengthCond</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoLengthCond.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoLengthCond-struct">FoLengthCond</link>;
<link linkend="FoLengthCondClass">FoLengthCondClass</link>;
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-length-cond-new">fo_length_cond_new</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-length-cond-new-with-value">fo_length_cond_new_with_value</link> (<link linkend="gdouble">gdouble</link> length,
<link linkend="gboolean">gboolean</link> condity);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-length-cond-new-from-length">fo_length_cond_new_from_length</link> (<link linkend="FoDatatype">FoDatatype</link> *length);
<link linkend="gdouble">gdouble</link> <link linkend="fo-length-cond-get-length">fo_length_cond_get_length</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="void">void</link> <link linkend="fo-length-cond-set-length">fo_length_cond_set_length</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gdouble">gdouble</link> new_length);
<link linkend="gboolean">gboolean</link> <link linkend="fo-length-cond-get-condity">fo_length_cond_get_condity</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="void">void</link> <link linkend="fo-length-cond-set-condity">fo_length_cond_set_condity</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gboolean">gboolean</link> new_condity);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-length-cond-get-length-cond-zero">fo_length_cond_get_length_cond_zero</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-length-cond-resolve">fo_length_cond_resolve</link> (<link linkend="FoDatatype">FoDatatype</link> *shortform,
<link linkend="FoDatatype">FoDatatype</link> *length,
<link linkend="FoDatatype">FoDatatype</link> *condity,
<link linkend="GError">GError</link> **error);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoLengthCond.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>
+----FoLengthCond
</synopsis>
</refsect1>
<refsect1 id="FoLengthCond.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoLengthCond--conditionality">conditionality</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct Only
"<link linkend="FoLengthCond--length">length</link>" <link linkend="gdouble">gdouble</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="FoLengthCond.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="FoLengthCond.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoLengthCond-struct" role="struct">
<title>FoLengthCond</title>
<indexterm zone="FoLengthCond-struct"><primary>FoLengthCond</primary></indexterm><programlisting>typedef struct _FoLengthCond FoLengthCond;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoLengthCondClass" role="struct">
<title>FoLengthCondClass</title>
<indexterm zone="FoLengthCondClass"><primary>FoLengthCondClass</primary></indexterm><programlisting>typedef struct _FoLengthCondClass FoLengthCondClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-length-cond-new" role="function">
<title>fo_length_cond_new ()</title>
<indexterm zone="fo-length-cond-new"><primary>fo_length_cond_new</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_length_cond_new (void);</programlisting>
<para>
Creates a new <link linkend="FoLengthCond"><type>FoLengthCond</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoLengthCond"><type>FoLengthCond</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-length-cond-new-with-value" role="function">
<title>fo_length_cond_new_with_value ()</title>
<indexterm zone="fo-length-cond-new-with-value"><primary>fo_length_cond_new_with_value</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_length_cond_new_with_value (<link linkend="gdouble">gdouble</link> length,
<link linkend="gboolean">gboolean</link> condity);</programlisting>
<para>
Creates a new <link linkend="FoLengthCond"><type>FoLengthCond</type></link> set to <parameter>length</parameter> and <parameter>condity</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> Length component of the new <link linkend="FoLengthCond"><type>FoLengthCond</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>condity</parameter> :</term>
<listitem><simpara> Conditionality component of the new <link linkend="FoLengthCond"><type>FoLengthCond</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="FoLengthCond"><type>FoLengthCond</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-length-cond-new-from-length" role="function">
<title>fo_length_cond_new_from_length ()</title>
<indexterm zone="fo-length-cond-new-from-length"><primary>fo_length_cond_new_from_length</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_length_cond_new_from_length (<link linkend="FoDatatype">FoDatatype</link> *length);</programlisting>
<para>
Creates a new <link linkend="FoLengthCond"><type>FoLengthCond</type></link> with .length component set to <parameter>length</parameter>
and .conditionality component set to default value.</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="FoLengthCond"><type>FoLengthCond</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-length-cond-get-length" role="function">
<title>fo_length_cond_get_length ()</title>
<indexterm zone="fo-length-cond-get-length"><primary>fo_length_cond_get_length</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> fo_length_cond_get_length (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .length component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoLengthCond"><type>FoLengthCond</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .length value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-length-cond-set-length" role="function">
<title>fo_length_cond_set_length ()</title>
<indexterm zone="fo-length-cond-set-length"><primary>fo_length_cond_set_length</primary></indexterm><programlisting><link linkend="void">void</link> fo_length_cond_set_length (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gdouble">gdouble</link> new_length);</programlisting>
<para>
Sets the .length component of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoLengthCond"><type>FoLengthCond</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_length</parameter> :</term>
<listitem><simpara> New .length value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-length-cond-get-condity" role="function">
<title>fo_length_cond_get_condity ()</title>
<indexterm zone="fo-length-cond-get-condity"><primary>fo_length_cond_get_condity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_length_cond_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="FoLengthCond"><type>FoLengthCond</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .conditionality component value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-length-cond-set-condity" role="function">
<title>fo_length_cond_set_condity ()</title>
<indexterm zone="fo-length-cond-set-condity"><primary>fo_length_cond_set_condity</primary></indexterm><programlisting><link linkend="void">void</link> fo_length_cond_set_condity (<link linkend="FoDatatype">FoDatatype</link> *datatype,
<link linkend="gboolean">gboolean</link> new_condity);</programlisting>
<para>
Sets the .condity component of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoLengthCond"><type>FoLengthCond</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_condity</parameter> :</term>
<listitem><simpara> New .condity value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-length-cond-get-length-cond-zero" role="function">
<title>fo_length_cond_get_length_cond_zero ()</title>
<indexterm zone="fo-length-cond-get-length-cond-zero"><primary>fo_length_cond_get_length_cond_zero</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_length_cond_get_length_cond_zero (void);</programlisting>
<para>
Get an <link linkend="FoLengthCond"><type>FoLengthCond</type></link> with the well-known value of 0pt/discard.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="FoLengthCond"><type>FoLengthCond</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-length-cond-resolve" role="function">
<title>fo_length_cond_resolve ()</title>
<indexterm zone="fo-length-cond-resolve"><primary>fo_length_cond_resolve</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_length_cond_resolve (<link linkend="FoDatatype">FoDatatype</link> *shortform,
<link linkend="FoDatatype">FoDatatype</link> *length,
<link linkend="FoDatatype">FoDatatype</link> *condity,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Resolve the shortform and components of the length-conditional 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 length-conditional, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> .length 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>error</parameter> :</term>
<listitem><simpara> <link linkend="GError"><type>GError</type></link> 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="FoLengthCond.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoLengthCond--conditionality"><title>The <literal>"conditionality"</literal> property</title>
<indexterm zone="FoLengthCond--conditionality"><primary>FoLengthCond: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="FoLengthCond--length"><title>The <literal>"length"</literal> property</title>
<indexterm zone="FoLengthCond--length"><primary>FoLengthCond:length</primary></indexterm><programlisting> "length" <link linkend="gdouble">gdouble</link> : Read / Write / Construct Only</programlisting>
<para>Length_Cond length.</para><para>Default value: 0</para>
</refsect2>
</refsect1>
</refentry>
|
