[WIP] Move Workbench from Pyface

apptools/workbench/action/action_controller.py

@@ -0,0 +1,36 @@
+""" The action controller for workbench menu and tool bars. """
+
+
+# Enthought library imports.
+from pyface.action.api import ActionController
+from traits.api import Instance
+
+from apptools.workbench.api import WorkbenchWindow
+
+
+class ActionController(ActionController):
+    """ The action controller for workbench menu and tool bars.
+
+    The controller is used to 'hook' the invocation of every action on the menu
+    and tool bars. This is done so that additional (and workbench specific)
+    information can be added to action events. Currently, we attach a reference
+    to the workbench window.
+
+    """
+
+    #### 'ActionController' interface #########################################
+
+    # The workbench window that this is the controller for.
+    window = Instance(WorkbenchWindow)
+
+    ###########################################################################
+    # 'ActionController' interface.
+    ###########################################################################
+
+    def perform(self, action, event):
+        """ Control an action invocation. """
+
+        # Add a reference to the window and the application to the event.
+        event.window = self.window
+
+        return action.perform(event)

apptools/workbench/action/api.py

@@ -0,0 +1,5 @@
+from __future__ import absolute_import
+
+from .menu_bar_manager import MenuBarManager
+from .tool_bar_manager import ToolBarManager
+from .view_menu_manager import ViewMenuManager

apptools/workbench/action/delete_user_perspective_action.py

@@ -0,0 +1,79 @@
+#-----------------------------------------------------------------------------
+#
+#  Copyright (c) 2005-2006 by Enthought, Inc.
+#  All rights reserved.
+#
+#  Author: David C. Morrill <dmorrill@enthought.com>
+#
+#-----------------------------------------------------------------------------
+""" An action that deletes a user perspective. """
+
+
+# Enthought library imports.
+from pyface.api import YES
+
+# Local imports.
+from .user_perspective_action import UserPerspectiveAction
+
+
+class DeleteUserPerspectiveAction(UserPerspectiveAction):
+    """ An action that deletes a user perspective. """
+
+    #### 'Action' interface ###################################################
+
+    # The action's unique identifier (may be None).
+    id = 'apptools.workbench.action.delete_user_perspective_action'
+
+    # The action's name (displayed on menus/tool bar tools etc).
+    name = 'Delete Perspective'
+
+    ###########################################################################
+    # 'Action' interface.
+    ###########################################################################
+
+    def perform(self, event):
+        """ Perform the action. """
+
+        window  = event.window
+        manager = window.workbench.user_perspective_manager
+
+        # The perspective to delete.
+        perspective = window.active_perspective
+
+        # Make sure that the user isn't having second thoughts!
+        message = 'Are you sure you want to delete the "%s" perspective?' % \
+                  perspective.name
+
+        answer = window.confirm(message, title='Confirm Delete')
+        if answer == YES:
+            # Set the active perspective to be the first remaining perspective.
+            #
+            # There is always a default NON-user perspective (even if no
+            # perspectives are explicitly defined) so we should never(!) not
+            # be able to find one!
+            window.active_perspective = self._get_next_perspective(window)
+
+            # Remove the perspective from the window.
+            window.perspectives.remove(perspective)
+
+            # Remove it from the user perspective manager.
+            manager.remove(perspective.id)
+
+        return
+
+    ###########################################################################
+    # Private interface.
+    ###########################################################################
+
+    def _get_next_perspective(self, window):
+        """ Return the first perspective that is not the active one! """
+
+        if window.active_perspective is window.perspectives[0]:
+            index = 1
+
+        else:
+            index = 0
+
+        return window.perspectives[index]
+
+#### EOF #####################################################################

apptools/workbench/action/menu_bar_manager.py

