~ubuntu-branches/ubuntu/trusty/libpeas/trusty-proposed

<a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> * <a class="link" href="PeasEngine.html#peas-engine-new" title="peas_engine_new ()">peas_engine_new</a> (<code>void</code>);

<a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> * <a class="link" href="PeasEngine.html#peas-engine-get-default" title="peas_engine_get_default ()">peas_engine_get_default</a> (<code>void</code>);

void <a class="link" href="PeasEngine.html#peas-engine-add-search-path" title="peas_engine_add_search_path ()">peas_engine_add_search_path</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code>const gchar *module_dir</code>,

<code>const gchar *data_dir</code>);

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *module_dir</code>,

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *data_dir</code>);

void <a class="link" href="PeasEngine.html#peas-engine-prepend-search-path" title="peas_engine_prepend_search_path ()">peas_engine_prepend_search_path</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code>const gchar *module_dir</code>,

<code>const gchar *data_dir</code>);

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *module_dir</code>,

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *data_dir</code>);

void <a class="link" href="PeasEngine.html#peas-engine-enable-loader" title="peas_engine_enable_loader ()">peas_engine_enable_loader</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code>const gchar *loader_id</code>);

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *loader_id</code>);

void <a class="link" href="PeasEngine.html#peas-engine-rescan-plugins" title="peas_engine_rescan_plugins ()">peas_engine_rescan_plugins</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);

const GList * <a class="link" href="PeasEngine.html#peas-engine-get-plugin-list" title="peas_engine_get_plugin_list ()">peas_engine_get_plugin_list</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);

gchar ** <a class="link" href="PeasEngine.html#peas-engine-get-loaded-plugins" title="peas_engine_get_loaded_plugins ()">peas_engine_get_loaded_plugins</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> * <a class="link" href="PeasEngine.html#peas-engine-get-plugin-list" title="peas_engine_get_plugin_list ()">peas_engine_get_plugin_list</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> ** <a class="link" href="PeasEngine.html#peas-engine-get-loaded-plugins" title="peas_engine_get_loaded_plugins ()">peas_engine_get_loaded_plugins</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);

void <a class="link" href="PeasEngine.html#peas-engine-set-loaded-plugins" title="peas_engine_set_loaded_plugins ()">peas_engine_set_loaded_plugins</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code>const gchar **plugin_names</code>);

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **plugin_names</code>);

<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> * <a class="link" href="PeasEngine.html#peas-engine-get-plugin-info" title="peas_engine_get_plugin_info ()">peas_engine_get_plugin_info</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code>const gchar *plugin_name</code>);

gboolean <a class="link" href="PeasEngine.html#peas-engine-load-plugin" title="peas_engine_load_plugin ()">peas_engine_load_plugin</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *plugin_name</code>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="PeasEngine.html#peas-engine-load-plugin" title="peas_engine_load_plugin ()">peas_engine_load_plugin</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>);

gboolean <a class="link" href="PeasEngine.html#peas-engine-unload-plugin" title="peas_engine_unload_plugin ()">peas_engine_unload_plugin</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="PeasEngine.html#peas-engine-unload-plugin" title="peas_engine_unload_plugin ()">peas_engine_unload_plugin</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>);

void <a class="link" href="PeasEngine.html#peas-engine-garbage-collect" title="peas_engine_garbage_collect ()">peas_engine_garbage_collect</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);

gboolean <a class="link" href="PeasEngine.html#peas-engine-provides-extension" title="peas_engine_provides_extension ()">peas_engine_provides_extension</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="PeasEngine.html#peas-engine-provides-extension" title="peas_engine_provides_extension ()">peas_engine_provides_extension</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>,

<code>GType extension_type</code>);

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> extension_type</code>);

<a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> * <a class="link" href="PeasEngine.html#peas-engine-create-extension" title="peas_engine_create_extension ()">peas_engine_create_extension</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>,

<code>GType extension_type</code>,

<code>const gchar *first_property</code>,

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> extension_type</code>,

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *first_property</code>,

<code>...</code>);

<a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> * <a class="link" href="PeasEngine.html#peas-engine-create-extensionv" title="peas_engine_create_extensionv ()">peas_engine_create_extensionv</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>,

<code>GType extension_type</code>,

<code>guint n_parameters</code>,

<code>GParameter *parameters</code>);

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> extension_type</code>,

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> n_parameters</code>,

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GParameter">GParameter</a> *parameters</code>);

