/usr/share/gtk-doc/html/libpeas/libpeas-PeasExtension.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 | <!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: PeasExtension</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="PeasPluginInfo.html" title="PeasPluginInfo">
<link rel="next" href="PeasExtensionSet.html" title="PeasExtensionSet">
<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="#libpeas-PeasExtension.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libpeas-PeasExtension.object-hierarchy" class="shortcut">Object Hierarchy</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="PeasPluginInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="PeasExtensionSet.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libpeas-PeasExtension"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libpeas-PeasExtension.top_of_page"></a>PeasExtension</span></h2>
<p>PeasExtension — Proxy for extensions.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libpeas-PeasExtension.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">GType</span>
</td>
<td class="function_name">
<a class="link" href="libpeas-PeasExtension.html#peas-extension-get-extension-type" title="peas_extension_get_extension_type ()">peas_extension_get_extension_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libpeas-PeasExtension.html#peas-extension-call" title="peas_extension_call ()">peas_extension_call</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libpeas-PeasExtension.html#peas-extension-call-valist" title="peas_extension_call_valist ()">peas_extension_call_valist</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libpeas-PeasExtension.html#peas-extension-callv" title="peas_extension_callv ()">peas_extension_callv</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libpeas-PeasExtension.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="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libpeas-PeasExtension.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="libpeas-PeasExtension.description"></a><h2>Description</h2>
<p><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a> is a proxy class used to access actual extensions
implemented using various languages. As such, the application writer will
use <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a> instances to call methods on extension provided by
loaded plugins.</p>
<p>To properly use the proxy instances, you will need GObject-introspection
data for the <span class="type">GInterface</span> or <span class="type">GObjectClass</span> you want to use as an extension
point. For instance, if you wish to use <a class="link" href="PeasActivatable.html" title="PeasActivatable"><span class="type">PeasActivatable</span></a>, you will need to
put the following code excerpt in the engine initialization code, in order
to load the required "Peas" typelib:</p>
<div class="informalexample"><pre class="programlisting">
g_irepository_require (g_irepository_get_default (),
"Peas", "1.0", 0, NULL);
</pre></div>
<p></p>
<p>You should proceed the same way for any namespace which provides interfaces
you want to use as extension points. GObject-introspection data is required
for all the supported languages, even for C.</p>
<p><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a> does not provide any way to access the underlying object.
The main reason is that some loaders may not rely on proper GObject
inheritance for the definition of extensions, and hence it would not be
possible for libpeas to provide a functional GObject instance at all.
Another reason is that it makes reference counting issues easier to deal
with.</p>
<p>See <a class="link" href="libpeas-PeasExtension.html#peas-extension-call" title="peas_extension_call ()"><code class="function">peas_extension_call()</code></a> for more information.</p>
</div>
<div class="refsect1">
<a name="libpeas-PeasExtension.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="peas-extension-get-extension-type"></a><h3>peas_extension_get_extension_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
peas_extension_get_extension_type (<em class="parameter"><code><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a> *exten</code></em>);</pre>
<div class="warning"><p><code class="literal">peas_extension_get_extension_type</code> has been deprecated since version 1.2. and should not be used in newly-written code.</p></div>
<p>Get the type of the extension interface of the object proxied by <em class="parameter"><code>exten</code></em>
.</p>
<div class="refsect3">
<a name="id-1.2.2.4.7.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>exten</p></td>
<td class="parameter_description"><p>A <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.4.7.2.7"></a><h4>Returns</h4>
<p> The <span class="type">GType</span> proxied by <em class="parameter"><code>exten</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="peas-extension-call"></a><h3>peas_extension_call ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
peas_extension_call (<em class="parameter"><code><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a> *exten</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *method_name</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">peas_extension_call</code> has been deprecated since version 1.2 and should not be used in newly-written code.</p>
<p>Use the dynamically implemented interface instead.</p>
</div>
<p>Call a method of the object behind <em class="parameter"><code>extension</code></em>
.</p>
<p>The arguments provided to this functions should be of the same type as
those defined in the <span class="type">GInterface</span> or <span class="type">GObjectClass</span> used as a base for the
proxied extension. They should be provided in the same order, and if its
return type is not void, then a pointer to a variable of that type should
be passed as the last argument.</p>
<p>For instance, if the method prototype is:</p>
<div class="informalexample"><pre class="programlisting">
you should call peas_extension_call() this way:
|[ peas_extension_call (extension, "my_method", "some_str", obj, &gint_var); ]|
This function will not do anything if the introspection data for the proxied
object's class has not been loaded previously through g_irepository_require().
</pre></div>
<div class="refsect3">
<a name="id-1.2.2.4.7.3.9"></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>exten</p></td>
<td class="parameter_description"><p>A <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method_name</p></td>
<td class="parameter_description"><p>the name of the method that should be called.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>arguments for the method.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.4.7.3.10"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on successful call.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="peas-extension-call-valist"></a><h3>peas_extension_call_valist ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
peas_extension_call_valist (<em class="parameter"><code><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a> *exten</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *method_name</code></em>,
<em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
<div class="warning">
<p><code class="literal">peas_extension_call_valist</code> has been deprecated since version 1.2 and should not be used in newly-written code.</p>
<p>Use the dynamically implemented interface instead.</p>
</div>
<p>Call a method of the object behind <em class="parameter"><code>extension</code></em>
, using <em class="parameter"><code>args</code></em>
as arguments.</p>
<p>See <a class="link" href="libpeas-PeasExtension.html#peas-extension-call" title="peas_extension_call ()"><code class="function">peas_extension_call()</code></a> for more information.</p>
<div class="refsect3">
<a name="id-1.2.2.4.7.4.7"></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>exten</p></td>
<td class="parameter_description"><p>A <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method_name</p></td>
<td class="parameter_description"><p>the name of the method that should be called.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>args</p></td>
<td class="parameter_description"><p>the arguments for the method.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.4.7.4.8"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on successful call.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="peas-extension-callv"></a><h3>peas_extension_callv ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
peas_extension_callv (<em class="parameter"><code><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a> *exten</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *method_name</code></em>,
<em class="parameter"><code><span class="type">GIArgument</span> *args</code></em>,
<em class="parameter"><code><span class="type">GIArgument</span> *return_value</code></em>);</pre>
<div class="warning">
<p><code class="literal">peas_extension_callv</code> has been deprecated since version 1.2 and should not be used in newly-written code.</p>
<p>Use the dynamically implemented interface instead.</p>
</div>
<p>Call a method of the object behind <em class="parameter"><code>extension</code></em>
, using <em class="parameter"><code>args</code></em>
as arguments.</p>
<p>See <a class="link" href="libpeas-PeasExtension.html#peas-extension-call" title="peas_extension_call ()"><code class="function">peas_extension_call()</code></a> for more information.</p>
<div class="refsect3">
<a name="id-1.2.2.4.7.5.7"></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>exten</p></td>
<td class="parameter_description"><p>A <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method_name</p></td>
<td class="parameter_description"><p>the name of the method that should be called.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>args</p></td>
<td class="parameter_description"><p>the arguments for the method.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>return_value</p></td>
<td class="parameter_description"><p>the return falue for the method.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.4.7.5.8"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on successful call.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libpeas-PeasExtension.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="PeasExtension"></a><h3>PeasExtension</h3>
<pre class="programlisting">typedef GObject PeasExtension;
</pre>
<p>A proxy class to access the actual plugin.</p>
</div>
</div>
<div class="refsect1">
<a name="libpeas-PeasExtension.see-also"></a><h2>See Also</h2>
<p><a class="link" href="PeasExtensionSet.html" title="PeasExtensionSet"><span class="type">PeasExtensionSet</span></a></p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|