/usr/share/gtk-doc/html/ethos/EthosPluginInfo.html is in libethos-doc 0.2.2-2ubuntu1.
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 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EthosPluginInfo</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Ethos Reference Manual">
<link rel="up" href="ch04.html" title="Ethos Reference">
<link rel="prev" href="EthosManager.html" title="EthosManager">
<link rel="next" href="ethos-EthosPluginLoader.html" title="EthosPluginLoader">
<meta name="generator" content="GTK-Doc V1.18 (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="EthosManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.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">Ethos Reference Manual</th>
<td><a accesskey="n" href="ethos-EthosPluginLoader.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EthosPluginInfo.synopsis" class="shortcut">Top</a>
|
<a href="#EthosPluginInfo.description" class="shortcut">Description</a>
|
<a href="#EthosPluginInfo.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EthosPluginInfo.properties" class="shortcut">Properties</a>
|
<a href="#EthosPluginInfo.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EthosPluginInfo"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EthosPluginInfo.top_of_page"></a>EthosPluginInfo</span></h2>
<p>EthosPluginInfo — plugin description during runtime</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EthosPluginInfo.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="EthosPluginInfo.html#ETHOS-PLUGIN-INFO-CONST:CAPS" title="ETHOS_PLUGIN_INFO_CONST()">ETHOS_PLUGIN_INFO_CONST</a> (obj)
struct <a class="link" href="EthosPluginInfo.html#EthosPluginInfo-struct" title="struct EthosPluginInfo">EthosPluginInfo</a>;
struct <a class="link" href="EthosPluginInfo.html#EthosPluginInfoClass" title="struct EthosPluginInfoClass">EthosPluginInfoClass</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-active" title="ethos_plugin_info_get_active ()">ethos_plugin_info_get_active</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
<span class="returnvalue">gchar</span> ** <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-authors" title="ethos_plugin_info_get_authors ()">ethos_plugin_info_get_authors</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-copyright" title="ethos_plugin_info_get_copyright ()">ethos_plugin_info_get_copyright</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-dependencies" title="ethos_plugin_info_get_dependencies ()">ethos_plugin_info_get_dependencies</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-description" title="ethos_plugin_info_get_description ()">ethos_plugin_info_get_description</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-errors" title="ethos_plugin_info_get_errors ()">ethos_plugin_info_get_errors</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-filename" title="ethos_plugin_info_get_filename ()">ethos_plugin_info_get_filename</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-iage" title="ethos_plugin_info_get_iage ()">ethos_plugin_info_get_iage</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-icon-name" title="ethos_plugin_info_get_icon_name ()">ethos_plugin_info_get_icon_name</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-id" title="ethos_plugin_info_get_id ()">ethos_plugin_info_get_id</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-loader" title="ethos_plugin_info_get_loader ()">ethos_plugin_info_get_loader</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-module" title="ethos_plugin_info_get_module ()">ethos_plugin_info_get_module</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-name" title="ethos_plugin_info_get_name ()">ethos_plugin_info_get_name</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-version" title="ethos_plugin_info_get_version ()">ethos_plugin_info_get_version</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-website" title="ethos_plugin_info_get_website ()">ethos_plugin_info_get_website</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-has-errors" title="ethos_plugin_info_has_errors ()">ethos_plugin_info_has_errors</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-load-from-data" title="ethos_plugin_info_load_from_data ()">ethos_plugin_info_load_from_data</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gsize</span> length</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-load-from-file" title="ethos_plugin_info_load_from_file ()">ethos_plugin_info_load_from_file</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-load-from-key-file" title="ethos_plugin_info_load_from_key_file ()">ethos_plugin_info_load_from_key_file</a>
(<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group</code></em>,
<em class="parameter"><code><span class="type">GKeyFile</span> *key_file</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="returnvalue">EthosPluginInfo</span></a> * <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-new" title="ethos_plugin_info_new ()">ethos_plugin_info_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-set-active" title="ethos_plugin_info_set_active ()">ethos_plugin_info_set_active</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> active</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-set-filename" title="ethos_plugin_info_set_filename ()">ethos_plugin_info_set_filename</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-set-id" title="ethos_plugin_info_set_id ()">ethos_plugin_info_set_id</a> (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EthosPluginInfo.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----EthosPluginInfo
</pre>
</div>
<div class="refsect1">
<a name="EthosPluginInfo.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--active" title='The "active" property'>active</a>" <span class="type">gboolean</span> : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--authors" title='The "authors" property'>authors</a>" <span class="type">GStrv</span> : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--copyright" title='The "copyright" property'>copyright</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--dependencies" title='The "dependencies" property'>dependencies</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--description" title='The "description" property'>description</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--filename" title='The "filename" property'>filename</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--icon-name" title='The "icon-name" property'>icon-name</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--id" title='The "id" property'>id</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--loader" title='The "loader" property'>loader</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--module" title='The "module" property'>module</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--version" title='The "version" property'>version</a>" <span class="type">gchar</span>* : Read
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo--website" title='The "website" property'>website</a>" <span class="type">gchar</span>* : Read
</pre>
</div>
<div class="refsect1">
<a name="EthosPluginInfo.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo-loaded" title='The "loaded" signal'>loaded</a>" : <code class="literal">Run First</code>
"<a class="link" href="EthosPluginInfo.html#EthosPluginInfo-unloaded" title='The "unloaded" signal'>unloaded</a>" : <code class="literal">Run First</code>
</pre>
</div>
<div class="refsect1">
<a name="EthosPluginInfo.description"></a><h2>Description</h2>
<p>
<a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> encapsulates information about a plugin during runtime. The data for an
<a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> is read from a plugin description file such as "my-plugin.example-plugin".
This includes information about the plugin module to load, what <span class="type">EthosPluginLoader</span> should
be used, the author, description, and the icon for the plugin.
</p>
<p>
The naming of the plugin description files is derived from the name of the application or
the name set using <a class="link" href="EthosManager.html#ethos-manager-set-app-name" title="ethos_manager_set_app_name ()"><code class="function">ethos_manager_set_app_name()</code></a>. It is all lowercase and is named such as
"name.appname-plugin" where appname is lowercase. Therfore, if the application was named
"Marina" and the plugin was named "foo", an apt name for the description file would be
"foo.marina-plugin".
</p>
<p>
The plugin description file consists of a simple <span class="type">GKeyFile</span> format. The header for key-file
is also derived from the application name. Therefore, if the application was named "Marina",
the header for the key file would be "[Marina Plugin]".
</p>
<p>
A plugin for an application named "Sample" may look like:
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
# example.sample-plugin
[Sample Plugin]
Name=Example
Loader=python
Module=example
IAge=1
Authors=Foo;Bar;Baz
Copyright=MIT X11
Website=http://example.com
</pre></div>
<p>
</p>
</div>
<div class="refsect1">
<a name="EthosPluginInfo.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ETHOS-PLUGIN-INFO-CONST:CAPS"></a><h3>ETHOS_PLUGIN_INFO_CONST()</h3>
<pre class="programlisting">#define ETHOS_PLUGIN_INFO_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ETHOS_TYPE_PLUGIN_INFO, EthosPluginInfo const))
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo-struct"></a><h3>struct EthosPluginInfo</h3>
<pre class="programlisting">struct EthosPluginInfo;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfoClass"></a><h3>struct EthosPluginInfoClass</h3>
<pre class="programlisting">struct EthosPluginInfoClass {
GObjectClass parent_class;
void (*reserved1) (void);
void (*reserved2) (void);
void (*reserved3) (void);
void (*reserved4) (void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-active"></a><h3>ethos_plugin_info_get_active ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> ethos_plugin_info_get_active (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves whether or not the plugin is currently activated.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</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 currently active</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-authors"></a><h3>ethos_plugin_info_get_authors ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> ** ethos_plugin_info_get_authors (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retreives the authors of the plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <code class="literal">NULL</code> terminated array of strings that contain the authors.
This value should not be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-copyright"></a><h3>ethos_plugin_info_get_copyright ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_copyright (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves the copyright of the plugin
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the copyright. The string
should not be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-dependencies"></a><h3>ethos_plugin_info_get_dependencies ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_dependencies (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves the list of dependencies as a string. The string is a set
of checks that must pass before the plugin can be loaded.
</p>
<p>
Such as:
</p>
<p>
"network >= 0.1 xmpp"
</p>
<p>
Would require the network plugin 0.1 or greater and any version of the
xmpp plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the dependencies or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-description"></a><h3>ethos_plugin_info_get_description ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_description (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves the description of the plugin
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the description. The string
should not be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-errors"></a><h3>ethos_plugin_info_get_errors ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * ethos_plugin_info_get_errors (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves a list of errors that occurred while trying to load the
plugin. If no errors have occurred, NULL is returned. The list
is a copy however the <span class="type">GError</span>s contained are not. You should
free the list with <code class="function">g_list_free()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <span class="type">GList</span> containing <span class="type">GError</span>s that should be freed
with <code class="function">g_list_free()</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-filename"></a><h3>ethos_plugin_info_get_filename ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_filename (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retreives the filename that was used to load the <em class="parameter"><code>plugin_info</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-iage"></a><h3>ethos_plugin_info_get_iage ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> ethos_plugin_info_get_iage (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retreives the interface age that the plugin conforms to.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">guint</span> containing the age.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-icon-name"></a><h3>ethos_plugin_info_get_icon_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_icon_name (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves the icon field for the <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</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>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the icon name or <code class="literal">NULL</code>. This value
should not be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-id"></a><h3>ethos_plugin_info_get_id ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_id (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retreives the unique id of the plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The unique id of the plugin which should not be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-loader"></a><h3>ethos_plugin_info_get_loader ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_loader (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves the name of the <span class="type">EthosPluginLoader</span> that should load the plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The loader to use to load the plugin. This value should
not be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-module"></a><h3>ethos_plugin_info_get_module ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_module (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retreives the module that implements an <a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</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>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The module of the plugin. This value should not be
modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-name"></a><h3>ethos_plugin_info_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_name (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves the name of the plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The name of the plugin. This value should not be freed or modified.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-version"></a><h3>ethos_plugin_info_get_version ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_version (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves the version of the plugin
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the version of the plugin</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-get-website"></a><h3>ethos_plugin_info_get_website ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_plugin_info_get_website (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Retrieves the website url of the plugin
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string containing the website. The string
should not be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-has-errors"></a><h3>ethos_plugin_info_has_errors ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> ethos_plugin_info_has_errors (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>);</pre>
<p>
Checks whether or not the plugin has had any errors.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</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 had an error loading.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-load-from-data"></a><h3>ethos_plugin_info_load_from_data ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> ethos_plugin_info_load_from_data (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gsize</span> length</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Loads the plugin information from a buffer of information. The data
should be in <span class="type">GKeyFile</span> format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>A <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>the group to load information from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a buffer of data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>length of buffer to use</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A location for a <span class="type">GError</span> or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success. <em class="parameter"><code>error</code></em> is set on failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-load-from-file"></a><h3>ethos_plugin_info_load_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> ethos_plugin_info_load_from_file (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Loads the plugin information found within <em class="parameter"><code>filename</code></em>. If there is an
error, <code class="literal">FALSE</code> is returned and <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>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>the keyfile group to extract information from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>A path to the file containing the plugin info</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A location for a <span class="type">GError</span> or <code class="literal">NULL</code>
</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 data was loaded successfully</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-load-from-key-file"></a><h3>ethos_plugin_info_load_from_key_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> ethos_plugin_info_load_from_key_file
(<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *group</code></em>,
<em class="parameter"><code><span class="type">GKeyFile</span> *key_file</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Loads the plugin information from <em class="parameter"><code>key_file</code></em>. The information is loaded from the group named
<em class="parameter"><code>group</code></em> within the keyfile. Therfore, if <em class="parameter"><code>group</code></em> where "Sample Plugin" then the keyfile should
have a group header such as "[Sample Plugin]" within it.
</p>
<p>
Upon failure, <em class="parameter"><code>error</code></em> is set and <code class="literal">FALSE</code> is returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>the name of the group to load</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_file</code></em> :</span></p></td>
<td>A <span class="type">GKeyFile</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A location for a <span class="type">GError</span> or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-new"></a><h3>ethos_plugin_info_new ()</h3>
<pre class="programlisting"><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="returnvalue">EthosPluginInfo</span></a> * ethos_plugin_info_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> instance.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-set-active"></a><h3>ethos_plugin_info_set_active ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ethos_plugin_info_set_active (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> active</code></em>);</pre>
<p>
Set the active status of the <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>. This is useful so
that gui front-ends can keep track if the plugin is currently in use.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>active</code></em> :</span></p></td>
<td>if the <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> is active</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-set-filename"></a><h3>ethos_plugin_info_set_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ethos_plugin_info_set_filename (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>
Sets the filename used to load the plugin-info.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>The filename</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-plugin-info-set-id"></a><h3>ethos_plugin_info_set_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ethos_plugin_info_set_id (<em class="parameter"><code><a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>
Sets the id of the plugin. This is typically taking from the filename
of the description file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>the id of the plugin</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EthosPluginInfo.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EthosPluginInfo--active"></a><h3>The <code class="literal">"active"</code> property</h3>
<pre class="programlisting"> "active" <span class="type">gboolean</span> : Read</pre>
<p>
Whether or not the plugin is currently loaded.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--authors"></a><h3>The <code class="literal">"authors"</code> property</h3>
<pre class="programlisting"> "authors" <span class="type">GStrv</span> : Read</pre>
<p>
The list of authors that have contributed to the plugin.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--copyright"></a><h3>The <code class="literal">"copyright"</code> property</h3>
<pre class="programlisting"> "copyright" <span class="type">gchar</span>* : Read</pre>
<p>
The copyright the plugin is released under such as "GPL-2".
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--dependencies"></a><h3>The <code class="literal">"dependencies"</code> property</h3>
<pre class="programlisting"> "dependencies" <span class="type">gchar</span>* : Read</pre>
<p>
Dependencies that must be loaded for the plugin to load. See
<a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-dependencies" title="ethos_plugin_info_get_dependencies ()"><code class="function">ethos_plugin_info_get_dependencies()</code></a>.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--description"></a><h3>The <code class="literal">"description"</code> property</h3>
<pre class="programlisting"> "description" <span class="type">gchar</span>* : Read</pre>
<p>
A short description of the plugin.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
<pre class="programlisting"> "filename" <span class="type">gchar</span>* : Read / Write</pre>
<p>
The filename that was used to load the plugin.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3>
<pre class="programlisting"> "icon-name" <span class="type">gchar</span>* : Read</pre>
<p>
The name of the icon to display in the manager widgets.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--id"></a><h3>The <code class="literal">"id"</code> property</h3>
<pre class="programlisting"> "id" <span class="type">gchar</span>* : Read / Write</pre>
<p>
Unique identifier for the plugin.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--loader"></a><h3>The <code class="literal">"loader"</code> property</h3>
<pre class="programlisting"> "loader" <span class="type">gchar</span>* : Read</pre>
<p>
The name of the <span class="type">EthosPluginLoader</span> that should be used to load the plugin.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--module"></a><h3>The <code class="literal">"module"</code> property</h3>
<pre class="programlisting"> "module" <span class="type">gchar</span>* : Read</pre>
<p>
The name of the module that should be used to load the plugin.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting"> "name" <span class="type">gchar</span>* : Read</pre>
<p>
The name of the plugin.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--version"></a><h3>The <code class="literal">"version"</code> property</h3>
<pre class="programlisting"> "version" <span class="type">gchar</span>* : Read</pre>
<p>
The version of the plugin. See <a class="link" href="EthosPluginInfo.html#ethos-plugin-info-get-version" title="ethos_plugin_info_get_version ()"><code class="function">ethos_plugin_info_get_version()</code></a>.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo--website"></a><h3>The <code class="literal">"website"</code> property</h3>
<pre class="programlisting"> "website" <span class="type">gchar</span>* : Read</pre>
<p>
The website to find more information on the plugin.
</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="EthosPluginInfo.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EthosPluginInfo-loaded"></a><h3>The <code class="literal">"loaded"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
Signal emitted when a new 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>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EthosPluginInfo-unloaded"></a><h3>The <code class="literal">"unloaded"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> *plugin_info,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
Signal emitted when the plugin is unloaded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_info</code></em> :</span></p></td>
<td>An <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|