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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
#------------------------------------------------------------------------------
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
# Thanks for using Enthought open source!
#
# Author: Enthought, Inc.
# Description: <Enthought pyface package component>
#------------------------------------------------------------------------------
""" A menu manager realizes itself in a menu control. """
# Major package imports.
import wx
# Enthought library imports.
from enthought.traits.api import Bool, Str
# Local imports.
from action_manager_item import ActionManagerItem
from action_manager import ActionManager
from group import Group
class MenuManager(ActionManager, ActionManagerItem):
""" A menu manager realizes itself in a menu control.
This could be a sub-menu or a context (popup) menu.
"""
#### 'MenuManager' interface ##############################################
# The menu manager's name (if the manager is a sub-menu, this is what its
# label will be).
name = Str
###########################################################################
# 'MenuManager' interface.
###########################################################################
def create_menu(self, parent, controller=None):
""" Creates a menu representation of the manager. """
# If a controller is required it can either be set as a trait on the
# menu manager (the trait is part of the 'ActionManager' API), or
# passed in here (if one is passed in here it takes precedence over the
# trait).
if controller is None:
controller = self.controller
return _Menu(self, parent, controller)
###########################################################################
# 'ActionManagerItem' interface.
###########################################################################
def add_to_menu(self, parent, menu, controller):
""" Adds the item to a menu. """
menu.AppendMenu(
wx.NewId(), self.name, self.create_menu(parent, controller)
)
return
def add_to_toolbar(self, parent, tool_bar, image_cache, controller):
""" Adds the item to a tool bar. """
raise ValueError("Cannot add a menu manager to a toolbar.")
class _Menu(wx.Menu):
""" The toolkit-specific menu control. """
###########################################################################
# 'object' interface.
###########################################################################
def __init__(self, manager, parent, controller):
""" Creates a new tree. """
# Base class constructor.
wx.Menu.__init__(self)
# The parent of the menu.
self._parent = parent
# The manager that the menu is a view of.
self._manager = manager
# The controller.
self._controller = controller
# Create the menu structure.
self.refresh()
# Listen to the manager being updated.
self._manager.on_trait_change(self.refresh, 'changed')
return
###########################################################################
# '_Menu' interface.
###########################################################################
def clear(self):
""" Clears the items from the menu. """
for item in self.GetMenuItems():
self.Delete(item.GetId())
return
def is_empty(self):
""" Is the menu empty? """
return self.GetMenuItemCount() == 0
def refresh(self):
""" Ensures that the menu reflects the state of the manager. """
self.clear()
manager = self._manager
parent = self._parent
previous_non_empty_group = None
for group in manager.groups:
previous_non_empty_group = self._add_group(
parent, group, previous_non_empty_group
)
return
def show(self, x, y):
""" Show the menu at the specified location. """
self._parent.PopupMenuXY(self, x, y)
return
###########################################################################
# Private interface.
###########################################################################
def _add_group(self, parent, group, previous_non_empty_group=None):
""" Adds a group to a menu. """
if len(group.items) > 0:
# Is a separator required?
if previous_non_empty_group is not None and group.separator:
self.AppendSeparator()
# Create actions and sub-menus for each contribution item in
# the group.
for item in group.items:
if isinstance(item, Group):
if len(item.items) > 0:
self._add_group(parent, item, previous_non_empty_group)
if previous_non_empty_group is not None \
and previous_non_empty_group.separator \
and item.separator:
self.AppendSeparator()
previous_non_empty_group = item
else:
item.add_to_menu(parent, self, self._controller)
previous_non_empty_group = group
return previous_non_empty_group
#### EOF ######################################################################
|
