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
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
|
#------------------------------------------------------------------------------
#
# 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!
#------------------------------------------------------------------------------
""" Defines the various color editors for the Wx user interface toolkit.
"""
#------------------------------------------------------------------------------
# Imports:
#------------------------------------------------------------------------------
import wx
import wx.combo
from traits.api import List, TraitError
from traitsui.editors.color_editor \
import ToolkitEditorFactory as BaseToolkitEditorFactory
from editor_factory import SimpleEditor as BaseSimpleEditor
from editor_factory import ReadonlyEditor as BaseReadonlyEditor
from editor_factory import TextEditor as BaseTextEditor
from color_trait import w3c_color_database
from helper import TraitsUIPanel
# Version dependent imports (ColourPtr not defined in wxPython 2.5):
try:
ColorTypes = (wx.Colour, wx.ColourPtr)
except:
ColorTypes = wx.Colour
#---------------------------------------------------------------------------
# The Wx ToolkitEditorFactory class.
#---------------------------------------------------------------------------
class ToolkitEditorFactory(BaseToolkitEditorFactory):
""" Wx editor factory for color editors.
"""
def to_wx_color(self, editor, color=None):
""" Gets the wxPython color equivalent of the object trait.
"""
if color is None:
if self.mapped:
color = getattr(editor.object, editor.name + '_')
else:
color = getattr(editor.object, editor.name)
if isinstance(color, tuple):
color = wx.Colour(*[int(round(c * 255.0)) for c in color])
return color
#--------------------------------------------------------------------------
# Gets the application equivalent of a wxPython value:
#--------------------------------------------------------------------------
def from_wx_color(self, color):
""" Gets the application equivalent of a wxPython value.
"""
return color.Red(), color.Green(), color.Blue()
#--------------------------------------------------------------------------
# Returns the text representation of a specified color value:
#--------------------------------------------------------------------------
def str_color(self, color):
""" Returns the text representation of a specified color value.
"""
if isinstance(color, ColorTypes):
alpha = color.Alpha()
if alpha == 255:
return "rgb(%d,%d,%d)" % (
color.Red(), color.Green(), color.Blue())
return "rgb(%d,%d,%d,%d)" % (
color.Red(), color.Green(), color.Blue(), alpha)
return str(color)
#------------------------------------------------------------------------------
# 'ColorComboBox' class:
#------------------------------------------------------------------------------
class ColorComboBox(wx.combo.OwnerDrawnComboBox):
def OnDrawItem(self, dc, rect, item, flags):
r = wx.Rect(rect.x, rect.y, rect.width, rect.height)
r.Deflate(3, 0)
swatch_size = r.height - 2
color_name = self.GetString(item)
dc.DrawText(color_name, r.x + 3,
r.y + (r.height - dc.GetCharHeight()) / 2)
if color_name == 'custom':
swatch = wx.Rect(r.x + r.width - swatch_size, r.y + 1,
swatch_size, swatch_size)
dc.GradientFillLinear(swatch, wx.Colour(255, 255, 0),
wx.Colour(0, 0, 255))
else:
color = w3c_color_database.Find(color_name)
brush = wx.Brush(color)
dc.SetBrush(brush)
dc.DrawRectangle(r.x + r.width - swatch_size, r.y + 1,
swatch_size, swatch_size)
#------------------------------------------------------------------------------
# 'SimpleColorEditor' class:
#------------------------------------------------------------------------------
class SimpleColorEditor(BaseSimpleEditor):
""" Simple style of color editor, which displays a text field whose
background color is the color value. Selecting the text field displays
a dialog box for selecting a new color value.
"""
#--------------------------------------------------------------------------
# Invokes the pop-up editor for an object trait:
#--------------------------------------------------------------------------
choices = List()
def _choices_default(self):
""" by default, uses the W3C 16 color names.
"""
return ['aqua', 'black', 'blue', 'fuchsia', 'gray', 'green',
'lime', 'maroon', 'navy', 'olive', 'purple', 'red',
'silver', 'teal', 'white', 'yellow', 'custom']
def init(self, parent):
"""
Finishes initializing the editor by creating the underlying widget.
"""
current_color = self.factory.to_wx_color(self)
current_color_name = current_color.GetAsString()
self.control = ColorComboBox(parent, -1, current_color_name,
wx.Point(0, 0), wx.Size(40, -1), self.choices,
style=wx.wx.CB_READONLY)
self.control.Bind(wx.EVT_COMBOBOX, self.color_selected)
return
#--------------------------------------------------------------------------
# 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.
"""
current_color = self.factory.to_wx_color(self)
self.control.SetValue(self.string_value(current_color))
def color_selected(self, event):
"""
Event for when color is selected
"""
color_name = self.choices[event.Selection]
if color_name == 'custom':
color_dialog = wx.ColourDialog(self.control)
result = color_dialog.ShowModal()
if result == wx.ID_CANCEL:
return
color = color_dialog.GetColourData().GetColour()
self.value = self.factory.from_wx_color(color)
else:
try:
color = w3c_color_database.Find(color_name)
self.value = self.factory.from_wx_color(color)
except ValueError:
pass
return
def string_value(self, color):
""" Returns the text representation of a specified color value.
"""
color_name = w3c_color_database.FindName(color)
if color_name != '':
return color_name
return color.GetAsString()
#------------------------------------------------------------------------------
# 'CustomColorEditor' class:
#------------------------------------------------------------------------------
class CustomColorEditor(BaseSimpleEditor):
""" Simple style of color editor, which displays a text field whose
background color is the color value. Selecting the text field displays
a dialog box for selecting a new color value.
"""
#--------------------------------------------------------------------------
# Invokes the pop-up editor for an object trait:
#--------------------------------------------------------------------------
def init(self, parent):
"""
Finishes initializing the editor by creating the underlying widget.
"""
self.control = self._panel = parent = TraitsUIPanel(parent, -1)
sizer = wx.BoxSizer(wx.HORIZONTAL)
# 'text_control' is the text display of the color.
text_control = wx.TextCtrl(parent, -1, self.str_value,
style=wx.TE_PROCESS_ENTER)
wx.EVT_KILL_FOCUS(text_control, self.update_object)
wx.EVT_TEXT_ENTER(parent, text_control.GetId(), self.update_object)
# 'button_control' shows the 'Edit' button.
button_control = wx.Button(parent, label='Edit', style=wx.BU_EXACTFIT)
wx.EVT_BUTTON(button_control, button_control.GetId(),
self.open_color_dialog)
sizer.Add(text_control, wx.ALIGN_LEFT)
sizer.AddSpacer(8)
sizer.Add(button_control, wx.ALIGN_RIGHT)
self.control.SetSizer(sizer)
self._text_control = text_control
self._button_control = button_control
self.set_tooltip()
return
def update_object(self, event):
""" Handles the user changing the contents of the edit control.
"""
if not isinstance(event, wx._core.CommandEvent):
return
try:
# The TextCtrl object was saved as self._text_control in init().
value = self._text_control.GetValue()
self.value = w3c_color_database.Find(value)
self.set_color()
except TraitError:
pass
def set_color(self):
# The CustomColorEditor uses this method instead of the global
# set_color function.
color = self.factory.to_wx_color(self)
self._text_control.SetBackgroundColour(color)
self.control.SetBackgroundColour(color)
self._text_control.SetValue(self.string_value(color))
#--------------------------------------------------------------------------
# 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.
"""
self.set_color()
def open_color_dialog(self, event):
""" Opens the color dialog and sets the value upon return
"""
color_data = wx.ColourData()
color_data.SetColour(self.value)
color_dialog = wx.ColourDialog(self.control, color_data)
result = color_dialog.ShowModal()
if result == wx.ID_CANCEL:
return
color = color_dialog.GetColourData().GetColour()
self.value = color
self.set_color()
def color_selected(self, event):
"""
Event for when color is selected
"""
color = event.GetColour()
try:
self.value = self.factory.from_wx_color(color)
except ValueError:
pass
return
def string_value(self, color):
""" Returns the text representation of a specified color value.
"""
color_name = w3c_color_database.FindName(color)
if color_name != '':
return color_name
return self.factory.str_color(color)
#------------------------------------------------------------------------------
# 'ReadonlyColorEditor' class:
#------------------------------------------------------------------------------
class ReadonlyColorEditor(BaseReadonlyEditor):
""" Read-only style of color editor, which displays a read-only text field
whose background color is the color value.
"""
#--------------------------------------------------------------------------
# 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.control = wx.TextCtrl(parent, style=wx.TE_READONLY)
#--------------------------------------------------------------------------
# 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.
"""
#super(ReadonlyColorEditor, self).update_editor()
self.control.SetValue(self.string_value(self.value))
set_color(self)
#--------------------------------------------------------------------------
# Returns the text representation of a specified color value:
#--------------------------------------------------------------------------
def string_value(self, color):
""" Returns the text representation of a specified color value.
"""
color_name = w3c_color_database.FindName(color)
if color_name != '':
return color_name
return self.factory.str_color(color)
#------------------------------------------------------------------------------
# 'ReadonlyColorEditor' class:
#------------------------------------------------------------------------------
class TextColorEditor(BaseTextEditor):
""" Text style of color editor, which displays a text field
whose background color is the color 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.
"""
self.control.SetValue(self.string_value(self.value))
set_color(self)
def update_object(self, event):
""" Handles the user changing the contents of the edit control.
"""
if not isinstance(event, wx._core.CommandEvent):
return
try:
self.value = w3c_color_database.Find(self.control.GetValue())
set_color(self)
except TraitError:
pass
#--------------------------------------------------------------------------
# Returns the text representation of a specified color value:
#--------------------------------------------------------------------------
def string_value(self, color):
""" Returns the text representation of a specified color value.
"""
color_name = w3c_color_database.FindName(color)
if color_name != '':
return color_name
return self.factory.str_color(color)
#------------------------------------------------------------------------------
# Sets the color of the specified editor's color control:
#------------------------------------------------------------------------------
def set_color(editor):
""" Sets the color of the specified color control.
"""
color = editor.factory.to_wx_color(editor)
editor.control.SetBackgroundColour(color)
# Define the SimpleEditor, CustomEditor, etc. classes which are used by the
# editor factory for the color editor.
SimpleEditor = SimpleColorEditor
CustomEditor = CustomColorEditor
TextEditor = TextColorEditor
ReadonlyEditor = ReadonlyColorEditor
|
