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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in 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!
""" Classes to provide a switcher. """
import wx
from wx.lib.scrolledpanel import ScrolledPanel as wxScrolledPanel
from traits.api import HasTraits, Int
class SwitcherModel(HasTraits):
""" Base class for switcher models. """
# The index of the selected 'page'.
selected = Int(-1)
def __init__(self):
""" Creates a new switcher model. """
# The items to display in the switcher control.
self.items = [] # (str label, object value)
return
# ------------------------------------------------------------------------
# 'SwitcherModel' interface.
# ------------------------------------------------------------------------
def create_page(self, parent, index):
""" Creates a page for the switcher panel. """
raise NotImplementedError()
class SwitcherControl(wx.Panel):
""" The default switcher control (a combo box). """
def __init__(self, parent, id, model, label=None, **kw):
""" Creates a new switcher control. """
# Base-class constructor.
wx.Panel.__init__(self, parent, id, **kw)
# The switcher model that we are a controller for.
self.model = model
# The optional label.
self.label = label
# Create the widget!
self._create_widget(model, label)
# Listen for when the selected item in the model is changed.
model.observe(self._on_selected_changed, "selected")
return
# ------------------------------------------------------------------------
# Trait event handlers.
# ------------------------------------------------------------------------
def _on_selected_changed(self, event):
""" Called when the selected item in the model is changed. """
selected = event.new
self.combo.SetSelection(selected)
return
# ------------------------------------------------------------------------
# wx event handlers.
# ------------------------------------------------------------------------
def _on_combobox(self, event):
""" Called when the combo box selection is changed. """
combo = event.GetEventObject()
# Update the model.
self.model.selected = combo.GetSelection()
return
# ------------------------------------------------------------------------
# Private interface.
# ------------------------------------------------------------------------
def _create_widget(self, model, label):
""" Creates the widget."""
self.sizer = sizer = wx.BoxSizer(wx.VERTICAL)
self.SetSizer(sizer)
self.SetAutoLayout(True)
# Switcher combo.
sizer.Add(self._combo(self, model, label), 1, wx.EXPAND)
# Resize the panel to match the sizer's minimal size.
sizer.Fit(self)
def _combo(self, parent, model, label):
""" Creates the switcher combo. """
sizer = wx.BoxSizer(wx.HORIZONTAL)
# Label.
if label is not None:
text = wx.StaticText(parent, -1, label)
sizer.Add(text, 0, wx.ALIGN_CENTER | wx.ALL, 5)
# Combo.
self.combo = combo = wx.ComboBox(
parent, -1, style=wx.CB_DROPDOWN | wx.CB_READONLY
)
sizer.Add(combo, 1, wx.EXPAND | wx.ALIGN_CENTER | wx.ALL, 5)
# Ask the model for the available options.
items = model.items
if len(items) > 0:
for name, data in model.items:
combo.Append(name, data)
# Listen for changes to the selected item.
self.Bind(wx.EVT_COMBOBOX, self._on_combobox, id=combo.GetId())
# If the model's selected variable has been set ...
if model.selected != -1:
combo.SetSelection(model.selected)
return sizer
class SwitcherPanel(wxScrolledPanel):
""" The default switcher panel. """
def __init__(self, parent, id, model, label=None, cache=True, **kw):
# Base-class constructor.
wxScrolledPanel.__init__(self, parent, id, **kw)
self.SetupScrolling()
# The switcher model that we are a panel for.
self.model = model
# Should we cache pages as we create them?
self.cache = cache
# The page cache (if caching was requested).
self._page_cache = {}
# The currently displayed page.
self.current = None
# Create the widget!
self._create_widget(model, label)
return
# ------------------------------------------------------------------------
# 'SwitcherPanel' interface.
# ------------------------------------------------------------------------
def show_page(self, index):
""" Shows the page at the specified index. """
self._show_page(index)
return
# ------------------------------------------------------------------------
# Private interface.
# ------------------------------------------------------------------------
def _create_widget(self, model, label):
""" Creates the widget. """
self.sizer = sizer = wx.BoxSizer(wx.VERTICAL)
self.SetSizer(sizer)
self.SetAutoLayout(True)
# Nothing to add here as we add the panel contents lazily!
pass
# Resize the panel to match the sizer's minimal size.
sizer.Fit(self)
def _show_page(self, index):
""" Shows the page at the specified index. """
# If a page is already displayed then hide it.
if self.current is not None:
self.current.Show(False)
self.sizer.Remove(self.current)
# Is the page in the cache?
page = self._page_cache.get(index)
if not self.cache or page is None:
# If not then ask our panel factory to create it.
page = self.model.create_page(self, index)
# Add it to the cache!
self._page_cache[index] = page
# Display the page.
self.sizer.Add(page, 15, wx.EXPAND, 5)
page.Show(True)
self.current = page
# Force a new layout of the sizer's children but KEEPING the current
# dimension.
self.sizer.Layout()
class Switcher(wx.Panel):
""" A switcher. """
def __init__(self, parent, id, model, label=None, **kw):
""" Create a new switcher. """
# Base-class constructor.
wx.Panel.__init__(self, parent, id, **kw)
# The model that we are a switcher for.
self.model = model
# Create the widget!
self._create_widget(model, label)
return
# ------------------------------------------------------------------------
# Private interface.
# ------------------------------------------------------------------------
def _create_widget(self, model, label):
""" Creates the widget. """
self.sizer = sizer = wx.BoxSizer(wx.VERTICAL)
self.SetSizer(sizer)
self.SetAutoLayout(True)
# Switcher control.
self.control = control = SwitcherControl(self, -1, model, label)
sizer.Add(control, 0, wx.EXPAND)
# Switcher panel.
self.panel = panel = SwitcherPanel(self, -1, model, label)
sizer.Add(panel, 1, wx.EXPAND)
# Resize the panel to match the sizer's minimal size.
sizer.Fit(self)
return
|
