Foundry.ExtensionSet¶

Subclasses:: None

Methods¶

Inherited:: Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8), Gio.ListModel (4)
Structs:: GObject.ObjectClass (5)

	`foreach` (foreach_func, *user_data)
	`foreach_by_priority` (foreach_func, *user_data)
	`get_engine` ()
	`get_extension` (plugin_info)
	`get_interface_type` ()
	`get_key` ()
	`get_n_extensions` ()
	`get_value` ()
	`set_key` (key)
	`set_value` (value)

Virtual Methods¶

Inherited:: GObject.Object (7), Json.Serializable (5), Gio.ListModel (3)

Properties¶

Inherited:: Foundry.Contextual (1)

Name	Type	Flags
`engine`	`Peas.Engine`	r/w/co
`interface-type`	`GObject.GType`	r/w/co
`key`	`str`	r/w
`value`	`str`	r/w

Signals¶

Inherited:: GObject.Object (1), Gio.ListModel (1)

Name	Short Description
`extension-added`
`extension-removed`
`extensions-loaded`

Fields¶

Inherited:: GObject.Object (1), Gio.ListModel (1)

Class Details¶

class Foundry.ExtensionSet(**kwargs)¶

Bases:: Foundry.Contextual, Gio.ListModel
Abstract:: No
Structure:: Foundry.ExtensionSetClass

Manages a collection of extensions and provides unified access to their functionality.

Foundry.ExtensionSet provides a model for managing extensions that implement a common interface. It handles extension loading, lifecycle management, and provides efficient access to extension functionality through a unified API. It integrates with the plugin system and supports dynamic extension management.

foreach(foreach_func, *user_data)¶

Parameters:

foreach_func (Foundry.ExtensionSetForeachFunc) – A callback
user_data (object or None) – user data for foreach_func

Calls foreach_func for every extension loaded by the extension set.

foreach_by_priority(foreach_func, *user_data)¶

Parameters:

foreach_func (Foundry.ExtensionSetForeachFunc) – A callback
user_data (object or None) – user data for foreach_func

Calls foreach_func for every extension loaded by the extension set.

get_engine()¶

Returns:: a Peas.Engine.
Return type:: Peas.Engine

Gets the Foundry.ExtensionSet :engine property.

get_extension(plugin_info)¶

Parameters:: plugin_info (Peas.PluginInfo) – a Peas.PluginInfo
Returns:: a GObject.Object or None
Return type:: GObject.Object or None

Locates the extension owned by plugin_info if such extension exists.

get_interface_type()¶

Return type:: GObject.GType

get_key()¶

Return type:: str

get_n_extensions()¶

Return type:: int

get_value()¶

Return type:: str

set_key(key)¶

Parameters:: key (str) –

set_value(value)¶

Parameters:: value (str) –

Signal Details¶

Foundry.ExtensionSet.signals.extension_added(extension_set, object, p0)¶

Signal Name:

extension-added

Flags:

RUN_LAST

Parameters:

extension_set (Foundry.ExtensionSet) – The object which received the signal
object (Peas.PluginInfo) –
p0 (GObject.Object) –

Foundry.ExtensionSet.signals.extension_removed(extension_set, object, p0)¶

Signal Name:

extension-removed

Flags:

RUN_LAST

Parameters:

extension_set (Foundry.ExtensionSet) – The object which received the signal
object (Peas.PluginInfo) –
p0 (GObject.Object) –

Foundry.ExtensionSet.signals.extensions_loaded(extension_set)¶

Signal Name:: extensions-loaded
Flags:: RUN_LAST
Parameters:: extension_set (Foundry.ExtensionSet) – The object which received the signal

Property Details¶

Foundry.ExtensionSet.props.engine¶

Name:: engine
Type:: Peas.Engine
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.ExtensionSet.props.interface_type¶

Name:: interface-type
Type:: GObject.GType
Default Value:: <GType GObject>
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.ExtensionSet.props.key¶

Name:: key
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Foundry.ExtensionSet.props.value¶

Name:: value
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE