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
|
#------------------------------------------------------------------------------
#
# 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 various text editors for the wxPython user interface toolkit.
"""
#-------------------------------------------------------------------------------
# Imports:
#------------------------------------------------------------------------------
import wx
from traits.api \
import TraitError
# FIXME: ToolkitEditorFactory is a proxy class defined here just for backward
# compatibility. The class has been moved to the
# traitsui.editors.text_editor file.
from traitsui.editors.text_editor \
import ToolkitEditorFactory, evaluate_trait
from editor \
import Editor
from editor_factory \
import ReadonlyEditor as BaseReadonlyEditor
from constants \
import OKColor
#-------------------------------------------------------------------------------
# Constants:
#-------------------------------------------------------------------------------
# Readonly text editor with view state colors:
HoverColor = wx.LIGHT_GREY
DownColor = wx.WHITE
#-------------------------------------------------------------------------------
# 'SimpleEditor' class:
#-------------------------------------------------------------------------------
class SimpleEditor ( Editor ):
""" Simple style text editor, which displays a text field.
"""
# Flag for window styles:
base_style = 0
# Background color when input is OK:
ok_color = OKColor
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Function used to evaluate textual user input:
evaluate = evaluate_trait
#---------------------------------------------------------------------------
# Finishes initializing the editor by creating the underlying toolkit
# widget:
#---------------------------------------------------------------------------
def init ( self, parent ):
""" Finishes initializing the editor by creating the underlying toolkit
widget.
"""
factory = self.factory
style = self.base_style
self.evaluate = factory.evaluate
self.sync_value( factory.evaluate_name, 'evaluate', 'from' )
if (not factory.multi_line) or factory.password:
style &= ~wx.TE_MULTILINE
if factory.password:
style |= wx.TE_PASSWORD
multi_line = ((style & wx.TE_MULTILINE) != 0)
if multi_line:
self.scrollable = True
if factory.enter_set and (not multi_line):
control = wx.TextCtrl( parent, -1, self.str_value,
style = style | wx.TE_PROCESS_ENTER )
wx.EVT_TEXT_ENTER( parent, control.GetId(), self.update_object )
else:
control = wx.TextCtrl( parent, -1, self.str_value, style = style )
wx.EVT_KILL_FOCUS( control, self.update_object )
if factory.auto_set:
wx.EVT_TEXT( parent, control.GetId(), self.update_object )
self.control = control
self.set_error_state( False )
self.set_tooltip()
#---------------------------------------------------------------------------
# Handles the user entering input data in the edit control:
#---------------------------------------------------------------------------
def update_object ( self, event ):
""" Handles the user entering input data in the edit control.
"""
if (not self._no_update) and (self.control is not None):
try:
self.value = self._get_user_value()
if self._error is not None:
self._error = None
self.ui.errors -= 1
self.set_error_state( False )
except TraitError, excp:
pass
#---------------------------------------------------------------------------
# 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.
"""
user_value = self._get_user_value()
try:
unequal = bool( user_value != self.value )
except ValueError:
# This might be a numpy array.
unequal = True
if unequal:
self._no_update = True
self.control.SetValue( self.str_value )
self._no_update = False
if self._error is not None:
self._error = None
self.ui.errors -= 1
self.set_error_state( False )
#---------------------------------------------------------------------------
# Gets the actual value corresponding to what the user typed:
#---------------------------------------------------------------------------
def _get_user_value ( self ):
""" Gets the actual value corresponding to what the user typed.
"""
value = self.control.GetValue()
try:
value = self.evaluate( value )
except:
pass
try:
ret = self.factory.mapping.get( value, value )
except TypeError:
# The value is probably not hashable:
ret = value
return ret
#---------------------------------------------------------------------------
# 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.
"""
if self._error is None:
self._error = True
self.ui.errors += 1
self.set_error_state( True )
#---------------------------------------------------------------------------
# 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 (self.invalid or self._error)
#-------------------------------------------------------------------------------
# 'CustomEditor' class:
#-------------------------------------------------------------------------------
class CustomEditor ( SimpleEditor ):
""" Custom style of text editor, which displays a multi-line text field.
"""
# Flag for window style. This value overrides the default.
base_style = wx.TE_MULTILINE
#-------------------------------------------------------------------------------
# 'ReadonlyEditor' class:
#-------------------------------------------------------------------------------
class ReadonlyEditor ( BaseReadonlyEditor ):
""" Read-only style of text editor, which displays a read-only text field.
"""
#---------------------------------------------------------------------------
# Finishes initializing the editor by creating the underlying toolkit
# widget:
#---------------------------------------------------------------------------
def init ( self, parent ):
""" Finishes initializing the editor by creating the underlying toolkit
widget.
"""
super( ReadonlyEditor, self ).init( parent )
if self.factory.view is not None:
control = self.control
wx.EVT_ENTER_WINDOW( control, self._enter_window )
wx.EVT_LEAVE_WINDOW( control, self._leave_window )
wx.EVT_LEFT_DOWN( control, self._left_down )
wx.EVT_LEFT_UP( control, self._left_up )
#---------------------------------------------------------------------------
# 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.
"""
control = self.control
new_value = self.str_value
if hasattr(self.factory, 'password') and self.factory.password:
new_value = '*' * len( new_value )
if (self.item.resizable is True) or (self.item.height != -1.0):
if control.GetValue() != new_value:
control.SetValue( new_value )
control.SetInsertionPointEnd()
elif control.GetLabel() != new_value:
control.SetLabel( new_value )
#---------------------------------------------------------------------------
# Disposes of the contents of an editor:
#---------------------------------------------------------------------------
def dispose ( self ):
""" Disposes of the contents of an editor.
"""
if self.factory.view is not None:
control = self.control
wx.EVT_ENTER_WINDOW( control, None )
wx.EVT_LEAVE_WINDOW( control, None )
wx.EVT_LEFT_DOWN( control, None )
wx.EVT_LEFT_UP( control, None )
super( ReadonlyEditor, self ).dispose()
#-- Private Methods --------------------------------------------------------
def _set_color ( self ):
control = self.control
if not self._in_window:
color = control.GetParent().GetBackgroundColour()
elif self._down:
color = DownColor
else:
color = HoverColor
control.SetBackgroundColour( color )
control.Refresh()
#-- wxPython Event Handlers ------------------------------------------------
def _enter_window ( self, event ):
self._in_window = True
self._set_color()
def _leave_window ( self, event ):
self._in_window = False
self._set_color()
def _left_down ( self, event ):
self.control.CaptureMouse()
self._down = True
self._set_color()
def _left_up ( self, event ):
self._set_color()
if not self._down:
return
self.control.ReleaseMouse()
self._down = False
if self._in_window:
self.object.edit_traits( view = self.factory.view,
parent = self.control )
TextEditor = SimpleEditor
|
