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
|
# (C) Copyright 2004-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in 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!
""" Defines the abstract ViewElement class that all trait view template items
(i.e., View, Group, Item, Include) derive from.
"""
import re
from traits.api import AbstractViewElement, Bool, HasPrivateTraits, Instance
from .ui_traits import (
AnObject,
DockStyle,
EditorStyle,
ExportType,
HelpId,
Image,
)
label_pat = re.compile(r"^(.*)\[(.*)\](.*)$", re.MULTILINE | re.DOTALL)
label_pat2 = re.compile(r"^(.*){(.*)}(.*)$", re.MULTILINE | re.DOTALL)
# -------------------------------------------------------------------------
# 'ViewElement' class (abstract):
# -------------------------------------------------------------------------
class ViewElement(HasPrivateTraits):
"""An element of a view."""
def replace_include(self, view_elements):
"""Searches the current object's **content** attribute for objects that
have an **id** attribute, and replaces each one with an Include object
with the same **id** value, and puts the replaced object into the
specified ViewElements object.
Parameters
----------
view_elements : ViewElements object
Object containing Group, Item, and Include objects
"""
pass # Normally overridden in a subclass
def is_includable(self):
"""Returns whether the object is replacable by an Include object."""
return False # Normally overridden in a subclass
class DefaultViewElement(ViewElement):
"""A view element that can be used as a default value for traits whose
value is a view element.
"""
# -------------------------------------------------------------------------
# Trait definitions:
# -------------------------------------------------------------------------
#: The default context object to edit:
object = AnObject
#: The default editor style to use:
style = EditorStyle
#: The default dock style to use:
dock = DockStyle
#: The default notebook tab image to use:
image = Image
#: The category of elements dragged out of the view:
export = ExportType
#: Should labels be added to items in a group?
show_labels = Bool(True)
# -------------------------------------------------------------------------
# Trait definitions:
# -------------------------------------------------------------------------
# The container trait used by ViewSubElements:
Container = Instance(ViewElement, factory=DefaultViewElement)
# -------------------------------------------------------------------------
# 'ViewSubElement' class (abstract):
# -------------------------------------------------------------------------
class ViewSubElement(ViewElement):
"""Abstract class representing elements that can be contained in a view."""
# -------------------------------------------------------------------------
# Trait definitions:
# -------------------------------------------------------------------------
#: The object this ViewSubElement is contained in; must be a ViewElement.
container = Container
#: External help context identifier:
help_id = HelpId
def _split(self, name, value, char, finder, assign, result):
"""Splits a string at a specified character."""
col = finder(value, char)
if col < 0:
return value
items = (value[:col].strip(), value[col + 1 :].strip())
if items[assign] != "":
setattr(self, name, items[assign])
return items[result]
def _option(self, string, option, name, value):
"""Sets a object trait if a specified option string is found."""
col = string.find(option)
if col >= 0:
string = string[:col] + string[col + len(option) :]
setattr(self, name, value)
return string
def _parse_style(self, value):
"""Parses any of the one-character forms of the **style** trait."""
value = self._option(value, "$", "style", "simple")
value = self._option(value, "@", "style", "custom")
value = self._option(value, "*", "style", "text")
value = self._option(value, "~", "style", "readonly")
value = self._split("style", value, ";", str.rfind, 1, 0)
return value
def _parse_label(self, value):
"""Parses a '[label]' value from the string definition."""
match = label_pat.match(value)
if match is not None:
self._parsed_label()
else:
match = label_pat2.match(value)
empty = False
if match is not None:
self.label = match.group(2).strip()
empty = self.label == ""
value = match.group(1) + match.group(3)
return (value, empty)
def _parsed_label(self):
"""Handles a label being found in the string definition."""
pass
def _repr_value(self, value, prefix="", suffix="", ignore=""):
"""Returns a "pretty print" version of a specified Item trait value."""
if value == ignore:
return ""
return "%s%s%s" % (prefix, value, suffix)
def _repr_options(self, *names):
"""Returns a 'pretty print' version of a list of traits."""
result = []
for name in names:
value = getattr(self, name)
if value != self.trait(name).default_value_for(self, name):
result.append((name, repr(value)))
if len(result) > 0:
n = max([len(name) for name, value in result])
return ",\n".join(
["%s = %s" % (name.ljust(n), value) for name, value in result]
)
return None
def _indent(self, string, indent=" "):
"""Indents each line in a specified string by 4 spaces."""
return "\n".join([indent + s for s in string.split("\n")])
# Register ViewElement as implementing AbstractViewElement
# TODO: eventually have ViewElement inherit directly
AbstractViewElement.register(ViewElement)
|
