Peas.Activatable

Implementations:

None

Methods

	activate ()
	deactivate ()
	update_state ()

Virtual Methods

	do_activate ()
	do_deactivate ()
	do_update_state ()

Properties

Name	Type	Flags	Short Description
object	GObject.Object	r/w/co	Object

Signals

None

Fields

None

Class Details

class Peas.Activatable

Bases:

GObject.GInterface

Structure:

Peas.ActivatableInterface

Interface for activatable plugins.

activate()

Activates the extension on the targetted object.

On activation, the extension should hook itself to the object where it makes sense.

deactivate()

Deactivates the extension on the targetted object.

On deactivation, an extension should remove itself from all the hooks it used and should perform any cleanup required, so it can be unreffed safely and without any more effect on the host application.

update_state()

Triggers an update of the extension internal state to take into account state changes in the targetted object, due to some event or user action.

do_activate() virtual

Activates the extension on the targetted object.

On activation, the extension should hook itself to the object where it makes sense.

do_deactivate() virtual

Deactivates the extension on the targetted object.

On deactivation, an extension should remove itself from all the hooks it used and should perform any cleanup required, so it can be unreffed safely and without any more effect on the host application.

do_update_state() virtual

Triggers an update of the extension internal state to take into account state changes in the targetted object, due to some event or user action.

Property Details

Peas.Activatable.props.object

Name:

object

Type:

GObject.Object

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The object property contains the targetted object for this Peas.Activatable instance.

For example a toplevel window in a typical windowed application. It is set at construction time and won’t change.