<a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> * <a class="link" href="PeasEngine.html#peas-engine-create-extension-valist" title="peas_engine_create_extension_valist ()">peas_engine_create_extension_valist</a> (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>,

<code>GType extension_type</code>,

<code>const gchar *first_property</code>,

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> extension_type</code>,

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *first_property</code>,

<code>va_list var_args</code>);

</pre>

</div>

<a name="PeasEngine.object-hierarchy"></a><h2>Object Hierarchy</h2>

GObject

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

+----PeasEngine

</pre>

</div>

<a name="PeasEngine.properties"></a><h2>Properties</h2>

100

"<a class="link" href="PeasEngine.html#PeasEngine--loaded-plugins" title='The "loaded-plugins" property'>loaded-plugins</a>" GStrv : Read / Write

101

"<a class="link" href="PeasEngine.html#PeasEngine--plugin-list" title='The "plugin-list" property'>plugin-list</a>" gpointer : Read

100

"<a class="link" href="PeasEngine.html#PeasEngine--loaded-plugins" title='The "loaded-plugins" property'>loaded-plugins</a>" <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv">GStrv</a> : Read / Write

101

"<a class="link" href="PeasEngine.html#PeasEngine--plugin-list" title='The "plugin-list" property'>plugin-list</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> : Read

102

</pre>

103

</div>

104

105

<a name="PeasEngine.signals"></a><h2>Signals</h2>

106

107

"<a class="link" href="PeasEngine.html#PeasEngine-load-plugin" title='The "load-plugin" signal'>load-plugin</a>" : <code class="literal">Run Last</code>

108

"<a class="link" href="PeasEngine.html#PeasEngine-unload-plugin" title='The "unload-plugin" signal'>unload-plugin</a>" : <code class="literal">Run Last</code>

107

"<a class="link" href="PeasEngine.html#PeasEngine-load-plugin" title='The "load-plugin" signal'>load-plugin</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

108

"<a class="link" href="PeasEngine.html#PeasEngine-unload-plugin" title='The "unload-plugin" signal'>unload-plugin</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

109

</pre>

110

</div>

111

155

156

<tbody>

157

<tr>

158

<td>GObjectClass <code><a name="PeasEngineClass.parent-class"></a>parent_class</code>;</td>

158

<td><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> <code><a name="PeasEngineClass.parent-class"></a>parent_class</code>;</td>

159

<td>The parent class.</td>

160

</tr>

161

<tr>

209

210

<a name="peas-engine-add-search-path"></a><h3>peas_engine_add_search_path ()</h3>

211

<pre class="programlisting">void peas_engine_add_search_path (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

212

<code>const gchar *module_dir</code>,

213

<code>const gchar *data_dir</code>);</pre>

212

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *module_dir</code>,

213

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *data_dir</code>);</pre>

214

215

This function appends a search path to the list of paths where to

216

look for plugins.

229

<a class="link" href="PeasPluginInfo.html#peas-plugin-info-get-data-dir" title="peas_plugin_info_get_data_dir ()"><code class="function">peas_plugin_info_get_data_dir()</code></a> when looking for its data files.

230

231

232

If <code>data_dir</code> is <code class="literal">NULL</code>, then it is set to the same value as

232

If <code>data_dir</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then it is set to the same value as

233

<code>module_dir</code>.

234

235

255

256

<a name="peas-engine-prepend-search-path"></a><h3>peas_engine_prepend_search_path ()</h3>

257

<pre class="programlisting">void peas_engine_prepend_search_path (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

258

<code>const gchar *module_dir</code>,

259

<code>const gchar *data_dir</code>);</pre>

258

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *module_dir</code>,

259

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *data_dir</code>);</pre>

260

261

This function prepends a search path to the list of paths where to

262

look for plugins.

287

288

<a name="peas-engine-enable-loader"></a><h3>peas_engine_enable_loader ()</h3>

289

<pre class="programlisting">void peas_engine_enable_loader (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

290

<code>const gchar *loader_id</code>);</pre>

290

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *loader_id</code>);</pre>

291

292

Enable a loader, enables a loader for plugins.

293

The C plugin loader is always enabled.

350

<hr>

351

352

<a name="peas-engine-get-plugin-list"></a><h3>peas_engine_get_plugin_list ()</h3>

353

<pre class="programlisting">const GList * peas_engine_get_plugin_list (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);</pre>

353

<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> * peas_engine_get_plugin_list (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);</pre>

354

355

Returns the list of <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> known to the engine.

