← Back to branch summary

~ubuntu-branches/ubuntu/trusty/totem/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/html/TotemPlugin.html

  • Committer: Bazaar Package Importer
  • Author(s): Sjoerd Simons, Josselin Mouette, Sjoerd Simons, Emilio Pozuelo Monfort
  • Date: 2009-04-19 17:28:51 UTC
  • mfrom: (1.2.52 upstream) (5.1.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090419172851-epoqimnq62akn294
Tags: 2.26.1-1
http://bugs.debian.org/523582
http://bugs.debian.org/523052
[ Josselin Mouette ]
* totem-plugins depends on python-gdbm. Closes: #523582.

[ Sjoerd Simons ]
* New upstream release (2.26.1)
* debian/patches/02_flv.patch: Dropped, fixed upstream
* debian/patches/04_tracker_build.patch: Dropped, fixed upstream
* debian/patches/01_fake_keypresses.patch: Updated and simplified
* debian/patches/70_bbc_plugin.patch: Updated
* debian/patches/90_autotools.patch: Updated

[ Emilio Pozuelo Monfort ]
* Recommend gnome-codec-install rather than gnome-app-install.
  Closes: #523052.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/TotemPlugin.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>TotemPlugin</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
7
<link rel="home" href="index.html" title="Totem Reference Manual">
 
8
<link rel="up" href="core-api.html" title="Core API">
 
9
<link rel="prev" href="totem-Interface.html" title="Interface">
 
10
<link rel="next" href="widget-api.html" title="Widgets">
 
11
<meta name="generator" content="GTK-Doc V1.12 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="core-api.html" title="Core API">
 
14
<link rel="chapter" href="widget-api.html" title="Widgets">
 
15
<link rel="index" href="api-index-full.html" title="Index of all symbols">
 
16
<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
 
17
</head>
 
18
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
19
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
20
<tr valign="middle">
 
21
<td><a accesskey="p" href="totem-Interface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
22
<td><a accesskey="u" href="core-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
24
<th width="100%" align="center">Totem Reference Manual</th>
 
25
<td><a accesskey="n" href="widget-api.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
26
</tr>
 
27
<tr><td colspan="5" class="shortcuts">
 
28
<a href="#TotemPlugin.synopsis" class="shortcut">Top</a>
 
29
                   | 
 
30
                  <a href="#TotemPlugin.description" class="shortcut">Description</a>
 
31
                   | 
 
32
                  <a href="#TotemPlugin.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
33
                   | 
 
34
                  <a href="#TotemPlugin.properties" class="shortcut">Properties</a>
 
35
</td></tr>
 
36
</table>
 
37
<div class="refentry" lang="en">
 
38
<a name="TotemPlugin"></a><div class="titlepage"></div>
 
39
<div class="refnamediv"><table width="100%"><tr>
 
40
<td valign="top">
 
41
<h2><span class="refentrytitle"><a name="TotemPlugin.top_of_page"></a>TotemPlugin</span></h2>
 
42
<p>TotemPlugin — base plugin class and loading/unloading functions</p>
 
43
</td>
 
44
<td valign="top" align="right"></td>
 
45
</tr></table></div>
 
46
<div class="refsect1" lang="en">
 
47
<a name="TotemPlugin.stability-level"></a><h2>Stability Level</h2>
 
48
Unstable, unless otherwise indicated
 
49
</div>
 
50
<div class="refsynopsisdiv">
 
51
<a name="TotemPlugin.synopsis"></a><h2>Synopsis</h2>
 
52
<pre class="synopsis">
 
53
 
 
54
#include &lt;totem-plugin.h&gt;
 
55
 
 
56
                    <a class="link" href="TotemPlugin.html#TotemPlugin-struct" title="TotemPlugin">TotemPlugin</a>;
 
57
                    <a class="link" href="TotemPlugin.html#TotemPluginClass" title="TotemPluginClass">TotemPluginClass</a>;
 
58
enum                <a class="link" href="TotemPlugin.html#TotemPluginError" title="enum TotemPluginError">TotemPluginError</a>;
 
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>            <a class="link" href="TotemPlugin.html#totem-plugin-activate" title="totem_plugin_activate ()">totem_plugin_activate</a>               (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
 
60
                                                         <a class="link" href="TotemObject.html" title="TotemObject">TotemObject</a> *totem,
 
61
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error);
 
62
void                <a class="link" href="TotemPlugin.html#totem-plugin-deactivate" title="totem_plugin_deactivate ()">totem_plugin_deactivate</a>             (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
 
63
                                                         <a class="link" href="TotemObject.html" title="TotemObject">TotemObject</a> *totem);
 
64
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a> *         <a class="link" href="TotemPlugin.html#totem-plugin-create-configure-dialog" title="totem_plugin_create_configure_dialog ()">totem_plugin_create_configure_dialog</a>
 
65
                                                        (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);
 
66
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>            <a class="link" href="TotemPlugin.html#totem-plugin-is-configurable" title="totem_plugin_is_configurable ()">totem_plugin_is_configurable</a>        (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);
 
67
<a href="http://library.gnome.org/devel/gtk/unstable/GtkBuilder.html">GtkBuilder</a> *        <a class="link" href="TotemPlugin.html#totem-plugin-load-interface" title="totem_plugin_load_interface ()">totem_plugin_load_interface</a>         (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
 
68
                                                         const char *name,
 
69
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> fatal,
 
70
                                                         <a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html">GtkWindow</a> *parent,
 
71
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data);
 
72
char *              <a class="link" href="TotemPlugin.html#totem-plugin-find-file" title="totem_plugin_find_file ()">totem_plugin_find_file</a>              (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
 
73
                                                         const char *file);
 
74
</pre>
 
75
</div>
 
76
<div class="refsect1" lang="en">
 
77
<a name="TotemPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
78
<pre class="synopsis">
 
79
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
80
   +----TotemPlugin
 
81
</pre>
 
82
</div>
 
83
<div class="refsect1" lang="en">
 
84
<a name="TotemPlugin.properties"></a><h2>Properties</h2>
 
85
<pre class="synopsis">
 
86
  "<a class="link" href="TotemPlugin.html#TotemPlugin--name" title='The "name" property'>name</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a>*                : Read / Write
 
87
</pre>
 
88
</div>
 
89
<div class="refsect1" lang="en">
 
90
<a name="TotemPlugin.description"></a><h2>Description</h2>
 
91
<p>
 
92
<a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a> is a general-purpose architecture for adding plugins to Totem, with
 
93
derived support for different programming languages.</p>
 
94
<p>
 
95
</p>
 
96
</div>
 
97
<div class="refsect1" lang="en">
 
98
<a name="TotemPlugin.details"></a><h2>Details</h2>
 
99
<div class="refsect2" lang="en">
 
100
<a name="TotemPlugin-struct"></a><h3>TotemPlugin</h3>
 
101
<pre class="programlisting">typedef struct _TotemPlugin TotemPlugin;</pre>
 
102
<p>
 
103
All the fields in the <a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a> structure are private and should never be accessed directly.</p>
 
104
<p>
 
105
</p>
 
106
</div>
 
107
<hr>
 
108
<div class="refsect2" lang="en">
 
109
<a name="TotemPluginClass"></a><h3>TotemPluginClass</h3>
 
110
<pre class="programlisting">typedef struct {
 
111
        GObjectClass parent_class;
 
112
 
 
113
        /* Virtual public methods */
 
114
 
 
115
        TotemPluginActivationFunc activate;
 
116
        TotemPluginDeactivationFunc deactivate;
 
117
        TotemPluginWidgetFunc           create_configure_dialog;
 
118
} TotemPluginClass;
 
119
</pre>
 
120
<p>
 
121
The class structure for the <a href="http://library.gnome.org/devel/totem-pl-parser/TotemPlParser.html#TotemPlParser"><span class="type">TotemPlParser</span></a> type.</p>
 
122
<p>
 
123
</p>
 
124
<div class="variablelist"><table border="0">
 
125
<col align="left" valign="top">
 
126
<tbody>
 
127
<tr>
 
128
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> <em class="structfield"><code>parent_class</code></em>;</span></p></td>
 
129
<td> the parent class
 
130
</td>
 
131
</tr>
 
132
<tr>
 
133
<td><p><span class="term">TotemPluginActivationFunc <em class="structfield"><code>activate</code></em>;</span></p></td>
 
134
<td> function called when activating a plugin using <a class="link" href="TotemPlugin.html#totem-plugin-activate" title="totem_plugin_activate ()"><code class="function">totem_plugin_activate()</code></a>.
 
135
It must be set by inheriting classes, and should return <code class="literal">TRUE</code> if it successfully created/got handles to
 
136
the resources needed by the plugin. If it returns <code class="literal">FALSE</code>, loading the plugin is abandoned.
 
137
</td>
 
138
</tr>
 
139
<tr>
 
140
<td><p><span class="term">TotemPluginDeactivationFunc <em class="structfield"><code>deactivate</code></em>;</span></p></td>
 
141
<td> function called when deactivating a plugin using <a class="link" href="TotemPlugin.html#totem-plugin-deactivate" title="totem_plugin_deactivate ()"><code class="function">totem_plugin_deactivate()</code></a>;
 
142
It must be set by inheriting classes, and should free/unref any resources the plugin used.
 
143
</td>
 
144
</tr>
 
145
<tr>
 
146
<td><p><span class="term">TotemPluginWidgetFunc <em class="structfield"><code>create_configure_dialog</code></em>;</span></p></td>
 
147
<td> function called when configuring a plugin using <a class="link" href="TotemPlugin.html#totem-plugin-create-configure-dialog" title="totem_plugin_create_configure_dialog ()"><code class="function">totem_plugin_create_configure_dialog()</code></a>.
 
148
If non-<a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, it should create and return the plugin's configuration dialog. If <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the plugin is not
 
149
configurable.
 
150
</td>
 
151
</tr>
 
152
</tbody>
 
153
</table></div>
 
154
</div>
 
155
<hr>
 
156
<div class="refsect2" lang="en">
 
157
<a name="TotemPluginError"></a><h3>enum TotemPluginError</h3>
 
158
<pre class="programlisting">typedef enum {
 
159
        TOTEM_PLUGIN_ERROR_ACTIVATION
 
160
} TotemPluginError;
 
161
</pre>
 
162
<p>
 
163
Error codes returned by <a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a> operations.</p>
 
164
<p>
 
165
</p>
 
166
<div class="variablelist"><table border="0">
 
167
<col align="left" valign="top">
 
168
<tbody><tr>
 
169
<td><p><a name="TOTEM-PLUGIN-ERROR-ACTIVATION:CAPS"></a><span class="term"><code class="literal">TOTEM_PLUGIN_ERROR_ACTIVATION</code></span></p></td>
 
170
<td> there was an error activating the plugin
 
171
</td>
 
172
</tr></tbody>
 
173
</table></div>
 
174
</div>
 
175
<hr>
 
176
<div class="refsect2" lang="en">
 
177
<a name="totem-plugin-activate"></a><h3>totem_plugin_activate ()</h3>
 
178
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>            totem_plugin_activate               (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
 
179
                                                         <a class="link" href="TotemObject.html" title="TotemObject">TotemObject</a> *totem,
 
180
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error);</pre>
 
181
<p>
 
182
Activates the passed <em class="parameter"><code>plugin</code></em> by calling its activate method.</p>
 
183
<p>
 
184
</p>
 
185
<div class="variablelist"><table border="0">
 
186
<col align="left" valign="top">
 
187
<tbody>
 
188
<tr>
 
189
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
190
<td> a <a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a>
 
191
</td>
 
192
</tr>
 
193
<tr>
 
194
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
 
195
<td> a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
 
196
</td>
 
197
</tr>
 
198
<tr>
 
199
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
200
<td> return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
201
</td>
 
202
</tr>
 
203
<tr>
 
204
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
205
<td> <code class="literal">TRUE</code> on success
 
206
</td>
 
207
</tr>
 
208
</tbody>
 
209
</table></div>
 
210
</div>
 
211
<hr>
 
212
<div class="refsect2" lang="en">
 
213
<a name="totem-plugin-deactivate"></a><h3>totem_plugin_deactivate ()</h3>
 
214
<pre class="programlisting">void                totem_plugin_deactivate             (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
 
215
                                                         <a class="link" href="TotemObject.html" title="TotemObject">TotemObject</a> *totem);</pre>
 
216
<p>
 
217
Deactivates <em class="parameter"><code>plugin</code></em> by calling its deactivate method.</p>
 
218
<p>
 
219
</p>
 
220
<div class="variablelist"><table border="0">
 
221
<col align="left" valign="top">
 
222
<tbody>
 
223
<tr>
 
224
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
225
<td> a <a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a>
 
226
</td>
 
227
</tr>
 
228
<tr>
 
229
<td><p><span class="term"><em class="parameter"><code>totem</code></em> :</span></p></td>
 
230
<td> a <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>
 
231
</td>
 
232
</tr>
 
233
</tbody>
 
234
</table></div>
 
235
</div>
 
236
<hr>
 
237
<div class="refsect2" lang="en">
 
238
<a name="totem-plugin-create-configure-dialog"></a><h3>totem_plugin_create_configure_dialog ()</h3>
 
239
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a> *         totem_plugin_create_configure_dialog
 
240
                                                        (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);</pre>
 
241
<p>
 
242
Returns the plugin's configuration dialog, as created by
 
243
the plugin's create_configure_dialog method.</p>
 
244
<p>
 
245
</p>
 
246
<div class="variablelist"><table border="0">
 
247
<col align="left" valign="top">
 
248
<tbody>
 
249
<tr>
 
250
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
251
<td> a <a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a>
 
252
</td>
 
253
</tr>
 
254
<tr>
 
255
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
256
<td> the configuration dialog, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
257
</td>
 
258
</tr>
 
259
</tbody>
 
260
</table></div>
 
261
</div>
 
262
<hr>
 
263
<div class="refsect2" lang="en">
 
264
<a name="totem-plugin-is-configurable"></a><h3>totem_plugin_is_configurable ()</h3>
 
265
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>            totem_plugin_is_configurable        (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);</pre>
 
266
<p>
 
267
Returns <code class="literal">TRUE</code> if the plugin is configurable and has a
 
268
configuration dialog. It calls the plugin's
 
269
is_configurable method.</p>
 
270
<p>
 
271
</p>
 
272
<div class="variablelist"><table border="0">
 
273
<col align="left" valign="top">
 
274
<tbody>
 
275
<tr>
 
276
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
277
<td> a <a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a>
 
278
</td>
 
279
</tr>
 
280
<tr>
 
281
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
282
<td> <code class="literal">TRUE</code> if the plugin is configurable
 
283
</td>
 
284
</tr>
 
285
</tbody>
 
286
</table></div>
 
287
</div>
 
288
<hr>
 
289
<div class="refsect2" lang="en">
 
290
<a name="totem-plugin-load-interface"></a><h3>totem_plugin_load_interface ()</h3>
 
291
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkBuilder.html">GtkBuilder</a> *        totem_plugin_load_interface         (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
 
292
                                                         const char *name,
 
293
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> fatal,
 
294
                                                         <a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html">GtkWindow</a> *parent,
 
295
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data);</pre>
 
