4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ParoleProviderPlugin</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Parole Plugins Reference Manual">
8
8
<link rel="up" href="API.html" title="Part IV. Parole Plugin Reference">
9
9
<link rel="prev" href="API.html" title="Part IV. Parole Plugin Reference">
10
10
<link rel="next" href="Parole-Plugins-parole-provider-player.html" title="ParoleProviderPlayer">
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="Intro.html" title="Part I. Introduction">
14
<link rel="part" href="parole-plugins-tut.html" title="Part II. Parole Plugin Tutorial">
15
<link rel="part" href="fundamentals.html" title="Part III. Fundamentals">
16
<link rel="part" href="API.html" title="Part IV. Parole Plugin Reference">
17
<link rel="part" href="Utils.html" title="Part V. Parole Utilities">
18
<link rel="index" href="api-index-full.html" title="API Index">
20
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
21
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
45
39
</tr></table></div>
46
40
<div class="refsynopsisdiv">
47
41
<a name="Parole-Plugins-parole-provider-plugin.synopsis"></a><h2>Synopsis</h2>
48
<a name="ParoleProviderPlugin"></a><pre class="synopsis"> <a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPluginIface">ParoleProviderPluginIface</a>;
49
<a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin-struct">ParoleProviderPlugin</a>;
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a href="Parole-Plugins-parole-provider-plugin.html#parole-provider-plugin-get-is-configurable">parole_provider_plugin_get_is_configurable</a>
51
(<a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="returnvalue">ParoleProviderPlugin</span></a> *provider);
52
<span class="returnvalue">void</span> <a href="Parole-Plugins-parole-provider-plugin.html#parole-provider-plugin-configure">parole_provider_plugin_configure</a> (<a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="returnvalue">ParoleProviderPlugin</span></a> *provider,
53
<span class="returnvalue">GtkWidget</span> *parent);
54
<span class="returnvalue">void</span> <a href="Parole-Plugins-parole-provider-plugin.html#parole-provider-plugin-set-player">parole_provider_plugin_set_player</a> (<a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="returnvalue">ParoleProviderPlugin</span></a> *provider,
55
<a href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer"><span class="returnvalue">ParoleProviderPlayer</span></a> *player);
42
<a name="ParoleProviderPlugin"></a><pre class="synopsis">struct <a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPluginIface" title="struct ParoleProviderPluginIface">ParoleProviderPluginIface</a>;
43
<a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin-struct" title="ParoleProviderPlugin">ParoleProviderPlugin</a>;
44
<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>
45
(<em class="parameter"><code><a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a> *provider</code></em>);
46
<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>,
47
<em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>);
48
<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>,
49
<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>);
58
<div class="refsect1" lang="en">
52
<div class="refsect1">
59
53
<a name="Parole-Plugins-parole-provider-plugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
60
54
<pre class="synopsis">
62
56
+----ParoleProviderPlugin
65
<div class="refsect1" lang="en">
59
<div class="refsect1">
66
60
<a name="Parole-Plugins-parole-provider-plugin.description"></a><h2>Description</h2>
68
62
The methods of this interface should be overridden by the plugin, the Parole player
69
63
calls these methods to determine if the plugin is configurable, to ask the plugin to
70
open its configuration dialog or to set the <a href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a> that the plugin
64
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
71
65
can use to get access to various functionalities of the player.
74
<div class="refsect1" lang="en">
68
<div class="refsect1">
75
69
<a name="Parole-Plugins-parole-provider-plugin.details"></a><h2>Details</h2>
76
<div class="refsect2" lang="en">
77
<a name="ParoleProviderPluginIface"></a><h3>ParoleProviderPluginIface</h3>
78
<pre class="programlisting">typedef struct {
70
<div class="refsect2">
71
<a name="ParoleProviderPluginIface"></a><h3>struct ParoleProviderPluginIface</h3>
72
<pre class="programlisting">struct ParoleProviderPluginIface {
79
73
GTypeInterface __parent__;
81
75
gboolean (*get_is_configurable) (ParoleProviderPlugin *provider);
86
80
void (*set_player) (ParoleProviderPlugin *provider,
87
81
ParoleProviderPlayer *player);
88
} ParoleProviderPluginIface;
94
<div class="refsect2" lang="en">
88
<div class="refsect2">
95
89
<a name="ParoleProviderPlugin-struct"></a><h3>ParoleProviderPlugin</h3>
96
90
<pre class="programlisting">typedef struct _ParoleProviderPlugin ParoleProviderPlugin;</pre>
101
<div class="refsect2" lang="en">
95
<div class="refsect2">
102
96
<a name="parole-provider-plugin-get-is-configurable"></a><h3>parole_provider_plugin_get_is_configurable ()</h3>
103
97
<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
104
(<a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="returnvalue">ParoleProviderPlugin</span></a> *provider);</pre>
98
(<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>
106
Get if the plugin is configurable.</p>
100
Get if the plugin is configurable.
107
102
<div class="variablelist"><table border="0">
108
103
<col align="left" valign="top">
111
106
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
112
<td> a <a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
107
<td>a <a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
116
111
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
117
<td> TRUE if the plugin is configurable, FALSE otherwise.
112
<td>TRUE if the plugin is configurable, FALSE otherwise.</td>
124
116
<p class="since">Since 0.2</p>
127
<div class="refsect2" lang="en">
119
<div class="refsect2">
128
120
<a name="parole-provider-plugin-configure"></a><h3>parole_provider_plugin_configure ()</h3>
129
<pre class="programlisting"><span class="returnvalue">void</span> parole_provider_plugin_configure (<a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="returnvalue">ParoleProviderPlugin</span></a> *provider,
130
<span class="returnvalue">GtkWidget</span> *parent);</pre>
121
<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>,
122
<em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>);</pre>
132
Open the plugin configuration dialog</p>
124
Open the plugin configuration dialog
133
126
<div class="variablelist"><table border="0">
134
127
<col align="left" valign="top">
137
130
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
138
<td> a <a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
131
<td>a <a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
142
135
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
143
<td> a <span class="type">GtkWidget</span> parent window
136
<td>a <span class="type">GtkWidget</span> parent window</td>
148
140
<p class="since">Since 0.2</p>
151
<div class="refsect2" lang="en">
143
<div class="refsect2">
152
144
<a name="parole-provider-plugin-set-player"></a><h3>parole_provider_plugin_set_player ()</h3>
153
<pre class="programlisting"><span class="returnvalue">void</span> parole_provider_plugin_set_player (<a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="returnvalue">ParoleProviderPlugin</span></a> *provider,
154
<a href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer"><span class="returnvalue">ParoleProviderPlayer</span></a> *player);</pre>
145
<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>,
146
<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>
156
148
The player calls this method on the iface_init funtion implemented by the plugin
157
to set the <a href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a>, don't take any reference of the Player.</p>
149
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.
158
151
<div class="variablelist"><table border="0">
159
152
<col align="left" valign="top">
162
155
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
163
<td> a <a href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
156
<td>a <a class="link" href="Parole-Plugins-parole-provider-plugin.html#ParoleProviderPlugin"><span class="type">ParoleProviderPlugin</span></a>
167
160
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
168
<td> a <a href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a>
161
<td>a <a class="link" href="Parole-Plugins-parole-provider-player.html#ParoleProviderPlayer" title="ParoleProviderPlayer"><span class="type">ParoleProviderPlayer</span></a>