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
181
182
183
184
|
#------------------------------------------------------------------------------
# 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 tool bar manager realizes itself in errr, a tool bar control. """
# Major package imports.
import wx
# Enthought library imports.
from enthought.pyface.image_cache import ImageCache
from enthought.traits.api import Any, Bool, Enum, Instance, Tuple
# Local imports.
from action_manager import ActionManager
class ToolBarManager(ActionManager):
""" A tool bar manager realizes itself in errr, a tool bar control. """
# The default tool bar style.
STYLE = wx.NO_BORDER | wx.TB_FLAT | wx.CLIP_CHILDREN
#### 'ToolBarManager' interface ###########################################
# The size of tool images (width, height).
image_size = Tuple((16, 16))
# The orientation of the toolbar.
orientation = Enum('horizontal', 'vertical')
# Should we display the name of each tool bar tool under its image?
show_tool_names = Bool(True)
# Should we display the horizontal divider?
show_divider = Bool(True)
#### Private interface ####################################################
# Cache of tool images (scaled to the appropriate size).
_image_cache = Instance(ImageCache)
###########################################################################
# 'object' interface.
###########################################################################
def __init__(self, *args, **traits):
""" Creates a new tool bar manager. """
# Base class contructor.
super(ToolBarManager, self).__init__(*args, **traits)
# An image cache to make sure that we only load each image used in the
# tool bar exactly once.
self._image_cache = ImageCache(self.image_size[0], self.image_size[1])
return
###########################################################################
# 'ToolBarManager' interface.
###########################################################################
def create_tool_bar(self, parent, controller=None):
""" Creates a tool bar. """
# If a controller is required it can either be set as a trait on the
# tool bar 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
# Determine the wx style for the tool bar based on any optional
# settings.
style = self._get_style()
# Create the control.
tool_bar = wx.ToolBar(parent, -1, style=style)
# fixme: Setting the tool bitmap size seems to be the only way to
# change the height of the toolbar in wx.
tool_bar.SetToolBitmapSize(self.image_size)
# Add all of items in the manager's groups to the tool bar.
self._add_tools(parent, tool_bar, self.groups, controller)
# Make the tools appear in the tool bar (without this you will see
# nothing!).
tool_bar.Realize()
# fixme: Without the following hack, only the first item in a radio
# group can be selected when the tool bar is first realised 8^()
self._set_initial_tool_state(tool_bar, self.groups)
return tool_bar
###########################################################################
# Private interface.
###########################################################################
def _get_style(self):
""" Returns the wx style for the tool bar control. """
style = self.STYLE
if self.show_tool_names:
style |= wx.TB_TEXT
if self.orientation == 'horizontal':
style |= wx.TB_HORIZONTAL
else:
style |= wx.TB_VERTICAL
if not self.show_divider:
style |= wx.TB_NODIVIDER
return style
def _add_tools(self, parent, tool_bar, groups, controller):
""" Adds tools for all items in a list of groups. """
previous_non_empty_group = None
for group in self.groups:
if len(group.items) > 0:
# Is a separator required?
if previous_non_empty_group is not None and group.separator:
tool_bar.AddSeparator()
previous_non_empty_group = group
# Create a tool bar tool for each item in the group.
for item in group.items:
item.add_to_toolbar(
parent,
tool_bar,
self._image_cache,
controller,
self.show_tool_names
)
return
def _set_initial_tool_state(self, tool_bar, groups):
""" Workaround for the wxPython tool bar bug.
Without this, only the first item in a radio group can be selected
when the tool bar is first realised 8^()
"""
for group in groups:
checked = False
for item in group.items:
# If the group is a radio group, set the initial checked state
# of every tool in it.
if item.action.style == 'radio':
tool_bar.ToggleTool(item.control_id, item.action.checked)
checked = checked or item.action.checked
# Every item in a radio group MUST be 'radio' style, so we
# can just skip to the next group.
else:
break
# We get here if the group is a radio group.
else:
# If none of the actions in the group is specified as 'checked'
# we will check the first one.
if not checked and len(group.items) > 0:
group.items[0].action.checked = True
return
#### EOF ######################################################################
|
