Inherits from
- HasTraits: enthought.traits.has_traits.HasTraits
Attributes
- extension_registry
These traits allow application developers to build completely different styles of extensible application. It allows Envisage to be used as a framework for frameworks ;^)
The extension registry.
extension_registry = Instance(IExtensionRegistry)
- home
The name of a directory (created for you) that the application can read and write to at will.
home = Str
- id
The application's globally unique identifier.
id = Str
- plugin_added
Fired when a plugin has been added.
plugin_added = Delegate('plugin_manager', modify = True)
- plugin_manager
The plugin manager (starts and stops plugins etc).
plugin_manager = Instance(IPluginManager)
- plugin_removed
Fired when a plugin has been removed.
plugin_removed = Delegate('plugin_manager', modify = True)
- preferences
The root preferences node.
preferences = Instance(IPreferences)
- service_registry
The service registry.
service_registry = Instance(IServiceRegistry)
- started
Fired when all plugins have been started.
started = Event(ApplicationEvent)
- starting
Fired when the application is starting.
starting = VetoableEvent(ApplicationEvent)
- stopped
Fired when all plugins have been stopped.
stopped = Event(ApplicationEvent)
- stopping
Fired when the application is stopping.
stopping = VetoableEvent(ApplicationEvent)
Inherited from base classes
Method summary
- __init__(self, plugins = None, **traits)
- __iter__(self)
- add_extension_point(self, extension_point)
- add_extension_point_listener(self, listener, extension_point_id = None)
- add_plugin(self, plugin)
- get_extension_point(self, extension_point_id)
- get_extension_points(self)
- get_extensions(self, extension_point_id)
- get_plugin(self, plugin_id)
- get_service(self, protocol, query = '', minimize = '', maximize = '')
- get_service_properties(self, service_id)
- get_services(self, protocol, query = '', minimize = '', maximize = '')
- import_symbol(self, symbol_path)
- register_service(self, protocol, obj, properties = None)
- remove_extension_point(self, extension_point_id)
- remove_extension_point_listener(self, listener, extension_point_id = None)
- remove_plugin(self, plugin)
- run(self)
- set_extensions(self, extension_point_id, extensions)
- set_service_properties(self, service_id, properties)
- start(self)
- start_plugin(self, plugin = None, plugin_id = None)
- stop(self)
- stop_plugin(self, plugin = None, plugin_id = None)
- unregister_service(self, service_id)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- default_traits_view(self)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- has_traits_interface(self, *interfaces)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- __init__(self, plugins = None, **traits)
Constructor.
We allow the caller to specify an initial list of plugins, but the list itself is not part of the public API. To add and remove plugins after after construction, use the 'add_plugin' and 'remove_plugin' methods respectively. The application is also iterable, so to iterate over the plugins use 'for plugin in application: ...'.
- __iter__(self)
Return an iterator over the manager's plugins.
- add_extension_point(self, extension_point)
Add an extension point.
- add_extension_point_listener(self, listener, extension_point_id = None)
Add a listener for extensions being added/removed.
- add_plugin(self, plugin)
Add a plugin to the manager.
- get_extension_point(self, extension_point_id)
Return the extension point with the specified Id.
- get_extension_points(self)
Return all extension points that have been added to the registry.
- get_extensions(self, extension_point_id)
Return a list containing all contributions to an extension point.
- get_plugin(self, plugin_id)
Return the plugin with the specified Id.
- get_service(self, protocol, query = '', minimize = '', maximize = '')
Return at most one service that matches the specified query.
- get_service_properties(self, service_id)
Return the dictionary of properties associated with a service.
- get_services(self, protocol, query = '', minimize = '', maximize = '')
Return all services that match the specified query.
- import_symbol(self, symbol_path)
Import the symbol defined by the specified symbol path.
- register_service(self, protocol, obj, properties = None)
Register a service.
- remove_extension_point(self, extension_point_id)
Remove an extension point.
- remove_extension_point_listener(self, listener, extension_point_id = None)
Remove a listener for extensions being added/removed.
- remove_plugin(self, plugin)
Remove a plugin from the manager.
- run(self)
Run the application.
- set_extensions(self, extension_point_id, extensions)
Set the extensions contributed to an extension point.
- set_service_properties(self, service_id, properties)
Set the dictionary of properties associated with a service.
- start(self)
Start the plugin manager.
Returns True unless the start was vetoed.
- start_plugin(self, plugin = None, plugin_id = None)
Start the specified plugin.
- stop(self)
Stop the plugin manager.
Returns True unless the stop was vetoed.
- stop_plugin(self, plugin = None, plugin_id = None)
Stop the specified plugin.
- unregister_service(self, service_id)
Unregister a service.