@@ -0,0 +1,36 @@
+""" The menu bar manager for Envisage workbench windows. """
+
+
+# Enthought library imports.
+from pyface.action.api import MenuBarManager as BaseMenuBarManager
+from traits.api import Instance
+
+# Local imports.
+from .action_controller import ActionController
+
+
+class MenuBarManager(BaseMenuBarManager):
+    """ The menu bar manager for Envisage workbench windows. """
+
+    #### 'MenuBarManager' interface ###########################################
+
+    # The workbench window that we are the menu bar manager for.
+    window = Instance('apptools.workbench.api.WorkbenchWindow')
+
+    ###########################################################################
+    # 'MenuBarManager' interface.
+    ###########################################################################
+
+    def create_menu_bar(self, parent):
+        """ Creates a menu bar representation of the manager. """
+
+        # The controller handles the invocation of every action.
+        controller = ActionController(window=self.window)
+
+        menu_bar = super(MenuBarManager, self).create_menu_bar(
+            parent, controller=controller
+        )
+
+        return menu_bar
+
+#### EOF ######################################################################

apptools/workbench/action/new_user_perspective_action.py

@@ -0,0 +1,54 @@
+#-----------------------------------------------------------------------------
+#
+#  Copyright (c) 2005-2006 by Enthought, Inc.
+#  All rights reserved.
+#
+#  Author: David C. Morrill <dmorrill@enthought.com>
+#
+#-----------------------------------------------------------------------------
+""" An action that creates a new (and empty) user perspective. """
+
+
+# Local imports.
+from .user_perspective_name import UserPerspectiveName
+from .workbench_action import WorkbenchAction
+
+
+class NewUserPerspectiveAction(WorkbenchAction):
+    """ An action that creates a new (and empty) user perspective. """
+
+    #### 'Action' interface ###################################################
+
+    # The action's unique identifier.
+    id = 'apptools.workbench.action.new_user_perspective_action'
+
+    # The action's name.
+    name = 'New Perspective...'
+
+    ###########################################################################
+    # 'Action' interface.
+    ###########################################################################
+
+    def perform(self, event):
+        """ Peform the action. """
+
+        window  = event.window
+        manager = window.workbench.user_perspective_manager
+
+        # Get the details of the new perspective.
+        upn = UserPerspectiveName(name='User Perspective %d' % manager.next_id)
+        if upn.edit_traits(view='new_view').result:
+            # Create a new (and empty) user perspective.
+            perspective = manager.create_perspective(
+                upn.name.strip(), upn.show_editor_area
+            )
+
+            # Add it to the window...
+            window.perspectives.append(perspective)
+
+            # ... and make it the active perspective.
+            window.active_perspective = perspective
+
+        return
+
+#### EOF #####################################################################

apptools/workbench/action/perspective_menu_manager.py

