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.19.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="10"><tr valign="middle">
  16 <td width="100%" align="left">
  17 <a href="#" class="shortcut">Top</a>
  18                    |
  19                   <a href="#gi-GIPropertyInfo.description" class="shortcut">Description</a>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="gi-GIFieldInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="gi-GITypeInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="gi-GIPropertyInfo"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="gi-GIPropertyInfo.top_of_page"></a>GIPropertyInfo</span></h2>
  31 <p>GIPropertyInfo — Struct representing a property</p>
  32 </td>
  33 <td valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsynopsisdiv">
  36 <a name="gi-GIPropertyInfo.synopsis"></a><h2>Synopsis</h2>
  37 <pre class="synopsis">#define             <a class="link" href="gi-GIPropertyInfo.html#GI-IS-PROPERTY-INFO:CAPS" title="GI_IS_PROPERTY_INFO()">GI_IS_PROPERTY_INFO</a>                 (info)
  38 typedef             <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo">GIPropertyInfo</a>;
  39 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="returnvalue">GParamFlags</span></a>         <a class="link" href="gi-GIPropertyInfo.html#g-property-info-get-flags" title="g_property_info_get_flags ()">g_property_info_get_flags</a>           (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);
  40 <a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="returnvalue">GITransfer</span></a>          <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>
  41                                                         (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);
  42 <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> *        <a class="link" href="gi-GIPropertyInfo.html#g-property-info-get-type" title="g_property_info_get_type ()">g_property_info_get_type</a>            (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);
  43 </pre>
  44 </div>
  45 <div class="refsect1">
  46 <a name="gi-GIPropertyInfo.description"></a><h2>Description</h2>
  47 <p>
  48 GIPropertyInfo represents a property. A property belongs to
  49 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>.
  50 </p>
  51 <p>
  52 </p>
  53 <div class="refsect1">
  54 <a name="gi-gipropertyinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
  55 <pre class="synopsis">
  56   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
  57    +----GIPropertyInfo
  58 </pre>
  59 </div>
  60 <p>
  61 </p>
  62 </div>
  63 <div class="refsect1">
  64 <a name="gi-GIPropertyInfo.details"></a><h2>Details</h2>
  65 <div class="refsect2">
  66 <a name="GI-IS-PROPERTY-INFO:CAPS"></a><h3>GI_IS_PROPERTY_INFO()</h3>
  67 <pre class="programlisting">#define             GI_IS_PROPERTY_INFO(info)</pre>
  68 <p>
  69 Checks if <em class="parameter"><code>info</code></em> is a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>.
  70 </p>
  71 <div class="variablelist"><table border="0" class="variablelist">
  72 <colgroup>
  73 <col align="left" valign="top">
  74 <col>
  75 </colgroup>
  76 <tbody><tr>
  77 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
  78 <td>an info structure</td>
  79 </tr></tbody>
  80 </table></div>
  81 </div>
  82 <hr>
  83 <div class="refsect2">
  84 <a name="GIPropertyInfo"></a><h3>GIPropertyInfo</h3>
  85 <pre class="programlisting">typedef GIBaseInfo GIPropertyInfo;
  86 </pre>
  87 <p>
  88 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>.
  89 </p>
  90 </div>
  91 <hr>
  92 <div class="refsect2">
  93 <a name="g-property-info-get-flags"></a><h3>g_property_info_get_flags ()</h3>
  94 <pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="returnvalue">GParamFlags</span></a>         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>
  95 <p>
  96 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
  97 more information about possible flag values.
  98 </p>
  99 <div class="variablelist"><table border="0" class="variablelist">
 100 <colgroup>
 101 <col align="left" valign="top">
 102 <col>
 103 </colgroup>
 104 <tbody>
 105 <tr>
 106 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 107 <td>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>
 108 </td>
 109 </tr>
 110 <tr>
 111 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 112 <td>the flags</td>
 113 </tr>
 114 </tbody>
 115 </table></div>
 116 </div>
 117 <hr>
 118 <div class="refsect2">
 119 <a name="g-property-info-get-ownership-transfer"></a><h3>g_property_info_get_ownership_transfer ()</h3>
 120 <pre class="programlisting"><a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="returnvalue">GITransfer</span></a>          g_property_info_get_ownership_transfer
 121                                                         (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);</pre>
 122 <p>
 123 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
 124 information about transfer values.
 125 </p>
 126 <div class="variablelist"><table border="0" class="variablelist">
 127 <colgroup>
 128 <col align="left" valign="top">
 129 <col>
 130 </colgroup>
 131 <tbody>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 134 <td>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>
 135 </td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 139 <td>the transfer</td>
 140 </tr>
 141 </tbody>
 142 </table></div>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="g-property-info-get-type"></a><h3>g_property_info_get_type ()</h3>
 147 <pre class="programlisting"><a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> *        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>
 148 <p>
 149 Obtain the type information for the property <em class="parameter"><code>info</code></em>.
 150 </p>
 151 <div class="variablelist"><table border="0" class="variablelist">
 152 <colgroup>
 153 <col align="left" valign="top">
 154 <col>
 155 </colgroup>
 156 <tbody>
 157 <tr>
 158 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 159 <td>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>
 160 </td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 164 <td>the <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>, free it with
 165 <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>
 166 </td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 </div>
 172 </div>
 173 <div class="footer">
 174 <hr>
 175           Generated by GTK-Doc V1.19.1</div>
 176 </body>
 177 </html>