← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gobject-introspection/trusty

« back to all changes in this revision

Viewing changes to docs/reference/html/gi-GIEnumInfo.html

Tags: upstream-0.10.4
Import upstream version 0.10.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/gi-GIEnumInfo.html
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="GObject Introspection Reference Manual">
8
8
<link rel="up" href="gi-repository-structs.html" title="GIRepository structs">
9
 
<link rel="prev" href="gi-gisignalinfo.html" title="gisignalinfo">
10
 
<link rel="next" href="gi-giregisteredtypeinfo.html" title="giregisteredtypeinfo">
11
 
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
 
9
<link rel="prev" href="gi-GISignalInfo.html" title="GISignalInfo">
 
10
<link rel="next" href="gi-GIRegisteredTypeInfo.html" title="GIRegisteredTypeInfo">
 
11
<meta name="generator" content="GTK-Doc V1.16.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
16
<tr valign="middle">
17
 
<td><a accesskey="p" href="gi-gisignalinfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
17
<td><a accesskey="p" href="gi-GISignalInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
18
<td><a accesskey="u" href="gi-repository-structs.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
20
<th width="100%" align="center">GObject Introspection Reference Manual</th>
21
 
<td><a accesskey="n" href="gi-giregisteredtypeinfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
21
<td><a accesskey="n" href="gi-GIRegisteredTypeInfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
22
</tr>
23
23
<tr><td colspan="5" class="shortcuts">
24
24
<a href="#gi-GIEnumInfo.synopsis" class="shortcut">Top</a>
26
26
                  <a href="#gi-GIEnumInfo.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" title="GIEnumInfo">
 
29
<div class="refentry">
30
30
<a name="gi-GIEnumInfo"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv" title="Synopsis">
 
38
<div class="refsynopsisdiv">
39
39
<a name="gi-GIEnumInfo.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis">typedef             <a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo">GIEnumInfo</a>;
 
40
<pre class="synopsis">#define             <a class="link" href="gi-GIEnumInfo.html#GI-IS-ENUM-INFO:CAPS" title="GI_IS_ENUM_INFO()">GI_IS_ENUM_INFO</a>                     (info)
 
41
#define             <a class="link" href="gi-GIEnumInfo.html#GI-IS-VALUE-INFO:CAPS" title="GI_IS_VALUE_INFO()">GI_IS_VALUE_INFO</a>                    (info)
 
