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
|
#------------------------------------------------------------------------------
#
# 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 editors for multi-selection enumerations, for the
wxPython user interface toolkit.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
import logging
import wx
from string \
import capitalize
from traits.api \
import List, Str, TraitError
# FIXME: ToolkitEditorFactory is a proxy class defined here just for backward
# compatibility. The class has been moved to the
# traitsui.editors.check_list_editor file.
from traitsui.editors.check_list_editor \
import ToolkitEditorFactory
from editor_factory \
import TextEditor as BaseTextEditor
from editor \
import EditorWithList
from helper \
import TraitsUIPanel
logger = logging.getLogger(__name__)
#-------------------------------------------------------------------------------
# 'SimpleEditor' class:
#-------------------------------------------------------------------------------
class SimpleEditor ( EditorWithList ):
""" Simple style of editor for checklists, which displays a combo box.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Checklist item names
names = List( Str )
# Checklist item values
values = List
#---------------------------------------------------------------------------
# Finishes initializing the editor by creating the underlying toolkit
# widget:
#---------------------------------------------------------------------------
def init ( self, parent ):
""" Finishes initializing the editor by creating the underlying toolkit
widget.
"""
self.create_control( parent )
super( SimpleEditor, self ).init( parent )
self.set_tooltip()
#---------------------------------------------------------------------------
# Creates the initial editor control:
#---------------------------------------------------------------------------
def create_control ( self, parent ):
""" Creates the initial editor control.
"""
self.control = wx.Choice( parent, -1,
wx.Point( 0, 0 ), wx.Size( 100, 20 ), [] )
wx.EVT_CHOICE( parent, self.control.GetId(), self.update_object )
#---------------------------------------------------------------------------
# Handles the list of legal check list values being updated:
#---------------------------------------------------------------------------
def list_updated ( self, values ):
""" Handles updates to the list of legal checklist values.
"""
sv = self.string_value
if (len( values ) > 0) and isinstance( values[0], basestring ):
values = [ ( x, sv( x, capitalize ) ) for x in values ]
self.values = valid_values = [ x[0] for x in values ]
self.names = [ x[1] for x in values ]
# Make sure the current value is still legal:
modified = False
cur_value = parse_value( self.value )
for i in range( len( cur_value ) - 1, -1, -1 ):
if cur_value[i] not in valid_values:
try:
del cur_value[i]
modified = True
except TypeError, e:
logger.warn('Unable to remove non-current value [%s] from '
'values %s', cur_value[i], values)
if modified:
if isinstance( self.value, basestring ):
cur_value = ','.join( cur_value )
self.value = cur_value
self.rebuild_editor()
#---------------------------------------------------------------------------
# Rebuilds the editor after its definition is modified:
#---------------------------------------------------------------------------
def rebuild_editor ( self ):
""" Rebuilds the editor after its definition is modified.
"""
control = self.control
control.Clear()
for name in self.names:
control.Append( name )
self.update_editor()
#----------------------------------------------------------------------------
# Handles the user selecting a new value from the combo box:
#----------------------------------------------------------------------------
def update_object ( self, event ):
""" Handles the user selecting a new value from the combo box.
"""
value = self.values[ self.names.index( event.GetString() ) ]
if type( self.value ) is not str:
value = [ value ]
self.value = value
#---------------------------------------------------------------------------
# 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.
"""
try:
self.control.SetSelection(
self.values.index( parse_value( self.value )[0] ) )
except:
pass
#-------------------------------------------------------------------------------
# 'CustomEditor' class:
#-------------------------------------------------------------------------------
class CustomEditor ( SimpleEditor ):
""" Custom style of editor for checklists, which displays a set of check
boxes.
"""
#---------------------------------------------------------------------------
# Creates the initial editor control:
#---------------------------------------------------------------------------
def create_control ( self, parent ):
""" Creates the initial editor control.
"""
# Create a panel to hold all of the check boxes
self.control = panel = TraitsUIPanel( parent, -1 )
#---------------------------------------------------------------------------
# Rebuilds the editor after its definition is modified:
#---------------------------------------------------------------------------
def rebuild_editor ( self ):
""" Rebuilds the editor after its definition is modified.
"""
panel = self.control
panel.SetSizer( None )
panel.DestroyChildren()
cur_value = parse_value( self.value )
# Create a sizer to manage the radio buttons:
labels = self.names
values = self.values
n = len( labels )
cols = self.factory.cols
rows = (n + cols - 1) / cols
incr = [ n / cols ] * cols
rem = n % cols
for i in range( cols ):
incr[i] += (rem > i)
incr[-1] = -(reduce( lambda x, y: x + y, incr[:-1], 0 ) - 1)
if cols > 1:
sizer = wx.GridSizer( 0, cols, 2, 4 )
else:
sizer = wx.BoxSizer( wx.VERTICAL )
# Add the set of all possible choices:
index = 0
for i in range( rows ):
for j in range( cols ):
if n > 0:
label = labels[ index ]
control = wx.CheckBox( panel, -1, label )
control.value = value = values[ index ]
control.SetValue( value in cur_value )
wx.EVT_CHECKBOX( panel, control.GetId(), self.update_object)
index += incr[j]
n -= 1
else:
control = wx.CheckBox( panel, -1, '' )
control.Show( False )
sizer.Add( control, 0, wx.NORTH, 5 )
# Lay out the controls:
panel.SetSizerAndFit( sizer )
# FIXME: There are cases where one of the parent panel's of the check
# list editor has a fixed 'min size' which prevents the check list
# editor from expanding correctly, so we currently are making sure
# that all of the parent panels do not have a fixed min size before
# doing the layout/refresh:
parent = panel.GetParent()
while isinstance( parent, wx.Panel ):
parent.SetMinSize( wx.Size( -1, -1 ) )
panel = parent
parent = parent.GetParent()
panel.Layout()
panel.Refresh()
#---------------------------------------------------------------------------
# Handles the user clicking one of the 'custom' check boxes:
#---------------------------------------------------------------------------
def update_object ( self, event ):
""" Handles the user clicking one of the custom check boxes.
"""
control = event.GetEventObject()
cur_value = parse_value( self.value )
if control.GetValue():
cur_value.append( control.value )
else:
cur_value.remove( control.value )
if isinstance(self.value, basestring):
cur_value = ','.join( cur_value )
self.value = cur_value
#---------------------------------------------------------------------------
# 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_values = parse_value( self.value )
for control in self.control.GetChildren():
if control.IsShown():
control.SetValue( control.value in new_values )
#-------------------------------------------------------------------------------
# 'TextEditor' class:
#-------------------------------------------------------------------------------
class TextEditor ( BaseTextEditor ):
""" Text style of editor for checklists, which displays a text field.
"""
#---------------------------------------------------------------------------
# Handles the user changing the contents of the edit control:
#---------------------------------------------------------------------------
def update_object ( self, event ):
""" Handles the user changing the contents of the edit control.
"""
try:
value = self.control.GetValue()
value = eval( value )
except:
pass
try:
self.value = value
except TraitError, excp:
pass
#-------------------------------------------------------------------------------
# Parse a value into a list:
#-------------------------------------------------------------------------------
def parse_value ( value ):
""" Parses a value into a list.
"""
if value is None:
return []
if type( value ) is not str:
return value[:]
return [ x.strip() for x in value.split( ',' ) ]
### EOF ########################################################################
|
