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
|
#------------------------------------------------------------------------------
#
# 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: 03/03/2006
#
#------------------------------------------------------------------------------
""" Defines the BasicUIEditor class, which allows creating editors that define
their function by creating an embedded Traits UI.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from __future__ import absolute_import
from traits.api import Instance
from .ui import UI
from .editor import Editor
#-------------------------------------------------------------------------------
# 'UIEditor' base class:
#-------------------------------------------------------------------------------
class UIEditor ( Editor ):
""" An editor that creates an embedded Traits UI.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# The Traits UI created by the editor
editor_ui = Instance( UI )
#---------------------------------------------------------------------------
# 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.editor_ui = self.init_ui( parent ).set( parent = self.ui )
self.control = self.editor_ui.control
#---------------------------------------------------------------------------
# Creates the traits UI for the editor (can be overridden by a subclass):
#---------------------------------------------------------------------------
def init_ui ( self, parent ):
""" Creates the traits UI for the editor.
"""
return self.value.edit_traits( view = self.trait_view(),
context = { 'object': self.value,
'editor': self },
parent = parent )
#---------------------------------------------------------------------------
# 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.
"""
# Do nothing, since the embedded traits UI should handle the updates
# itself, without our meddling:
pass
#---------------------------------------------------------------------------
# Disposes of the contents of an editor:
#---------------------------------------------------------------------------
def dispose ( self ):
""" Disposes of the contents of an editor.
"""
# Make sure the embedded traits UI is disposed of properly:
if self.editor_ui is not None:
self.editor_ui.dispose()
super( UIEditor, self ).dispose()
#---------------------------------------------------------------------------
# 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.editor_ui.get_error_controls()
#-- UI preference save/restore interface ---------------------------------------
#---------------------------------------------------------------------------
# Restores any saved user preference information associated with the
# editor:
#---------------------------------------------------------------------------
def restore_prefs ( self, prefs ):
""" Restores any saved user preference information associated with the
editor.
"""
self.editor_ui.set_prefs( prefs )
#---------------------------------------------------------------------------
# Returns any user preference information associated with the editor:
#---------------------------------------------------------------------------
def save_prefs ( self ):
""" Returns any user preference information associated with the editor.
"""
return self.editor_ui.get_prefs()
#-- EOF ----------------------------------------------------------------------
|