42
typedef             <a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo">GIEnumInfo</a>;
41
43
typedef             <a class="link" href="gi-GIEnumInfo.html#GIValueInfo" title="GIValueInfo">GIValueInfo</a>;
42
44
<span class="returnvalue">gint</span>                <a class="link" href="gi-GIEnumInfo.html#g-enum-info-get-n-values" title="g_enum_info_get_n_values ()">g_enum_info_get_n_values</a>            (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo"><span class="type">GIEnumInfo</span></a> *info</code></em>);
43
45
<a class="link" href="gi-GIEnumInfo.html#GIValueInfo" title="GIValueInfo"><span class="returnvalue">GIValueInfo</span></a> *       <a class="link" href="gi-GIEnumInfo.html#g-enum-info-get-value" title="g_enum_info_get_value ()">g_enum_info_get_value</a>               (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo"><span class="type">GIEnumInfo</span></a> *info</code></em>,
44
46
                                                         <em class="parameter"><code><span class="type">gint</span> n</code></em>);
45
47
<a class="link" href="gi-GITypeInfo.html#GITypeTag" title="enum GITypeTag"><span class="returnvalue">GITypeTag</span></a>           <a class="link" href="gi-GIEnumInfo.html#g-enum-info-get-storage-type" title="g_enum_info_get_storage_type ()">g_enum_info_get_storage_type</a>        (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo"><span class="type">GIEnumInfo</span></a> *info</code></em>);
46
 
<span class="returnvalue">glong</span>               <a class="link" href="gi-GIEnumInfo.html#g-value-info-get-value" title="g_value_info_get_value ()">g_value_info_get_value</a>              (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIValueInfo" title="GIValueInfo"><span class="type">GIValueInfo</span></a> *info</code></em>);
 
48
<span class="returnvalue">gint64</span>              <a class="link" href="gi-GIEnumInfo.html#g-value-info-get-value" title="g_value_info_get_value ()">g_value_info_get_value</a>              (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIValueInfo" title="GIValueInfo"><span class="type">GIValueInfo</span></a> *info</code></em>);
47
49
</pre>
48
50
</div>
49
 
<div class="refsect1" title="Description">
 
51
<div class="refsect1">
50
52
<a name="gi-GIEnumInfo.description"></a><h2>Description</h2>
51
53
<p>
52
54
A GIEnumInfo represents an enumeration and a GIValueInfo struct represents a value
53
55
of an enumeration. The GIEnumInfo contains a set of values and a type
54
56
The GIValueInfo is fetched by calling <a class="link" href="gi-GIEnumInfo.html#g-enum-info-get-value" title="g_enum_info_get_value ()"><code class="function">g_enum_info_get_value()</code></a> on a <a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo"><span class="type">GIEnumInfo</span></a>.
55
57
</p>
56
 
</div>
57
 
<div class="refsect1" title="Details">
 
58
<p>
 
59
</p>
 
60
<div class="refsect1">
 
61
<a name="gi-gienuminfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
 
62
<pre class="synopsis">
 
63
  <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
 
64
   +----<a class="link" href="gi-GIRegisteredTypeInfo.html" title="GIRegisteredTypeInfo">GIRegisteredTypeInfo</a>
 
65
         +----GIEnumInfo
 
66
</pre>
 
67
</div>
 
68
<p>
 
69
</p>
 
70
</div>
 
71
<div class="refsect1">
58
72
<a name="gi-GIEnumInfo.details"></a><h2>Details</h2>
59
 
<div class="refsect2" title="GIEnumInfo">
 
73
<div class="refsect2">
 
74
<a name="GI-IS-ENUM-INFO:CAPS"></a><h3>GI_IS_ENUM_INFO()</h3>
 
75
<pre class="programlisting">#define             GI_IS_ENUM_INFO(info)</pre>
 
76
<p>
 
77
</p>
 
78
</div>
 
79
<hr>
 
80
<div class="refsect2">
 
81
<a name="GI-IS-VALUE-INFO:CAPS"></a><h3>GI_IS_VALUE_INFO()</h3>
 
82
<pre class="programlisting">#define             GI_IS_VALUE_INFO(info)</pre>
 
83
<p>
 
84
</p>
 
85
</div>
 
86
<hr>
 
87
<div class="refsect2">
60
88
<a name="GIEnumInfo"></a><h3>GIEnumInfo</h3>
61
89
<pre class="programlisting">typedef GIBaseInfo GIEnumInfo;
62
90
</pre>
65
93
</p>
66
94
</div>
67
95
<hr>
68
 
<div class="refsect2" title="GIValueInfo">
 
96
<div class="refsect2">
69
97
<a name="GIValueInfo"></a><h3>GIValueInfo</h3>
70
98
<pre class="programlisting">typedef GIBaseInfo GIValueInfo;
71
99
</pre>
74
102
</p>
75
103
</div>
76
104
<hr>
77
 
<div class="refsect2" title="g_enum_info_get_n_values ()">
 
105
<div class="refsect2">
78
106
<a name="g-enum-info-get-n-values"></a><h3>g_enum_info_get_n_values ()</h3>
79
107
<pre class="programlisting"><span class="returnvalue">gint</span>                g_enum_info_get_n_values            (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo"><span class="type">GIEnumInfo</span></a> *info</code></em>);</pre>
80
108
<p>
90
118
</tr>
91
119
<tr>
92
120
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
93
 
<td> the number of enumeration values
94
 
</td>
 
121
<td>the number of enumeration values</td>
95
122
</tr>
96
123
</tbody>
97
124
</table></div>
98
125
</div>
99
126
<hr>
100
 
<div class="refsect2" title="g_enum_info_get_value ()">
 
127
<div class="refsect2">
101
128
<a name="g-enum-info-get-value"></a><h3>g_enum_info_get_value ()</h3>
102
129
<pre class="programlisting"><a class="link" href="gi-GIEnumInfo.html#GIValueInfo" title="GIValueInfo"><span class="returnvalue">GIValueInfo</span></a> *       g_enum_info_get_value               (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo"><span class="type">GIEnumInfo</span></a> *info</code></em>,
103
130
                                                         <em class="parameter"><code><span class="type">gint</span> n</code></em>);</pre>
114
141
</tr>
115
142
<tr>
116
143
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
117
 
<td>index of value to fetch
118
 
</td>
 
144
<td>index of value to fetch</td>
119
145
</tr>
120
146
<tr>
121
147
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
122
 
<td> the enumeration value or <code class="literal">NULL</code> if type tag is wrong,
123
 
free the struct with <a class="link" href="gi-GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done.. <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>. </td>
 
148
<td>the enumeration value or <code class="literal">NULL</code> if type tag is wrong,
 
149
free the struct with <a class="link" href="gi-GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
150
</td>
124
151
</tr>
125
152
</tbody>
126
153
</table></div>
127
154
</div>
128
155
<hr>
129
 
<div class="refsect2" title="g_enum_info_get_storage_type ()">
 
156
<div class="refsect2">
130
157
<a name="g-enum-info-get-storage-type"></a><h3>g_enum_info_get_storage_type ()</h3>
131
158
<pre class="programlisting"><a class="link" href="gi-GITypeInfo.html#GITypeTag" title="enum GITypeTag"><span class="returnvalue">GITypeTag</span></a>           g_enum_info_get_storage_type        (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo"><span class="type">GIEnumInfo</span></a> *info</code></em>);</pre>
132
159
<p>
148
175
</tr>
149
176
<tr>
150
177
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
151
 
<td> the storage type for the enumeration
152
 
</td>
 
178
<td>the storage type for the enumeration</td>
153
179
</tr>
154
180
</tbody>
155
181
</table></div>
156
182
</div>
157
183
<hr>
158
 
<div class="refsect2" title="g_value_info_get_value ()">
 
184
<div class="refsect2">
159
185
<a name="g-value-info-get-value"></a><h3>g_value_info_get_value ()</h3>
160
 
<pre class="programlisting"><span class="returnvalue">glong</span>               g_value_info_get_value              (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIValueInfo" title="GIValueInfo"><span class="type">GIValueInfo</span></a> *info</code></em>);</pre>
 
186
<pre class="programlisting"><span class="returnvalue">gint64</span>              g_value_info_get_value              (<em class="parameter"><code><a class="link" href="gi-GIEnumInfo.html#GIValueInfo" title="GIValueInfo"><span class="type">GIValueInfo</span></a> *info</code></em>);</pre>
161
187
<p>
162
188
Obtain the enumeration value of the <a class="link" href="gi-GIEnumInfo.html#GIValueInfo" title="GIValueInfo"><span class="type">GIValueInfo</span></a>.
163
189
</p>
171
197
</tr>
172
198
<tr>
173
199
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
174
 
<td> the enumeration value
175
 
</td>
 
200
<td>the enumeration value. This will always be representable
 
201
as a 32-bit signed or unsigned value. The use of gint64 as the
 
202
return type is to allow both.</td>
176
203
</tr>
177
204
</tbody>
178
205
</table></div>
181
208
</div>
182
209
<div class="footer">
183
210
<hr>
184
 
          Generated by GTK-Doc V1.14</div>
 
211
          Generated by GTK-Doc V1.16.1</div>
185
212
</body>
186
213
</html>
 
 
b'\\ No newline at end of file'