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</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-GIEnumInfo.html" title="GIEnumInfo">
  10 <link rel="next" href="gi-GIObjectInfo.html" title="GIObjectInfo">
  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-GIEnumInfo.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-GIObjectInfo.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-GIRegisteredTypeInfo.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gi-GIRegisteredTypeInfo.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gi-GIRegisteredTypeInfo"></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-GIRegisteredTypeInfo.top_of_page"></a>GIRegisteredTypeInfo</span></h2>
  34 <p>GIRegisteredTypeInfo — Struct representing a struct with a GType</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gi-GIRegisteredTypeInfo.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">#define             <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>          (info)
  41 typedef             <a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo">GIRegisteredTypeInfo</a>;
  42 const <span class="returnvalue">gchar</span> *       <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>
  43                                                         (<em class="parameter"><code><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> *info</code></em>);
  44 const <span class="returnvalue">gchar</span> *       <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>
  45                                                         (<em class="parameter"><code><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> *info</code></em>);
  46 <span class="returnvalue">GType</span>               <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>   (<em class="parameter"><code><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> *info</code></em>);
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gi-GIRegisteredTypeInfo.description"></a><h2>Description</h2>
  51 <p>
  52 GIRegisteredTypeInfo represents an entity with a GType associated. Could
  53 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
  54 <a class="link" href="gi-GIUnionInfo.html#GIUnionInfo" title="GIUnionInfo"><span class="type">GIUnionInfo</span></a>.
  55 </p>
  56 <p>
  57 A registered type info struct has a name and a type function.
  58 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>.
  59 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
  60 about the rest of the details.
  61 </p>
  62 <p>
  63 </p>
  64 <div class="refsect1">
  65 <a name="gi-giregisteredtypeinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
  66 <pre class="synopsis">
  67   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
  68    +----GIRegisteredTypeInfo
  69          +----<a class="link" href="gi-GIEnumInfo.html" title="GIEnumInfo">GIEnumInfo</a>
  70          +----<a class="link" href="gi-GIInterfaceInfo.html" title="GIInterfaceInfo">GIInterfaceInfo</a>
  71          +----<a class="link" href="gi-GIObjectInfo.html" title="GIObjectInfo">GIObjectInfo</a>
  72          +----<a class="link" href="gi-GIStructInfo.html" title="GIStructInfo">GIStructInfo</a>
  73          +----<a class="link" href="gi-GIUnionInfo.html" title="GIUnionInfo">GIUnionInfo</a>
  74 </pre>
  75 </div>
  76 <p>
  77 </p>
  78 </div>
  79 <div class="refsect1">
  80 <a name="gi-GIRegisteredTypeInfo.details"></a><h2>Details</h2>
  81 <div class="refsect2">
  82 <a name="GI-IS-REGISTERED-TYPE-INFO:CAPS"></a><h3>GI_IS_REGISTERED_TYPE_INFO()</h3>
  83 <pre class="programlisting">#define             GI_IS_REGISTERED_TYPE_INFO(info)</pre>
  84 </div>
  85 <hr>
  86 <div class="refsect2">
  87 <a name="GIRegisteredTypeInfo"></a><h3>GIRegisteredTypeInfo</h3>
  88 <pre class="programlisting">typedef GIBaseInfo GIRegisteredTypeInfo;
  89 </pre>
  90 <p>
  91 Represent a registered type.
  92 </p>
  93 </div>
  94 <hr>
  95 <div class="refsect2">
  96 <a name="g-registered-type-info-get-type-name"></a><h3>g_registered_type_info_get_type_name ()</h3>
  97 <pre class="programlisting">const <span class="returnvalue">gchar</span> *       g_registered_type_info_get_type_name
  98                                                         (<em class="parameter"><code><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> *info</code></em>);</pre>
  99 <p>
 100 Obtain the type name of the struct within the GObject type system.
 101 This type can be passed to <code class="function">g_type_name()</code> to get a <span class="type">GType</span>.
 102 </p>
 103 <div class="variablelist"><table border="0">
 104 <col align="left" valign="top">
 105 <tbody>
 106 <tr>
 107 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 108 <td>a <a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a>
 109 </td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 113 <td>the type name</td>
 114 </tr>
 115 </tbody>
 116 </table></div>
 117 </div>
 118 <hr>
 119 <div class="refsect2">
 120 <a name="g-registered-type-info-get-type-init"></a><h3>g_registered_type_info_get_type_init ()</h3>
 121 <pre class="programlisting">const <span class="returnvalue">gchar</span> *       g_registered_type_info_get_type_init
 122                                                         (<em class="parameter"><code><a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a> *info</code></em>);</pre>
 123 <p>
 124 Obtain the type init function for <em class="parameter"><code>info</code></em>. The type init function is the
 125 function which will register the GType within the GObject type system.
 126 Usually this is not called by langauge bindings or applications, use
 127 <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.
 128 </p>
 129 <div class="variablelist"><table border="0">
 130 <col align="left" valign="top">
 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-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</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 symbol name of the type init function, suitable for
 140 passing into <code class="function">g_module_symbol()</code>.</td>
 141 </tr>
 142 </tbody>
 143 </table></div>
 144 </div>
 145 <hr>
 146 <div class="refsect2">
 147 <a name="g-registered-type-info-get-g-type"></a><h3>g_registered_type_info_get_g_type ()</h3>
 148 <pre class="programlisting"><span class="returnvalue">GType</span>               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>
 149 <p>
 150 Obtain the <span class="type">GType</span> for this registered type or G_TYPE_NONE which a special meaning.
 151 It means that either there is no type information associated with this <em class="parameter"><code>info</code></em> or
 152 that the shared library which provides the type_init function for this
 153 <em class="parameter"><code>info</code></em> cannot be called.
 154 </p>
 155 <div class="variablelist"><table border="0">
 156 <col align="left" valign="top">
 157 <tbody>
 158 <tr>
 159 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 160 <td>a <a class="link" href="gi-GIRegisteredTypeInfo.html#GIRegisteredTypeInfo" title="GIRegisteredTypeInfo"><span class="type">GIRegisteredTypeInfo</span></a>
 161 </td>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 165 <td>the <span class="type">GType</span>.</td>
 166 </tr>
 167 </tbody>
 168 </table></div>
 169 </div>
 170 </div>
 171 </div>
 172 <div class="footer">
 173 <hr>
 174           Generated by GTK-Doc V1.18.1</div>
 175 </body>
 176 </html>