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
|
#------------------------------------------------------------------------------
#
# 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 base wxPython EditorFactory class and classes the various
styles of editors used in a Traits-based user interface.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
import warnings
import wx
from traits.api \
import TraitError, Any, Bool, Event, Str
from traitsui.editor_factory \
import EditorFactory as BaseEditorFactory
from editor \
import Editor
from constants \
import WindowColor
#-------------------------------------------------------------------------------
# 'EditorFactory' class
# Deprecated alias for traitsui.editor_factory.EditorFactory
#-------------------------------------------------------------------------------
class EditorFactory(BaseEditorFactory):
""" Deprecated alias for traitsui.editor_factory.EditorFactory.
"""
def __init__(self, *args, **kwds):
super(EditorFactory, self).__init__(*args, **kwds)
warnings.warn("DEPRECATED: Use traitsui.editor_factory."
".EditorFactory instead.", DeprecationWarning)
#-------------------------------------------------------------------------------
# 'SimpleEditor' class:
#-------------------------------------------------------------------------------
class SimpleEditor ( Editor ):
""" Base class for simple style editors, which displays a text field
containing the text representation of the object trait value. Clicking
in the text field displays an editor-specific dialog box for changing
the value.
"""
# Has the left mouse button been pressed:
left_down = Bool( False )
#---------------------------------------------------------------------------
# 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 = self.create_control( parent )
wx.EVT_LEFT_DOWN( self.control, self._enable_popup_editor )
wx.EVT_LEFT_UP( self.control, self._show_popup_editor )
self.set_tooltip()
#---------------------------------------------------------------------------
# Creates the control to use for the simple editor:
#---------------------------------------------------------------------------
def create_control ( self, parent ):
""" Creates the control to use for the simple editor.
"""
return wx.TextCtrl( parent, -1, self.str_value, style = wx.TE_READONLY )
#---------------------------------------------------------------------------
# Invokes the pop-up editor for an object trait:
#
# (Normally overridden in a subclass)
#---------------------------------------------------------------------------
def popup_editor ( self, event ):
""" Invokes the pop-up editor for an object trait.
"""
pass
def _enable_popup_editor ( self, event ):
""" Mark the left mouse button as being pressed currently.
"""
self.left_down = True
def _show_popup_editor ( self, event ):
""" Display the popup editor if the left mouse button was pressed
previously.
"""
if self.left_down:
self.left_down = False
self.popup_editor( event )
#-------------------------------------------------------------------------------
# 'TextEditor' class:
#-------------------------------------------------------------------------------
class TextEditor ( Editor ):
""" Base class for text style editors, which displays an editable text
field, containing a text representation of the object trait 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, -1, self.str_value,
style = wx.TE_PROCESS_ENTER )
wx.EVT_KILL_FOCUS( self.control, self.update_object )
wx.EVT_TEXT_ENTER( parent, self.control.GetId(), self.update_object )
self.set_tooltip()
#---------------------------------------------------------------------------
# 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:
self.value = self.control.GetValue()
except TraitError, excp:
pass
#-------------------------------------------------------------------------------
# 'ReadonlyEditor' class:
#-------------------------------------------------------------------------------
class ReadonlyEditor ( Editor ):
""" Base class for read-only style editors, which displays a read-only text
field, containing a text representation of the object trait value.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# layout_style = 0 # Style for imbedding control in a sizer (override)
#---------------------------------------------------------------------------
# Finishes initializing the editor by creating the underlying toolkit
# widget:
#---------------------------------------------------------------------------
def init ( self, parent ):
""" Finishes initializing the editor by creating the underlying toolkit
widget.
"""
if (self.item.resizable is True) or (self.item.height != -1.0):
self.control = wx.TextCtrl( parent, -1, self.str_value,
style = wx.NO_BORDER | wx.TE_MULTILINE | wx.TE_READONLY )
self.control.SetBackgroundColour( WindowColor )
else:
self.control = wx.StaticText( parent, -1, self.str_value,
style = wx.ALIGN_LEFT )
self.layout_style = 0
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 externally to the
editor.
"""
new_value = self.str_value
if (self.item.resizable is True) or (self.item.height!= -1.0):
if self.control.GetValue() != new_value:
self.control.SetValue( new_value )
elif self.control.GetLabel() != new_value:
self.control.SetLabel( new_value )
|