356

363

</tr>

364

<tr>

365

<td>Returns :</td>

366

<td>a GList of

366

<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> of

367

<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a>. Note that the list belongs to the engine and should

368

not be freed. [<acronym title="Don't free data after the code is done.">transfer none</acronym>][<acronym title="Generics and defining elements of containers and arrays.">element-type</acronym> Peas.PluginInfo]

369

</td>

374

<hr>

375

376

<a name="peas-engine-get-loaded-plugins"></a><h3>peas_engine_get_loaded_plugins ()</h3>

377

<pre class="programlisting">gchar ** peas_engine_get_loaded_plugins (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);</pre>

377

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> ** peas_engine_get_loaded_plugins (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>);</pre>

378

379

Returns the list of the names of all the loaded plugins, or an array

380

containing a single <code class="literal">NULL</code> element if there is no plugin currently loaded.

380

containing a single <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> element if there is no plugin currently loaded.

381

382

383

Please note that the returned array is a newly allocated one: you will need

384

to free it using <code class="function">g_strfreev()</code>.

384

to free it using <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a>.

385

386

387

393

<tr>

394

<td>Returns :</td>

395

<td>A newly-allocated

396

<code class="literal">NULL</code>-terminated array of strings. [<acronym title="Free data after the code is done.">transfer full</acronym>][<acronym title="Parameter points to an array of items.">array</acronym> zero-terminated=1]

396

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of strings. [<acronym title="Free data after the code is done.">transfer full</acronym>][<acronym title="Parameter points to an array of items.">array</acronym> zero-terminated=1]

397

</td>

398

</tr>

399

</tbody>

403

404

<a name="peas-engine-set-loaded-plugins"></a><h3>peas_engine_set_loaded_plugins ()</h3>

405

<pre class="programlisting">void peas_engine_set_loaded_plugins (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

406

<code>const gchar **plugin_names</code>);</pre>

406

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> **plugin_names</code>);</pre>

407

408

Sets the list of loaded plugins for <code>engine</code>. When this function is called,

409

the <a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> will load all the plugins whose names are in <code>plugin_names</code>,

410

and ensures all other active plugins are unloaded.

411

412

413

If <code>plugin_names</code> is <code class="literal">NULL</code>, all plugins will be unloaded.

413

If <code>plugin_names</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, all plugins will be unloaded.

414

415

416

421

</tr>

422

<tr>

423

<td><code>plugin_names</code> :</td>

424

<td>A <code class="literal">NULL</code>-terminated

425

array of plugin names, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>][<acronym title="Parameter points to an array of items.">array</acronym> zero-terminated=1]

424

<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated

425

array of plugin names, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>][<acronym title="Parameter points to an array of items.">array</acronym> zero-terminated=1]

426

</td>

427

</tr>

428

</tbody>

432

433

<a name="peas-engine-get-plugin-info"></a><h3>peas_engine_get_plugin_info ()</h3>

434

<pre class="programlisting"><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> * peas_engine_get_plugin_info (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

435

<code>const gchar *plugin_name</code>);</pre>

435

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *plugin_name</code>);</pre>

436

437

Gets the <a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> corresponding with <code>plugin_name</code>,

438

or <code class="literal">NULL</code> if <code>plugin_name</code> was not found.

438

or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>plugin_name</code> was not found.

439

440

441

460

<hr>

461

462

<a name="peas-engine-load-plugin"></a><h3>peas_engine_load_plugin ()</h3>

463

