File: libcroco-cr-num.html

package info (click to toggle)
libcroco 0.6.6-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 4,980 kB
  • sloc: ansic: 20,862; sh: 11,517; makefile: 322
file content (265 lines) | stat: -rw-r--r-- 16,796 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>cr-num</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Libcroco Reference Manual">
<link rel="up" href="ch01.html" title="Extensive APIs description">
<link rel="prev" href="libcroco-cr-input.html" title="cr-input">
<link rel="next" href="libcroco-cr-om-parser.html" title="cr-om-parser">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libcroco-cr-input.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libcroco Reference Manual</th>
<td><a accesskey="n" href="libcroco-cr-om-parser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libcroco-cr-num.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libcroco-cr-num.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libcroco-cr-num"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libcroco-cr-num.top_of_page"></a>cr-num</span></h2>
<p>cr-num</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libcroco-cr-num.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum">CRNum</a>;
enum <span class="returnvalue">CRStatus</span>       <a class="link" href="libcroco-cr-num.html#cr-num-copy" title="cr_num_copy ()">cr_num_copy</a>                         (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> *a_dest</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> const *a_src</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libcroco-cr-num.html#cr-num-destroy" title="cr_num_destroy ()">cr_num_destroy</a>                      (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> *a_this</code></em>);
<a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="returnvalue">CRNum</span></a> *             <a class="link" href="libcroco-cr-num.html#cr-num-dup" title="cr_num_dup ()">cr_num_dup</a>                          (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> const *a_this</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libcroco-cr-num.html#cr-num-is-fixed-length" title="cr_num_is_fixed_length ()">cr_num_is_fixed_length</a>              (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> const *a_this</code></em>);
<a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="returnvalue">CRNum</span></a> *             <a class="link" href="libcroco-cr-num.html#cr-num-new" title="cr_num_new ()">cr_num_new</a>                          (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="returnvalue">CRNum</span></a> *             <a class="link" href="libcroco-cr-num.html#cr-num-new-with-val" title="cr_num_new_with_val ()">cr_num_new_with_val</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> a_val</code></em>,
                                                         <em class="parameter"><code><span class="type">enum CRNumType</span> a_type</code></em>);
enum <span class="returnvalue">CRStatus</span>       <a class="link" href="libcroco-cr-num.html#cr-num-set" title="cr_num_set ()">cr_num_set</a>                          (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> *a_this</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> a_val</code></em>,
                                                         <em class="parameter"><code><span class="type">enum CRNumType</span> a_type</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *            <a class="link" href="libcroco-cr-num.html#cr-num-to-string" title="cr_num_to_string ()">cr_num_to_string</a>                    (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> const *a_this</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libcroco-cr-num.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libcroco-cr-num.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CRNum"></a><h3>struct CRNum</h3>
<pre class="programlisting">struct CRNum {
        enum CRNumType type ;
        gdouble val ;
        CRParsingLocation location ;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="cr-num-copy"></a><h3>cr_num_copy ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span>       cr_num_copy                         (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> *a_dest</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> const *a_src</code></em>);</pre>
<p>
Copies an instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_dest</code></em> :</span></p></td>
<td>the destination of the copy.
Must be non NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_src</code></em> :</span></p></td>
<td>the instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> to copy.
Must be non NULL.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon successful completion, an
error code otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-num-destroy"></a><h3>cr_num_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                cr_num_destroy                      (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> *a_this</code></em>);</pre>
<p>
The destructor of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the this pointer of
the current instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-num-dup"></a><h3>cr_num_dup ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="returnvalue">CRNum</span></a> *             cr_num_dup                          (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> const *a_this</code></em>);</pre>
<p>
Duplicates an instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> to duplicate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly created (duplicated) instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.
Must be freed by <a class="link" href="libcroco-cr-num.html#cr-num-destroy" title="cr_num_destroy ()"><code class="function">cr_num_destroy()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-num-is-fixed-length"></a><h3>cr_num_is_fixed_length ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            cr_num_is_fixed_length              (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> const *a_this</code></em>);</pre>
<p>
Tests if the current instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> is a fixed
length value or not. Typically a fixed length value
is anything from NUM_LENGTH_EM to NUM_LENGTH_PC.
See the definition of <span class="type">CRNumType</span> to see what we mean.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> .</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> is a fixed length number,
FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-num-new"></a><h3>cr_num_new ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="returnvalue">CRNum</span></a> *             cr_num_new                          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
<a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly built instance of
<a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-num-new-with-val"></a><h3>cr_num_new_with_val ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="returnvalue">CRNum</span></a> *             cr_num_new_with_val                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> a_val</code></em>,
                                                         <em class="parameter"><code><span class="type">enum CRNumType</span> a_type</code></em>);</pre>
<p>
A constructor of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_val</code></em> :</span></p></td>
<td>the numerical value of the number.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_type</code></em> :</span></p></td>
<td>the type of number.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly built instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> or
NULL if an error arises.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-num-set"></a><h3>cr_num_set ()</h3>
<pre class="programlisting">enum <span class="returnvalue">CRStatus</span>       cr_num_set                          (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> *a_this</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> a_val</code></em>,
                                                         <em class="parameter"><code><span class="type">enum CRNumType</span> a_type</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> to be set.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_val</code></em> :</span></p></td>
<td>the new numerical value to be hold by the current
instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_type</code></em> :</span></p></td>
<td>the new type of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>CR_OK upon succesful completion, an error code otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cr-num-to-string"></a><h3>cr_num_to_string ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *            cr_num_to_string                    (<em class="parameter"><code><a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a> const *a_this</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>a_this</code></em> :</span></p></td>
<td>the current instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the newly built string representation
of the current instance of <a class="link" href="libcroco-cr-num.html#CRNum" title="struct CRNum"><span class="type">CRNum</span></a>. The returned
string is NULL terminated. The caller *must*
free the returned string.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>