← Back to branch summary

~swem/totem/assignment

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-01-27 09:40:18 UTC
  • mfrom: (1.4.2 upstream) (5.1.13 sid)
  • Revision ID: james.westby@ubuntu.com-20100127094018-q6rzt7va0y8ketwt
Tags: 2.29.4-1
* New upstream development release:
  + debian/patches/90_autotools.patch:
    - Refreshed for the new version.
  + debian/control.in:
    - Update build dependencies and dependencies.
    - Drop tracker plugin, it needs tracker 0.7.
  + debian/totem-mozilla.links:
    - Drop the complex plugin, it doesn't exist anymore.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/TotemPlugin.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>TotemPlugin</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Totem Reference Manual">
8
8
<link rel="up" href="core-api.html" title="Core API">
9
9
<link rel="prev" href="totem-Interface.html" title="Interface">
35
35
                <a href="#TotemPlugin.properties" class="shortcut">Properties</a>
36
36
</td></tr>
37
37
</table>
38
 
<div class="refentry" lang="en">
 
38
<div class="refentry" title="TotemPlugin">
39
39
<a name="TotemPlugin"></a><div class="titlepage"></div>
40
40
<div class="refnamediv"><table width="100%"><tr>
41
41
<td valign="top">
44
44
</td>
45
45
<td valign="top" align="right"></td>
46
46
</tr></table></div>
47
 
<div class="refsect1" lang="en">
 
47
<div class="refsect1" title="Stability Level">
48
48
<a name="TotemPlugin.stability-level"></a><h2>Stability Level</h2>
49
49
Unstable, unless otherwise indicated
50
50
</div>
51
 
<div class="refsynopsisdiv">
 
51
<div class="refsynopsisdiv" title="Synopsis">
52
52
<a name="TotemPlugin.synopsis"></a><h2>Synopsis</h2>
53
53
<pre class="synopsis">
54
54
 
66
66
>GError</a> **error);
67
67
void                (<a class="link" href="TotemPlugin.html#TotemPluginDeactivationFunc" title="TotemPluginDeactivationFunc ()">*TotemPluginDeactivationFunc</a>)      (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
68
68
                                                         <a class="link" href="TotemObject.html" title="TotemObject">TotemObject</a> *totem);
69
 
<a
70
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
71
 
>GtkWidget</a> *         (<a class="link" href="TotemPlugin.html#TotemPluginWidgetFunc" title="TotemPluginWidgetFunc ()">*TotemPluginWidgetFunc</a>)            (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);
 
69
GtkWidget *         (<a class="link" href="TotemPlugin.html#TotemPluginWidgetFunc" title="TotemPluginWidgetFunc ()">*TotemPluginWidgetFunc</a>)            (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);
72
70
#define             <a class="link" href="TotemPlugin.html#TOTEM-PLUGIN-DEFINE-TYPE--CAPS" title="TOTEM_PLUGIN_DEFINE_TYPE()">TOTEM_PLUGIN_DEFINE_TYPE</a>            (TypeName, type_name, TYPE_PARENT)
73
71
#define             <a class="link" href="TotemPlugin.html#TOTEM-PLUGIN-REGISTER--CAPS" title="TOTEM_PLUGIN_REGISTER()">TOTEM_PLUGIN_REGISTER</a>               (PluginName, plugin_name)
74
72
#define             <a class="link" href="TotemPlugin.html#TOTEM-PLUGIN-REGISTER-EXTENDED--CAPS" title="TOTEM_PLUGIN_REGISTER_EXTENDED()">TOTEM_PLUGIN_REGISTER_EXTENDED</a>      (PluginName, plugin_name, _C_)
82
80
>GError</a> **error);
83
81
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,
84
82
                                                         <a class="link" href="TotemObject.html" title="TotemObject">TotemObject</a> *totem);
85
 
<a
86
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
87
 
>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>
 
