Class enthought.​envisage.​ui.​workbench.​workbench_plugin.​WorkbenchPlugin

Contents:
• Base classes
• Attributes
• Methods

Inherits from

• Plugin: enthought.envisage.plugin.Plugin

Attributes

• ACTION_SETS

  The Ids of the extension points that this plugin offers.

  ACTION_SETS = (PKG + '.action_sets')
  
  

• action_sets

  action_sets = ExtensionPoint(List(Callable), id = ACTION_SETS, desc = """
  
          An action set contains the toobars, menus, groups and actions that you
          would like to add to top-level workbench windows (i.e. the main
          application window). You can create new toolbars, menus and groups
          and/or add to existing ones.
      
          Each contribution to this extension point must be a factory that
          creates an action set, where 'factory' means any callable with the
          following signature::
      
            callable(**traits) -> IActionSet
      
          The easiest way to contribute such a factory is to create a class
          that derives from 'enthought.envisage.ui.action.api.ActionSet'.
      
          """)
  
  

• id

  The plugin's unique identifier.

  id = 'enthought.envisage.ui.workbench'
  
  

• my_action_sets

  my_action_sets = List(contributes_to = ACTION_SETS)
  
  

• my_preferences

  my_preferences = List(contributes_to = PREFERENCES)
  
  

• my_preferences_pages

  my_preferences_pages = List(contributes_to = PREFERENCES_PAGES)
  
  

• my_service_offers

  my_service_offers = List(contributes_to = SERVICE_OFFERS)
  
  

• name

  The plugin's name (suitable for displaying to the user).

  name = 'Workbench'
  
  

• PERSPECTIVES

  PERSPECTIVES = (PKG + '.perspectives')
  
  

• perspectives

  perspectives = ExtensionPoint(List(Callable), id = PERSPECTIVES, desc = """
          
          A perspective is simply an arrangment of views around the (optionally
          hidden) editor area.
  
          Each contribution to this extension point must be a factory that
          creates a perspective, where 'factory' means any callable with the
          following signature::
      
            callable(**traits) -> IPerspective
  
          The easiest way to contribute such a factory is to create a class
          that derives from 'enthought.pyface.workbench.api.IPerspective'.
  
          """)
  
  

• PREFERENCES

  The Ids of the extension points that this plugin contributes to.

  PREFERENCES = 'enthought.envisage.preferences'
  
  

• PREFERENCES_PAGES

  PREFERENCES_PAGES = (PKG + '.preferences_pages')
  
  

• preferences_pages

  preferences_pages = ExtensionPoint(List(Callable), id = PREFERENCES_PAGES, desc = """
  
          A preferences page appears in the preferences dialog to allow the user
          to manipulate some preference values.
  
          Each contribution to this extension point must be a factory that
          creates a preferences page, where 'factory' means any callable with the
          following signature::
      
            callable(**traits) -> IPreferencesPage
  
          The easiest way to contribute such a factory is to create a class
          that derives from 'enthought.preferences.ui.api.IPreferencesPage'.
            
          """)
  
  

• SERVICE_OFFERS

  SERVICE_OFFERS = 'enthought.envisage.service_offers'
  
  

• service_offers

  service_offers = ExtensionPoint(List(ServiceOffer), id = WORKBENCH_SERVICE_OFFERS, desc = """
  
          Services are simply objects that a plugin wants to make available to
          other plugins. This extension point allows you to offer 'per
          window' services that are created 'on-demand' (where 'on demand' means
          the first time somebody looks up a service of the appropriate
          protocol).
          .
  
          e.g.
  
          my_service_offer = ServiceOffer(
              protocol   = 'acme.IMyService',
              factory    = an_object_or_a_callable_that_creates_one,
              properties = {'a dictionary' : 'that is passed to the factory'}
          )
  
          Any properties specified are passed as keywrod arguments to the
          factory, i.e. the factory signature is::
  
            callable(**properties)
            
          """)
  
  

• VIEWS

  VIEWS = (PKG + '.views')
  
  

• views

  views = ExtensionPoint(List(Callable), id = VIEWS, desc = """
  
          A view provides information to the user to support their current
          task. Views can contain anything you like(!) and are arranged around
          the (optionally hidden) editor area. The user can re-arrange views as
          he/she sees fit.
  
          Each contribution to this extension point must be a factory that
          creates a view, where 'factory' means any callable with the following
          signature::
      
            callable(**traits) -> IView
  
          The easiest way to contribute such a factory is to create a class
          that derives from 'enthought.pyface.workbench.api.View'.
  
          It is also common to use a simple function (especially when a view
          is a representation of a service) e.g::
  
              def foo_view_factory(**traits):
                  ' Create a view that is a representation of a service. '
                  foo = self.application.get_service('IFoo')
  
                  return FooView(foo=foo, **traits)
  
          """)
  
  

• WORKBENCH_SERVICE_OFFERS

  WORKBENCH_SERVICE_OFFERS = (PKG + '.service_offers')
  
  

Method summary