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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
|
#------------------------------------------------------------------------------
# Copyright (c) 2007, Riverbank Computing Limited
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD license.
# However, when used with the GPL version of PyQt the additional terms described in the PyQt GPL exception also apply
#
# Author: Riverbank Computing Limited
#------------------------------------------------------------------------------
""" Defines the base class for PyQt editors.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from pyface.qt import QtGui
from traits.api \
import HasTraits, Instance, Str, Callable
from traitsui.api \
import Editor as UIEditor
from constants \
import OKColor, ErrorColor
#-------------------------------------------------------------------------------
# 'Editor' class:
#-------------------------------------------------------------------------------
class Editor ( UIEditor ):
""" Base class for PyQt editors for Traits-based UIs.
"""
def clear_layout(self):
""" Delete the contents of a control's layout.
"""
layout = self.control.layout()
while True:
itm = layout.takeAt(0)
if itm is None:
break
itm.widget().setParent(None)
#---------------------------------------------------------------------------
# Handles the 'control' trait being set:
#---------------------------------------------------------------------------
def _control_changed ( self, control ):
""" Handles the **control** trait being set.
"""
# FIXME: Check we actually make use of this.
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.text() != new_value:
self.control.setText( 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.
"""
# Make sure the control is a widget rather than a layout.
if isinstance(self.control, QtGui.QLayout):
control = self.control.parentWidget()
else:
control = self.control
QtGui.QMessageBox.information(control,
self.description + ' value error', str(excp))
#---------------------------------------------------------------------------
# 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.setToolTip( 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.
"""
if self.control is not None:
self._enabled_changed_helper(self.control, enabled)
def _enabled_changed_helper(self, control, enabled):
"""A helper that allows the control to be a layout and recursively
manages all its widgets.
"""
if isinstance(control, QtGui.QWidget):
control.setEnabled(enabled)
else:
for i in range(control.count()):
itm = control.itemAt(i)
self._enabled_changed_helper((itm.widget() or itm.layout()),
enabled)
#---------------------------------------------------------------------------
# Handles the 'visible' state of the editor being changed:
#---------------------------------------------------------------------------
def _visible_changed(self, visible):
"""Handles the **visible** state of the editor being changed.
"""
if self.label_control is not None:
self.label_control.setVisible(visible)
if self.control is None:
# We are being called after the editor has already gone away.
return
self._visible_changed_helper(self.control, visible)
page = self.control.parent()
if page is None or page.parent() is None or page.parent().parent() is None or page.layout().count() != 1:
return
# The TabWidget (representing the notebook) has a StackedWidget inside it,
# which then contains our parent.
# Even after the tab is removed, the parent-child relationship between
# our container widget (representing the page) and the enclosing TabWidget,
# so the following reference is still valid.
stack_widget = page.parent()
notebook = stack_widget.parent()
is_tabbed_group = notebook.property("traits_tabbed_group")
if notebook is None or not isinstance(notebook, QtGui.QTabWidget) or not is_tabbed_group:
return
if not visible:
# Store the page number and name on the parent
for i in range(0, notebook.count()):
if notebook.widget(i) == page:
self._tab_index = i
self._tab_text = notebook.tabText(i)
page.setVisible(False)
notebook.removeTab(i)
break
else:
# Check to see if our parent has previously-stored tab
# index and text attributes
if (getattr(self, "_tab_index", None) is not None and
getattr(self, "_tab_text", None) is not None):
page.setVisible(True)
notebook.insertTab(self._tab_index, page, self._tab_text)
return
def _visible_changed_helper(self, control, visible):
"""A helper that allows the control to be a layout and recursively
manages all its widgets.
"""
if isinstance(control, QtGui.QWidget):
control.setVisible(visible)
else:
for i in range(control.count()):
itm = control.itemAt(i)
self._visible_changed_helper((itm.widget() or itm.layout()),
visible)
#---------------------------------------------------------------------------
# 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()
if not isinstance( control, list ):
control = [ control ]
for item in control:
if item is None:
continue
pal = QtGui.QPalette(item.palette())
if state:
color = ErrorColor
if getattr( item, '_ok_color', None ) is None:
item._ok_color = QtGui.QColor(pal.color(QtGui.QPalette.Base))
else:
color = getattr( item, '_ok_color', OKColor )
pal.setColor(QtGui.QPalette.Base, color)
item.setPalette(pal)
#---------------------------------------------------------------------------
# Handles the editor's invalid state changing:
#---------------------------------------------------------------------------
def _invalid_changed ( self, state ):
""" Handles the editor's invalid state changing.
"""
self.set_error_state()
#---------------------------------------------------------------------------
# Handles the editor's context menu action
#---------------------------------------------------------------------------
def perform (self, action, action_event = None ):
""" Performs the action described by a specified Action object.
"""
self.ui.do_undoable( self._perform, action )
def _perform ( self, action ):
method_name = action.action
info = self._menu_context['info']
handler = self._menu_context['handler']
object = self._menu_context['object']
selection = self._menu_context['selection']
self._menu_context['action'] = action
if method_name.find( '.' ) >= 0:
if method_name.find( '(' ) < 0:
method_name += '()'
try:
eval( method_name, globals(), self._menu_context )
except:
from traitsui.api import raise_to_debug
raise_to_debug()
return
method = getattr( handler, method_name, None )
if method is not None:
method( info, selection )
return
if action.on_perform is not None:
action.on_perform(selection)
action.perform(selection)
def eval_when ( self, condition, object, trait ):
""" Evaluates a condition within a defined context, and sets a
specified object trait based on the result, which is assumed to be a
Boolean.
"""
if condition != '':
value = True
try:
if not eval( condition, globals(), self._menu_context ):
value = False
except:
from traitsui.api import raise_to_debug
raise_to_debug()
setattr( object, trait, value )
def add_to_menu ( self, menu_item ):
""" Adds a menu item to the menu bar being constructed.
"""
action = menu_item.item.action
self.eval_when( action.enabled_when, menu_item, 'enabled' )
self.eval_when( action.checked_when, menu_item, 'checked' )
def can_add_to_menu(self, action) :
""" Returns whether the action should be defined in the user interface.
"""
if action.defined_when != '':
try:
if not eval( action.defined_when, globals(), self._menu_context ):
return False
except:
from traitsui.api import raise_to_debug
raise_to_debug()
if action.visible_when != '':
try:
if not eval( action.visible_when, globals(), self._menu_context ):
return False
except:
from traitsui.api import raise_to_debug
raise_to_debug()
return True
def set_size_policy(self, direction, resizable, springy, stretch) :
policy = self.control.sizePolicy()
if direction == QtGui.QBoxLayout.LeftToRight:
policy.setHorizontalStretch(stretch)
if springy:
policy.setHorizontalPolicy(QtGui.QSizePolicy.Expanding)
if resizable :
policy.setVerticalPolicy(QtGui.QSizePolicy.Expanding)
else:
policy.setVerticalStretch(stretch)
if resizable :
policy.setHorizontalPolicy(QtGui.QSizePolicy.Expanding)
if springy :
policy.setVerticalPolicy(QtGui.QSizePolicy.Expanding)
self.control.setSizePolicy(policy)
#-------------------------------------------------------------------------------
# '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_object.on_trait_change( self._list_updated,
self.list_name+'_items', 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 )
self.list_object.on_trait_change( self._list_updated,
self.list_name+'_items', 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()
|