83
GtkWidget *         <a class="link" href="TotemPlugin.html#totem-plugin-create-configure-dialog" title="totem_plugin_create_configure_dialog ()">totem_plugin_create_configure_dialog</a>
88
84
                                                        (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);
89
85
<a
90
86
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
106
102
                                                         const char *file);
107
103
</pre>
108
104
</div>
109
 
<div class="refsect1" lang="en">
 
105
<div class="refsect1" title="Object Hierarchy">
110
106
<a name="TotemPlugin.object-hierarchy"></a><h2>Object Hierarchy</h2>
111
107
<pre class="synopsis">
112
108
  <a
115
111
   +----TotemPlugin
116
112
</pre>
117
113
</div>
118
 
<div class="refsect1" lang="en">
 
114
<div class="refsect1" title="Properties">
119
115
<a name="TotemPlugin.properties"></a><h2>Properties</h2>
120
116
<pre class="synopsis">
121
117
  "<a class="link" href="TotemPlugin.html#TotemPlugin--name" title='The "name" property'>name</a>"                     <a
123
119
>gchar</a>*                : Read / Write
124
120
</pre>
125
121
</div>
126
 
<div class="refsect1" lang="en">
 
122
<div class="refsect1" title="Description">
127
123
<a name="TotemPlugin.description"></a><h2>Description</h2>
128
124
<p>
129
125
<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
131
127
<p>
132
128
</p>
133
129
</div>
134
 
<div class="refsect1" lang="en">
 
130
<div class="refsect1" title="Details">
135
131
<a name="TotemPlugin.details"></a><h2>Details</h2>
136
 
<div class="refsect2" lang="en">
 
132
<div class="refsect2" title="TotemPlugin">
137
133
<a name="TotemPlugin-struct"></a><h3>TotemPlugin</h3>
138
134
<pre class="programlisting">typedef struct _TotemPlugin TotemPlugin;</pre>
139
135
<p>
142
138
</p>
143
139
</div>
144
140
<hr>
145
 
<div class="refsect2" lang="en">
 
141
<div class="refsect2" title="TotemPluginClass">
146
142
<a name="TotemPluginClass"></a><h3>TotemPluginClass</h3>
147
143
<pre class="programlisting">typedef struct {
148
144
        GObjectClass parent_class;
156
152
</pre>
157
153
<p>
158
154
The class structure for the <a
159
 
href="http://library.gnome.org/devel/totem-pl-parser/TotemPlParser.html#TotemPlParser"
 
155
href="http://library.gnome.org/devel/totem-pl-parser/TotemPlParser.html"
160
156
><span class="type">TotemPlParser</span></a> type.</p>
161
157
<p>
162
158
</p>
173
169
<tr>
174
170
<td><p><span class="term"><a class="link" href="TotemPlugin.html#TotemPluginActivationFunc" title="TotemPluginActivationFunc ()">TotemPluginActivationFunc</a> <em class="structfield"><code>activate</code></em>;</span></p></td>
175
171
<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>.
176
 
It must be set by inheriting classes, and should return <a
177
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
178
 
><code class="literal">TRUE</code></a> if it successfully created/got handles to
179
 
the resources needed by the plugin. If it returns <a
180
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
181
 
><code class="literal">FALSE</code></a>, loading the plugin is abandoned.
 
172
It must be set by inheriting classes, and should return <code class="literal">TRUE</code> if it successfully created/got handles to
 
173
the resources needed by the plugin. If it returns <code class="literal">FALSE</code>, loading the plugin is abandoned.
182
174
</td>
183
175
</tr>
184
176
<tr>
190
182
<tr>
191
183
<td><p><span class="term"><a class="link" href="TotemPlugin.html#TotemPluginWidgetFunc" title="TotemPluginWidgetFunc ()">TotemPluginWidgetFunc</a> <em class="structfield"><code>create_configure_dialog</code></em>;</span></p></td>
192
184
<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>.
193
 
If non-<a
194
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
195
 
><code class="literal">NULL</code></a>, it should create and return the plugin's configuration dialog. If <a
196
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
197
 
><code class="literal">NULL</code></a>, the plugin is not
 
185
If non-<code class="literal">NULL</code>, it should create and return the plugin's configuration dialog. If <code class="literal">NULL</code>, the plugin is not
198
186
configurable.
199
187
</td>
200
188
</tr>
202
190
</table></div>
203
191
</div>
204
192
<hr>
205
 
<div class="refsect2" lang="en">
 
193
<div class="refsect2" title="enum TotemPluginError">
206
194
<a name="TotemPluginError"></a><h3>enum TotemPluginError</h3>
207
195
<pre class="programlisting">typedef enum {
208
196
        TOTEM_PLUGIN_ERROR_ACTIVATION
222
210
</table></div>
223
211
</div>
224
212
<hr>
225
 
<div class="refsect2" lang="en">
 
213
<div class="refsect2" title="TotemPluginActivationFunc ()">
226
214
<a name="TotemPluginActivationFunc"></a><h3>TotemPluginActivationFunc ()</h3>
227
215
<pre class="programlisting"><a
228
216
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
237
225
</p>
238
226
<p>
239
227
If an error is encountered while setting up the plugin, <em class="parameter"><code>error</code></em> should be set, and the function
240
 
should return <a
241
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
242
 
><code class="literal">FALSE</code></a>. Totem will then not mark the plugin as activated, and will ensure it's not loaded
 
228
should return <code class="literal">FALSE</code>. Totem will then not mark the plugin as activated, and will ensure it's not loaded
243
229
again unless explicitly asked for by the user.</p>
244
230
<p>
245
231
</p>
265
251
</tr>
266
252
<tr>
267
253
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
268
 
<td> <a
269
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
270
 
><code class="literal">TRUE</code></a> on success, <a
271
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
272
 
><code class="literal">FALSE</code></a> otherwise
 
254
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise
273
255
</td>
274
256
</tr>
275
257
</tbody>
276
258
</table></div>
277
259
</div>
278
260
<hr>
279
 
<div class="refsect2" lang="en">
 
261
<div class="refsect2" title="TotemPluginDeactivationFunc ()">
280
262
<a name="TotemPluginDeactivationFunc"></a><h3>TotemPluginDeactivationFunc ()</h3>
281
263
<pre class="programlisting">void                (*TotemPluginDeactivationFunc)      (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
282
264
                                                         <a class="link" href="TotemObject.html" title="TotemObject">TotemObject</a> *totem);</pre>
306
288
</table></div>
307
289
</div>
308
290
<hr>
309
 
<div class="refsect2" lang="en">
 
291
<div class="refsect2" title="TotemPluginWidgetFunc ()">
310
292
<a name="TotemPluginWidgetFunc"></a><h3>TotemPluginWidgetFunc ()</h3>
311
 
<pre class="programlisting"><a
312
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
313
 
>GtkWidget</a> *         (*TotemPluginWidgetFunc)            (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);</pre>
 
293
<pre class="programlisting">GtkWidget *         (*TotemPluginWidgetFunc)            (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);</pre>
314
294
<p>
315
295
Called when the configuration dialogue for the plugin needs to be built, this function should return
316
296
a complete window which will be shown by the Totem code. The widget needs to be capable of hiding itself
330
310
</tr>
331
311
<tr>
332
312
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
333
 
<td> a <a
334
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
335
 
><span class="type">GtkWidget</span></a>
 
313
<td> a <span class="type">GtkWidget</span>
336
314
</td>
337
315
</tr>
338
316
</tbody>
339
317
</table></div>
340
318
</div>
341
319
<hr>
342
 
<div class="refsect2" lang="en">
 
320
<div class="refsect2" title="TOTEM_PLUGIN_DEFINE_TYPE()">
343
321
<a name="TOTEM-PLUGIN-DEFINE-TYPE--CAPS"></a><h3>TOTEM_PLUGIN_DEFINE_TYPE()</h3>
344
322
<pre class="programlisting">#define             TOTEM_PLUGIN_DEFINE_TYPE(TypeName, type_name, TYPE_PARENT)</pre>
345
323
<p>
369
347
</table></div>
370
348
</div>
371
349
<hr>
372
 
<div class="refsect2" lang="en">
 
350
<div class="refsect2" title="TOTEM_PLUGIN_REGISTER()">
373
351
<a name="TOTEM-PLUGIN-REGISTER--CAPS"></a><h3>TOTEM_PLUGIN_REGISTER()</h3>
374
352
<pre class="programlisting">#define             TOTEM_PLUGIN_REGISTER(PluginName, plugin_name)</pre>
375
353
<p>
394
372
</table></div>
395
373
</div>
396
374
<hr>
397
 
<div class="refsect2" lang="en">
 
375
<div class="refsect2" title="TOTEM_PLUGIN_REGISTER_EXTENDED()">
398
376
<a name="TOTEM-PLUGIN-REGISTER-EXTENDED--CAPS"></a><h3>TOTEM_PLUGIN_REGISTER_EXTENDED()</h3>
399
377
<pre class="programlisting">#define             TOTEM_PLUGIN_REGISTER_EXTENDED(PluginName, plugin_name, _C_)</pre>
400
378
<p>
438
416
</table></div>
439
417
</div>
440
418
<hr>
441
 
<div class="refsect2" lang="en">
 
419
<div class="refsect2" title="TOTEM_PLUGIN_REGISTER_TYPE()">
442
420
<a name="TOTEM-PLUGIN-REGISTER-TYPE--CAPS"></a><h3>TOTEM_PLUGIN_REGISTER_TYPE()</h3>
443
421
<pre class="programlisting">#define             TOTEM_PLUGIN_REGISTER_TYPE(type_name)</pre>
444
422
<p>
456
434
</table></div>
457
435
</div>
458
436
<hr>
459
 
<div class="refsect2" lang="en">
 
437
<div class="refsect2" title="totem_plugin_activate ()">
460
438
<a name="totem-plugin-activate"></a><h3>totem_plugin_activate ()</h3>
461
439
<pre class="programlisting"><a
462
440
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
486
464
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
487
465
<td> return location for a <a
488
466
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
489
 
><span class="type">GError</span></a>, or <a
490
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
491
 
><code class="literal">NULL</code></a>
 
467
><span class="type">GError</span></a>, or <code class="literal">NULL</code>
492
468
</td>
493
469
</tr>
494
470
<tr>
495
471
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
496
 
<td> <a
497
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
498
 
><code class="literal">TRUE</code></a> on success
 
472
<td> <code class="literal">TRUE</code> on success
499
473
</td>
500
474
</tr>
501
475
</tbody>
502
476
</table></div>
503
477
</div>
504
478
<hr>
505
 
<div class="refsect2" lang="en">
 
479
<div class="refsect2" title="totem_plugin_deactivate ()">
506
480
<a name="totem-plugin-deactivate"></a><h3>totem_plugin_deactivate ()</h3>
507
481
<pre class="programlisting">void                totem_plugin_deactivate             (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
508
482
                                                         <a class="link" href="TotemObject.html" title="TotemObject">TotemObject</a> *totem);</pre>
527
501
</table></div>
528
502
</div>
529
503
<hr>
530
 
<div class="refsect2" lang="en">
 
504
<div class="refsect2" title="totem_plugin_create_configure_dialog ()">
531
505
<a name="totem-plugin-create-configure-dialog"></a><h3>totem_plugin_create_configure_dialog ()</h3>
532
 
<pre class="programlisting"><a
533
 
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
534
 
>GtkWidget</a> *         totem_plugin_create_configure_dialog
 
506
<pre class="programlisting">GtkWidget *         totem_plugin_create_configure_dialog
535
507
                                                        (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);</pre>
536
508
<p>
537
509
Returns the plugin's configuration dialog, as created by
548
520
</tr>
549
521
<tr>
550
522
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
551
 
<td> the configuration dialog, or <a
552
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
553
 
><code class="literal">NULL</code></a>
 
523
<td> the configuration dialog, or <code class="literal">NULL</code>
554
524
</td>
555
525
</tr>
556
526
</tbody>
557
527
</table></div>
558
528
</div>
559
529
<hr>
560
 
<div class="refsect2" lang="en">
 
530
<div class="refsect2" title="totem_plugin_is_configurable ()">
561
531
<a name="totem-plugin-is-configurable"></a><h3>totem_plugin_is_configurable ()</h3>
562
532
<pre class="programlisting"><a
563
533
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
564
534
>gboolean</a>            totem_plugin_is_configurable        (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin);</pre>
565
535
<p>
566
 
Returns <a
567
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
568
 
><code class="literal">TRUE</code></a> if the plugin is configurable and has a
 
536
Returns <code class="literal">TRUE</code> if the plugin is configurable and has a
569
537
configuration dialog. It calls the plugin's
570
538
is_configurable method.</p>
571
539
<p>
580
548
</tr>
581
549
<tr>
582
550
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
583
 
<td> <a
584
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
585
 
><code class="literal">TRUE</code></a> if the plugin is configurable
 
551
<td> <code class="literal">TRUE</code> if the plugin is configurable
586
552
</td>
587
553
</tr>
588
554
</tbody>
589
555
</table></div>
590
556
</div>
591
557
<hr>
592
 
<div class="refsect2" lang="en">
 
558
<div class="refsect2" title="totem_plugin_load_interface ()">
593
559
<a name="totem-plugin-load-interface"></a><h3>totem_plugin_load_interface ()</h3>
594
560
<pre class="programlisting"><a
595
561
href="http://library.gnome.org/devel/gtk/unstable/GtkBuilder.html"
627
593
</tr>
628
594
<tr>
629
595
<td><p><span class="term"><em class="parameter"><code>fatal</code></em> :</span></p></td>
630
 
<td> <a
631
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
632
 
><code class="literal">TRUE</code></a> if it's a fatal error if the interface can't be loaded
 
596
<td> <code class="literal">TRUE</code> if it's a fatal error if the interface can't be loaded
633
597
</td>
634
598
</tr>
635
599
<tr>
655
619
</table></div>
656
620
</div>
657
621
<hr>
658
 
<div class="refsect2" lang="en">
 
622
<div class="refsect2" title="totem_plugin_find_file ()">
659
623
<a name="totem-plugin-find-file"></a><h3>totem_plugin_find_file ()</h3>
660
624
<pre class="programlisting">char *              totem_plugin_find_file              (<a class="link" href="TotemPlugin.html" title="TotemPlugin">TotemPlugin</a> *plugin,
661
625
                                                         const char *file);</pre>
684
648
</tr>
685
649
<tr>
686
650
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
687
 
<td> a newly-allocated absolute path for the file, or <a
688
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
689
 
><code class="literal">NULL</code></a>
 
651
<td> a newly-allocated absolute path for the file, or <code class="literal">NULL</code>
690
652
</td>
691
653
</tr>
692
654
</tbody>
693
655
</table></div>
694
656
</div>
695
657
</div>
696
 
<div class="refsect1" lang="en">
 
658
<div class="refsect1" title="Property Details">
697
659
<a name="TotemPlugin.property-details"></a><h2>Property Details</h2>
698
 
<div class="refsect2" lang="en">
 
660
<div class="refsect2" title='The "name" property'>
699
661
<a name="TotemPlugin--name"></a><h3>The <code class="literal">"name"</code> property</h3>
700
662
<pre class="programlisting">  "name"                     <a
701
663
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"