296
<p>
 
297
Loads an interface file (GtkBuilder UI file) for a plugin, given its filename and
 
298
assuming it's installed in the plugin's data directory.
 
299
</p>
 
300
<p>
 
301
This should be used instead of attempting to load interfaces manually in plugins.</p>
 
302
<p>
 
303
</p>
 
304
<div class="variablelist"><table border="0">
 
305
<col align="left" valign="top">
 
306
<tbody>
 
307
<tr>
 
308
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
309
<td> a <a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a>
 
310
</td>
 
311
</tr>
 
312
<tr>
 
313
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
314
<td> interface filename
 
315
</td>
 
316
</tr>
 
317
<tr>
 
318
<td><p><span class="term"><em class="parameter"><code>fatal</code></em> :</span></p></td>
 
319
<td> <code class="literal">TRUE</code> if it's a fatal error if the interface can't be loaded
 
320
</td>
 
321
</tr>
 
322
<tr>
 
323
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
 
324
<td> the interface's parent <a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"><span class="type">GtkWindow</span></a>
 
325
</td>
 
326
</tr>
 
327
<tr>
 
328
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
329
<td> a pointer to be passed to each signal handler in the interface when they're called
 
330
</td>
 
331
</tr>
 
332
<tr>
 
333
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
334
<td> the <a href="http://library.gnome.org/devel/gtk/unstable/GtkBuilder.html"><span class="type">GtkBuilder</span></a> instance for the interface
 
