Imported Upstream version 1.49.1
[platform/upstream/gobject-introspection.git] / docs / reference / html / gi-common-types.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>common types: GObject Introspection Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="index.html" title="GObject Introspection Reference Manual">
8 <link rel="up" href="ch01.html" title="GIRepository">
9 <link rel="prev" href="gi-struct-hierarchy.html" title="Struct hierarchy">
10 <link rel="next" href="gi-GIBaseInfo.html" title="GIBaseInfo">
11 <meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18                   <a href="#gi-common-types.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="gi-struct-hierarchy.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="gi-GIBaseInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="gi-common-types"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="gi-common-types.top_of_page"></a>common types</span></h2>
30 <p>common types — TODO</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="gi-common-types.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody><tr>
42 <td class="define_keyword">#define</td>
43 <td class="function_name">
44 <a class="link" href="gi-common-types.html#G-TYPE-TAG-IS-BASIC:CAPS" title="G_TYPE_TAG_IS_BASIC()">G_TYPE_TAG_IS_BASIC</a><span class="c_punctuation">()</span>
45 </td>
46 </tr></tbody>
47 </table></div>
48 </div>
49 <div class="refsect1">
50 <a name="gi-common-types.other"></a><h2>Types and Values</h2>
51 <div class="informaltable"><table class="informaltable" width="100%" border="0">
52 <colgroup>
53 <col width="150px" class="name">
54 <col class="description">
55 </colgroup>
56 <tbody>
57 <tr>
58 <td class="datatype_keyword"> </td>
59 <td class="function_name"><a class="link" href="gi-common-types.html#GIArgument" title="GIArgument">GIArgument</a></td>
60 </tr>
61 <tr>
62 <td class="datatype_keyword"> </td>
63 <td class="function_name"><a class="link" href="gi-common-types.html#GIUnresolvedInfo" title="GIUnresolvedInfo">GIUnresolvedInfo</a></td>
64 </tr>
65 <tr>
66 <td class="datatype_keyword">enum</td>
67 <td class="function_name"><a class="link" href="gi-common-types.html#GITypeTag" title="enum GITypeTag">GITypeTag</a></td>
68 </tr>
69 <tr>
70 <td class="datatype_keyword">enum</td>
71 <td class="function_name"><a class="link" href="gi-common-types.html#GIArrayType" title="enum GIArrayType">GIArrayType</a></td>
72 </tr>
73 <tr>
74 <td class="define_keyword">#define</td>
75 <td class="function_name"><a class="link" href="gi-common-types.html#GI-TYPE-TAG-N-TYPES:CAPS" title="GI_TYPE_TAG_N_TYPES">GI_TYPE_TAG_N_TYPES</a></td>
76 </tr>
77 </tbody>
78 </table></div>
79 </div>
80 <div class="refsect1">
81 <a name="gi-common-types.description"></a><h2>Description</h2>
82 <p>TODO</p>
83 </div>
84 <div class="refsect1">
85 <a name="gi-common-types.functions_details"></a><h2>Functions</h2>
86 <div class="refsect2">
87 <a name="G-TYPE-TAG-IS-BASIC:CAPS"></a><h3>G_TYPE_TAG_IS_BASIC()</h3>
88 <pre class="programlisting">#define G_TYPE_TAG_IS_BASIC(tag) (tag &lt; GI_TYPE_TAG_ARRAY || tag == GI_TYPE_TAG_UNICHAR)
89 </pre>
90 <p>Checks if <em class="parameter"><code>tag</code></em>
91  is a basic type.</p>
92 <div class="refsect3">
93 <a name="G-TYPE-TAG-IS-BASIC.parameters"></a><h4>Parameters</h4>
94 <div class="informaltable"><table class="informaltable" width="100%" border="0">
95 <colgroup>
96 <col width="150px" class="parameters_name">
97 <col class="parameters_description">
98 <col width="200px" class="parameters_annotations">
99 </colgroup>
100 <tbody><tr>
101 <td class="parameter_name"><p>tag</p></td>
102 <td class="parameter_description"><p>a type tag</p></td>
103 <td class="parameter_annotations"> </td>
104 </tr></tbody>
105 </table></div>
106 </div>
107 </div>
108 </div>
109 <div class="refsect1">
110 <a name="gi-common-types.other_details"></a><h2>Types and Values</h2>
111 <div class="refsect2">
112 <a name="GIArgument"></a><h3>GIArgument</h3>
113 <p>Stores an argument of varying type</p>
114 <div class="refsect3">
115 <a name="GIArgument.members"></a><h4>Members</h4>
116 <div class="informaltable"><table class="informaltable" width="100%" border="0">
117 <colgroup>
118 <col width="300px" class="union_members_name">
119 <col class="union_members_description">
120 <col width="200px" class="union_members_annotations">
121 </colgroup>
122 <tbody>
123 <tr>
124 <td class="union_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="GIArgument.v-boolean"></a>v_boolean</code></em>;</p></td>
125 <td class="union_member_description"><p>TODO</p></td>
126 <td class="union_member_annotations"> </td>
127 </tr>
128 <tr>
129 <td class="union_member_name"><p><span class="type">gint8</span> <em class="structfield"><code><a name="GIArgument.v-int8"></a>v_int8</code></em>;</p></td>
130 <td class="union_member_description"><p>TODO</p></td>
131 <td class="union_member_annotations"> </td>
132 </tr>
133 <tr>
134 <td class="union_member_name"><p><span class="type">guint8</span> <em class="structfield"><code><a name="GIArgument.v-uint8"></a>v_uint8</code></em>;</p></td>
135 <td class="union_member_description"><p>TODO</p></td>
136 <td class="union_member_annotations"> </td>
137 </tr>
138 <tr>
139 <td class="union_member_name"><p><span class="type">gint16</span> <em class="structfield"><code><a name="GIArgument.v-int16"></a>v_int16</code></em>;</p></td>
140 <td class="union_member_description"><p>TODO</p></td>
141 <td class="union_member_annotations"> </td>
142 </tr>
143 <tr>
144 <td class="union_member_name"><p><span class="type">guint16</span> <em class="structfield"><code><a name="GIArgument.v-uint16"></a>v_uint16</code></em>;</p></td>
145 <td class="union_member_description"><p>TODO</p></td>
146 <td class="union_member_annotations"> </td>
147 </tr>
148 <tr>
149 <td class="union_member_name"><p><span class="type">gint32</span> <em class="structfield"><code><a name="GIArgument.v-int32"></a>v_int32</code></em>;</p></td>
150 <td class="union_member_description"><p>TODO</p></td>
151 <td class="union_member_annotations"> </td>
152 </tr>
153 <tr>
154 <td class="union_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="GIArgument.v-uint32"></a>v_uint32</code></em>;</p></td>
155 <td class="union_member_description"><p>TODO</p></td>
156 <td class="union_member_annotations"> </td>
157 </tr>
158 <tr>
159 <td class="union_member_name"><p><span class="type">gint64</span> <em class="structfield"><code><a name="GIArgument.v-int64"></a>v_int64</code></em>;</p></td>
160 <td class="union_member_description"><p>TODO</p></td>
161 <td class="union_member_annotations"> </td>
162 </tr>
163 <tr>
164 <td class="union_member_name"><p><span class="type">guint64</span> <em class="structfield"><code><a name="GIArgument.v-uint64"></a>v_uint64</code></em>;</p></td>
165 <td class="union_member_description"><p>TODO</p></td>
166 <td class="union_member_annotations"> </td>
167 </tr>
168 <tr>
169 <td class="union_member_name"><p><span class="type">gfloat</span> <em class="structfield"><code><a name="GIArgument.v-float"></a>v_float</code></em>;</p></td>
170 <td class="union_member_description"><p>TODO</p></td>
171 <td class="union_member_annotations"> </td>
172 </tr>
173 <tr>
174 <td class="union_member_name"><p><span class="type">gdouble</span> <em class="structfield"><code><a name="GIArgument.v-double"></a>v_double</code></em>;</p></td>
175 <td class="union_member_description"><p>TODO</p></td>
176 <td class="union_member_annotations"> </td>
177 </tr>
178 <tr>
179 <td class="union_member_name"><p><span class="type">gshort</span> <em class="structfield"><code><a name="GIArgument.v-short"></a>v_short</code></em>;</p></td>
180 <td class="union_member_description"><p>TODO</p></td>
181 <td class="union_member_annotations"> </td>
182 </tr>
183 <tr>
184 <td class="union_member_name"><p><span class="type">gushort</span> <em class="structfield"><code><a name="GIArgument.v-ushort"></a>v_ushort</code></em>;</p></td>
185 <td class="union_member_description"><p>TODO</p></td>
186 <td class="union_member_annotations"> </td>
187 </tr>
188 <tr>
189 <td class="union_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GIArgument.v-int"></a>v_int</code></em>;</p></td>
190 <td class="union_member_description"><p>TODO</p></td>
191 <td class="union_member_annotations"> </td>
192 </tr>
193 <tr>
194 <td class="union_member_name"><p><span class="type">guint</span> <em class="structfield"><code><a name="GIArgument.v-uint"></a>v_uint</code></em>;</p></td>
195 <td class="union_member_description"><p>TODO</p></td>
196 <td class="union_member_annotations"> </td>
197 </tr>
198 <tr>
199 <td class="union_member_name"><p><span class="type">glong</span> <em class="structfield"><code><a name="GIArgument.v-long"></a>v_long</code></em>;</p></td>
200 <td class="union_member_description"><p>TODO</p></td>
201 <td class="union_member_annotations"> </td>
202 </tr>
203 <tr>
204 <td class="union_member_name"><p><span class="type">gulong</span> <em class="structfield"><code><a name="GIArgument.v-ulong"></a>v_ulong</code></em>;</p></td>
205 <td class="union_member_description"><p>TODO</p></td>
206 <td class="union_member_annotations"> </td>
207 </tr>
208 <tr>
209 <td class="union_member_name"><p><span class="type">gssize</span> <em class="structfield"><code><a name="GIArgument.v-ssize"></a>v_ssize</code></em>;</p></td>
210 <td class="union_member_description"><p>TODO</p></td>
211 <td class="union_member_annotations"> </td>
212 </tr>
213 <tr>
214 <td class="union_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="GIArgument.v-size"></a>v_size</code></em>;</p></td>
215 <td class="union_member_description"><p>TODO</p></td>
216 <td class="union_member_annotations"> </td>
217 </tr>
218 <tr>
219 <td class="union_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="GIArgument.v-string"></a>v_string</code></em>;</p></td>
220 <td class="union_member_description"><p>TODO</p></td>
221 <td class="union_member_annotations"> </td>
222 </tr>
223 <tr>
224 <td class="union_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="GIArgument.v-pointer"></a>v_pointer</code></em>;</p></td>
225 <td class="union_member_description"><p>TODO</p></td>
226 <td class="union_member_annotations"> </td>
227 </tr>
228 </tbody>
229 </table></div>
230 </div>
231 </div>
232 <hr>
233 <div class="refsect2">
234 <a name="GIUnresolvedInfo"></a><h3>GIUnresolvedInfo</h3>
235 <pre class="programlisting">typedef struct _GIUnresolvedInfo GIUnresolvedInfo;</pre>
236 <p>Represents a unresolved type in a typelib.</p>
237 </div>
238 <hr>
239 <div class="refsect2">
240 <a name="GITypeTag"></a><h3>enum GITypeTag</h3>
241 <p>The type tag of a <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>.</p>
242 <div class="refsect3">
243 <a name="GITypeTag.members"></a><h4>Members</h4>
244 <div class="informaltable"><table class="informaltable" width="100%" border="0">
245 <colgroup>
246 <col width="300px" class="enum_members_name">
247 <col class="enum_members_description">
248 <col width="200px" class="enum_members_annotations">
249 </colgroup>
250 <tbody>
251 <tr>
252 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-VOID:CAPS"></a>GI_TYPE_TAG_VOID</p></td>
253 <td class="enum_member_description">
254 <p>void</p>
255 </td>
256 <td class="enum_member_annotations"> </td>
257 </tr>
258 <tr>
259 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-BOOLEAN:CAPS"></a>GI_TYPE_TAG_BOOLEAN</p></td>
260 <td class="enum_member_description">
261 <p>boolean</p>
262 </td>
263 <td class="enum_member_annotations"> </td>
264 </tr>
265 <tr>
266 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-INT8:CAPS"></a>GI_TYPE_TAG_INT8</p></td>
267 <td class="enum_member_description">
268 <p>8-bit signed integer</p>
269 </td>
270 <td class="enum_member_annotations"> </td>
271 </tr>
272 <tr>
273 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-UINT8:CAPS"></a>GI_TYPE_TAG_UINT8</p></td>
274 <td class="enum_member_description">
275 <p>8-bit unsigned integer</p>
276 </td>
277 <td class="enum_member_annotations"> </td>
278 </tr>
279 <tr>
280 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-INT16:CAPS"></a>GI_TYPE_TAG_INT16</p></td>
281 <td class="enum_member_description">
282 <p>16-bit signed integer</p>
283 </td>
284 <td class="enum_member_annotations"> </td>
285 </tr>
286 <tr>
287 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-UINT16:CAPS"></a>GI_TYPE_TAG_UINT16</p></td>
288 <td class="enum_member_description">
289 <p>16-bit unsigned integer</p>
290 </td>
291 <td class="enum_member_annotations"> </td>
292 </tr>
293 <tr>
294 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-INT32:CAPS"></a>GI_TYPE_TAG_INT32</p></td>
295 <td class="enum_member_description">
296 <p>32-bit signed integer</p>
297 </td>
298 <td class="enum_member_annotations"> </td>
299 </tr>
300 <tr>
301 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-UINT32:CAPS"></a>GI_TYPE_TAG_UINT32</p></td>
302 <td class="enum_member_description">
303 <p>32-bit unsigned integer</p>
304 </td>
305 <td class="enum_member_annotations"> </td>
306 </tr>
307 <tr>
308 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-INT64:CAPS"></a>GI_TYPE_TAG_INT64</p></td>
309 <td class="enum_member_description">
310 <p>64-bit signed integer</p>
311 </td>
312 <td class="enum_member_annotations"> </td>
313 </tr>
314 <tr>
315 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-UINT64:CAPS"></a>GI_TYPE_TAG_UINT64</p></td>
316 <td class="enum_member_description">
317 <p>64-bit unsigned integer</p>
318 </td>
319 <td class="enum_member_annotations"> </td>
320 </tr>
321 <tr>
322 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-FLOAT:CAPS"></a>GI_TYPE_TAG_FLOAT</p></td>
323 <td class="enum_member_description">
324 <p>float</p>
325 </td>
326 <td class="enum_member_annotations"> </td>
327 </tr>
328 <tr>
329 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-DOUBLE:CAPS"></a>GI_TYPE_TAG_DOUBLE</p></td>
330 <td class="enum_member_description">
331 <p>double floating point</p>
332 </td>
333 <td class="enum_member_annotations"> </td>
334 </tr>
335 <tr>
336 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-GTYPE:CAPS"></a>GI_TYPE_TAG_GTYPE</p></td>
337 <td class="enum_member_description">
338 <p>a <span class="type">GType</span></p>
339 </td>
340 <td class="enum_member_annotations"> </td>
341 </tr>
342 <tr>
343 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-UTF8:CAPS"></a>GI_TYPE_TAG_UTF8</p></td>
344 <td class="enum_member_description">
345 <p>a UTF-8 encoded string</p>
346 </td>
347 <td class="enum_member_annotations"> </td>
348 </tr>
349 <tr>
350 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-FILENAME:CAPS"></a>GI_TYPE_TAG_FILENAME</p></td>
351 <td class="enum_member_description">
352 <p>a filename, encoded in the same encoding
353   as the native filesystem is using.</p>
354 </td>
355 <td class="enum_member_annotations"> </td>
356 </tr>
357 <tr>
358 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-ARRAY:CAPS"></a>GI_TYPE_TAG_ARRAY</p></td>
359 <td class="enum_member_description">
360 <p>an array</p>
361 </td>
362 <td class="enum_member_annotations"> </td>
363 </tr>
364 <tr>
365 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-INTERFACE:CAPS"></a>GI_TYPE_TAG_INTERFACE</p></td>
366 <td class="enum_member_description">
367 <p>an extended interface object</p>
368 </td>
369 <td class="enum_member_annotations"> </td>
370 </tr>
371 <tr>
372 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-GLIST:CAPS"></a>GI_TYPE_TAG_GLIST</p></td>
373 <td class="enum_member_description">
374 <p>a <span class="type">GList</span></p>
375 </td>
376 <td class="enum_member_annotations"> </td>
377 </tr>
378 <tr>
379 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-GSLIST:CAPS"></a>GI_TYPE_TAG_GSLIST</p></td>
380 <td class="enum_member_description">
381 <p>a <span class="type">GSList</span></p>
382 </td>
383 <td class="enum_member_annotations"> </td>
384 </tr>
385 <tr>
386 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-GHASH:CAPS"></a>GI_TYPE_TAG_GHASH</p></td>
387 <td class="enum_member_description">
388 <p>a <span class="type">GHashTable</span></p>
389 </td>
390 <td class="enum_member_annotations"> </td>
391 </tr>
392 <tr>
393 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-ERROR:CAPS"></a>GI_TYPE_TAG_ERROR</p></td>
394 <td class="enum_member_description">
395 <p>a <span class="type">GError</span></p>
396 </td>
397 <td class="enum_member_annotations"> </td>
398 </tr>
399 <tr>
400 <td class="enum_member_name"><p><a name="GI-TYPE-TAG-UNICHAR:CAPS"></a>GI_TYPE_TAG_UNICHAR</p></td>
401 <td class="enum_member_description">
402 <p>Unicode character</p>
403 </td>
404 <td class="enum_member_annotations"> </td>
405 </tr>
406 </tbody>
407 </table></div>
408 </div>
409 </div>
410 <hr>
411 <div class="refsect2">
412 <a name="GIArrayType"></a><h3>enum GIArrayType</h3>
413 <p>The type of array in a <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>.</p>
414 <div class="refsect3">
415 <a name="GIArrayType.members"></a><h4>Members</h4>
416 <div class="informaltable"><table class="informaltable" width="100%" border="0">
417 <colgroup>
418 <col width="300px" class="enum_members_name">
419 <col class="enum_members_description">
420 <col width="200px" class="enum_members_annotations">
421 </colgroup>
422 <tbody>
423 <tr>
424 <td class="enum_member_name"><p><a name="GI-ARRAY-TYPE-C:CAPS"></a>GI_ARRAY_TYPE_C</p></td>
425 <td class="enum_member_description">
426 <p>a C array, char[] for instance</p>
427 </td>
428 <td class="enum_member_annotations"> </td>
429 </tr>
430 <tr>
431 <td class="enum_member_name"><p><a name="GI-ARRAY-TYPE-ARRAY:CAPS"></a>GI_ARRAY_TYPE_ARRAY</p></td>
432 <td class="enum_member_description">
433 <p>a <em class="parameter"><code>GArray</code></em>
434  array</p>
435 </td>
436 <td class="enum_member_annotations"> </td>
437 </tr>
438 <tr>
439 <td class="enum_member_name"><p><a name="GI-ARRAY-TYPE-PTR-ARRAY:CAPS"></a>GI_ARRAY_TYPE_PTR_ARRAY</p></td>
440 <td class="enum_member_description">
441 <p>a <span class="type">GPtrArray</span> array</p>
442 </td>
443 <td class="enum_member_annotations"> </td>
444 </tr>
445 <tr>
446 <td class="enum_member_name"><p><a name="GI-ARRAY-TYPE-BYTE-ARRAY:CAPS"></a>GI_ARRAY_TYPE_BYTE_ARRAY</p></td>
447 <td class="enum_member_description">
448 <p>a <span class="type">GByteArray</span> array</p>
449 </td>
450 <td class="enum_member_annotations"> </td>
451 </tr>
452 </tbody>
453 </table></div>
454 </div>
455 </div>
456 <hr>
457 <div class="refsect2">
458 <a name="GI-TYPE-TAG-N-TYPES:CAPS"></a><h3>GI_TYPE_TAG_N_TYPES</h3>
459 <pre class="programlisting">#define GI_TYPE_TAG_N_TYPES (GI_TYPE_TAG_UNICHAR+1)
460 </pre>
461 <p>TODO</p>
462 </div>
463 </div>
464 </div>
465 <div class="footer">
466 <hr>Generated by GTK-Doc V1.25.1</div>
467 </body>
468 </html>