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
|
<refentry id="FoProperty">
<refmeta>
<refentrytitle role="top_of_page" id="FoProperty.top_of_page">FoProperty</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoProperty</refname>
<refpurpose>Abstract FO property type</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoProperty.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoProperty-struct">FoProperty</link>;
<link linkend="FoPropertyClass">FoPropertyClass</link>;
#define <link linkend="FO-PROPERTY-ERROR:CAPS">FO_PROPERTY_ERROR</link>
<link linkend="GQuark">GQuark</link> <link linkend="fo-property-error-quark">fo_property_error_quark</link> (void);
enum <link linkend="FoPropertyError">FoPropertyError</link>;
<link linkend="FoProperty">FoProperty</link>* <link linkend="fo-property-new-from-expr">fo_property_new_from_expr</link> (<link linkend="FoPropertyClass">FoPropertyClass</link> *property_class,
const <link linkend="gchar">gchar</link> *expr,
<link linkend="FoContext">FoContext</link> *context,
<link linkend="FoProperty">FoProperty</link> *current_font_size,
<link linkend="FoFo">FoFo</link> *fo_node,
<link linkend="GError">GError</link> **error);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-property-get-value">fo_property_get_value</link> (<link linkend="FoProperty">FoProperty</link> *property);
<link linkend="void">void</link> <link linkend="fo-property-set-value">fo_property_set_value</link> (<link linkend="FoProperty">FoProperty</link> *property,
<link linkend="FoDatatype">FoDatatype</link> *new_value);
<link linkend="gboolean">gboolean</link> <link linkend="fo-property-class-is-inherited">fo_property_class_is_inherited</link> (<link linkend="FoPropertyClass">FoPropertyClass</link> *property_class);
<link linkend="gboolean">gboolean</link> <link linkend="fo-property-is-inherited">fo_property_is_inherited</link> (<link linkend="FoProperty">FoProperty</link> *property);
<link linkend="gboolean">gboolean</link> <link linkend="fo-property-class-is-shorthand">fo_property_class_is_shorthand</link> (<link linkend="FoPropertyClass">FoPropertyClass</link> *property_class);
<link linkend="gboolean">gboolean</link> <link linkend="fo-property-is-shorthand">fo_property_is_shorthand</link> (<link linkend="FoProperty">FoProperty</link> *property);
<link linkend="FoDatatype">FoDatatype</link>* (<link linkend="FoResolveEnumFunc">*FoResolveEnumFunc</link>) (const <link linkend="gchar">gchar</link> *token,
<link linkend="FoContext">FoContext</link> *context,
<link linkend="GError">GError</link> **err);
<link linkend="FoDatatype">FoDatatype</link>* (<link linkend="FoResolvePercentFunc">*FoResolvePercentFunc</link>) (<link linkend="gdouble">gdouble</link> percentage,
const <link linkend="FoDatatype">FoDatatype</link> *font_size,
const <link linkend="FoFo">FoFo</link> *fo_node,
const <link linkend="FoContext">FoContext</link> *context,
<link linkend="GError">GError</link> **err);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoProperty.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="FoObject">FoObject</link>
+----FoProperty
+----<link linkend="FoPropertyBorderLeftWidth">FoPropertyBorderLeftWidth</link>
</synopsis>
</refsect1>
<refsect1 id="FoProperty.derived-interfaces" role="derived_interfaces">
<title role="derived_interfaces.title">Known Derived Interfaces</title>
<para>
FoProperty is required by
<link linkend="FoPropertyTextPropertyIface">FoPropertyTextPropertyIface</link>.</para>
</refsect1>
<refsect1 id="FoProperty.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoProperty--is-inherited">is-inherited</link>" <link linkend="gboolean">gboolean</link> : Read
"<link linkend="FoProperty--is-shorthand">is-shorthand</link>" <link linkend="gboolean">gboolean</link> : Read
"<link linkend="FoProperty--value">value</link>" <link linkend="FoDatatype">FoDatatype</link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="FoProperty.description" role="desc">
<title role="desc.title">Description</title>
<para>
Every property is a subtype of <link linkend="FoProperty"><type>FoProperty</type></link>.</para>
<para>
</para>
</refsect1>
<refsect1 id="FoProperty.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoProperty-struct" role="struct">
<title>FoProperty</title>
<indexterm zone="FoProperty-struct"><primary>FoProperty</primary></indexterm><programlisting>typedef struct _FoProperty FoProperty;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoPropertyClass" role="struct">
<title>FoPropertyClass</title>
<indexterm zone="FoPropertyClass"><primary>FoPropertyClass</primary></indexterm><programlisting>typedef struct _FoPropertyClass FoPropertyClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FO-PROPERTY-ERROR:CAPS" role="macro">
<title>FO_PROPERTY_ERROR</title>
<indexterm zone="FO-PROPERTY-ERROR:CAPS"><primary>FO_PROPERTY_ERROR</primary></indexterm><programlisting>#define FO_PROPERTY_ERROR fo_property_error_quark ()
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-property-error-quark" role="function">
<title>fo_property_error_quark ()</title>
<indexterm zone="fo-property-error-quark"><primary>fo_property_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> fo_property_error_quark (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoPropertyError" role="enum">
<title>enum FoPropertyError</title>
<indexterm zone="FoPropertyError"><primary>FoPropertyError</primary></indexterm><programlisting>typedef enum
{
FO_PROPERTY_ERROR_FAILED,
FO_PROPERTY_ERROR_EXPRESSION,
FO_PROPERTY_ERROR_NO_ENUMERATION,
FO_PROPERTY_ERROR_ILLEGAL_NEGATIVE,
FO_PROPERTY_ERROR_ZERO_LENGTH,
FO_PROPERTY_ERROR_LAST
} FoPropertyError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-property-new-from-expr" role="function">
<title>fo_property_new_from_expr ()</title>
<indexterm zone="fo-property-new-from-expr"><primary>fo_property_new_from_expr</primary></indexterm><programlisting><link linkend="FoProperty">FoProperty</link>* fo_property_new_from_expr (<link linkend="FoPropertyClass">FoPropertyClass</link> *property_class,
const <link linkend="gchar">gchar</link> *expr,
<link linkend="FoContext">FoContext</link> *context,
<link linkend="FoProperty">FoProperty</link> *current_font_size,
<link linkend="FoFo">FoFo</link> *fo_node,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Evaluates <parameter>expr</parameter> as a value of an instance of <parameter>property_class</parameter>.
The other parameters provide the context for evaluating <parameter>expr</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property_class</parameter> :</term>
<listitem><simpara> Class of property for which to evaluate expression.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>expr</parameter> :</term>
<listitem><simpara> Expression to evaluate.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara> Current <link linkend="FoContext"><type>FoContext</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>current_font_size</parameter> :</term>
<listitem><simpara> Current "font-size" value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fo_node</parameter> :</term>
<listitem><simpara> Current FO
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Indication of any error that occurred
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> New instance of <parameter>property_class</parameter>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if an
error ocurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-property-get-value" role="function">
<title>fo_property_get_value ()</title>
<indexterm zone="fo-property-get-value"><primary>fo_property_get_value</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_property_get_value (<link linkend="FoProperty">FoProperty</link> *property);</programlisting>
<para>
Returns the current value property value of <parameter>property</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property</parameter> :</term>
<listitem><simpara> <link linkend="FoProperty"><type>FoProperty</type></link> object whose value is to be retrieved.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The current 'value' property value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-property-set-value" role="function">
<title>fo_property_set_value ()</title>
<indexterm zone="fo-property-set-value"><primary>fo_property_set_value</primary></indexterm><programlisting><link linkend="void">void</link> fo_property_set_value (<link linkend="FoProperty">FoProperty</link> *property,
<link linkend="FoDatatype">FoDatatype</link> *new_value);</programlisting>
<para>
Sets the 'value' property of <parameter>property</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property</parameter> :</term>
<listitem><simpara> <link linkend="FoProperty"><type>FoProperty</type></link> object whose value is to be set.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_value</parameter> :</term>
<listitem><simpara> New value for the property.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-property-class-is-inherited" role="function">
<title>fo_property_class_is_inherited ()</title>
<indexterm zone="fo-property-class-is-inherited"><primary>fo_property_class_is_inherited</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_property_class_is_inherited (<link linkend="FoPropertyClass">FoPropertyClass</link> *property_class);</programlisting>
<para>
Indicates whether the XSL property represented by <parameter>property_class</parameter>
is defined in the XSL 1.0 Recommendation as an inherited property.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property_class</parameter> :</term>
<listitem><simpara> <link linkend="FoPropertyClass"><type>FoPropertyClass</type></link> or a subclass of <link linkend="FoPropertyClass"><type>FoPropertyClass</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if <parameter>property_class</parameter> is inherited, FALSE if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-property-is-inherited" role="function">
<title>fo_property_is_inherited ()</title>
<indexterm zone="fo-property-is-inherited"><primary>fo_property_is_inherited</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_property_is_inherited (<link linkend="FoProperty">FoProperty</link> *property);</programlisting>
<para>
Indicates whether the XSL property represented by <parameter>property</parameter> is
defined in the XSL 1.0 Recommendation as an inherited property.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property</parameter> :</term>
<listitem><simpara> <link linkend="FoProperty"><type>FoProperty</type></link> or subclass of <link linkend="FoProperty"><type>FoProperty</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if <parameter>property</parameter> is inherited, FALSE otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-property-class-is-shorthand" role="function">
<title>fo_property_class_is_shorthand ()</title>
<indexterm zone="fo-property-class-is-shorthand"><primary>fo_property_class_is_shorthand</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_property_class_is_shorthand (<link linkend="FoPropertyClass">FoPropertyClass</link> *property_class);</programlisting>
<para>
Indicates whether the XSL property represented by <parameter>property_class</parameter>
is defined in the XSL 1.0 Recommendation as a shorthand property.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property_class</parameter> :</term>
<listitem><simpara> <link linkend="FoPropertyClass"><type>FoPropertyClass</type></link> or a subclass of <link linkend="FoPropertyClass"><type>FoPropertyClass</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if <parameter>property_class</parameter> is a shorthand, FALSE if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-property-is-shorthand" role="function">
<title>fo_property_is_shorthand ()</title>
<indexterm zone="fo-property-is-shorthand"><primary>fo_property_is_shorthand</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_property_is_shorthand (<link linkend="FoProperty">FoProperty</link> *property);</programlisting>
<para>
Indicates whether the XSL property represented by <parameter>property</parameter> is
defined in the XSL 1.0 Recommendation as a shorthand property.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property</parameter> :</term>
<listitem><simpara> <link linkend="FoProperty"><type>FoProperty</type></link> or a subclass of <link linkend="FoProperty"><type>FoProperty</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if <parameter>property</parameter> is a shorthand, FALSE otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoResolveEnumFunc" role="function">
<title>FoResolveEnumFunc ()</title>
<indexterm zone="FoResolveEnumFunc"><primary>FoResolveEnumFunc</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* (*FoResolveEnumFunc) (const <link linkend="gchar">gchar</link> *token,
<link linkend="FoContext">FoContext</link> *context,
<link linkend="GError">GError</link> **err);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>token</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoResolvePercentFunc" role="function">
<title>FoResolvePercentFunc ()</title>
<indexterm zone="FoResolvePercentFunc"><primary>FoResolvePercentFunc</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* (*FoResolvePercentFunc) (<link linkend="gdouble">gdouble</link> percentage,
const <link linkend="FoDatatype">FoDatatype</link> *font_size,
const <link linkend="FoFo">FoFo</link> *fo_node,
const <link linkend="FoContext">FoContext</link> *context,
<link linkend="GError">GError</link> **err);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>percentage</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font_size</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fo_node</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>context</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="FoProperty.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoProperty--is-inherited"><title>The <literal>"is-inherited"</literal> property</title>
<indexterm zone="FoProperty--is-inherited"><primary>FoProperty:is-inherited</primary></indexterm><programlisting> "is-inherited" <link linkend="gboolean">gboolean</link> : Read</programlisting>
<para>Is this an inherited property?.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="FoProperty--is-shorthand"><title>The <literal>"is-shorthand"</literal> property</title>
<indexterm zone="FoProperty--is-shorthand"><primary>FoProperty:is-shorthand</primary></indexterm><programlisting> "is-shorthand" <link linkend="gboolean">gboolean</link> : Read</programlisting>
<para>Is this a shorthand property?.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="FoProperty--value"><title>The <literal>"value"</literal> property</title>
<indexterm zone="FoProperty--value"><primary>FoProperty:value</primary></indexterm><programlisting> "value" <link linkend="FoDatatype">FoDatatype</link>* : Read / Write</programlisting>
<para>Property value.</para></refsect2>
</refsect1>
</refentry>
|
