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
|
#------------------------------------------------------------------------------
#
# 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
# Date: 10/07/2004
#
#------------------------------------------------------------------------------
""" Defines the text editor factory for all traits toolkit backends.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
from __future__ import absolute_import
from traits.api import Dict, Str, Any, Bool
# 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 ..ui_traits import AView
from ..editor_factory import EditorFactory
#-------------------------------------------------------------------------------
# Define a simple identity mapping:
#-------------------------------------------------------------------------------
class _Identity ( object ):
""" A simple identity mapping.
"""
def __call__ ( self, value ):
return value
#-------------------------------------------------------------------------------
# Trait definitions:
#-------------------------------------------------------------------------------
# Mapping from user input text to other value
mapping_trait = Dict( Str, Any )
# Function used to evaluate textual user input
evaluate_trait = Any( _Identity() )
#-------------------------------------------------------------------------------
# 'ToolkitEditorFactory' class:
#-------------------------------------------------------------------------------
class ToolkitEditorFactory ( EditorFactory ):
""" Editor factory for text editors.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Dictionary that maps user input to other values
mapping = mapping_trait
# Is user input set on every keystroke?
auto_set = Bool( True )
# Is user input set when the Enter key is pressed?
enter_set = Bool( False )
# Is multi-line text allowed?
multi_line = Bool( True )
# Is editor readonly (will use custom / default editor appearance with readonly flag set to true)
# in contrasrt with readonly style for item when completely another edito is used
read_only = Bool( False )
# Is user input unreadable? (e.g., for a password)
password = Bool( False )
# Function to evaluate textual user input
evaluate = evaluate_trait
# The object trait containing the function used to evaluate user input
evaluate_name = Str
# The optional view to display when a read-only text editor is clicked:
view = AView
# In a read-only text editor, allow selection and copying of the text.
readonly_allow_selection = Bool(False)
#---------------------------------------------------------------------------
# Traits view definition:
#---------------------------------------------------------------------------
traits_view = View( [ 'auto_set{Set value when text is typed}',
'enter_set{Set value when enter is pressed}',
'multi_line{Allow multiple lines of text}',
'<extras>',
'|options:[Options]>' ] )
extras = Group( 'password{Is this a password field?}' )
# Define the TextEditor class.
TextEditor = ToolkitEditorFactory
### EOF #######################################################################
|