335
</td>
 
336
</tr>
 
337
</tbody>
 
338
</table></div>
 
339
</div>
 
340
<hr>
 
341
<div class="refsect2" lang="en">
 
342
<a name="totem-plugin-find-file"></a><h3>totem_plugin_find_file ()</h3>
 
343
<pre class="programlisting">char *              totem_plugin_find_file              (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
 
344
                                                         const char *file);</pre>
 
345
<p>
 
346
Finds the specified <em class="parameter"><code>file</code></em> by looking in the plugin paths
 
347
listed by <code class="function">totem_get_plugin_paths()</code> and then in the system
 
348
Totem data directory.
 
349
</p>
 
350
<p>
 
351
This should be used by plugins to find plugin-specific
 
352
resource files.</p>
 
353
<p>
 
354
</p>
 
355
<div class="variablelist"><table border="0">
 
356
<col align="left" valign="top">
 
357
<tbody>
 
358
<tr>
 
359
<td><p><span class="term"><em class="parameter"><code>plugin</code></em> :</span></p></td>
 
360
<td> a <a class="link" href="TotemPlugin.html" title="TotemPlugin"><span class="type">TotemPlugin</span></a>
 
361
</td>
 
362
</tr>
 
363
<tr>
 
364
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
 
365
<td> the file to find
 
366
</td>
 
367
</tr>
 
368
<tr>
 
369
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
370
<td> a newly-allocated absolute path for the file, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
371
</td>
 
372
</tr>
 
373
</tbody>
 
374
</table></div>
 
375
</div>
 
376
</div>
 
377
<div class="refsect1" lang="en">
 
378
<a name="TotemPlugin.property-details"></a><h2>Property Details</h2>
 
379
<div class="refsect2" lang="en">
 
380
<a name="TotemPlugin--name"></a><h3>The <code class="literal">"name"</code> property</h3>
 
381
<pre class="programlisting">  "name"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a>*                : Read / Write</pre>
 
382
<p>
 
383
The plugin's name. It should be a construction property, but due to the Python plugin hack, it
 
384
can't be: do not change the name after construction. Should be the same as used for naming plugin-
 
385
specific resources.</p>
 
386
<p>
 
387
</p>
 
388
<p>Default value: NULL</p>
 
389
</div>
 
390
</div>
 
391
</div>
 
392
<div class="footer">
 
393
<hr>
 
394
          Generated by GTK-Doc V1.12</div>
 
395
</body>
 
396
</html>