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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PeasPluginInfo</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="ch01.html" title="Core Classes">
<link rel="prev" href="PeasEngine.html" title="PeasEngine">
<link rel="next" href="libpeas-PeasExtension.html" title="PeasExtension">
<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="PeasEngine.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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="libpeas-PeasExtension.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PeasPluginInfo.synopsis" class="shortcut">Top</a>
|
<a href="#PeasPluginInfo.description" class="shortcut">Description</a>
|
<a href="#PeasPluginInfo.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="PeasPluginInfo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PeasPluginInfo.top_of_page"></a>PeasPluginInfo</span></h2>
<p>PeasPluginInfo — Information about a plugin.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PeasPluginInfo.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="PeasPluginInfo.html#PeasPluginInfo-struct" title="PeasPluginInfo">PeasPluginInfo</a>;
enum <a class="link" href="PeasPluginInfo.html#PeasPluginInfoError" title="enum PeasPluginInfoError">PeasPluginInfoError</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="PeasPluginInfo.html#peas-plugin-info-is-loaded" title="peas_plugin_info_is_loaded ()">peas_plugin_info_is_loaded</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="PeasPluginInfo.html#peas-plugin-info-is-available" title="peas_plugin_info_is_available ()">peas_plugin_info_is_available</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="PeasPluginInfo.html#peas-plugin-info-is-builtin" title="peas_plugin_info_is_builtin ()">peas_plugin_info_is_builtin</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="PeasPluginInfo.html#peas-plugin-info-is-hidden" title="peas_plugin_info_is_hidden ()">peas_plugin_info_is_hidden</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-module-name" title="peas_plugin_info_get_module_name ()">peas_plugin_info_get_module_name</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-module-dir" title="peas_plugin_info_get_module_dir ()">peas_plugin_info_get_module_dir</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-data-dir" title="peas_plugin_info_get_data_dir ()">peas_plugin_info_get_data_dir</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
<span class="returnvalue">GSettings</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-settings" title="peas_plugin_info_get_settings ()">peas_plugin_info_get_settings</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *schema_id</code></em>);
const <span class="returnvalue">gchar</span> ** <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-dependencies" title="peas_plugin_info_get_dependencies ()">peas_plugin_info_get_dependencies</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="PeasPluginInfo.html#peas-plugin-info-has-dependency" title="peas_plugin_info_has_dependency ()">peas_plugin_info_has_dependency</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *module_name</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-name" title="peas_plugin_info_get_name ()">peas_plugin_info_get_name</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-description" title="peas_plugin_info_get_description ()">peas_plugin_info_get_description</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-icon-name" title="peas_plugin_info_get_icon_name ()">peas_plugin_info_get_icon_name</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-help-uri" title="peas_plugin_info_get_help_uri ()">peas_plugin_info_get_help_uri</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> ** <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-authors" title="peas_plugin_info_get_authors ()">peas_plugin_info_get_authors</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-website" title="peas_plugin_info_get_website ()">peas_plugin_info_get_website</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-copyright" title="peas_plugin_info_get_copyright ()">peas_plugin_info_get_copyright</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-version" title="peas_plugin_info_get_version ()">peas_plugin_info_get_version</a> (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PeasPluginInfo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GBoxed
+----PeasPluginInfo
</pre>
</div>
<div class="refsect1">
<a name="PeasPluginInfo.description"></a><h2>Description</h2>
<p>
A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> contains all the information available about a plugin.
</p>
<p>
All this information comes from the related plugin info file, whose file
extension is ".plugin". Here is an example of such a plugin file, in the
<span class="type">GKeyFile</span> format:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">[</span>Plugin<span class="gtkdoc opt">]</span>
Module<span class="gtkdoc opt">=</span>helloworld
Name<span class="gtkdoc opt">=</span>Hello World
Description<span class="gtkdoc opt">=</span>Displays <span class="string">"Hello World"</span>
Authors<span class="gtkdoc opt">=</span>Steve Frécinaux <span class="gtkdoc opt"><</span>code@istique<span class="gtkdoc opt">.</span>net<span class="gtkdoc opt">></span>
Copyright<span class="gtkdoc opt">=</span>Copyright © <span class="number">2009</span><span class="gtkdoc opt">-</span><span class="number">10</span> Steve Frécinaux
Website<span class="gtkdoc opt">=</span>http<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//live.gnome.org/Libpeas</span>
Help<span class="gtkdoc opt">=</span>http<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//library.gnome.org/devel/libpeas/unstable/</span>
IAge<span class="gtkdoc opt">=</span><span class="number">2</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="PeasPluginInfo.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PeasPluginInfo-struct"></a><h3>PeasPluginInfo</h3>
<pre class="programlisting">typedef struct _PeasPluginInfo PeasPluginInfo;</pre>
<p>
The <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> structure contains only private data and should only
be accessed using the provided API.
</p>
</div>
<hr>
<div class="refsect2">
<a name="PeasPluginInfoError"></a><h3>enum PeasPluginInfoError</h3>
<pre class="programlisting">typedef enum {
PEAS_PLUGIN_INFO_ERROR_LOADING_FAILED,
PEAS_PLUGIN_INFO_ERROR_LOADER_NOT_FOUND,
PEAS_PLUGIN_INFO_ERROR_DEP_NOT_FOUND,
PEAS_PLUGIN_INFO_ERROR_DEP_LOADING_FAILED
} PeasPluginInfoError;
</pre>
<p>
These identify the various errors that can occur while
loading a plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="PEAS-PLUGIN-INFO-ERROR-LOADING-FAILED:CAPS"></a><span class="term"><code class="literal">PEAS_PLUGIN_INFO_ERROR_LOADING_FAILED</code></span></p></td>
<td> The plugin failed to load.
</td>
</tr>
<tr>
<td><p><a name="PEAS-PLUGIN-INFO-ERROR-LOADER-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">PEAS_PLUGIN_INFO_ERROR_LOADER_NOT_FOUND</code></span></p></td>
<td> The plugin's loader was not found.
</td>
</tr>
<tr>
<td><p><a name="PEAS-PLUGIN-INFO-ERROR-DEP-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">PEAS_PLUGIN_INFO_ERROR_DEP_NOT_FOUND</code></span></p></td>
<td> A dependency of the plugin was not found.
</td>
</tr>
<tr>
<td><p><a name="PEAS-PLUGIN-INFO-ERROR-DEP-LOADING-FAILED:CAPS"></a><span class="term"><code class="literal">PEAS_PLUGIN_INFO_ERROR_DEP_LOADING_FAILED</code></span></p></td>
<td> A dependency of the plugin failed to load.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-is-loaded"></a><h3>peas_plugin_info_is_loaded ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> peas_plugin_info_is_loaded (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Check if the plugin is loaded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the plugin is loaded.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-is-available"></a><h3>peas_plugin_info_is_available ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> peas_plugin_info_is_available (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Check if the plugin is available.
</p>
<p>
A plugin is marked as not available when there is no loader available to
load it, or when there has been an error when trying to load it previously.
If not available then <em class="parameter"><code>error</code></em> will be set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <span class="type">GError</span>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the plugin is available.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-is-builtin"></a><h3>peas_plugin_info_is_builtin ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> peas_plugin_info_is_builtin (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Check if the plugin is a builtin plugin.
</p>
<p>
A builtin plugin is a plugin which cannot be enabled or disabled by the
user through a plugin manager (like <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>). Loading or
unloading such plugins is the responsibility of the application alone.
Most applications will usually load those plugins immediately after
the initialization of the <a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a>.
</p>
<p>
The relevant key in the plugin info file is "Builtin".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the plugin is a builtin plugin, <code class="literal">FALSE</code>
if not.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-is-hidden"></a><h3>peas_plugin_info_is_hidden ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> peas_plugin_info_is_hidden (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Check if the plugin is a hidden plugin.
</p>
<p>
A hidden plugin is a plugin which cannot be seen by a
user through a plugin manager (like <a class="link" href="PeasGtkPluginManager.html" title="PeasGtkPluginManager"><span class="type">PeasGtkPluginManager</span></a>). Loading and
unloading such plugins is the responsibility of the application alone or
through plugins that depend on them.
</p>
<p>
The relevant key in the plugin info file is "Hidden".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the plugin is a hidden plugin, <code class="literal">FALSE</code>
if not.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-module-name"></a><h3>peas_plugin_info_get_module_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_module_name (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the module name.
</p>
<p>
The module name will be used to find the actual plugin. The way this value
will be used depends on the loader (i.e. on the language) of the plugin.
This value is also used to uniquely identify a particular plugin.
</p>
<p>
The relevant key in the plugin info file is "Module".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the module name.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-module-dir"></a><h3>peas_plugin_info_get_module_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_module_dir (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the module directory.
</p>
<p>
The module directory is the directory where the plugin file was found. This
is not a value from the <span class="type">GKeyFile</span>, but rather a value provided by the
<a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the module directory.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-data-dir"></a><h3>peas_plugin_info_get_data_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_data_dir (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the data dir of the plugin.
</p>
<p>
The module data directory is the directory where a plugin should find its
runtime data. This is not a value read from the <span class="type">GKeyFile</span>, but rather a
value provided by the <a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a>, depending on where the plugin file was
found.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's data dir.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-settings"></a><h3>peas_plugin_info_get_settings ()</h3>
<pre class="programlisting"><span class="returnvalue">GSettings</span> * peas_plugin_info_get_settings (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *schema_id</code></em>);</pre>
<p>
Creates a new <span class="type">GSettings</span> for the given <em class="parameter"><code>schema_id</code></em> and if
gschemas.compiled is not in the module directory an attempt
will be made to create it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema_id</code></em> :</span></p></td>
<td>The schema id. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <span class="type">GSettings</span>, or <code class="literal">NULL</code>. <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>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-dependencies"></a><h3>peas_plugin_info_get_dependencies ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> ** peas_plugin_info_get_dependencies (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the dependencies of the plugin.
</p>
<p>
The <a class="link" href="PeasEngine.html" title="PeasEngine"><span class="type">PeasEngine</span></a> will always ensure that the dependencies of a plugin are
loaded when the said plugin is loaded. It means that dependencies are
loaded before the plugin, and unloaded after it. Circular dependencies of
plugins lead to undefined loading order.
</p>
<p>
The relevant key in the plugin info file is "Depends".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's dependencies. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-has-dependency"></a><h3>peas_plugin_info_has_dependency ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> peas_plugin_info_has_dependency (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *module_name</code></em>);</pre>
<p>
Check if the plugin depends on another plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>module_name</code></em> :</span></p></td>
<td>The name of the plugin to check.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether the plugin depends on the plugin <em class="parameter"><code>module_name</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-name"></a><h3>peas_plugin_info_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_name (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the name of the plugin.
</p>
<p>
The name of a plugin should be a nice short string to be presented in UIs.
</p>
<p>
The relevant key in the plugin info file is "Name".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's name.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-description"></a><h3>peas_plugin_info_get_description ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_description (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the description of the plugin.
</p>
<p>
The description of the plugin should be a string presenting the purpose of
the plugin. It will typically be presented in a plugin's about box.
</p>
<p>
The relevant key in the plugin info file is "Description".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's description.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-icon-name"></a><h3>peas_plugin_info_get_icon_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_icon_name (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the icon name of the plugin.
</p>
<p>
The icon of the plugin will be presented in the plugin manager UI. If no
icon is specified, the default green puzzle icon will be used.
</p>
<p>
The relevant key in the plugin info file is "Icon".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's icon name.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-help-uri"></a><h3>peas_plugin_info_get_help_uri ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_help_uri (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the help URI of the plugin.
</p>
<p>
The Help URI of a plugin will typically be presented by the plugin manager
as a "Help" button linking to the URI. It can either be a HTTP URL on some
website or a ghelp: URI if a Gnome help page is available for the plugin.
</p>
<p>
The relevant key in the plugin info file is "Help". Other platform-specific
keys exist for platform-specific help files. Those are "Help-GNOME",
"Help-Windows" and "Help-MacOS-X".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's help URI.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-authors"></a><h3>peas_plugin_info_get_authors ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> ** peas_plugin_info_get_authors (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets a <code class="literal">NULL</code>-terminated array of strings with the authors of the plugin.
</p>
<p>
The relevant key in the plugin info file is "Authors".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's author list. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-website"></a><h3>peas_plugin_info_get_website ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_website (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the website of the plugin.
</p>
<p>
The relevant key in the plugin info file is "Website".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's associated website.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-copyright"></a><h3>peas_plugin_info_get_copyright ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_copyright (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the copyright of the plugin.
</p>
<p>
The relevant key in the plugin info file is "Copyright".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's copyright information.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-version"></a><h3>peas_plugin_info_get_version ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * peas_plugin_info_get_version (<em class="parameter"><code>const <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a> *info</code></em>);</pre>
<p>
Gets the version of the plugin.
</p>
<p>
The relevant key in the plugin info file is "Version".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the plugin's version.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|
