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
|
# (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 a text editor which displays a text field and maintains a history
of previously entered values.
"""
from traits.api import Any, observe
from pyface.timer.api import do_later
from .editor import Editor
from .history_control import HistoryControl
# -------------------------------------------------------------------------
# '_HistoryEditor' class:
# -------------------------------------------------------------------------
class _HistoryEditor(Editor):
"""Simple style text editor, which displays a text field and maintains a
history of previously entered values, the maximum number of which is
specified by the 'entries' trait of the HistoryEditor factory.
"""
# -------------------------------------------------------------------------
# Trait definitions:
# -------------------------------------------------------------------------
#: The history control:
history = Any()
def init(self, parent):
"""Finishes initializing the editor by creating the underlying toolkit
widget.
"""
self.history = history = HistoryControl(
value=self.value,
entries=self.factory.entries,
auto_set=self.factory.auto_set,
)
self.control = history.create_control(parent)
self.set_tooltip()
def dispose(self):
"""Disposes of the contents of an editor."""
self.history.dispose()
self.history = None
super().dispose()
@observe("history:value")
def _value_changed(self, event):
"""Handles the history object's 'value' trait being changed."""
if not self._dont_update:
history = self.history
try:
self._dont_update = True
self.value = history.value
history.error = False
except:
history.error = True
do_later(self.trait_set, _dont_update=False)
def update_editor(self):
"""Updates the editor when the object trait changes externally to the
editor.
"""
if not self._dont_update:
self._dont_update = True
self.history.value = self.value
self.history.error = False
self._dont_update = False
def error(self, excp):
"""Handles an error that occurs while setting the object's trait value."""
pass
# -- UI preference save/restore interface ---------------------------------
def restore_prefs(self, prefs):
"""Restores any saved user preference information associated with the
editor.
"""
self.history.history = prefs.get("history", [])[: self.factory.entries]
def save_prefs(self):
"""Returns any user preference information associated with the editor."""
# If the view closed successfully, try to update the history with the
# current value:
if self.ui.result:
self._dont_update = True
self.history.set_value(self.value)
self._dont_update = False
return {"history": self.history.history[:]}
|
