docs/reference/html/gi-GIRegisteredTypeInfo.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>GIRegisteredTypeInfo: GObject Introspection Reference Manual</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-GIVFuncInfo.html" title="GIVFuncInfo">
  10 <link rel="next" href="gi-GIEnumInfo.html" title="GIEnumInfo">
  11 <meta name="generator" content="GTK-Doc V1.21.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-GIRegisteredTypeInfo.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-GIVFuncInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="gi-GIEnumInfo.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-GIRegisteredTypeInfo"></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-GIRegisteredTypeInfo.top_of_page"></a>GIRegisteredTypeInfo</span></h2>
  30 <p>GIRegisteredTypeInfo — Struct representing a struct with a GType</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-GIRegisteredTypeInfo.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-GIRegisteredTypeInfo.html#GI-IS-REGISTERED-TYPE-INFO:CAPS" title="GI_IS_REGISTERED_TYPE_INFO()">GI_IS_REGISTERED_TYPE_INFO</a><span class="c_punctuation">()</span>
  46 </td>
  47 </tr>
  48 <tr>
  49 <td class="function_type">const <span class="returnvalue">gchar</span> *
  50 </td>
  51 <td class="function_name">
  52 <a class="link" href="gi-GIRegisteredTypeInfo.html#g-registered-type-info-get-type-name" title="g_registered_type_info_get_type_name ()">g_registered_type_info_get_type_name</a> <span class="c_punctuation">()</span>
  53 </td>
  54 </tr>
  55 <tr>
  56 <td class="function_type">const <span class="returnvalue">gchar</span> *
  57 </td>
  58 <td class="function_name">
  59 <a class="link" href="gi-GIRegisteredTypeInfo.html#g-registered-type-info-get-type-init" title="g_registered_type_info_get_type_init ()">g_registered_type_info_get_type_init</a> <span class="c_punctuation">()</span>
  60 </td>
  61 </tr>
  62 <tr>
  63 <td class="function_type">
  64 <span class="returnvalue">GType</span>
  65 </td>
  66 <td class="function_name">
  67 <a class="link" href="gi-GIRegisteredTypeInfo.html#g-registered-type-info-get-g-type" title="g_registered_type_info_get_g_type ()">g_registered_type_info_get_g_type</a> <span class="c_punctuation">()</span>
  68 </td>
  69 </tr>
  70 </tbody>
  71 </table></div>
  72 </div>
  73 <div class="refsect1">
  74 <a name="gi-GIRegisteredTypeInfo.other"></a><h2>Types and Values</h2>
  75 <div class="informaltable"><table width="100%" border="0">
  76 <colgroup>
  77 <col width="150px" class="name">
  78 <col class="description">
  79 </colgroup>
  80 <tbody><tr>
  81 <td class="typedef_keyword">typedef</td>
  82 <td class="function_name"><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo">GIRegisteredTypeInfo</a></td>
  83 </tr></tbody>
  84 </table></div>
  85 </div>
  86 <div class="refsect1">
  87 <a name="gi-GIRegisteredTypeInfo.description"></a><h2>Description</h2>
  88 <p>GIRegisteredTypeInfo represents an entity with a GType associated. Could
  89 be either a <a class="link" href="gi-GIEnumInfo.html#GIEnumInfo" title="GIEnumInfo"><span class="type">GIEnumInfo</span></a>, <a class="link" href="gi-GIInterfaceInfo.html#GIInterfaceInfo" title="GIInterfaceInfo"><span class="type">GIInterfaceInfo</span></a>, <a class="link" href="gi-GIObjectInfo.html#GIObjectInfo" title="GIObjectInfo"><span class="type">GIObjectInfo</span></a>, <a class="link" href="gi-GIStructInfo.html#GIStructInfo" title="GIStructInfo"><span class="type">GIStructInfo</span></a> or a
  90 <a class="link" href="gi-GIUnionInfo.html#GIUnionInfo" title="GIUnionInfo"><span class="type">GIUnionInfo</span></a>.</p>
  91 <p>A registered type info struct has a name and a type function.
  92 To get the name call <a class="link" href="gi-GIRegisteredTypeInfo.html#g-registered-type-info-get-type-name" title="g_registered_type_info_get_type_name ()"><code class="function">g_registered_type_info_get_type_name()</code></a>.
  93 Most users want to call <a class="link" href="gi-GIRegisteredTypeInfo.html#g-registered-type-info-get-g-type" title="g_registered_type_info_get_g_type ()"><code class="function">g_registered_type_info_get_g_type()</code></a> and don't worry
  94 about the rest of the details.</p>
  95 <div class="refsect1">
  96 <a name="gi-giregisteredtypeinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
  97 <pre class="synopsis">
  98   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
  99    +----GIRegisteredTypeInfo
 100          +----<a class="link" href="gi-GIEnumInfo.html" title="GIEnumInfo">GIEnumInfo</a>
 101          +----<a class="link" href="gi-GIInterfaceInfo.html" title="GIInterfaceInfo">GIInterfaceInfo</a>
 102          +----<a class="link" href="gi-GIObjectInfo.html" title="GIObjectInfo">GIObjectInfo</a>
 103          +----<a class="link" href="gi-GIStructInfo.html" title="GIStructInfo">GIStructInfo</a>
 104          +----<a class="link" href="gi-GIUnionInfo.html" title="GIUnionInfo">GIUnionInfo</a>
 105 </pre>
 106 </div>
 107 </div>
 108 <div class="refsect1">
 109 <a name="gi-GIRegisteredTypeInfo.functions_details"></a><h2>Functions</h2>
 110 <div class="refsect2">
 111 <a name="GI-IS-REGISTERED-TYPE-INFO:CAPS"></a><h3>GI_IS_REGISTERED_TYPE_INFO()</h3>
 112 <pre class="programlisting">#define             GI_IS_REGISTERED_TYPE_INFO(info)</pre>
 113 <p>Checks if <em class="parameter"><code>info</code></em>
 114  is a <a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> or derived from it.</p>
 115 <div class="refsect3">
 116 <a name="id-1.4.2.11.6.2.5"></a><h4>Parameters</h4>
 117 <div class="informaltable"><table width="100%" border="0">
 118 <colgroup>
 119 <col width="150px" class="parameters_name">
 120 <col class="parameters_description">
 121 <col width="200px" class="parameters_annotations">
 122 </colgroup>
 123 <tbody><tr>
 124 <td class="parameter_name"><p>info</p></td>
 125 <td class="parameter_description"><p>an info structure</p></td>
 126 <td class="parameter_annotations"> </td>
 127 </tr></tbody>
 128 </table></div>
 129 </div>
 130 </div>
 131 <hr>
 132 <div class="refsect2">
 133 <a name="g-registered-type-info-get-type-name"></a><h3>g_registered_type_info_get_type_name ()</h3>
 134 <pre class="programlisting">const <span class="returnvalue">gchar</span> *
 135 g_registered_type_info_get_type_name (<em class="parameter"><code><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> *info</code></em>);</pre>
 136 <p>Obtain the type name of the struct within the GObject type system.
 137 This type can be passed to <code class="function">g_type_name()</code> to get a <span class="type">GType</span>.</p>
 138 <div class="refsect3">
 139 <a name="id-1.4.2.11.6.3.5"></a><h4>Parameters</h4>
 140 <div class="informaltable"><table width="100%" border="0">
 141 <colgroup>
 142 <col width="150px" class="parameters_name">
 143 <col class="parameters_description">
 144 <col width="200px" class="parameters_annotations">
 145 </colgroup>
 146 <tbody><tr>
 147 <td class="parameter_name"><p>info</p></td>
 148 <td class="parameter_description"><p>a <a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a></p></td>
 149 <td class="parameter_annotations"> </td>
 150 </tr></tbody>
 151 </table></div>
 152 </div>
 153 <div class="refsect3">
 154 <a name="id-1.4.2.11.6.3.6"></a><h4>Returns</h4>
 155 <p> the type name</p>
 156 <p></p>
 157 </div>
 158 </div>
 159 <hr>
 160 <div class="refsect2">
 161 <a name="g-registered-type-info-get-type-init"></a><h3>g_registered_type_info_get_type_init ()</h3>
 162 <pre class="programlisting">const <span class="returnvalue">gchar</span> *
 163 g_registered_type_info_get_type_init (<em class="parameter"><code><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> *info</code></em>);</pre>
 164 <p>Obtain the type init function for <em class="parameter"><code>info</code></em>
 165 . The type init function is the
 166 function which will register the GType within the GObject type system.
 167 Usually this is not called by langauge bindings or applications, use
 168 <a class="link" href="gi-GIRegisteredTypeInfo.html#g-registered-type-info-get-g-type" title="g_registered_type_info_get_g_type ()"><code class="function">g_registered_type_info_get_g_type()</code></a> directly instead.</p>
 169 <div class="refsect3">
 170 <a name="id-1.4.2.11.6.4.5"></a><h4>Parameters</h4>
 171 <div class="informaltable"><table width="100%" border="0">
 172 <colgroup>
 173 <col width="150px" class="parameters_name">
 174 <col class="parameters_description">
 175 <col width="200px" class="parameters_annotations">
 176 </colgroup>
 177 <tbody><tr>
 178 <td class="parameter_name"><p>info</p></td>
 179 <td class="parameter_description"><p>a <a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a></p></td>
 180 <td class="parameter_annotations"> </td>
 181 </tr></tbody>
 182 </table></div>
 183 </div>
 184 <div class="refsect3">
 185 <a name="id-1.4.2.11.6.4.6"></a><h4>Returns</h4>
 186 <p> the symbol name of the type init function, suitable for
 187 passing into <code class="function">g_module_symbol()</code>.</p>
 188 <p></p>
 189 </div>
 190 </div>
 191 <hr>
 192 <div class="refsect2">
 193 <a name="g-registered-type-info-get-g-type"></a><h3>g_registered_type_info_get_g_type ()</h3>
 194 <pre class="programlisting"><span class="returnvalue">GType</span>
 195 g_registered_type_info_get_g_type (<em class="parameter"><code><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> *info</code></em>);</pre>
 196 <p>Obtain the <span class="type">GType</span> for this registered type or G_TYPE_NONE which a special meaning.
 197 It means that either there is no type information associated with this <em class="parameter"><code>info</code></em>
 198  or
 199 that the shared library which provides the type_init function for this
 200 <em class="parameter"><code>info</code></em>
 201  cannot be called.</p>
 202 <div class="refsect3">
 203 <a name="id-1.4.2.11.6.5.5"></a><h4>Parameters</h4>
 204 <div class="informaltable"><table width="100%" border="0">
 205 <colgroup>
 206 <col width="150px" class="parameters_name">
 207 <col class="parameters_description">
 208 <col width="200px" class="parameters_annotations">
 209 </colgroup>
 210 <tbody><tr>
 211 <td class="parameter_name"><p>info</p></td>
 212 <td class="parameter_description"><p>a <a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a></p></td>
 213 <td class="parameter_annotations"> </td>
 214 </tr></tbody>
 215 </table></div>
 216 </div>
 217 <div class="refsect3">
 218 <a name="id-1.4.2.11.6.5.6"></a><h4>Returns</h4>
 219 <p> the <span class="type">GType</span>.</p>
 220 <p></p>
 221 </div>
 222 </div>
 223 </div>
 224 <div class="refsect1">
 225 <a name="gi-GIRegisteredTypeInfo.other_details"></a><h2>Types and Values</h2>
 226 <div class="refsect2">
 227 <a name="GIRegisteredTypeInfo"></a><h3>GIRegisteredTypeInfo</h3>
 228 <pre class="programlisting">typedef GIBaseInfo GIRegisteredTypeInfo;
 229 </pre>
 230 <p>Represent a registered type.</p>
 231 </div>
 232 </div>
 233 </div>
 234 <div class="footer">
 235 <hr>
 236           Generated by GTK-Doc V1.21.1</div>
 237 </body>
 238 </html>