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>GIPropertyInfo</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GObject Introspection Reference Manual">
   8 <link rel="up" href="gi-repository-structs.html" title="GIRepository structs">
   9 <link rel="prev" href="gi-GIFieldInfo.html" title="GIFieldInfo">
  10 <link rel="next" href="gi-GIVFuncInfo.html" title="GIVFuncInfo">
  11 <meta name="generator" content="GTK-Doc V1.18.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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gi-GIFieldInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  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 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GObject Introspection Reference Manual</th>
  21 <td><a accesskey="n" href="gi-GIVFuncInfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gi-GIPropertyInfo.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gi-GIPropertyInfo.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gi-GIPropertyInfo"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gi-GIPropertyInfo.top_of_page"></a>GIPropertyInfo</span></h2>
  34 <p>GIPropertyInfo — Struct representing a property</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gi-GIPropertyInfo.synopsis"></a><h2>Synopsis</h2>
  40 <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)
  41 typedef             <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo">GIPropertyInfo</a>;
  42 <span class="returnvalue">GParamFlags</span>         <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>);
  43 <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>);
  44 <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>
  45                                                         (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);
  46 </pre>
  47 </div>
  48 <div class="refsect1">
  49 <a name="gi-GIPropertyInfo.description"></a><h2>Description</h2>
  50 <p>
  51 GIPropertyInfo represents a property. A property belongs to
  52 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>.
  53 </p>
  54 <p>
  55 </p>
  56 <div class="refsect1">
  57 <a name="gi-gipropertyinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
  58 <pre class="synopsis">
  59   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
  60    +----GIPropertyInfo
  61 </pre>
  62 </div>
  63 <p>
  64 </p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gi-GIPropertyInfo.details"></a><h2>Details</h2>
  68 <div class="refsect2">
  69 <a name="GI-IS-PROPERTY-INFO:CAPS"></a><h3>GI_IS_PROPERTY_INFO()</h3>
  70 <pre class="programlisting">#define             GI_IS_PROPERTY_INFO(info)</pre>
  71 </div>
  72 <hr>
  73 <div class="refsect2">
  74 <a name="GIPropertyInfo"></a><h3>GIPropertyInfo</h3>
  75 <pre class="programlisting">typedef GIBaseInfo GIPropertyInfo;
  76 </pre>
  77 <p>
  78 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>.
  79 </p>
  80 </div>
  81 <hr>
  82 <div class="refsect2">
  83 <a name="g-property-info-get-flags"></a><h3>g_property_info_get_flags ()</h3>
  84 <pre class="programlisting"><span class="returnvalue">GParamFlags</span>         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>
  85 <p>
  86 Obtain the flags for this property info. See <span class="type">GParamFags</span> for
  87 more information about possible flag values.
  88 </p>
  89 <div class="variablelist"><table border="0">
  90 <col align="left" valign="top">
  91 <tbody>
  92 <tr>
  93 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
  94 <td>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>
  95 </td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  99 <td>the flags</td>
 100 </tr>
 101 </tbody>
 102 </table></div>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="g-property-info-get-type"></a><h3>g_property_info_get_type ()</h3>
 107 <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>
 108 <p>
 109 Obtain the type information for the property <em class="parameter"><code>info</code></em>.
 110 </p>
 111 <div class="variablelist"><table border="0">
 112 <col align="left" valign="top">
 113 <tbody>
 114 <tr>
 115 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 116 <td>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>
 117 </td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 121 <td>the <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>, free it with
 122 <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>
 123 </td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 </div>
 128 <hr>
 129 <div class="refsect2">
 130 <a name="g-property-info-get-ownership-transfer"></a><h3>g_property_info_get_ownership_transfer ()</h3>
 131 <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
 132                                                         (<em class="parameter"><code><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a> *info</code></em>);</pre>
 133 <p>
 134 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
 135 information about transfer values.
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 142 <td>a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>
 143 </td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 147 <td>the transfer</td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </div>
 152 </div>
 153 </div>
 154 <div class="footer">
 155 <hr>
 156           Generated by GTK-Doc V1.18.1</div>
 157 </body>
 158 </html>