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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PeasGtkPluginManagerView</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="ch02.html" title="Gtk+ Widgets">
<link rel="prev" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager">
<link rel="next" href="ch03.html" title="Built-in Extension Interfaces">
<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="PeasGtkPluginManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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="ch03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PeasGtkPluginManagerView.synopsis" class="shortcut">Top</a>
|
<a href="#PeasGtkPluginManagerView.description" class="shortcut">Description</a>
|
<a href="#PeasGtkPluginManagerView.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#PeasGtkPluginManagerView.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#PeasGtkPluginManagerView.properties" class="shortcut">Properties</a>
|
<a href="#PeasGtkPluginManagerView.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="PeasGtkPluginManagerView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PeasGtkPluginManagerView.top_of_page"></a>PeasGtkPluginManagerView</span></h2>
<p>PeasGtkPluginManagerView — Management tree view for plugins.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PeasGtkPluginManagerView.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="PeasGtkPluginManagerView.html#PeasGtkPluginManagerView-struct" title="struct PeasGtkPluginManagerView">PeasGtkPluginManagerView</a>;
struct <a class="link" href="PeasGtkPluginManagerView.html#PeasGtkPluginManagerViewClass" title="struct PeasGtkPluginManagerViewClass">PeasGtkPluginManagerViewClass</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="PeasGtkPluginManagerView.html#peas-gtk-plugin-manager-view-new" title="peas_gtk_plugin_manager_view_new ()">peas_gtk_plugin_manager_view_new</a> (<em class="parameter"><code><a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a> *engine</code></em>);
<span class="returnvalue">void</span> <a class="link" href="PeasGtkPluginManagerView.html#peas-gtk-plugin-manager-view-set-show-builtin" title="peas_gtk_plugin_manager_view_set_show_builtin ()">peas_gtk_plugin_manager_view_set_show_builtin</a>
(<em class="parameter"><code><a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show_builtin</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="PeasGtkPluginManagerView.html#peas-gtk-plugin-manager-view-get-show-builtin" title="peas_gtk_plugin_manager_view_get_show_builtin ()">peas_gtk_plugin_manager_view_get_show_builtin</a>
(<em class="parameter"><code><a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view</code></em>);
<span class="returnvalue">void</span> <a class="link" href="PeasGtkPluginManagerView.html#peas-gtk-plugin-manager-view-set-selected-plugin" title="peas_gtk_plugin_manager_view_set_selected_plugin ()">peas_gtk_plugin_manager_view_set_selected_plugin</a>
(<em class="parameter"><code><a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view</code></em>,
<em class="parameter"><code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="returnvalue">PeasPluginInfo</span></a> * <a class="link" href="PeasGtkPluginManagerView.html#peas-gtk-plugin-manager-view-get-selected-plugin" title="peas_gtk_plugin_manager_view_get_selected_plugin ()">peas_gtk_plugin_manager_view_get_selected_plugin</a>
(<em class="parameter"><code><a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManagerView.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkWidget
+----GtkContainer
+----GtkTreeView
+----PeasGtkPluginManagerView
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManagerView.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
PeasGtkPluginManagerView implements
AtkImplementorIface, GtkBuildable and GtkScrollable.</p>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManagerView.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="PeasGtkPluginManagerView.html#PeasGtkPluginManagerView--engine" title='The "engine" property'>engine</a>" <a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a>* : Read / Write / Construct Only
"<a class="link" href="PeasGtkPluginManagerView.html#PeasGtkPluginManagerView--show-builtin" title='The "show-builtin" property'>show-builtin</a>" <span class="type">gboolean</span> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManagerView.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="PeasGtkPluginManagerView.html#PeasGtkPluginManagerView-populate-popup" title='The "populate-popup" signal'>populate-popup</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManagerView.description"></a><h2>Description</h2>
<p>
The <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> is a tree view that can be used to manage
plugins, i.e. load or unload them, and see some pieces of information.
</p>
<p>
The only thing you need to do as an application writer if you wish
to use the view to display your plugins is to instantiate it using
<a class="link" href="PeasGtkPluginManagerView.html#peas-gtk-plugin-manager-view-new" title="peas_gtk_plugin_manager_view_new ()"><code class="function">peas_gtk_plugin_manager_view_new()</code></a> and pack it into another
widget or a window.
</p>
<p>
Note: Changing the model of the view is not supported.
</p>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManagerView.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PeasGtkPluginManagerView-struct"></a><h3>struct PeasGtkPluginManagerView</h3>
<pre class="programlisting">struct PeasGtkPluginManagerView;</pre>
<p>
The <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> structure contains only private data
and should only be accessed using the provided API.
</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasGtkPluginManagerViewClass"></a><h3>struct PeasGtkPluginManagerViewClass</h3>
<pre class="programlisting">struct PeasGtkPluginManagerViewClass {
GtkTreeViewClass parent_class;
void (*populate_popup) (PeasGtkPluginManagerView *view,
GtkMenu *menu);
};
</pre>
<p>
The class structure for <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">GtkTreeViewClass</span> <em class="structfield"><code><a name="PeasGtkPluginManagerViewClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>The parent class.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="PeasGtkPluginManagerViewClass.populate-popup"></a>populate_popup</code></em> ()</span></p></td>
<td>Signal class handler for the
<a class="link" href="PeasGtkPluginManagerView.html#PeasGtkPluginManagerView-populate-popup" title='The "populate-popup" signal'><span class="type">"populate-popup"</span></a> signal.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-gtk-plugin-manager-view-new"></a><h3>peas_gtk_plugin_manager_view_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * peas_gtk_plugin_manager_view_new (<em class="parameter"><code><a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a> *engine</code></em>);</pre>
<p>
Creates a new plugin manager view for the given <a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a>.
</p>
<p>
If <em class="parameter"><code>engine</code></em> is <code class="literal">NULL</code>, then the default engine will be used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>engine</code></em> :</span></p></td>
<td>A <a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-gtk-plugin-manager-view-set-show-builtin"></a><h3>peas_gtk_plugin_manager_view_set_show_builtin ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> peas_gtk_plugin_manager_view_set_show_builtin
(<em class="parameter"><code><a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show_builtin</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_gtk_plugin_manager_view_set_show_builtin</code> has been deprecated since version 1.2 and should not be used in newly-written code. Use hidden plugins instead.</p>
</div>
<p>
Sets if builtin plugins should be shown.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>A <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show_builtin</code></em> :</span></p></td>
<td>If builtin plugins should be shown.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-gtk-plugin-manager-view-get-show-builtin"></a><h3>peas_gtk_plugin_manager_view_get_show_builtin ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> peas_gtk_plugin_manager_view_get_show_builtin
(<em class="parameter"><code><a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view</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_gtk_plugin_manager_view_get_show_builtin</code> has been deprecated since version 1.2 and should not be used in newly-written code. Use hidden plugins instead.</p>
</div>
<p>
Returns if builtin plugins should be shown.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>A <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>if builtin plugins should be shown.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-gtk-plugin-manager-view-set-selected-plugin"></a><h3>peas_gtk_plugin_manager_view_set_selected_plugin ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> peas_gtk_plugin_manager_view_set_selected_plugin
(<em class="parameter"><code><a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view</code></em>,
<em class="parameter"><code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Selects the given plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>A <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-gtk-plugin-manager-view-get-selected-plugin"></a><h3>peas_gtk_plugin_manager_view_get_selected_plugin ()</h3>
<pre class="programlisting"><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="returnvalue">PeasPluginInfo</span></a> * peas_gtk_plugin_manager_view_get_selected_plugin
(<em class="parameter"><code><a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view</code></em>);</pre>
<p>
Returns the currently selected plugin, or <code class="literal">NULL</code> if a plugin is not selected.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>view</code></em> :</span></p></td>
<td>A <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the selected plugin. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManagerView.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="PeasGtkPluginManagerView--engine"></a><h3>The <code class="literal">"engine"</code> property</h3>
<pre class="programlisting"> "engine" <a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a>* : Read / Write / Construct Only</pre>
<p>The PeasEngine this view is attached to.</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasGtkPluginManagerView--show-builtin"></a><h3>The <code class="literal">"show-builtin"</code> property</h3>
<pre class="programlisting"> "show-builtin" <span class="type">gboolean</span> : Read / Write</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">PeasGtkPluginManagerView:show-builtin</code> has been deprecated since version 1.2 and should not be used in newly-written code. Use hidden plugins instead.</p>
</div>
<p>
If builtin plugins should be shown.
</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManagerView.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="PeasGtkPluginManagerView-populate-popup"></a><h3>The <code class="literal">"populate-popup"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> *view,
<span class="type">GtkMenu</span> *menu,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
The ::populate-popup signal is emitted before showing the context
menu of the view. If you need to add items to the context menu,
connect to this signal and add your menuitems to the <em class="parameter"><code>menu</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>view</code></em> :</span></p></td>
<td>A <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td>
<td>A <span class="type">GtkMenu</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|
