Imported Upstream version 1.41.3
[platform/upstream/gobject-introspection.git] / docs / reference / html / gi-GIPropertyInfo.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>GObject Introspection Reference Manual: GIPropertyInfo</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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-GIFieldInfo.html" title="GIFieldInfo">
10 <link rel="next" href="gi-GITypeInfo.html" title="GITypeInfo">
11 <meta name="generator" content="GTK-Doc V1.20.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-GIPropertyInfo.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-GIFieldInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="gi-GITypeInfo.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-GIPropertyInfo"></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-GIPropertyInfo.top_of_page"></a>GIPropertyInfo</span></h2>
30 <p>GIPropertyInfo — Struct representing a property</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-GIPropertyInfo.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="define_keyword">#define</td>
44 <td class="function_name">
45 <a class="link" href="gi-GIPropertyInfo.html#GI-IS-PROPERTY-INFO:CAPS" title="GI_IS_PROPERTY_INFO()">GI_IS_PROPERTY_INFO</a><span class="c_punctuation">()</span>
46 </td>
47 </tr>
48 <tr>
49 <td class="function_type">
50 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="returnvalue">GParamFlags</span></a>
51 </td>
52 <td class="function_name">
53 <a class="link" href="gi-GIPropertyInfo.html#g-property-info-get-flags" title="g_property_info_get_flags ()">g_property_info_get_flags</a> <span class="c_punctuation">()</span>
54 </td>
55 </tr>
56 <tr>
57 <td class="function_type">
58 <a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="returnvalue">GITransfer</span></a>
59 </td>
60 <td class="function_name">
61 <a class="link" href="gi-GIPropertyInfo.html#g-property-info-get-ownership-transfer" title="g_property_info_get_ownership_transfer ()">g_property_info_get_ownership_transfer</a> <span class="c_punctuation">()</span>
62 </td>
63 </tr>
64 <tr>
65 <td class="function_type">
66 <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> *
67 </td>
68 <td class="function_name">
69 <a class="link" href="gi-GIPropertyInfo.html#g-property-info-get-type" title="g_property_info_get_type ()">g_property_info_get_type</a> <span class="c_punctuation">()</span>
70 </td>
71 </tr>
72 </tbody>
73 </table></div>
74 </div>
75 <div class="refsect1">
76 <a name="gi-GIPropertyInfo.other"></a><h2>Types and Values</h2>
77 <div class="informaltable"><table width="100%" border="0">
78 <colgroup>
79 <col width="150px" class="name">
80 <col class="description">
81 </colgroup>
82 <tbody><tr>
83 <td class="typedef_keyword">typedef</td>
84 <td class="function_name"><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo">GIPropertyInfo</a></td>
85 </tr></tbody>
86 </table></div>
87 </div>
88 <div class="refsect1">
89 <a name="gi-GIPropertyInfo.description"></a><h2>Description</h2>
90 <p>GIPropertyInfo represents a property. A property belongs to
91 either a <a class="link" href="gi-GIObjectInfo.html#GIObjectInfo" title="GIObjectInfo"><span class="type">GIObjectInfo</span></a> or a <a class="link" href="gi-GIInterfaceInfo.html#GIInterfaceInfo" title="GIInterfaceInfo"><span class="type">GIInterfaceInfo</span></a>.</p>
92 <div class="refsect1">
93 <a name="gi-gipropertyinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
94 <pre class="synopsis">
95   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
96    +----GIPropertyInfo
97 </pre>
98 </div>
99 </div>
100 <div class="refsect1">
101 <a name="gi-GIPropertyInfo.functions_details"></a><h2>Functions</h2>
102 <div class="refsect2">
103 <a name="GI-IS-PROPERTY-INFO:CAPS"></a><h3>GI_IS_PROPERTY_INFO()</h3>
104 <pre class="programlisting">#define             GI_IS_PROPERTY_INFO(info)</pre>
105 <p>Checks if <em class="parameter"><code>info</code></em>
106  is a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>.</p>
107 <div class="refsect3">
108 <a name="id-1.4.2.20.6.2.5"></a><h4>Parameters</h4>
109 <div class="informaltable"><table width="100%" border="0">
110 <colgroup>
111 <col width="150px" class="parameters_name">
112 <col class="parameters_description">
113 <col width="200px" class="parameters_annotations">
114 </colgroup>
115 <tbody><tr>
116 <td class="parameter_name"><p>info</p></td>
117 <td class="parameter_description"><p>an info structure</p></td>
118 <td class="parameter_annotations"> </td>
119 </tr></tbody>
120 </table></div>
121 </div>
122 </div>
123 <hr>
124 <div class="refsect2">
125 <a name="g-property-info-get-flags"></a><h3>g_property_info_get_flags ()</h3>
126 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="returnvalue">GParamFlags</span></a>
127 g_property_info_get_flags (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);</pre>
128 <p>Obtain the flags for this property info. See <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> for
129 more information about possible flag values.</p>
130 <div class="refsect3">
131 <a name="id-1.4.2.20.6.3.5"></a><h4>Parameters</h4>
132 <div class="informaltable"><table width="100%" border="0">
133 <colgroup>
134 <col width="150px" class="parameters_name">
135 <col class="parameters_description">
136 <col width="200px" class="parameters_annotations">
137 </colgroup>
138 <tbody><tr>
139 <td class="parameter_name"><p>info</p></td>
140 <td class="parameter_description"><p>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a></p></td>
141 <td class="parameter_annotations"> </td>
142 </tr></tbody>
143 </table></div>
144 </div>
145 <div class="refsect3">
146 <a name="id-1.4.2.20.6.3.6"></a><h4>Returns</h4>
147 <p> the flags</p>
148 <p></p>
149 </div>
150 </div>
151 <hr>
152 <div class="refsect2">
153 <a name="g-property-info-get-ownership-transfer"></a><h3>g_property_info_get_ownership_transfer ()</h3>
154 <pre class="programlisting"><a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="returnvalue">GITransfer</span></a>
155 g_property_info_get_ownership_transfer
156                                (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);</pre>
157 <p>Obtain the ownership transfer for this property. See <a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="type">GITransfer</span></a> for more
158 information about transfer values.</p>
159 <div class="refsect3">
160 <a name="id-1.4.2.20.6.4.5"></a><h4>Parameters</h4>
161 <div class="informaltable"><table width="100%" border="0">
162 <colgroup>
163 <col width="150px" class="parameters_name">
164 <col class="parameters_description">
165 <col width="200px" class="parameters_annotations">
166 </colgroup>
167 <tbody><tr>
168 <td class="parameter_name"><p>info</p></td>
169 <td class="parameter_description"><p>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a></p></td>
170 <td class="parameter_annotations"> </td>
171 </tr></tbody>
172 </table></div>
173 </div>
174 <div class="refsect3">
175 <a name="id-1.4.2.20.6.4.6"></a><h4>Returns</h4>
176 <p> the transfer</p>
177 <p></p>
178 </div>
179 </div>
180 <hr>
181 <div class="refsect2">
182 <a name="g-property-info-get-type"></a><h3>g_property_info_get_type ()</h3>
183 <pre class="programlisting"><a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> *
184 g_property_info_get_type (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);</pre>
185 <p>Obtain the type information for the property <em class="parameter"><code>info</code></em>
186 .</p>
187 <div class="refsect3">
188 <a name="id-1.4.2.20.6.5.5"></a><h4>Parameters</h4>
189 <div class="informaltable"><table width="100%" border="0">
190 <colgroup>
191 <col width="150px" class="parameters_name">
192 <col class="parameters_description">
193 <col width="200px" class="parameters_annotations">
194 </colgroup>
195 <tbody><tr>
196 <td class="parameter_name"><p>info</p></td>
197 <td class="parameter_description"><p>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a></p></td>
198 <td class="parameter_annotations"> </td>
199 </tr></tbody>
200 </table></div>
201 </div>
202 <div class="refsect3">
203 <a name="id-1.4.2.20.6.5.6"></a><h4>Returns</h4>
204 <p> the <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>, free it with
205 <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. </p>
206 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
207 </div>
208 </div>
209 </div>
210 <div class="refsect1">
211 <a name="gi-GIPropertyInfo.other_details"></a><h2>Types and Values</h2>
212 <div class="refsect2">
213 <a name="GIPropertyInfo"></a><h3>GIPropertyInfo</h3>
214 <pre class="programlisting">typedef GIBaseInfo GIPropertyInfo;
215 </pre>
216 <p>Represents a property of a <a class="link" href="gi-GIObjectInfo.html#GIObjectInfo" title="GIObjectInfo"><span class="type">GIObjectInfo</span></a> or a <a class="link" href="gi-GIInterfaceInfo.html#GIInterfaceInfo" title="GIInterfaceInfo"><span class="type">GIInterfaceInfo</span></a>.</p>
217 </div>
218 </div>
219 </div>
220 <div class="footer">
221 <hr>
222           Generated by GTK-Doc V1.20.1</div>
223 </body>
224 </html>