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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ParoleProviderPlugin</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Parole Plugins Reference Manual">
<link rel="up" href="API.html" title="Part IV. Parole Plugin Reference">
<link rel="prev" href="API.html" title="Part IV. Parole Plugin Reference">
<link rel="next" href="Parole-Plugins-parole-provider-player.html" title="ParoleProviderPlayer">
<meta name="generator" content="GTK-Doc V1.17 (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="API.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="API.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">Parole Plugins Reference Manual</th>
<td><a accesskey="n" href="Parole-Plugins-parole-provider-player.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#Parole-Plugins-parole-provider-plugin.synopsis" class="shortcut">Top</a>
|
<a href="#Parole-Plugins-parole-provider-plugin.description" class="shortcut">Description</a>
|
<a href="#Parole-Plugins-parole-provider-plugin.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="Parole-Plugins-parole-provider-plugin"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="Parole-Plugins-parole-provider-plugin.top_of_page"></a>ParoleProviderPlugin</span></h2>
<p>ParoleProviderPlugin — The interface of the plugin type registration.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="Parole-Plugins-parole-provider-plugin.synopsis"></a><h2>Synopsis</h2>
<a name="ParoleProviderPlugin"></a><pre class="synopsis">struct <a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPluginIface" title="struct ParoleProviderPluginIface">ParoleProviderPluginIface</a>;
<a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin-struct" title="ParoleProviderPlugin">ParoleProviderPlugin</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="Parole-Plugins-parole-provider-plugin.html#parole-provider-plugin-get-is-configurable" title="parole_provider_plugin_get_is_configurable ()">parole_provider_plugin_get_is_configurable</a>
(<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a> *provider</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Parole-Plugins-parole-provider-plugin.html#parole-provider-plugin-configure" title="parole_provider_plugin_configure ()">parole_provider_plugin_configure</a> (<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a> *provider</code></em>,
<em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>);
<span class="returnvalue">void</span> <a class="link" href="Parole-Plugins-parole-provider-plugin.html#parole-provider-plugin-set-player" title="parole_provider_plugin_set_player ()">parole_provider_plugin_set_player</a> (<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a> *provider</code></em>,
<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer" title="ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a> *player</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="Parole-Plugins-parole-provider-plugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----ParoleProviderPlugin
</pre>
</div>
<div class="refsect1">
<a name="Parole-Plugins-parole-provider-plugin.description"></a><h2>Description</h2>
<p>
The methods of this interface should be overridden by the plugin, the Parole player
calls these methods to determine if the plugin is configurable, to ask the plugin to
open its configuration dialog or to set the <a class="link" href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer" title="ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a> that the plugin
can use to get access to various functionalities of the player.
</p>
</div>
<div class="refsect1">
<a name="Parole-Plugins-parole-provider-plugin.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ParoleProviderPluginIface"></a><h3>struct ParoleProviderPluginIface</h3>
<pre class="programlisting">struct ParoleProviderPluginIface {
GTypeInterface __parent__;
gboolean (*get_is_configurable) (ParoleProviderPlugin *provider);
void (*configure) (ParoleProviderPlugin *provider,
GtkWidget *parent);
void (*set_player) (ParoleProviderPlugin *provider,
ParoleProviderPlayer *player);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ParoleProviderPlugin-struct"></a><h3>ParoleProviderPlugin</h3>
<pre class="programlisting">typedef struct _ParoleProviderPlugin ParoleProviderPlugin;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-provider-plugin-get-is-configurable"></a><h3>parole_provider_plugin_get_is_configurable ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> parole_provider_plugin_get_is_configurable
(<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a> *provider</code></em>);</pre>
<p>
Get if the plugin is configurable.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>a <a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the plugin is configurable, FALSE otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-provider-plugin-configure"></a><h3>parole_provider_plugin_configure ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> parole_provider_plugin_configure (<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a> *provider</code></em>,
<em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>);</pre>
<p>
Open the plugin configuration dialog
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>a <a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>a <span class="type">GtkWidget</span> parent window</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="parole-provider-plugin-set-player"></a><h3>parole_provider_plugin_set_player ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> parole_provider_plugin_set_player (<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a> *provider</code></em>,
<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer" title="ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a> *player</code></em>);</pre>
<p>
The player calls this method on the iface_init funtion implemented by the plugin
to set the <a class="link" href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer" title="ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a>, don't take any reference of the Player.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>a <a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
<td>a <a class="link" href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer" title="ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
</div>
<div class="refsect1">
<a name="Parole-Plugins-parole-provider-plugin.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer" title="ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a>.
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|
