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
|
#------------------------------------------------------------------------------
#
# Copyright (c) 2008, 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
#
#------------------------------------------------------------------------------
""" Defines the tuple editor factory for all traits user interface toolkits.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from __future__ import absolute_import
from traits.trait_base import SequenceTypes, enumerate
from traits.api import Bool, HasTraits, List, Tuple, Unicode, Int, Any, TraitType
# CIRCULAR IMPORT FIXME: Importing from the source rather than traits.ui.api
# to avoid circular imports, as this EditorFactory will be part of
# traits.ui.api as well.
from ..view import View
from ..group import Group
from ..item import Item
from ..editor_factory import EditorFactory
from ..editor import Editor
#-------------------------------------------------------------------------------
# 'ToolkitEditorFactory' class:
#-------------------------------------------------------------------------------
class ToolkitEditorFactory ( EditorFactory ):
""" Editor factory for tuple editors.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Trait definitions for each tuple field
types = Any
# Labels for each of the tuple fields
labels = List( Unicode )
# Editors for each of the tuple fields:
editors = List( EditorFactory )
# Number of tuple fields or rows
cols = Int( 1 )
# Is user input set on every keystroke? This is applied to every field
# of the tuple, provided the field does not already have an 'auto_set'
# metadata or an editor defined.
auto_set = Bool( True )
# Is user input set when the Enter key is pressed? This is applied to
# every field of the tuple, provided the field does not already have an
# 'enter_set' metadata or an editor defined.
enter_set = Bool( False )
#-------------------------------------------------------------------------------
# 'SimpleEditor' class:
#-------------------------------------------------------------------------------
class SimpleEditor ( Editor ):
""" Simple style of editor for tuples.
The editor displays an editor for each of the fields in the tuple, based on
the type of each 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.
"""
self._ts = ts = TupleStructure( self )
self._ui = ui = ts.view.ui( ts, parent, kind = 'subpanel' ).set(
parent = self.ui )
self.control = ui.control
self.set_tooltip()
#---------------------------------------------------------------------------
# Updates the editor when the object trait changes external to the editor:
#---------------------------------------------------------------------------
def update_editor ( self ):
""" Updates the editor when the object trait changes external to the
editor.
"""
ts = self._ts
for i, value in enumerate( self.value ):
setattr( ts, 'f%d' % i, value )
#---------------------------------------------------------------------------
# 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._ui.get_error_controls()
#-------------------------------------------------------------------------------
# 'TupleStructure' class:
#-------------------------------------------------------------------------------
class TupleStructure ( HasTraits ):
""" Creates a view containing items for each field in a tuple.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Editor this structure is linked to
editor = Any
# The constructed View for the tuple
view = Any
# Number of tuple fields
fields = Int
#---------------------------------------------------------------------------
# Initializes the object:
#---------------------------------------------------------------------------
def __init__ ( self, editor ):
""" Initializes the object.
"""
factory = editor.factory
types = factory.types
labels = factory.labels
editors = factory.editors
cols = factory.cols
# Save the reference to the editor:
self.editor = editor
# Get the tuple we are mirroring:
object = editor.value
# For each tuple field, add a trait with the appropriate trait
# definition and default value:
content = []
self.fields = len( object )
len_labels = len( labels )
len_editors = len( editors )
if types is None:
type = editor.value_trait.handler
if isinstance( type, Tuple ):
types = type.types
if not isinstance( types, SequenceTypes ):
types = [ types ]
len_types = len( types )
if len_types == 0:
types = [ Any ]
len_types = 1
for i, value in enumerate( object ):
type = types[ i % len_types ]
auto_set = enter_set = None
if isinstance(type, TraitType):
auto_set = type.auto_set
enter_set = type.enter_set
if auto_set is None:
auto_set = editor.factory.auto_set
if enter_set is None:
enter_set = editor.factory.enter_set
label = ''
if i < len_labels:
label = labels[i]
field_editor = None
if i < len_editors:
field_editor = editors[i]
name = 'f%d' % i
self.add_trait( name, type( value, event = 'field',
auto_set = auto_set,
enter_set = enter_set ) )
item = Item( name = name, label = label, editor = field_editor )
if cols <= 1:
content.append( item )
else:
if (i % cols) == 0:
group = Group( orientation = 'horizontal' )
content.append( group )
group.content.append( item )
self.view = View( Group( show_labels = (len_labels != 0), *content ) )
#---------------------------------------------------------------------------
# Updates the underlying tuple when any field changes value:
#---------------------------------------------------------------------------
def _field_changed ( self ):
""" Updates the underlying tuple when any field changes value.
"""
self.editor.value = tuple( [ getattr( self, 'f%d' % i )
for i in range( self.fields ) ] )
# Define the TupleEditor class.
TupleEditor = ToolkitEditorFactory
### EOF #######################################################################
|
