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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Container - Variant</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="liblangtag Documentation">
<link rel="up" href="Container.html" title="Container APIs">
<link rel="prev" href="liblangtag-Container---Tag.html" title="Container - Tag">
<link rel="next" href="Module.html" title="Module APIs">
<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="liblangtag-Container---Tag.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Container.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">liblangtag Documentation</th>
<td><a accesskey="n" href="Module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#liblangtag-Container---Variant.synopsis" class="shortcut">Top</a>
|
<a href="#liblangtag-Container---Variant.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="liblangtag-Container---Variant"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="liblangtag-Container---Variant.top_of_page"></a>Container - Variant</span></h2>
<p>Container - Variant — A container class for Variant subtag</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="liblangtag-Container---Variant.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="liblangtag-Miscellaneous-Macros.html#lt-bool-t" title="lt_bool_t"><span class="returnvalue">lt_bool_t</span></a> <a class="link" href="liblangtag-Container---Variant.html#lt-variant-compare" title="lt_variant_compare ()">lt_variant_compare</a> (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *v1</code></em>,
<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *v2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="liblangtag-Container---Variant.html#lt-variant-dump" title="lt_variant_dump ()">lt_variant_dump</a> (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="liblangtag-Container---Variant.html#lt-variant-get-better-tag" title="lt_variant_get_better_tag ()">lt_variant_get_better_tag</a> (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="liblangtag-Container---Variant.html#lt-variant-get-name" title="lt_variant_get_name ()">lt_variant_get_name</a> (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="liblangtag-Container---Variant.html#lt-variant-get-preferred-tag" title="lt_variant_get_preferred_tag ()">lt_variant_get_preferred_tag</a> (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);
const <a class="link" href="liblangtag-Doubly-Linked-Lists.html#lt-list-t" title="lt_list_t"><span class="returnvalue">lt_list_t</span></a> * <a class="link" href="liblangtag-Container---Variant.html#lt-variant-get-prefix" title="lt_variant_get_prefix ()">lt_variant_get_prefix</a> (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="liblangtag-Container---Variant.html#lt-variant-get-tag" title="lt_variant_get_tag ()">lt_variant_get_tag</a> (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);
<a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="returnvalue">lt_variant_t</span></a> * <a class="link" href="liblangtag-Container---Variant.html#lt-variant-ref" title="lt_variant_ref ()">lt_variant_ref</a> (<em class="parameter"><code><a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);
<a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t">lt_variant_t</a>;
<span class="returnvalue">void</span> <a class="link" href="liblangtag-Container---Variant.html#lt-variant-unref" title="lt_variant_unref ()">lt_variant_unref</a> (<em class="parameter"><code><a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="liblangtag-Container---Variant.description"></a><h2>Description</h2>
<p>
This container class provides a data access to Variant subtag entry.
</p>
</div>
<div class="refsect1">
<a name="liblangtag-Container---Variant.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="lt-variant-compare"></a><h3>lt_variant_compare ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Miscellaneous-Macros.html#lt-bool-t" title="lt_bool_t"><span class="returnvalue">lt_bool_t</span></a> lt_variant_compare (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *v1</code></em>,
<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *v2</code></em>);</pre>
<p>
Compare if <em class="parameter"><code>v1</code></em> and <em class="parameter"><code>v2</code></em> is the same object or not.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>v1</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>v2</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if it's the same, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-dump"></a><h3>lt_variant_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> lt_variant_dump (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);</pre>
<p>
Dumps the container information to the standard output.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-get-better-tag"></a><h3>lt_variant_get_better_tag ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * lt_variant_get_better_tag (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);</pre>
<p>
Obtains the better tag for use. this is a convenient function to get
the preferred-value if available.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a tag string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-get-name"></a><h3>lt_variant_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * lt_variant_get_name (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);</pre>
<p>
Obtains the description of the subtag.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a description string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-get-preferred-tag"></a><h3>lt_variant_get_preferred_tag ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * lt_variant_get_preferred_tag (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);</pre>
<p>
Obtains the preferred-value. this is available only when the tag is
marked as deprecated.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a preferred-value for the tag or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-get-prefix"></a><h3>lt_variant_get_prefix ()</h3>
<pre class="programlisting">const <a class="link" href="liblangtag-Doubly-Linked-Lists.html#lt-list-t" title="lt_list_t"><span class="returnvalue">lt_list_t</span></a> * lt_variant_get_prefix (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);</pre>
<p>
Obtains the prefix being assigned to the subtag.
This is available only when the subtag has any suitable sequence of
subtags for forming (with other subtags, as appropriate) a language
tag when using the variant.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="liblangtag-Doubly-Linked-Lists.html#lt-list-t" title="lt_list_t"><span class="type">lt_list_t</span></a> contains prefix strings or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-get-tag"></a><h3>lt_variant_get_tag ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * lt_variant_get_tag (<em class="parameter"><code>const <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);</pre>
<p>
Obtains the tag name.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a tag string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-ref"></a><h3>lt_variant_ref ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="returnvalue">lt_variant_t</span></a> * lt_variant_ref (<em class="parameter"><code><a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);</pre>
<p>
Increases the reference count of <em class="parameter"><code>variant</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the same <em class="parameter"><code>variant</code></em> object. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-t"></a><h3>lt_variant_t</h3>
<pre class="programlisting">typedef struct _lt_variant_t lt_variant_t;</pre>
<p>
All the fields in the <span class="structname">lt_variant_t</span>
structure are private to the <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> implementation.
</p>
</div>
<hr>
<div class="refsect2">
<a name="lt-variant-unref"></a><h3>lt_variant_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> lt_variant_unref (<em class="parameter"><code><a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a> *variant</code></em>);</pre>
<p>
Decreases the reference count of <em class="parameter"><code>variant</code></em>. when its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>a <a class="link" href="liblangtag-Container---Variant.html#lt-variant-t" title="lt_variant_t"><span class="type">lt_variant_t</span></a>.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
