envisage.application module

An extensible, pluggable, application.

class envisage.application.Application(plugins=None, **traits)

Bases: HasTraits

An extensible, pluggable, application.

This class handles the common case for non-GUI applications, and it is intended to be subclassed to change start/stop behaviour etc.

add_extension_point(extension_point)

Add an extension point.

add_extension_point_listener(listener, extension_point_id=None)

Add a listener for extensions being added/removed.

add_plugin(plugin)

Add a plugin to the manager.

extension_registry

The extension registry.

get_extension_point(extension_point_id)

Return the extension point with the specified Id.

get_extension_points()

Return all extension points that have been added to the registry.

get_extensions(extension_point_id)

Return a list containing all contributions to an extension point.

get_plugin(plugin_id)

Return the plugin with the specified Id.

get_required_service(protocol, query='', minimize='', maximize='')

Return the service that matches the specified query.

Raise a ‘NoSuchServiceError’ exception if no such service exists.

get_service(protocol, query='', minimize='', maximize='')

Return at most one service that matches the specified query.

get_service_from_id(service_id)

Return the service with the specified id.

get_service_properties(service_id)

Return the dictionary of properties associated with a service.

get_services(protocol, query='', minimize='', maximize='')

Return all services that match the specified query.

home

The name of a directory (created for you) to which the application can read and write non-user accessible data, i.e. configuration information, preferences, etc.

id

The application’s globally unique identifier.

import_symbol(symbol_path)

Import the symbol defined by the specified symbol path.

plugin_added

Fired when a plugin has been added.

plugin_manager

The plugin manager (starts and stops plugins etc).

plugin_removed

Fired when a plugin has been removed.

preferences

The root preferences node.

register_service(protocol, obj, properties=None)

Register a service.

remove_extension_point(extension_point_id)

Remove an extension point.

remove_extension_point_listener(listener, extension_point_id=None)

Remove a listener for extensions being added/removed.

remove_plugin(plugin)

Remove a plugin from the manager.

run()

Run the application.

service_registry

The service registry.

set_extensions(extension_point_id, extensions)

Set the extensions contributed to an extension point.

set_service_properties(service_id, properties)

Set the dictionary of properties associated with a service.

start()

Start the plugin manager.

Returns True unless the start was vetoed.

start_plugin(plugin=None, plugin_id=None)

Start the specified plugin.

started

Fired when all plugins have been started.

starting

Fired when the application is starting.

stop()

Stop the plugin manager.

Returns True unless the stop was vetoed.

stop_plugin(plugin=None, plugin_id=None)

Stop the specified plugin.

stopped

Fired when all plugins have been stopped.

stopping

Fired when the application is stopping.

unregister_service(service_id)

Unregister a service.

user_data

The name of a directory (created for you upon access) to which the application can read and write user-accessible data, e.g. projects created by the user.