<pre class="programlisting">gboolean peas_engine_load_plugin (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

463

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> peas_engine_load_plugin (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

464

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>);</pre>

465

466

Loads the plugin corresponding to <code>info</code> if it's not currently loaded.

489

<hr>

490

491

<a name="peas-engine-unload-plugin"></a><h3>peas_engine_unload_plugin ()</h3>

492

<pre class="programlisting">gboolean peas_engine_unload_plugin (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

492

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> peas_engine_unload_plugin (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

493

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>);</pre>

494

495

Unloads the plugin corresponding to <code>info</code>.

536

<hr>

537

538

<a name="peas-engine-provides-extension"></a><h3>peas_engine_provides_extension ()</h3>

539

<pre class="programlisting">gboolean peas_engine_provides_extension (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

539

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> peas_engine_provides_extension (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

540

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>,

541

<code>GType extension_type</code>);</pre>

541

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> extension_type</code>);</pre>

542

543

Returns if <code>info</code> provides an extension for <code>extension_type</code>.

544

If the <code>info</code> is not loaded than <code class="literal">FALSE</code> will always be returned.

544

If the <code>info</code> is not loaded than <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will always be returned.

545

546

547

556

</tr>

557

<tr>

558

<td><code>extension_type</code> :</td>

559

<td>The extension GType.</td>

559

<td>The extension <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a>.</td>

560

</tr>

561

<tr>

562

<td>Returns :</td>

570

<a name="peas-engine-create-extension"></a><h3>peas_engine_create_extension ()</h3>

571

<pre class="programlisting"><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> * peas_engine_create_extension (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

572

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>,

573

<code>GType extension_type</code>,

574

<code>const gchar *first_property</code>,

573

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> extension_type</code>,

574

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *first_property</code>,

575

576

577

If the plugin identified by <code>info</code> implements the <code>extension_type</code> interface,

578

then this function will return a new instance of this implementation,

579

wrapped in a new <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> instance. Otherwise, it will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

580

581

582

When creating the new instance of the <code>extension_type</code> subtype, the

583

provided construct properties will be passed to the extension construction

584

handler (exactly like if you had called <code class="function">g_object_new()</code> yourself).

584

handler (exactly like if you had called <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-new"><code class="function">g_object_new()</code></a> yourself).

585

586

587

The new extension instance produced by this function will always be

602

</tr>

603

<tr>

604

<td><code>extension_type</code> :</td>

605

<td>The implemented extension GType.</td>

605

<td>The implemented extension <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a>.</td>

606

</tr>

607

<tr>

608

<td><code>first_property</code> :</td>

611

<tr>

612

613

<td>the value of the first property, followed optionally by more

614

name/value pairs, followed by <code class="literal">NULL</code>.</td>

614

name/value pairs, followed by <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>

615

</tr>

616

<tr>

617

<td>Returns :</td>

618

<td>a new instance of <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> wrapping

619

the <code>extension_type</code> instance, or <code class="literal">NULL</code>.</td>

619

the <code>extension_type</code> instance, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>

620

</tr>

621

</tbody>

622

</table></div>

626

<a name="peas-engine-create-extensionv"></a><h3>peas_engine_create_extensionv ()</h3>

627

<pre class="programlisting"><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> * peas_engine_create_extensionv (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

628

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>,

629

<code>GType extension_type</code>,

630

<code>guint n_parameters</code>,

631

<code>GParameter *parameters</code>);</pre>

629

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> extension_type</code>,

630

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a> n_parameters</code>,

631

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GParameter">GParameter</a> *parameters</code>);</pre>

632

633

If the plugin identified by <code>info</code> implements the <code>extension_type</code> interface,

634

then this function will return a new instance of this implementation,

635

636

637

638

See <a class="link" href="PeasEngine.html#peas-engine-create-extension" title="peas_engine_create_extension ()"><code class="function">peas_engine_create_extension()</code></a> for more information.

650

</tr>

651

<tr>

652

<td><code>extension_type</code> :</td>

653

<td>The implemented extension GType.</td>

653

<td>The implemented extension <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a>.</td>

654

</tr>

655

<tr>

656

<td><code>n_parameters</code> :</td>

658

</tr>

659

<tr>

660

<td><code>parameters</code> :</td>

661

<td>an array of GParameter. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>][<acronym title="Parameter points to an array of items.">array</acronym> length=n_parameters]

661

<td>an array of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GParameter">GParameter</a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>][<acronym title="Parameter points to an array of items.">array</acronym> length=n_parameters]

662

</td>

663

</tr>

664

<tr>

665

<td>Returns :</td>

666

<td>a new instance of <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> wrapping

667

the <code>extension_type</code> instance, or <code class="literal">NULL</code>.

667

668

Rename to: peas_engine_create_extension. [<acronym title="Free data after the code is done.">transfer full</acronym>]

669

</td>

670

</tr>

676

<a name="peas-engine-create-extension-valist"></a><h3>peas_engine_create_extension_valist ()</h3>

677

<pre class="programlisting"><a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> * peas_engine_create_extension_valist (<code><a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine</code>,

678

<code><a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info</code>,

679

<code>GType extension_type</code>,

680

<code>const gchar *first_property</code>,

679

<code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> extension_type</code>,

680

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *first_property</code>,

681

682

683

If the plugin identified by <code>info</code> implements the <code>extension_type</code> interface,

684

then this function will return a new instance of this implementation,

685

686

687

688

See <a class="link" href="PeasEngine.html#peas-engine-create-extension" title="peas_engine_create_extension ()"><code class="function">peas_engine_create_extension()</code></a> for more information.

700

</tr>

701

<tr>

702

<td><code>extension_type</code> :</td>

703

<td>The implemented extension GType.</td>

703

<td>The implemented extension <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a>.</td>

704

</tr>

705

<tr>

706

<td><code>first_property</code> :</td>

709

<tr>

710

711

<td>the value of the first property, followed optionally by more

712

name/value pairs, followed by <code class="literal">NULL</code>.</td>

712

name/value pairs, followed by <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>

713

</tr>

714

<tr>

715

<td>Returns :</td>

716

<td>a new instance of <a class="link" href="libpeas-PeasExtension.html#PeasExtension" title="PeasExtension">PeasExtension</a> wrapping

717

the <code>extension_type</code> instance, or <code class="literal">NULL</code>.</td>

717

718

</tr>

719

</tbody>

720

</table></div>

724

<a name="PeasEngine.property-details"></a><h2>Property Details</h2>

725

726

<a name="PeasEngine--loaded-plugins"></a><h3>The <code class="literal">"loaded-plugins"</code> property</h3>

727

<pre class="programlisting"> "loaded-plugins" GStrv : Read / Write</pre>

727

<pre class="programlisting"> "loaded-plugins" <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv">GStrv</a> : Read / Write</pre>

728

729

The list of loaded plugins.

730

745

746

747

5</pre></td>

748

<td class="listing_code"><pre class="programlisting">g_settings_bind (gsettings_object,

748

<td class="listing_code"><pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GSettings.html#g-settings-bind">g_settings_bind</a> (gsettings_object,

749

LOADED_PLUGINS_KEY,

750

engine,

751

"loaded-plugins",

752

G_SETTINGS_BIND_DEFAULT);</pre></td>

752

<a href="http://library.gnome.org/devel/gio/unstable/GSettings.html#G-SETTINGS-BIND-DEFAULT:CAPS">G_SETTINGS_BIND_DEFAULT</a>);</pre></td>

753

</tr>

754

</tbody>

755

</table>

764

<hr>

765

766

<a name="PeasEngine--plugin-list"></a><h3>The <code class="literal">"plugin-list"</code> property</h3>

767

<pre class="programlisting"> "plugin-list" gpointer : Read</pre>

767

<pre class="programlisting"> "plugin-list" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> : Read</pre>

768

769

The list of found plugins.

770

783

<a name="PeasEngine-load-plugin"></a><h3>The <code class="literal">"load-plugin"</code> signal</h3>

784

<pre class="programlisting">void user_function (<a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine,

785

<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info,

786

gpointer user_data) : <code class="literal">Run Last</code></pre>

786

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>

787

788

The load-plugin signal is emitted when a plugin is being loaded.

789

790

791

The plugin is being loaded in the default handler. Hence, if you want to

792

perform some action before the plugin is loaded, you should use

793

<code class="function">g_signal_connect()</code>, but if you want to perform some action *after* the

793

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect"><code class="function">g_signal_connect()</code></a>, but if you want to perform some action *after* the

794

plugin is loaded (the most common case), you should use

795

<code class="function">g_signal_connect_after()</code>.

795

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect-after"><code class="function">g_signal_connect_after()</code></a>.

796

797

798

817

<a name="PeasEngine-unload-plugin"></a><h3>The <code class="literal">"unload-plugin"</code> signal</h3>

818

<pre class="programlisting">void user_function (<a class="link" href="PeasEngine.html" title="PeasEngine">PeasEngine</a> *engine,

819

<a class="link" href="PeasPluginInfo.html" title="PeasPluginInfo">PeasPluginInfo</a> *info,

820

gpointer user_data) : <code class="literal">Run Last</code></pre>

820

821

822

The unload-plugin signal is emitted when a plugin is being unloaded.

823

824

825

The plugin is being unloaded in the default handler. Hence, if you want

826

to perform some action before the plugin is unloaded (the most common

827

case), you should use <code class="function">g_signal_connect()</code>, but if you want to perform some

827

case), you should use <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect"><code class="function">g_signal_connect()</code></a>, but if you want to perform some

828

action after the plugin is unloaded (the most common case), you should

829

use <code class="function">g_signal_connect_after()</code>.

829

use <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect-after"><code class="function">g_signal_connect_after()</code></a>.

830

831

832

Older »