/usr/share/gtk-doc/html/libpeas/PeasPluginInfo.html is in libpeas-doc 1.8.1-2ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Peas Reference Manual: PeasPluginInfo</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#PeasPluginInfo.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#PeasPluginInfo.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="PeasEngine.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libpeas-PeasExtension.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="PeasPluginInfo.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-is-loaded" title="peas_plugin_info_is_loaded ()">peas_plugin_info_is_loaded</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-is-available" title="peas_plugin_info_is_available ()">peas_plugin_info_is_available</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-is-builtin" title="peas_plugin_info_is_builtin ()">peas_plugin_info_is_builtin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-is-hidden" title="peas_plugin_info_is_hidden ()">peas_plugin_info_is_hidden</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSettings</span> *
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-settings" title="peas_plugin_info_get_settings ()">peas_plugin_info_get_settings</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-dependencies" title="peas_plugin_info_get_dependencies ()">peas_plugin_info_get_dependencies</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-has-dependency" title="peas_plugin_info_has_dependency ()">peas_plugin_info_has_dependency</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-name" title="peas_plugin_info_get_name ()">peas_plugin_info_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-description" title="peas_plugin_info_get_description ()">peas_plugin_info_get_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-authors" title="peas_plugin_info_get_authors ()">peas_plugin_info_get_authors</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-website" title="peas_plugin_info_get_website ()">peas_plugin_info_get_website</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-copyright" title="peas_plugin_info_get_copyright ()">peas_plugin_info_get_copyright</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-version" title="peas_plugin_info_get_version ()">peas_plugin_info_get_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-external-data" title="peas_plugin_info_get_external_data ()">peas_plugin_info_get_external_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasPluginInfo.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="PeasPluginInfo.html#PeasPluginInfo-struct" title="PeasPluginInfo">PeasPluginInfo</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="PeasPluginInfo.html#PeasPluginInfoError" title="enum PeasPluginInfoError">PeasPluginInfoError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="PeasPluginInfo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GBoxed
<span class="lineart">╰──</span> 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"><pre class="programlisting">
[Plugin]
Module=helloworld
Name=Hello World
Description=Displays "Hello World"
Authors=Steve Frécinaux <code@istique.net>
Copyright=Copyright © 2009-10 Steve Frécinaux
Website=http://live.gnome.org/Libpeas
Help=http://library.gnome.org/devel/libpeas/unstable/
</pre></div>
<p></p>
</div>
<div class="refsect1">
<a name="PeasPluginInfo.functions_details"></a><h2>Functions</h2>
<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="refsect3">
<a name="id-1.2.2.3.7.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.2.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the plugin is loaded.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.3.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the plugin is available.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.4.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.4.8"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the plugin is a builtin plugin, <code class="literal">FALSE</code>
if not.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.5.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.5.8"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the plugin is a hidden plugin, <code class="literal">FALSE</code>
if not.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.6.8"></a><h4>Returns</h4>
<p> the module name.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.7.7"></a><h4>Returns</h4>
<p> the module directory.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.8.7"></a><h4>Returns</h4>
<p> the plugin's data dir.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>schema_id</p></td>
<td class="parameter_description"><p> The schema id. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.9.6"></a><h4>Returns</h4>
<p> a new <span class="type">GSettings</span>, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</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="refsect3">
<a name="id-1.2.2.3.7.10.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.10.8"></a><h4>Returns</h4>
<p> the plugin's dependencies. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</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="refsect3">
<a name="id-1.2.2.3.7.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>module_name</p></td>
<td class="parameter_description"><p>The name of the plugin to check.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.11.6"></a><h4>Returns</h4>
<p> whether the plugin depends on the plugin <em class="parameter"><code>module_name</code></em>
.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.12.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.12.8"></a><h4>Returns</h4>
<p> the plugin's name.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.13.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.13.8"></a><h4>Returns</h4>
<p> the plugin's description.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.14.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.14.8"></a><h4>Returns</h4>
<p> the plugin's icon name.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.15.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.15.8"></a><h4>Returns</h4>
<p> the plugin's help URI.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.16.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.16.7"></a><h4>Returns</h4>
<p> the plugin's author list. </p>
<p><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></p>
</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="refsect3">
<a name="id-1.2.2.3.7.17.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.17.7"></a><h4>Returns</h4>
<p> the plugin's associated website.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.18.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.18.7"></a><h4>Returns</h4>
<p> the plugin's copyright information.</p>
<p></p>
</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="refsect3">
<a name="id-1.2.2.3.7.19.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.19.7"></a><h4>Returns</h4>
<p> the plugin's version.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="peas-plugin-info-get-external-data"></a><h3>peas_plugin_info_get_external_data ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
peas_plugin_info_get_external_data (<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> *key</code></em>);</pre>
<p>Gets external data specified for the plugin.</p>
<p>External data is specified in the plugin info file prefixed with X-. For
example, if a key/value pair X-Peas=1 is specified in the key file, you
can use "Peas" for <em class="parameter"><code>key</code></em>
to retrieve the value "1".</p>
<p>Note: that you can omit the X- prefix when retrieving the value,
but not when specifying the value in the file.</p>
<div class="refsect3">
<a name="id-1.2.2.3.7.20.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo"><span class="type">PeasPluginInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The key to lookup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.3.7.20.8"></a><h4>Returns</h4>
<p> the external data, or <code class="literal">NULL</code> if the external data could not be found.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="PeasPluginInfo.other_details"></a><h2>Types and Values</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>
<p>These identify the various errors that can occur while
loading a plugin.</p>
<div class="refsect3">
<a name="id-1.2.2.3.8.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="PEAS-PLUGIN-INFO-ERROR-LOADING-FAILED:CAPS"></a>PEAS_PLUGIN_INFO_ERROR_LOADING_FAILED</p></td>
<td class="enum_member_description">
<p> The plugin failed to load.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PEAS-PLUGIN-INFO-ERROR-LOADER-NOT-FOUND:CAPS"></a>PEAS_PLUGIN_INFO_ERROR_LOADER_NOT_FOUND</p></td>
<td class="enum_member_description">
<p> The plugin's loader was not found.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PEAS-PLUGIN-INFO-ERROR-DEP-NOT-FOUND:CAPS"></a>PEAS_PLUGIN_INFO_ERROR_DEP_NOT_FOUND</p></td>
<td class="enum_member_description">
<p> A dependency of the plugin was not found.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PEAS-PLUGIN-INFO-ERROR-DEP-LOADING-FAILED:CAPS"></a>PEAS_PLUGIN_INFO_ERROR_DEP_LOADING_FAILED</p></td>
<td class="enum_member_description">
<p> A dependency of the plugin failed to load.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|