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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PeasExtension</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.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.18.1 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="PeasPluginInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Peas Reference Manual</th>
<td><a accesskey="n" href="PeasExtensionSet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libpeas-PeasExtension.synopsis" class="shortcut">Top</a>
|
<a href="#libpeas-PeasExtension.description" class="shortcut">Description</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libpeas-PeasExtension.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">typedef <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a>;
<span class="returnvalue">GType</span> <a class="link" href="libpeas-PeasExtension.html#peas-extension-get-extension-type" title="peas_extension_get_extension_type ()">peas_extension_get_extension_type</a> (<em class="parameter"><code><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a> *exten</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libpeas-PeasExtension.html#peas-extension-call" title="peas_extension_call ()">peas_extension_call</a> (<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>);
<span class="returnvalue">gboolean</span> <a class="link" href="libpeas-PeasExtension.html#peas-extension-call-valist" title="peas_extension_call_valist ()">peas_extension_call_valist</a> (<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>);
<span class="returnvalue">gboolean</span> <a class="link" href="libpeas-PeasExtension.html#peas-extension-callv" title="peas_extension_callv ()">peas_extension_callv</a> (<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>
<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>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function">g_irepository_require</span> <span class="gtkdoc opt">(</span><span class="function">g_irepository_get_default</span> <span class="gtkdoc opt">(),</span>
<span class="string">"Peas"</span><span class="gtkdoc opt">,</span> <span class="string">"1.0"</span><span class="gtkdoc opt">,</span> <span class="number">0</span><span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</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.details"></a><h2>Details</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>
<hr>
<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" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">peas_extension_get_extension_type</code> is deprecated and should not be used in newly-written code. 1.2.</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>exten</code></em> :</span></p></td>
<td>A <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <span class="type">GType</span> proxied by <em class="parameter"><code>exten</code></em>.</td>
</tr>
</tbody>
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">peas_extension_call</code> has been deprecated since version 1.2 and should not be used in newly-written code. 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">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function">gint</span> <span class="gtkdoc opt">(*</span>my_method<span class="gtkdoc opt">) (</span>MyClass <span class="gtkdoc opt">*</span>instance<span class="gtkdoc opt">,</span> <span class="gtkdoc kwb">const</span> gchar <span class="gtkdoc opt">*</span>str<span class="gtkdoc opt">,</span> SomeObject <span class="gtkdoc opt">*</span>obj<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
you should call <a class="link" href="libpeas-PeasExtension.html#peas-extension-call" title="peas_extension_call ()"><code class="function">peas_extension_call()</code></a> this way:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="libpeas-PeasExtension.html#peas-extension-call">peas_extension_call</a></span> <span class="gtkdoc opt">(</span>extension<span class="gtkdoc opt">,</span> <span class="string">"my_method"</span><span class="gtkdoc opt">,</span> <span class="string">"some_str"</span><span class="gtkdoc opt">,</span> obj<span class="gtkdoc opt">, &</span>gint_var<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
This function will not do anything if the introspection data for the proxied
object's class has not been loaded previously through <code class="function">g_irepository_require()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>exten</code></em> :</span></p></td>
<td>A <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method_name</code></em> :</span></p></td>
<td>the name of the method that should be called.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>arguments for the method.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on successful call.</td>
</tr>
</tbody>
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<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. 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>exten</code></em> :</span></p></td>
<td>A <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method_name</code></em> :</span></p></td>
<td>the name of the method that should be called.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
<td>the arguments for the method.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on successful call.</td>
</tr>
</tbody>
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">peas_extension_callv</code> has been deprecated since version 1.2 and should not be used in newly-written code. 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>exten</code></em> :</span></p></td>
<td>A <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension"><span class="type">PeasExtension</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>method_name</code></em> :</span></p></td>
<td>the name of the method that should be called.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>args</code></em> :</span></p></td>
<td>the arguments for the method.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>return_value</code></em> :</span></p></td>
<td>the return falue for the method.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on successful call.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libpeas-PeasExtension.see-also"></a><h2>See Also</h2>
<a class="link" href="PeasExtensionSet.html" title="PeasExtensionSet"><span class="type">PeasExtensionSet</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|
