/usr/share/gtk-doc/html/ethos/EthosManager.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EthosManager</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="ch04.html" title="Ethos Reference">
<link rel="next" href="EthosPluginInfo.html" title="EthosPluginInfo">
<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="ch04.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="EthosPluginInfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EthosManager.synopsis" class="shortcut">Top</a>
|
<a href="#EthosManager.description" class="shortcut">Description</a>
|
<a href="#EthosManager.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EthosManager.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EthosManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EthosManager.top_of_page"></a>EthosManager</span></h2>
<p>EthosManager — plugin management during runtime</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EthosManager.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="EthosManager.html#ETHOS-MANAGER-CONST:CAPS" title="ETHOS_MANAGER_CONST()">ETHOS_MANAGER_CONST</a> (obj)
struct <a class="link" href="EthosManager.html#EthosManager-struct" title="struct EthosManager">EthosManager</a>;
struct <a class="link" href="EthosManager.html#EthosManagerClass" title="struct EthosManagerClass">EthosManagerClass</a>;
const <span class="returnvalue">gchar</span> * <a class="link" href="EthosManager.html#ethos-manager-get-app-name" title="ethos_manager_get_app_name ()">ethos_manager_get_app_name</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);
<a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="returnvalue">EthosPlugin</span></a> * <a class="link" href="EthosManager.html#ethos-manager-get-plugin" title="ethos_manager_get_plugin ()">ethos_manager_get_plugin</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<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="EthosManager.html#ethos-manager-get-plugin-dirs" title="ethos_manager_get_plugin_dirs ()">ethos_manager_get_plugin_dirs</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="EthosManager.html#ethos-manager-get-plugin-info" title="ethos_manager_get_plugin_info ()">ethos_manager_get_plugin_info</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="EthosManager.html#ethos-manager-get-plugin-loaders" title="ethos_manager_get_plugin_loaders ()">ethos_manager_get_plugin_loaders</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EthosManager.html#ethos-manager-initialize" title="ethos_manager_initialize ()">ethos_manager_initialize</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EthosManager.html#ethos-manager-load-plugin" title="ethos_manager_load_plugin ()">ethos_manager_load_plugin</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<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">GError</span> **error</code></em>);
<a class="link" href="EthosManager.html" title="EthosManager"><span class="returnvalue">EthosManager</span></a> * <a class="link" href="EthosManager.html#ethos-manager-new" title="ethos_manager_new ()">ethos_manager_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="EthosManager.html" title="EthosManager"><span class="returnvalue">EthosManager</span></a> * <a class="link" href="EthosManager.html#ethos-manager-new-full" title="ethos_manager_new_full ()">ethos_manager_new_full</a> (<em class="parameter"><code>const <span class="type">gchar</span> *app_name</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **plugin_dirs</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EthosManager.html#ethos-manager-set-app-name" title="ethos_manager_set_app_name ()">ethos_manager_set_app_name</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *app_name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EthosManager.html#ethos-manager-set-plugin-dirs" title="ethos_manager_set_plugin_dirs ()">ethos_manager_set_plugin_dirs</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **plugin_dirs</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EthosManager.html#ethos-manager-unload" title="ethos_manager_unload ()">ethos_manager_unload</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EthosManager.html#ethos-manager-unload-plugin" title="ethos_manager_unload_plugin ()">ethos_manager_unload_plugin</a> (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<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">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EthosManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----EthosManager
</pre>
</div>
<div class="refsect1">
<a name="EthosManager.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EthosManager.html#EthosManager-initialized" title='The "initialized" signal'>initialized</a>" : <code class="literal">Run First</code>
"<a class="link" href="EthosManager.html#EthosManager-plugin-loaded" title='The "plugin-loaded" signal'>plugin-loaded</a>" : <code class="literal">Run First</code>
"<a class="link" href="EthosManager.html#EthosManager-plugin-unloaded" title='The "plugin-unloaded" signal'>plugin-unloaded</a>" : <code class="literal">Run First</code>
</pre>
</div>
<div class="refsect1">
<a name="EthosManager.description"></a><h2>Description</h2>
<p>
The <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> is responsible for managing plugins during runtime. It can be used to
load and unload plugins as well as configure where and how plugins should be loaded.
</p>
<p>
During runtime, the app_name and plugin_dirs should both be set. The app_name is used
to derive the plugin filenames and how to parse them. The plugin_dirs are used to locate
plugins.
</p>
</div>
<div class="refsect1">
<a name="EthosManager.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ETHOS-MANAGER-CONST:CAPS"></a><h3>ETHOS_MANAGER_CONST()</h3>
<pre class="programlisting">#define ETHOS_MANAGER_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ETHOS_TYPE_MANAGER, EthosManager const))
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosManager-struct"></a><h3>struct EthosManager</h3>
<pre class="programlisting">struct EthosManager;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="EthosManagerClass"></a><h3>struct EthosManagerClass</h3>
<pre class="programlisting">struct EthosManagerClass {
GObjectClass parent_class;
void (*initialized) (EthosManager *manager);
gboolean (*load_plugin) (EthosManager *manager,
EthosPlugin *plugin,
GError **error);
gboolean (*unload_plugin) (EthosManager *manager,
EthosPlugin *plugin,
GError **error);
void (*plugin_loaded) (EthosManager *manager,
EthosPluginInfo *plugin_info);
void (*plugin_unloaded) (EthosManager *manager,
EthosPluginInfo *plugin_info);
void (*reserved1) (void);
void (*reserved2) (void);
void (*reserved3) (void);
void (*reserved4) (void);
void (*reserved5) (void);
void (*reserved6) (void);
void (*reserved7) (void);
void (*reserved8) (void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-get-app-name"></a><h3>ethos_manager_get_app_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * ethos_manager_get_app_name (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);</pre>
<p>
Retrieves the app-name that the <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> should use.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the configured app name used for plugins or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-get-plugin"></a><h3>ethos_manager_get_plugin ()</h3>
<pre class="programlisting"><a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="returnvalue">EthosPlugin</span></a> * ethos_manager_get_plugin (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<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 created instance of the plugin defined by <em class="parameter"><code>plugin_info</code></em>. If
no instance of the plugin has been created, then <code class="literal">NULL</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>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr>
<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 <a class="link" href="EthosPlugin.html" title="EthosPlugin"><span class="type">EthosPlugin</span></a> instance or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-get-plugin-dirs"></a><h3>ethos_manager_get_plugin_dirs ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> ** ethos_manager_get_plugin_dirs (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);</pre>
<p>
Retrieves the list of plugin directories that are traversed when looking to load plugins.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</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 list of strings containing directories that will be
traversed to locate plugins. This reslut should never be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-get-plugin-info"></a><h3>ethos_manager_get_plugin_info ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * ethos_manager_get_plugin_info (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);</pre>
<p>
Retreives the list of <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> that were discovered.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</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> of <a class="link" href="EthosPluginInfo.html" title="EthosPluginInfo"><span class="type">EthosPluginInfo</span></a> which should be freed using
<code class="function">g_list_free()</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-get-plugin-loaders"></a><h3>ethos_manager_get_plugin_loaders ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * ethos_manager_get_plugin_loaders (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);</pre>
<p>
Retreives a list of <span class="type">EthosPluginLoader</span>s that were discovered
when the application was initialized.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</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> of <span class="type">EthosPluginLoader</span>s. The list should
be freed using <code class="function">g_list_free()</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-initialize"></a><h3>ethos_manager_initialize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ethos_manager_initialize (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);</pre>
<p>
Initialize the plugin manager. This will result in the manager looking for
all of the available plugins that it can find in the registered plugin
directories.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-load-plugin"></a><h3>ethos_manager_load_plugin ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> ethos_manager_load_plugin (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<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">GError</span> **error</code></em>);</pre>
<p>
Attempts to load a plugin using 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>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr>
<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>error</code></em> :</span></p></td>
<td>A location for a <span class="type">GError</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the plugin was loaded. <em class="parameter"><code>error</code></em> is set in case of
failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-new"></a><h3>ethos_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="EthosManager.html" title="EthosManager"><span class="returnvalue">EthosManager</span></a> * ethos_manager_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new instance of <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>. There should only be one of these
created per process.
</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="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> instance.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-new-full"></a><h3>ethos_manager_new_full ()</h3>
<pre class="programlisting"><a class="link" href="EthosManager.html" title="EthosManager"><span class="returnvalue">EthosManager</span></a> * ethos_manager_new_full (<em class="parameter"><code>const <span class="type">gchar</span> *app_name</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **plugin_dirs</code></em>);</pre>
<p>
Creates a new <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> instance and sets the application name and
plugin directories to traverse to locate plugins.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_name</code></em> :</span></p></td>
<td>The name of the application (Capitalized)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_dirs</code></em> :</span></p></td>
<td>An array of strings containing directories to locate plugins</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> instance.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-set-app-name"></a><h3>ethos_manager_set_app_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ethos_manager_set_app_name (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *app_name</code></em>);</pre>
<p>
Sets the app name used for the application. This should be a single word
to simplify the plugin development process. The app name is used inside
the plugin description files for the group prefix as well as in the name
of the file.
</p>
<p>
For example, an application named "Ethos" would have the group
[Ethos Plugin] in the plugin description file which would be named
myplugin.ethos-plugin.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_name</code></em> :</span></p></td>
<td>A single-worded name for the application</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-set-plugin-dirs"></a><h3>ethos_manager_set_plugin_dirs ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ethos_manager_set_plugin_dirs (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **plugin_dirs</code></em>);</pre>
<p>
Sets the list of directories to use for locating plugins.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>plugin_dirs</code></em> :</span></p></td>
<td>A <code class="literal">NULL</code> terminated list of strings of directories</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-unload"></a><h3>ethos_manager_unload ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> ethos_manager_unload (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>);</pre>
<p>
Unloads all of the plugins.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ethos-manager-unload-plugin"></a><h3>ethos_manager_unload_plugin ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> ethos_manager_unload_plugin (<em class="parameter"><code><a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager</code></em>,
<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">GError</span> **error</code></em>);</pre>
<p>
Attempts to unload the plugin that was created using <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>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr>
<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>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 plugin was unloaded. <em class="parameter"><code>error</code></em> is set in case of
failure.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EthosManager.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EthosManager-initialized"></a><h3>The <code class="literal">"initialized"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager,
<span class="type">gpointer</span> user_data) : <code class="literal">Run First</code></pre>
<p>
The initialized signal is emmitted after the manager has completed
initializing. This is a good place to load the plugins you want
loaded on startup.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</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="EthosManager-plugin-loaded"></a><h3>The <code class="literal">"plugin-loaded"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager,
<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>
The plugin-loaded signal is emitted when a plugin has been
successfully loaded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr>
<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="EthosManager-plugin-unloaded"></a><h3>The <code class="literal">"plugin-unloaded"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a> *manager,
<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>
The plugin-loaded signal is emitted when a plugin has been
successfully unloaded.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>An <a class="link" href="EthosManager.html" title="EthosManager"><span class="type">EthosManager</span></a>
</td>
</tr>
<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>
|