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
|
# This file is part of the Frescobaldi project, http://www.frescobaldi.org/
#
# Copyright (c) 2011 - 2014 by Wilbert Berendsen
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# See http://www.gnu.org/licenses/ for more information.
"""
Completer providing completions in a Q(Plain)TextEdit.
"""
from PyQt5.QtCore import QEvent, QModelIndex, Qt
from PyQt5.QtGui import QKeySequence, QTextCursor
from PyQt5.QtWidgets import QCompleter
class Completer(QCompleter):
"""A QCompleter providing completions in a Q(Plain)TextEdit.
Use setWidget() to assign the completer to a text edit.
You can reimplement completionCursor() to make your own, other than simple
string-based completions.
Call showCompletionPopup() to force the popup to show.
"""
autoComplete = True
autoCompleteLength = 2
def __init__(self, *args, **kwargs):
super(Completer, self).__init__(*args, **kwargs)
self.activated[QModelIndex].connect(self.insertCompletion)
def eventFilter(self, obj, ev):
if ev.type() != QEvent.KeyPress:
return super(Completer, self).eventFilter(obj, ev)
# we can't test for self.popup() as that will recursively call
# eventFilter during instantiation.
popupVisible = obj != self.widget()
if popupVisible:
# a key was pressed while the popup is visible
if ev.key() in (Qt.Key_Return, Qt.Key_Enter):
# insert the highlighted completion
self.setCurrentRow(self.popup().currentIndex().row())
self.insertCompletion(self.currentIndex())
self.popup().hide()
return True
elif ev.key() == Qt.Key_Backspace:
# deliver event, hide popup if completionPrefix already none
self.widget().event(ev)
if self.completionPrefix():
self.showCompletionPopup()
else:
self.popup().hide()
return True
elif self.isTextEvent(ev, True):
# deliver event and keep showing popup if necessary
self.widget().event(ev)
self.showCompletionPopup()
return True
elif ev.key() not in (
Qt.Key_Up, Qt.Key_Down, Qt.Key_PageUp, Qt.Key_PageDown,
Qt.Key_Shift, Qt.Key_Control, Qt.Key_Alt, Qt.Key_Meta):
# hide on anything except navigation keys
self.popup().hide()
return super(Completer, self).eventFilter(obj, ev)
# a key was pressed while the popup is not visible
if self.autoComplete and self.isTextEvent(ev, False):
self.widget().event(ev)
self.showCompletionPopup(False)
return True
return False
def isTextEvent(self, ev, visible):
"""Called when a key is pressed.
Should return True if the given KeyPress event 'ev' represents text that
makes sense for showing the completions popup.
The 'visible' argument is True when the popup is currently visible.
"""
return ev.text()[-1:] > " " and ev.key() != Qt.Key_Delete
def textCursor(self):
"""Returns the current text cursor of the TextEdit."""
return self.widget().textCursor()
def completionCursor(self):
"""Should return a QTextCursor or None.
If a QTextCursor is returned, its selection is used as the completion
prefix and its selectionStart() as the place to popup the popup.
This method may also alter the completion model.
"""
cursor = self.textCursor()
cursor.movePosition(QTextCursor.StartOfWord, QTextCursor.KeepAnchor)
return cursor
def showCompletionPopup(self, forced=True):
"""Shows the completion popup.
Calls completionCursor() to get the place where to popup, and that
method may also alter the completion model.
If forced is True (the default) the popup is always shown (if it
contains any entries). Otherwise it is only shown self.autoComplete is
True and the cursor returned by completionCursor() has at least
self.autoCompleteLength characters selected.
"""
cursor = self.completionCursor()
if not cursor:
self.popup().hide()
return
text = cursor.selectedText()
if forced or (self.autoComplete and len(text) >= self.autoCompleteLength):
self.setCompletionPrefix(text)
# hide if there is only one completion left
if (not self.setCurrentRow(1) and self.setCurrentRow(0)
and self.currentCompletion() == text):
self.popup().hide()
return
self.setCurrentRow(0)
rect = self.widget().cursorRect(cursor)
rect.setWidth(self.popup().sizeHintForColumn(0)
+ self.popup().verticalScrollBar().sizeHint().width())
rect.translate(self.widget().viewport().pos())
frameWidth = self.popup().frameWidth()
rect.translate(-frameWidth, frameWidth + 2)
rect.translate(-self.popup().viewport().pos())
self.complete(rect)
def insertCompletion(self, index):
"""Inserts the completion at the given index.
The default implementation reads the model data under the Qt.EditRole,
and inserts that with the (already entered) completionPrefix removed.
"""
text = self.completionModel().data(index, Qt.EditRole)
text = text[len(self.completionPrefix()):]
self.textCursor().insertText(text)
|
