PeasExtensionSet: Peas Reference Manual

PeasExtensionSet

PeasExtensionSet — Proxy for a set of extensions of the same type.

Functions

void	(*PeasExtensionSetForeachFunc) ()
gboolean	peas_extension_set_call ()
gboolean	peas_extension_set_call_valist ()
gboolean	peas_extension_set_callv ()
void	peas_extension_set_foreach ()
PeasExtension *	peas_extension_set_get_extension ()
PeasExtensionSet *	peas_extension_set_new ()
PeasExtensionSet *	peas_extension_set_newv ()
PeasExtensionSet *	peas_extension_set_new_valist ()

Properties

gpointer	construct-properties	Write / Construct Only
PeasEngine *	engine	Read / Write / Construct Only
GType *	extension-type	Read / Write / Construct Only

Signals

void	extension-added	Run Last
void	extension-removed	Run Last

Types and Values

struct	PeasExtensionSet
struct	PeasExtensionSetClass

Object Hierarchy

    GObject
    ╰── PeasExtensionSet

Description

A PeasExtensionSet is an object which proxies method calls to a set of actual extensions. The application writer will use these objects in order to call methods on several instances of an actual extension exported by all the currently loaded plugins.

PeasExtensionSet will automatically track loading and unloading of the plugins, and signal appearance and disappearance of new extension instances. You should connect to those signals if you wish to call specific methods on loading or unloading time.

Here is the code for a typical setup of PeasExtensionSet with PeasActivatable as the watched extension point, and GtkWindow instances as the target objects:

static void
on_extension_added (PeasExtensionSet *set,
                    PeasPluginInfo   *info,
                    PeasActivatable  *activatable)
{
  peas_activatable_activate (activatable);
}

static void
on_extension_removed (PeasExtensionSet *set,
                      PeasPluginInfo   *info,
                      PeasActivatable  *activatable)
{
  peas_activatable_deactivate (activatable);
}

PeasExtensionSet *
setup_extension_set (PeasEngine *engine,
                     GtkWindow  *window)
{
  PeasExtensionSet *set;

  set = peas_extension_set_new (engine, PEAS_TYPE_ACTIVATABLE,
                                "object", window, NULL);
  peas_extension_set_foreach (set,
                              (PeasExtensionSetForeachFunc) on_extension_added,
                              NULL);
  g_signal_connect (set, "extension-added",
                    G_CALLBACK (on_extension_added), NULL);
  g_signal_connect (set, "extension-removed",
                    G_CALLBACK (on_extension_removed), NULL);
  return set;
}

Functions

PeasExtensionSetForeachFunc ()

void
(*PeasExtensionSetForeachFunc) (PeasExtensionSet *set,
                                PeasPluginInfo *info,
                                PeasExtension *exten,
                                gpointer data);

This function is passed to peas_extension_set_foreach() and will be called for each extension in set .

Parameters

set	A PeasExtensionSet.
info	A PeasPluginInfo.
exten	A PeasExtension.
data	Optional data passed to the function.

Since: 1.2

peas_extension_set_call ()

gboolean
peas_extension_set_call (PeasExtensionSet *set,
                         const gchar *method_name,
                         ...);

peas_extension_set_call has been deprecated since version 1.2 and should not be used in newly-written code.

Use peas_extension_set_foreach() instead.

Call a method on all the PeasExtension instances contained in set .

See peas_extension_call() for more information.

Parameters

set	A PeasExtensionSet.
method_name	the name of the method that should be called.
...	arguments for the method.

Returns

TRUE on successful call.

peas_extension_set_call_valist ()

gboolean
peas_extension_set_call_valist (PeasExtensionSet *set,
                                const gchar *method_name,
                                va_list va_args);

peas_extension_set_call_valist has been deprecated since version 1.2 and should not be used in newly-written code.

Use peas_extension_set_foreach() instead.

Call a method on all the PeasExtension instances contained in set .

See peas_extension_call_valist() for more information.

Parameters

set	A PeasExtensionSet.
method_name	the name of the method that should be called.
va_args	the arguments for the method.

Returns

TRUE on successful call.

peas_extension_set_callv ()

gboolean
peas_extension_set_callv (PeasExtensionSet *set,
                          const gchar *method_name,
                          GIArgument *args);

peas_extension_set_callv has been deprecated since version 1.2 and should not be used in newly-written code.

Use peas_extension_set_foreach() instead.

Call a method on all the PeasExtension instances contained in set .

See peas_extension_callv() for more information.

Parameters

set	A PeasExtensionSet.
method_name	the name of the method that should be called.
args	the arguments for the method.

Returns

TRUE on successful call.

peas_extension_set_foreach ()

void
peas_extension_set_foreach (PeasExtensionSet *set,
                            PeasExtensionSetForeachFunc func,
                            gpointer data);

Calls func for each PeasExtension.

Parameters

set	A PeasExtensionSet.
func	A function call for each extension.	[scope call]
data	Optional data to be passed to the function or `NULL`.

Since: 1.2

peas_extension_set_get_extension ()

PeasExtension *
peas_extension_set_get_extension (PeasExtensionSet *set,
                                  PeasPluginInfo *info);

Returns the PeasExtension object corresponding to info , or NULL if the plugin doesn't provide such an extension.

Parameters

set	A PeasExtensionSet
info	a PeasPluginInfo

Returns

a reference to a PeasExtension or NULL.

[transfer none]

peas_extension_set_new ()

PeasExtensionSet *
peas_extension_set_new (PeasEngine *engine,
                        GType exten_type,
                        const gchar *first_property,
                        ...);

Create a new PeasExtensionSet for the exten_type extension type.

At any moment, the PeasExtensionSet will contain an extension instance for each loaded plugin which implements the exten_type extension type. It does so by connecting to the relevant signals from PeasEngine.

The property values passed to peas_extension_set_new() will be used for the construction of new extension instances.

If engine is NULL, then the default engine will be used.

See peas_engine_create_extension() for more information.

[skip]

Parameters

engine	A PeasEngine, or `NULL`.	[allow-none]
exten_type	the extension GType.
first_property	the name of the first property.
...	the value of the first property, followed optionally by more name/value pairs, followed by `NULL`.

Returns

a new instance of PeasExtensionSet.

peas_extension_set_newv ()

PeasExtensionSet *
peas_extension_set_newv (PeasEngine *engine,
                         GType exten_type,
                         guint n_parameters,
                         GParameter *parameters);

Create a new PeasExtensionSet for the exten_type extension type.

If engine is NULL, then the default engine will be used.

See peas_extension_set_new() for more information.

[rename-to peas_extension_set_new]

Parameters

engine	A PeasEngine, or `NULL`.	[allow-none]
exten_type	the extension GType.
n_parameters	the length of the `parameters` array.
parameters	an array of GParameter.	[array length=n_parameters]

Returns

a new instance of PeasExtensionSet.

[transfer full]

peas_extension_set_new_valist ()

PeasExtensionSet *
peas_extension_set_new_valist (PeasEngine *engine,
                               GType exten_type,
                               const gchar *first_property,
                               va_list var_args);

Create a new PeasExtensionSet for the exten_type extension type.

If engine is NULL, then the default engine will be used.

See