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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
|
#------------------------------------------------------------------------------
#
# 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: David C. Morrill
# Date: 10/21/2004
#
#------------------------------------------------------------------------------
""" Defines the base class for wxPython editors.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
import wx
from traits.api \
import HasTraits, Int, Instance, Str, Callable
# CIRCULAR IMPORT FIXME:
# We are importing from the source instead of from the api in order to
# avoid circular imports. The 'toolkit.py' file imports from 'helper' which in
# turns imports from this file. Therefore, trying to import
# 'traitsui.wx' (which imports the toolkit) will lead to importing
# all of the editor factories declared in traitsui.api. In addition,# some of the editor factories have a Color trait defined, and this will lead
# to an import of the wx 'toolkit' causing a circular import problem.
# Another solution could be to move the GroupEditor object from helper to this
# file.
from traitsui.editor \
import Editor as UIEditor
from constants \
import WindowColor, OKColor, ErrorColor
#-------------------------------------------------------------------------------
# 'Editor' class:
#-------------------------------------------------------------------------------
class Editor ( UIEditor ):
""" Base class for wxPython editors for Traits-based UIs.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Style for embedding control in a sizer:
layout_style = Int( wx.EXPAND )
# The maximum extra padding that should be allowed around the editor:
border_size = Int( 4 )
#---------------------------------------------------------------------------
# Handles the 'control' trait being set:
#---------------------------------------------------------------------------
def _control_changed ( self, control ):
""" Handles the **control** trait being set.
"""
if control is not None:
control._editor = self
#---------------------------------------------------------------------------
# Assigns focus to the editor's underlying toolkit widget:
#---------------------------------------------------------------------------
def set_focus ( self ):
""" Assigns focus to the editor's underlying toolkit widget.
"""
if self.control is not None:
self.control.SetFocus()
#---------------------------------------------------------------------------
# Updates the editor when the object trait changes external to the editor:
#---------------------------------------------------------------------------
def update_editor ( self ):
""" Updates the editor when the object trait changes externally to the
editor.
"""
new_value = self.str_value
if self.control.GetValue() != new_value:
self.control.SetValue( new_value )
#---------------------------------------------------------------------------
# Handles an error that occurs while setting the object's trait value:
#---------------------------------------------------------------------------
def error ( self, excp ):
""" Handles an error that occurs while setting the object's trait value.
"""
dlg = wx.MessageDialog( self.control, str( excp ),
self.description + ' value error',
wx.OK | wx.ICON_INFORMATION )
dlg.ShowModal()
dlg.Destroy()
#---------------------------------------------------------------------------
# Sets the tooltip for a specified control:
#---------------------------------------------------------------------------
def set_tooltip ( self, control = None ):
""" Sets the tooltip for a specified control.
"""
desc = self.description
if desc == '':
desc = self.object.base_trait( self.name ).desc
if desc is None:
return False
desc = 'Specifies ' + desc
if control is None:
control = self.control
control.SetToolTipString( desc )
return True
#---------------------------------------------------------------------------
# Handles the 'enabled' state of the editor being changed:
#---------------------------------------------------------------------------
def _enabled_changed ( self, enabled ):
""" Handles the **enabled** state of the editor being changed.
"""
control = self.control
if control is not None:
control.Enable( enabled )
control.Refresh()
#---------------------------------------------------------------------------
# Handles the 'visible' state of the editor being changed:
#---------------------------------------------------------------------------
def _visible_changed ( self, visible ):
""" Handles the **visible** state of the editor being changed.
"""
control = self.control
parent = control.GetParent()
# Handle the case where the item whose visibility has changed is a
# notebook page:
sizer = parent.GetSizer()
from pyface.dock.api import DockSizer
if isinstance(sizer, DockSizer):
dock_controls = sizer.GetContents().get_controls(False)
for dock_control in dock_controls:
if dock_control.control is control:
dock_control.visible = visible
sizer.Layout()
# Handle a normal item:
else:
if self.label_control is not None:
self.label_control.Show( visible )
control.Show( visible )
# If only control.Layout() is called there are certain cases where
# the newly visible items are sized incorrectly (see ticket 1797)
if parent is None:
control.Layout()
else:
parent.Layout()
#---------------------------------------------------------------------------
# Returns the editor's control for indicating error status:
#---------------------------------------------------------------------------
def get_error_control ( self ):
""" Returns the editor's control for indicating error status.
"""
return self.control
#---------------------------------------------------------------------------
# Returns whether or not the editor is in an error state:
#---------------------------------------------------------------------------
def in_error_state ( self ):
""" Returns whether or not the editor is in an error state.
"""
return False
#---------------------------------------------------------------------------
# Sets the editor's current error state:
#---------------------------------------------------------------------------
def set_error_state ( self, state = None, control = None ):
""" Sets the editor's current error state.
"""
if state is None:
state = self.invalid
state = state or self.in_error_state()
if control is None:
control = self.get_error_control() or []
if not isinstance( control, list ):
control = [ control ]
for item in control:
if state:
color = ErrorColor
if getattr( item, '_ok_color', None ) is None:
item._ok_color = item.GetBackgroundColour()
else:
color = getattr( item, '_ok_color', None )
if color is None:
color = OKColor
if isinstance( item, wx.Panel ):
color = WindowColor
item.SetBackgroundColour( color )
item.Refresh()
#---------------------------------------------------------------------------
# Handles the editor's invalid state changing:
#---------------------------------------------------------------------------
def _invalid_changed ( self, state ):
""" Handles the editor's invalid state changing.
"""
self.set_error_state()
#-------------------------------------------------------------------------------
# 'EditorWithList' class:
#-------------------------------------------------------------------------------
class EditorWithList ( Editor ):
""" Editor for an object that contains a list.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Object containing the list being monitored
list_object = Instance( HasTraits )
# Name of the monitored trait
list_name = Str
# Function used to evaluate the current list object value:
list_value = Callable
#---------------------------------------------------------------------------
# Initializes the object:
#---------------------------------------------------------------------------
def init ( self, parent ):
""" Initializes the object.
"""
factory = self.factory
name = factory.name
if name != '':
self.list_object, self.list_name, self.list_value = \
self.parse_extended_name( name )
else:
self.list_object, self.list_name = factory, 'values'
self.list_value = lambda: factory.values
self.list_object.on_trait_change(
self._list_updated, self.list_name + '[]', dispatch = 'ui' )
self._list_updated()
#---------------------------------------------------------------------------
# Disconnects the listeners set up by the constructor:
#---------------------------------------------------------------------------
def dispose ( self ):
""" Disconnects the listeners set up by the constructor.
"""
self.list_object.on_trait_change(
self._list_updated, self.list_name + '[]', remove = True )
super( EditorWithList, self ).dispose()
#---------------------------------------------------------------------------
# Handles the monitored trait being updated:
#---------------------------------------------------------------------------
def _list_updated ( self ):
""" Handles the monitored trait being updated.
"""
self.list_updated( self.list_value() )
#---------------------------------------------------------------------------
# Handles the monitored list being updated:
#---------------------------------------------------------------------------
def list_updated ( self, values ):
""" Handles the monitored list being updated.
"""
raise NotImplementedError
#-------------------------------------------------------------------------------
# 'EditorFromView' class:
#-------------------------------------------------------------------------------
class EditorFromView ( Editor ):
""" An editor generated from a View object.
"""
#---------------------------------------------------------------------------
# Initializes the object:
#---------------------------------------------------------------------------
def init ( self, parent ):
""" Initializes the object.
"""
self._ui = ui = self.init_ui( parent )
if ui.history is None:
ui.history = self.ui.history
self.control = ui.control
#---------------------------------------------------------------------------
# Creates and returns the traits UI defined by this editor:
# (Must be overridden by a subclass):
#---------------------------------------------------------------------------
def init_ui ( self, parent ):
""" Creates and returns the traits UI defined by this editor.
(Must be overridden by a subclass).
"""
raise NotImplementedError
#---------------------------------------------------------------------------
# Updates the editor when the object trait changes external to the editor:
#---------------------------------------------------------------------------
def update_editor ( self ):
""" Updates the editor when the object trait changes externally to the
editor.
"""
# Normally nothing needs to be done here, since it should all be handled
# by the editor's internally created traits UI:
pass
#---------------------------------------------------------------------------
# Dispose of the editor:
#---------------------------------------------------------------------------
def dispose ( self ):
""" Disposes of the editor.
"""
self._ui.dispose()
super( EditorFromView, self ).dispose()
|
