/usr/share/gtk-doc/html/libpeas/PeasObjectModule.html is in libpeas-doc 1.8.1-2ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Peas Reference Manual: PeasObjectModule</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Peas Reference Manual">
<link rel="up" href="ch01.html" title="Core Classes">
<link rel="prev" href="PeasExtensionBase.html" title="PeasExtensionBase">
<link rel="next" href="ch02.html" title="Gtk+ Widgets">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#PeasObjectModule.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#PeasObjectModule.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#PeasObjectModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#PeasObjectModule.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="PeasExtensionBase.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="PeasObjectModule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PeasObjectModule.top_of_page"></a>PeasObjectModule</span></h2>
<p>PeasObjectModule — Type module which allows extension registration.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="PeasObjectModule.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GObject</span> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="PeasObjectModule.html#PeasFactoryFunc" title="PeasFactoryFunc ()">*PeasFactoryFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="PeasObjectModule.html#peas-object-module-register-extension-factory" title="peas_object_module_register_extension_factory ()">peas_object_module_register_extension_factory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="PeasObjectModule.html#peas-object-module-register-extension-type" title="peas_object_module_register_extension_type ()">peas_object_module_register_extension_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasObjectModule.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PeasObjectModule.html#PeasObjectModule--module-name" title="The “module-name” property">module-name</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="PeasObjectModule.html#PeasObjectModule--path" title="The “path” property">path</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="PeasObjectModule.html#PeasObjectModule--resident" title="The “resident” property">resident</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasObjectModule.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="PeasObjectModule.html#PeasObjectModule-struct" title="struct PeasObjectModule">PeasObjectModule</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="PeasObjectModule.html#PeasObjectModuleClass" title="struct PeasObjectModuleClass">PeasObjectModuleClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasObjectModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GTypeModule
<span class="lineart">╰──</span> PeasObjectModule
</pre>
</div>
<div class="refsect1">
<a name="PeasObjectModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
PeasObjectModule implements
GTypePlugin.</p>
</div>
<div class="refsect1">
<a name="PeasObjectModule.description"></a><h2>Description</h2>
<p><a class="link" href="PeasObjectModule.html" title="PeasObjectModule"><span class="type">PeasObjectModule</span></a> is a subclass of <span class="type">GTypeModule</span> which allows registration
of extensions. It will be used by C extensions implementors to register
extension implementations from within the peas_register_types module
function.</p>
</div>
<div class="refsect1">
<a name="PeasObjectModule.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="PeasFactoryFunc"></a><h3>PeasFactoryFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">GObject</span> *
<span class="c_punctuation">(</span>*PeasFactoryFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">guint</span> n_parameters</code></em>,
<em class="parameter"><code><span class="type">GParameter</span> *parameters</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>A <a class="link" href="PeasObjectModule.html#PeasFactoryFunc" title="PeasFactoryFunc ()"><span class="type">PeasFactoryFunc</span></a> is a factory function which will instanciate a new
extension of a given type. <code class="function">g_object_newv()</code> is such a function.</p>
<p>It is used with <a class="link" href="PeasObjectModule.html#peas-object-module-register-extension-factory" title="peas_object_module_register_extension_factory ()"><code class="function">peas_object_module_register_extension_factory()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.7.9.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>n_parameters</p></td>
<td class="parameter_description"><p>The number of paramteters.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parameters</p></td>
<td class="parameter_description"><p> The parameters. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_parameters]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Optional data to be passed to the function, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.7.9.2.7"></a><h4>Returns</h4>
<p> The created object. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="peas-object-module-register-extension-factory"></a><h3>peas_object_module_register_extension_factory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
peas_object_module_register_extension_factory
(<em class="parameter"><code><a class="link" href="PeasObjectModule.html" title="PeasObjectModule"><span class="type">PeasObjectModule</span></a> *module</code></em>,
<em class="parameter"><code><span class="type">GType</span> iface_type</code></em>,
<em class="parameter"><code><a class="link" href="PeasObjectModule.html#PeasFactoryFunc" title="PeasFactoryFunc ()"><span class="type">PeasFactoryFunc</span></a> factory_func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy_func</code></em>);</pre>
<p>Register an implementation for an extension type through a factory
function <em class="parameter"><code>factory_func</code></em>
which will instantiate the extension when
requested.</p>
<p>This method is primarily meant to be used by native bindings (like gtkmm),
creating native types which cannot be instantiated correctly using
<code class="function">g_object_new()</code>. For other uses, you will usually prefer relying on
<a class="link" href="PeasObjectModule.html#peas-object-module-register-extension-type" title="peas_object_module_register_extension_type ()"><code class="function">peas_object_module_register_extension_type()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.7.9.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>module</p></td>
<td class="parameter_description"><p>Your plugin's <a class="link" href="PeasObjectModule.html" title="PeasObjectModule"><span class="type">PeasObjectModule</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iface_type</p></td>
<td class="parameter_description"><p>The <span class="type">GType</span> of the extension interface you implement.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>factory_func</p></td>
<td class="parameter_description"><p>The <a class="link" href="PeasObjectModule.html#PeasFactoryFunc" title="PeasFactoryFunc ()"><span class="type">PeasFactoryFunc</span></a> that will create the <em class="parameter"><code>iface_type</code></em>
instance when requested.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Data to pass to <em class="parameter"><code>func</code></em>
calls.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_func</p></td>
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span> for <em class="parameter"><code>user_data</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="peas-object-module-register-extension-type"></a><h3>peas_object_module_register_extension_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
peas_object_module_register_extension_type
(<em class="parameter"><code><a class="link" href="PeasObjectModule.html" title="PeasObjectModule"><span class="type">PeasObjectModule</span></a> *module</code></em>,
<em class="parameter"><code><span class="type">GType</span> iface_type</code></em>,
<em class="parameter"><code><span class="type">GType</span> extension_type</code></em>);</pre>
<p>Register an extension type which implements the extension interface
<em class="parameter"><code>iface_type</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.2.7.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>module</p></td>
<td class="parameter_description"><p>Your plugin's <a class="link" href="PeasObjectModule.html" title="PeasObjectModule"><span class="type">PeasObjectModule</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iface_type</p></td>
<td class="parameter_description"><p>The <span class="type">GType</span> of the extension interface you implement.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extension_type</p></td>
<td class="parameter_description"><p>The <span class="type">GType</span> of your implementation of <em class="parameter"><code>iface_type</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="PeasObjectModule.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="PeasObjectModule-struct"></a><h3>struct PeasObjectModule</h3>
<pre class="programlisting">struct PeasObjectModule;</pre>
<p>The <a class="link" href="PeasObjectModule.html" title="PeasObjectModule"><span class="type">PeasObjectModule</span></a> structure contains only private data and should only
be accessed using the provided API.</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasObjectModuleClass"></a><h3>struct PeasObjectModuleClass</h3>
<pre class="programlisting">struct PeasObjectModuleClass {
GTypeModuleClass parent_class;
};
</pre>
<p>The class structure for <a class="link" href="PeasObjectModule.html" title="PeasObjectModule"><span class="type">PeasObjectModule</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.2.7.10.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">GTypeModuleClass</span> <em class="structfield"><code><a name="PeasObjectModuleClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>The parent class.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="PeasObjectModule.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="PeasObjectModule--module-name"></a><h3>The <code class="literal">“module-name”</code> property</h3>
<pre class="programlisting"> “module-name” <span class="type">gchar</span> *</pre>
<p>The module to load for this object.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasObjectModule--path"></a><h3>The <code class="literal">“path”</code> property</h3>
<pre class="programlisting"> “path” <span class="type">gchar</span> *</pre>
<p>The path to use when loading this module.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasObjectModule--resident"></a><h3>The <code class="literal">“resident”</code> property</h3>
<pre class="programlisting"> “resident” <span class="type">gboolean</span></pre>
<p>Whether the module is resident.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|