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
98
99
100
101
102
103
104
105
106
107
|
""" An action set is a collection of menus, groups, and actions. """
# Standard library imports.
import logging
# Enthought library imports.
from enthought.envisage.util import camel_case_to_words
from enthought.traits.api import Bool, Dict, HasTraits, List, Str, implements
# Local imports.
from action import Action
from group import Group
from i_action_set import IActionSet
from menu import Menu
from tool_bar import ToolBar
# Logging.
logger = logging.getLogger(__name__)
class ActionSet(HasTraits):
""" An action set is a collection of menus, groups, and actions. """
implements(IActionSet)
# The action set's globally unique identifier.
id = Str
# The action set's name.
#
# fixme: This is not currently used, but in future it will be the name that
# is shown to the user when they are customizing perspectives by adding or
# removing action sets etc.
name = Str
# The actions in this set.
actions = List(Action)
# The groups in this set.
groups = List(Group)
# The menus in this set.
menus = List(Menu)
# The tool bars in this set.
tool_bars = List(ToolBar)
# Are the actions and menus in this set enabled (if they are disabled they
# will be greyed out). Tool bars are generally not greyed out themselves,
# but the actions within them are.
enabled = Bool(True)
# Are the actions, menus and tool bars in this set visible?
visible = Bool(True)
# A mapping from human-readable names to globally unique IDs.
#
# This mapping is used when interpreting the first item in a location path
# (i.e., the **path** trait of a **Location** instance).
#
# When the path is intepreted, the first component (i.e., the first item
# before any '/') is checked to see if it is in the mapping, and if so it
# is replaced with the value in the map.
#
# This technique allows paths to start with human readable names, as
# opposed to IDs (which are required in order to manage the namespace of
# all action sets).
#
# For example, in the Envisage workbench, the menu bar ID is:
#
# ``'enthought.envisage.workbench.menubar'``
#
# Without aliases, you must specify a location like this:
#
# ``Location(path='enthought.envisage.workbench.menubar/ASubMenu/AGroup')``
#
# This is a bit long-winded! Instead, you can define an alias:
#
# ``aliases = { 'MenuBar' : 'enthought.envisage.workbench.menubar' }``
#
# In that case, you can specify a location like this:
#
# ``Location(path='MenuBar/ASubMenu/AGroup')``
#
aliases = Dict(Str, Str)
#### Trait initializers ###################################################
def _id_default(self):
""" Trait initializer. """
id = '%s.%s' % (type(self).__module__, type(self).__name__)
logger.warn('action set %s has no Id - using <%s>' % (self, id))
return id
def _name_default(self):
""" Trait initializer. """
name = camel_case_to_words(type(self).__name__)
logger.warn('action set %s has no name - using <%s>' % (self, name))
return name
#### EOF ######################################################################
|
