File: PeasGtkPluginManager.html

package info (click to toggle)
libpeas 1.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 5,328 kB
  • sloc: sh: 11,723; ansic: 11,717; makefile: 938; python: 54; xml: 27
file content (191 lines) | stat: -rw-r--r-- 10,995 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PeasGtkPluginManager</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="ch02.html" title="Gtk+ Widgets">
<link rel="next" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView">
<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="ch02.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="PeasGtkPluginManagerView.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PeasGtkPluginManager.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#PeasGtkPluginManager.description" class="shortcut">Description</a>
                   | 
                  <a href="#PeasGtkPluginManager.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#PeasGtkPluginManager.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#PeasGtkPluginManager.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="PeasGtkPluginManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PeasGtkPluginManager.top_of_page"></a>PeasGtkPluginManager</span></h2>
<p>PeasGtkPluginManager — Management GUI for plugins.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PeasGtkPluginManager.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="PeasGtkPluginManager.html#PeasGtkPluginManager-struct" title="struct PeasGtkPluginManager">PeasGtkPluginManager</a>;
struct              <a class="link" href="PeasGtkPluginManager.html#PeasGtkPluginManagerClass" title="struct PeasGtkPluginManagerClass">PeasGtkPluginManagerClass</a>;
<span class="returnvalue">GtkWidget</span> *         <a class="link" href="PeasGtkPluginManager.html#peas-gtk-plugin-manager-new" title="peas_gtk_plugin_manager_new ()">peas_gtk_plugin_manager_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">GtkWidget</span> *         <a class="link" href="PeasGtkPluginManager.html#peas-gtk-plugin-manager-get-view" title="peas_gtk_plugin_manager_get_view ()">peas_gtk_plugin_manager_get_view</a>    (<em class="parameter"><code><a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a> *pm</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----PeasGtkPluginManager
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManager.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
PeasGtkPluginManager implements
 AtkImplementorIface,  GtkBuildable and  GtkOrientable.</p>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManager.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="PeasGtkPluginManager.html#PeasGtkPluginManager--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="PeasGtkPluginManager.html#PeasGtkPluginManager--view" title='The "view" property'>view</a>"                     <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>*  : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManager.description"></a><h2>Description</h2>
<p>
The <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a> is a widget that can be used to manage plugins,
i.e. load or unload them, and see some pieces of information.
</p>
<p>
<img src="peas-gtk-plugin-manager.png">
</p>
<p>
The only thing you need to do as an application writer if you wish to use
the manager to configure your plugins is to instantiate it using
<a class="link" href="PeasGtkPluginManager.html#peas-gtk-plugin-manager-new" title="peas_gtk_plugin_manager_new ()"><code class="function">peas_gtk_plugin_manager_new()</code></a> and pack it into another widget or a window
(as in the screenshot above).
</p>
</div>
<div class="refsect1">
<a name="PeasGtkPluginManager.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PeasGtkPluginManager-struct"></a><h3>struct PeasGtkPluginManager</h3>
<pre class="programlisting">struct PeasGtkPluginManager;</pre>
<p>
The <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a> structure contains only private data
and should only be accessed using the provided API.
</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasGtkPluginManagerClass"></a><h3>struct PeasGtkPluginManagerClass</h3>
<pre class="programlisting">struct PeasGtkPluginManagerClass {
  GtkBoxClass parent_class;
};
</pre>
<p>
The class structure for <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="type">GtkBoxClass</span> <em class="structfield"><code><a name="PeasGtkPluginManagerClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>The parent class.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-gtk-plugin-manager-new"></a><h3>peas_gtk_plugin_manager_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         peas_gtk_plugin_manager_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 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="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-gtk-plugin-manager-get-view"></a><h3>peas_gtk_plugin_manager_get_view ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *         peas_gtk_plugin_manager_get_view    (<em class="parameter"><code><a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a> *pm</code></em>);</pre>
<p>
Returns the <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> of <em class="parameter"><code>pm</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>pm</code></em> :</span></p></td>
<td>A <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</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">GtkTreeView</span> of <em class="parameter"><code>pm</code></em>. <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="PeasGtkPluginManager.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="PeasGtkPluginManager--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 <a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a> this manager is attached to.
</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasGtkPluginManager--view"></a><h3>The <code class="literal">"view"</code> property</h3>
<pre class="programlisting">  "view"                     <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a>*  : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="PeasGtkPluginManagerView.html" title="PeasGtkPluginManagerView"><span class="type">PeasGtkPluginManagerView</span></a> shown in the <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18.1</div>
</body>
</html>