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
|
# (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 pyface.qt import QtGui, is_qt4, is_qt5
from .editor import Editor
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.
"""
# -------------------------------------------------------------------------
# 'Editor' interface:
# -------------------------------------------------------------------------
def init(self, parent):
"""Finishes initializing the editor by creating the underlying toolkit
widget.
"""
self.control = control = QtGui.QComboBox()
control.setEditable(True)
control.setInsertPolicy(QtGui.QComboBox.InsertPolicy.InsertAtTop)
if self.factory.entries > 0:
control.model().rowsInserted.connect(self._truncate)
if self.factory.auto_set:
control.editTextChanged.connect(self.update_object)
else:
if is_qt4 or is_qt5:
control.activated[str].connect(self.update_object)
else:
control.textActivated.connect(self.update_object)
self.set_tooltip()
def update_object(self, text):
"""Handles the user entering input data in the edit control."""
if not self._no_update:
self.value = str(text)
def update_editor(self):
"""Updates the editor when the object trait changes externally to the
editor.
"""
self._no_update = True
self.control.setEditText(self.str_value)
self._no_update = False
# -- UI preference save/restore interface ---------------------------------
def restore_prefs(self, prefs):
"""Restores any saved user preference information associated with the
editor.
"""
history = prefs.get("history")
if history:
self._no_update = True
self.control.addItems(history[: self.factory.entries])
# Adding items sets the edit text, so we reset it afterwards:
self.control.setEditText(self.str_value)
self._no_update = False
def save_prefs(self):
"""Returns any user preference information associated with the editor."""
history = [
str(self.control.itemText(index))
for index in range(self.control.count())
]
# If the view closed successfully, update the history with the current
# editor value, as long it is different from the current object value:
if self.ui.result:
current = str(self.control.currentText())
if current != self.str_value:
history.insert(0, current)
return {"history": history}
# -------------------------------------------------------------------------
# '_HistoryEditor' private interface:
# -------------------------------------------------------------------------
def _truncate(self, parent, start, end):
"""Handle items being added to the combo box. If there are too many,
remove items at the end.
"""
diff = self.control.count() - self.factory.entries
if diff > 0:
for i in range(diff):
self.control.removeItem(self.factory.entries)
|
