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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PeasGtkConfigurable</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="ch03.html" title="Built-in Extension Interfaces">
<link rel="prev" href="PeasActivatable.html" title="PeasActivatable">
<link rel="next" href="api-index-full.html" title="API Index">
<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="PeasActivatable.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.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="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PeasGtkConfigurable.synopsis" class="shortcut">Top</a>
|
<a href="#PeasGtkConfigurable.description" class="shortcut">Description</a>
|
<a href="#PeasGtkConfigurable.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#PeasGtkConfigurable.prerequisites" class="shortcut">Prerequisites</a>
</td></tr>
</table>
<div class="refentry">
<a name="PeasGtkConfigurable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PeasGtkConfigurable.top_of_page"></a>PeasGtkConfigurable</span></h2>
<p>PeasGtkConfigurable — Interface for providing a plugin configuration UI.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PeasGtkConfigurable.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="PeasGtkConfigurable.html#PeasGtkConfigurable-struct" title="PeasGtkConfigurable">PeasGtkConfigurable</a>;
struct <a class="link" href="PeasGtkConfigurable.html#PeasGtkConfigurableInterface" title="struct PeasGtkConfigurableInterface">PeasGtkConfigurableInterface</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="PeasGtkConfigurable.html#peas-gtk-configurable-create-configure-widget" title="peas_gtk_configurable_create_configure_widget ()">peas_gtk_configurable_create_configure_widget</a>
(<em class="parameter"><code><a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a> *configurable</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----PeasGtkConfigurable
</pre>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.prerequisites"></a><h2>Prerequisites</h2>
<p>
PeasGtkConfigurable requires
GObject.</p>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.description"></a><h2>Description</h2>
<p>
The <a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a> interface will allow a plugin to provide a
graphical interface for the user to configure the plugin through the
<a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>: the <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a> will make its
“Configure Plugin” button active when the selected plugin implements
the <a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a> interface.
</p>
<p>
To allow plugin configuration from the <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>, the
plugin writer will just need to implement the
PeasGtkConfigurableInterface.create_configure_widget() method.
</p>
</div>
<div class="refsect1">
<a name="PeasGtkConfigurable.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PeasGtkConfigurable-struct"></a><h3>PeasGtkConfigurable</h3>
<pre class="programlisting">typedef struct _PeasGtkConfigurable PeasGtkConfigurable;</pre>
<p>
Interface for configurable plugins.
</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasGtkConfigurableInterface"></a><h3>struct PeasGtkConfigurableInterface</h3>
<pre class="programlisting">struct PeasGtkConfigurableInterface {
GTypeInterface g_iface;
GtkWidget *(*create_configure_widget) (PeasGtkConfigurable *configurable);
};
</pre>
<p>
Provides an interface for configurable plugins.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="PeasGtkConfigurableInterface.g-iface"></a>g_iface</code></em>;</span></p></td>
<td>The parent interface.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="PeasGtkConfigurableInterface.create-configure-widget"></a>create_configure_widget</code></em> ()</span></p></td>
<td>Creates the configure widget for the plugin.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-gtk-configurable-create-configure-widget"></a><h3>peas_gtk_configurable_create_configure_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * peas_gtk_configurable_create_configure_widget
(<em class="parameter"><code><a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a> *configurable</code></em>);</pre>
<p>
Creates the configure widget for the plugin. The returned widget
should allow configuring all the relevant aspects of the plugin, and should
allow instant-apply, as promoted by the Gnome Human Interface Guidelines.
</p>
<p>
<a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a> will embed the returned widget into a dialog box,
but you shouldn't take this behaviour for granted as other implementations
of a plugin manager UI might do otherwise.
</p>
<p>
This method should always return a valid <span class="type">GtkWidget</span> instance, never <code class="literal">NULL</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>configurable</code></em> :</span></p></td>
<td>A <a class="link" href="PeasGtkConfigurable.html" title="PeasGtkConfigurable"><span class="type">PeasGtkConfigurable</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <span class="type">GtkWidget</span> used for configuration. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|
