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
|
<refentry id="FoKeep">
<refmeta>
<refentrytitle role="top_of_page" id="FoKeep.top_of_page">FoKeep</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoKeep</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoKeep.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="FO-KEEP:CAPS">FO_KEEP</link> (object)
<link linkend="FoKeep-struct">FoKeep</link>;
<link linkend="FoKeepClass">FoKeepClass</link>;
<link linkend="GType">GType</link> <link linkend="fo-keep-get-type">fo_keep_get_type</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-new">fo_keep_new</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-new-with-value">fo_keep_new_with_value</link> (<link linkend="FoDatatype">FoDatatype</link> *value);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-get-keep-auto">fo_keep_get_keep_auto</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-get-keep-always">fo_keep_get_keep_always</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-get-within-line">fo_keep_get_within_line</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-get-within-column">fo_keep_get_within_column</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-get-within-page">fo_keep_get_within_page</link> (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-resolve">fo_keep_resolve</link> (<link linkend="FoDatatype">FoDatatype</link> *shortform,
<link linkend="FoDatatype">FoDatatype</link> *within_line,
<link linkend="FoDatatype">FoDatatype</link> *within_column,
<link linkend="FoDatatype">FoDatatype</link> *within_page,
<link linkend="GError">GError</link> **error);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-get-enum-auto">fo_keep_get_enum_auto</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-keep-get-enum-always">fo_keep_get_enum_always</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoKeep.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>
+----FoKeep
</synopsis>
</refsect1>
<refsect1 id="FoKeep.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoKeep--within-column">within-column</link>" <link linkend="FoDatatype">FoDatatype</link>* : Read / Write / Construct Only
"<link linkend="FoKeep--within-line">within-line</link>" <link linkend="FoDatatype">FoDatatype</link>* : Read / Write / Construct Only
"<link linkend="FoKeep--within-page">within-page</link>" <link linkend="FoDatatype">FoDatatype</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="FoKeep.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="FoKeep.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FO-KEEP:CAPS" role="macro">
<title>FO_KEEP()</title>
<indexterm zone="FO-KEEP:CAPS"><primary>FO_KEEP</primary></indexterm><programlisting>#define FO_KEEP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), FO_TYPE_KEEP, FoKeep))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoKeep-struct" role="struct">
<title>FoKeep</title>
<indexterm zone="FoKeep-struct"><primary>FoKeep</primary></indexterm><programlisting>typedef struct _FoKeep FoKeep;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoKeepClass" role="struct">
<title>FoKeepClass</title>
<indexterm zone="FoKeepClass"><primary>FoKeepClass</primary></indexterm><programlisting>typedef struct _FoKeepClass FoKeepClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-keep-get-type" role="function">
<title>fo_keep_get_type ()</title>
<indexterm zone="fo-keep-get-type"><primary>fo_keep_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link> fo_keep_get_type (void);</programlisting>
<para>
Register the <link linkend="FoKeep"><type>FoKeep</type></link> object type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GType value of the <link linkend="FoKeep"><type>FoKeep</type></link> object type.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-new" role="function">
<title>fo_keep_new ()</title>
<indexterm zone="fo-keep-new"><primary>fo_keep_new</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_new (void);</programlisting>
<para>
Creates a new <link linkend="FoKeep"><type>FoKeep</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoKeep"><type>FoKeep</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-new-with-value" role="function">
<title>fo_keep_new_with_value ()</title>
<indexterm zone="fo-keep-new-with-value"><primary>fo_keep_new_with_value</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_new_with_value (<link linkend="FoDatatype">FoDatatype</link> *value);</programlisting>
<para>
Creates a new <link linkend="FoKeep"><type>FoKeep</type></link> set to <parameter>value</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> Keep of the new <link linkend="FoKeep"><type>FoKeep</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="FoKeep"><type>FoKeep</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-get-keep-auto" role="function">
<title>fo_keep_get_keep_auto ()</title>
<indexterm zone="fo-keep-get-keep-auto"><primary>fo_keep_get_keep_auto</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_get_keep_auto (void);</programlisting>
<para>
Creates a new <link linkend="FoKeep"><type>FoKeep</type></link> set to .within-line="auto",
.within-column="auto", and .within-page="auto".</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="FoKeep"><type>FoKeep</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-get-keep-always" role="function">
<title>fo_keep_get_keep_always ()</title>
<indexterm zone="fo-keep-get-keep-always"><primary>fo_keep_get_keep_always</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_get_keep_always (void);</programlisting>
<para>
Creates a new <link linkend="FoKeep"><type>FoKeep</type></link> set to .within-line="always",
.within-column="always", and .within-page="always".</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="FoKeep"><type>FoKeep</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-get-within-line" role="function">
<title>fo_keep_get_within_line ()</title>
<indexterm zone="fo-keep-get-within-line"><primary>fo_keep_get_within_line</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_get_within_line (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .within-line component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoKeep"><type>FoKeep</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .within-line value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-get-within-column" role="function">
<title>fo_keep_get_within_column ()</title>
<indexterm zone="fo-keep-get-within-column"><primary>fo_keep_get_within_column</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_get_within_column (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .within-column component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoKeep"><type>FoKeep</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .within-column value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-get-within-page" role="function">
<title>fo_keep_get_within_page ()</title>
<indexterm zone="fo-keep-get-within-page"><primary>fo_keep_get_within_page</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_get_within_page (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .within-page component value of <parameter>datatype</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter> :</term>
<listitem><simpara> <link linkend="FoKeep"><type>FoKeep</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The .within-page value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-resolve" role="function">
<title>fo_keep_resolve ()</title>
<indexterm zone="fo-keep-resolve"><primary>fo_keep_resolve</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_resolve (<link linkend="FoDatatype">FoDatatype</link> *shortform,
<link linkend="FoDatatype">FoDatatype</link> *within_line,
<link linkend="FoDatatype">FoDatatype</link> *within_column,
<link linkend="FoDatatype">FoDatatype</link> *within_page,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Resolve the shortform and components of the keep in
accordance with Section 5.11, Datatypes, of the XSL 1.0
Recommendation.
</para>
<para>
Does not change the ref-count of any FoDatatype arguments.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>shortform</parameter> :</term>
<listitem><simpara> Single-value short form of the keep, or
NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>within_line</parameter> :</term>
<listitem><simpara> .within-line component of the keep, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>within_column</parameter> :</term>
<listitem><simpara> .within-column component of the keep, or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>within_page</parameter> :</term>
<listitem><simpara> .within-page component of the keep, or NULL
</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 keep datatype, or NULL if an error
occurred
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-get-enum-auto" role="function">
<title>fo_keep_get_enum_auto ()</title>
<indexterm zone="fo-keep-get-enum-auto"><primary>fo_keep_get_enum_auto</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_get_enum_auto (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-keep-get-enum-always" role="function">
<title>fo_keep_get_enum_always ()</title>
<indexterm zone="fo-keep-get-enum-always"><primary>fo_keep_get_enum_always</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_keep_get_enum_always (void);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="FoKeep.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoKeep--within-column"><title>The <literal>"within-column"</literal> property</title>
<indexterm zone="FoKeep--within-column"><primary>FoKeep:within-column</primary></indexterm><programlisting> "within-column" <link linkend="FoDatatype">FoDatatype</link>* : Read / Write / Construct Only</programlisting>
<para>Keep within column value.</para></refsect2>
<refsect2 id="FoKeep--within-line"><title>The <literal>"within-line"</literal> property</title>
<indexterm zone="FoKeep--within-line"><primary>FoKeep:within-line</primary></indexterm><programlisting> "within-line" <link linkend="FoDatatype">FoDatatype</link>* : Read / Write / Construct Only</programlisting>
<para>Keep within line value.</para></refsect2>
<refsect2 id="FoKeep--within-page"><title>The <literal>"within-page"</literal> property</title>
<indexterm zone="FoKeep--within-page"><primary>FoKeep:within-page</primary></indexterm><programlisting> "within-page" <link linkend="FoDatatype">FoDatatype</link>* : Read / Write / Construct Only</programlisting>
<para>Keep within page value.</para></refsect2>
</refsect1>
</refentry>
|
