1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
|
""" A plugin for controlling a remote editor. """
# Enthought library imports.
from enthought.envisage.api import Plugin
from enthought.plugins.remote_editor.api import IRemoteEditor
from enthought.traits.api import List, Instance, Any, on_trait_change
# Local imports
from envisage_remote_editor import EnvisageRemoteEditorController \
as RemoteEditorController
ID = 'enthought.plugins.remote_editor'
class RemoteEditorPlugin(Plugin):
""" A plugin for controlling a remote editor. """
# Extension point Ids.
REMOTE_EDITOR = ID
ACTION_SETS = 'enthought.envisage.ui.workbench.action_sets'
PREFERENCES = 'enthought.envisage.preferences'
PREFERENCES_PAGES = 'enthought.envisage.ui.workbench.preferences_pages'
# Our remote controller for the editor
remote_controller = Instance(RemoteEditorController)
# The shell and editor commands
server_prefs = Any
#### 'IPlugin' interface ##################################################
# The plugin's unique identifier.
id = 'enthought.plugins.remote_editor'
# The plugin's name (suitable for displaying to the user).
name = 'Remote editor'
#### Extension points offered by this plugin ##############################
#### Contributions to extension points made by this plugin ################
# Our action sets.
action_sets = List(contributes_to=ACTION_SETS)
# Preferences pages.
# FIXME: Create a UI for remote editor preferences
#preferences_pages = List(contributes_to=PREFERENCES_PAGES)
# Preferences.
preferences = List(contributes_to=PREFERENCES)
def _action_sets_default(self):
""" Trait initializer. """
from enthought.plugins.remote_editor.actions import \
RemoteEditorActionSet
return [ RemoteEditorActionSet ]
def _preferences_default(self):
""" Trait initializer. """
return [ 'pkgfile://%s/preferences.ini' % ID ]
def _preferences_pages_default(self):
""" Trait initializer. """
from enthought.plugins.remote_editor.preference_pages \
import RemoteEditorPreferencesPage
return [ RemoteEditorPreferencesPage ]
###########################################################################
# Private interface.
###########################################################################
# Create the central server for spawning shells and editors.
@on_trait_change('application:started')
def _create_server(self):
""" Create the central server for spawning shells and editors and
register the controller as an envisage service.
"""
# Register our client to the server. If the server does not exist, this
# will create it.
self.remote_controller = RemoteEditorController(
application=self.application)
# XXX I don't like this at all
if self.server_prefs:
self.remote_controller.server_prefs = self.server_prefs
self.remote_controller.register()
self.application.register_service(IRemoteEditor, self.remote_controller)
@on_trait_change('application:stopping')
def _unregister_from_server(self):
""" Unregister this client from the server.
"""
self.remote_controller.unregister()
#### EOF ######################################################################
|