@@ -0,0 +1,135 @@
+""" The default perspective menu for a workbench window. """
+
+
+# Enthought library imports.
+from pyface.action.api import Group, MenuManager
+from traits.api import Instance, List, on_trait_change
+
+# Local imports.
+from .delete_user_perspective_action import DeleteUserPerspectiveAction
+from .new_user_perspective_action import NewUserPerspectiveAction
+from .rename_user_perspective_action import RenameUserPerspectiveAction
+from .reset_all_perspectives_action import ResetAllPerspectivesAction
+from .reset_active_perspective_action import ResetActivePerspectiveAction
+from .save_as_user_perspective_action import SaveAsUserPerspectiveAction
+from .set_active_perspective_action import SetActivePerspectiveAction
+
+
+class PerspectiveMenuManager(MenuManager):
+    """ The default perspective menu for a workbench window. """
+
+    #### 'ActionManager' interface ############################################
+
+    # All of the groups in the manager.
+    groups = List(Group)
+
+    # The manager's unique identifier.
+    id = 'PerspectivesMenu'
+
+    #### 'MenuManager' interface ##############################################
+
+    # The menu manager's name.
+    name = 'Perspectives'
+
+    #### 'PerspectiveMenuManager' interface ###################################
+
+    # The workbench window that the manager is part of.
+    window = Instance('apptools.workbench.api.WorkbenchWindow')
+
+    ###########################################################################
+    # 'ActionManager' interface.
+    ###########################################################################
+
+    def _groups_default(self):
+        """ Trait initializer. """
+
+        groups = [
+            # Create a group containing the actions that switch to specific
+            # perspectives.
+            self._create_perspective_group(self.window),
+
+            # Create a group containing the user perspective create/save/rename
+            # /delete actions.
+            self._create_user_perspective_group(self.window),
+
+            # Create a group containing the reset actions.
+            self._create_reset_perspective_group(self.window)
+
+        ]
+
+        return groups
+
+    ###########################################################################
+    # 'PerspectiveMenuManager' interface.
+    ###########################################################################
+
+    @on_trait_change('window.perspectives')
+    @on_trait_change('window.perspectives_items')
+    def rebuild(self):
+        """ Rebuild the menu.
+
+        This is called when user perspectives have been added or removed.
+
+        """
+
+        # Clear out the old menu. This gives any actions that have trait
+        # listeners (i.e. the rename and delete actions!) a chance to unhook
+        # them.
+        self.destroy()
+
+        # Resetting the trait allows the initializer to run again (which will
+        # happen just as soon as we fire the 'changed' event).
+        self.reset_traits(['groups'])
+
+        # Let the associated menu know that we have changed.
+        self.changed = True
+
+        return
+
+    ###########################################################################
+    # Private interface.
+    ###########################################################################
+
+    def _create_perspective_group(self, window):
+        """ Create the actions that switch to specific perspectives. """
+
+        # fixme: Not sure if alphabetic sorting is appropriate in all cases,
+        # but it will do for now!
+        perspectives = window.perspectives[:]
+        perspectives.sort(key=lambda x:x.name)
+
+        # For each perspective, create an action that sets the active
+        # perspective to it.
+        group = Group()
+        for perspective in perspectives:
+            group.append(
+                SetActivePerspectiveAction(
+                    perspective=perspective, window=window
+                )
+            )
+
+        return group
+
+    def _create_user_perspective_group(self, window):
+        """ Create the user perspective create/save/rename/delete actions. """
+
+        group = Group(
+            NewUserPerspectiveAction(window=window),
+            SaveAsUserPerspectiveAction(window=window),
+            RenameUserPerspectiveAction(window=window),
+            DeleteUserPerspectiveAction(window=window)
+        )
+
+        return group
+
+    def _create_reset_perspective_group(self, window):
+        """ Create the reset perspective actions. """
+
+        group = Group(
+            ResetActivePerspectiveAction(window=window),
+            ResetAllPerspectivesAction(window=window)
+        )
+
+        return group
+
+#### EOF ######################################################################

apptools/workbench/action/rename_user_perspective_action.py

@@ -0,0 +1,45 @@
+#-----------------------------------------------------------------------------
+#
+#  Copyright (c) 2005-2006 by Enthought, Inc.
+#  All rights reserved.
+#
+#  Author: David C. Morrill <dmorrill@enthought.com>
+#
+#-----------------------------------------------------------------------------
+""" An action that renames a user perspective. """
+
+
+# Local imports.
+from .user_perspective_action import UserPerspectiveAction
+from .user_perspective_name import UserPerspectiveName
+
+
+class RenameUserPerspectiveAction(UserPerspectiveAction):
+    """ An action that renames a user perspective. """
+
+    #### 'Action' interface ###################################################
+
+    # The action's unique identifier (may be None).
+    id = 'apptools.workbench.action.rename_user_perspective_action'
+
+    # The action's name (displayed on menus/tool bar tools etc).
+    name = 'Rename Perspective...'
+
+    ###########################################################################
+    # 'Action' interface.
+    ###########################################################################
+
+    def perform( self, event):
+        """ Perform the action. """
+
+        window  = event.window
+        manager = window.workbench.user_perspective_manager
+
+        # Get the new name.
+        upn = UserPerspectiveName(name=window.active_perspective.name)
+        if upn.edit_traits(view='rename_view').result:
+            manager.rename(window.active_perspective, upn.name.strip())
+
+        return
+
+#### EOF #####################################################################