| Type: | typingInput |
| Uses (at least one of): |
TranslatorModule >
SettingsModule > |
| Requires (at least one of): |
GuiModule >
InputTypingLogicModule > |
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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 | #! /usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright 2011, Cas Widdershoven
# Copyright 2011-2013, Marten de Vries
# Copyright 2008-2011, Milan Boers
#
# This file is part of OpenTeacher.
#
# OpenTeacher 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 3 of the License, or
# (at your option) any later version.
#
# OpenTeacher 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 OpenTeacher. If not, see <http://www.gnu.org/licenses/>.
import datetime
import weakref
import difflib
def installQtClasses():
global InputTypingWidget
class InputTypingWidget(QtWidgets.QWidget):
def __init__(self, createController, getFadeTime, letterChosen, *args, **kwargs):
super().__init__(*args, **kwargs)
self._controller = createController()
self._getFadeTime = getFadeTime
self._buildUi()
self._connectToEvents(letterChosen)
def _connectToEvents(self, letterChosen):
#bind to controller events
self._controller.clearInput.handle(self.inputLineEdit.clear)
self._controller.enableInput.handle(lambda: self.inputLineEdit.setEnabled(True))
self._controller.disableInput.handle(lambda: self.inputLineEdit.setEnabled(False))
self._controller.focusInput.handle(self._onFocusInput)
self._controller.showCorrection.handle(self._showCorrection)
self._controller.hideCorrection.handle(self._hideCorrection)
self._controller.enableCheck.handle(lambda: self.checkButton.setEnabled(True))
self._controller.disableCheck.handle(lambda: self.checkButton.setEnabled(False))
self._controller.enableSkip.handle(lambda: self.skipButton.setEnabled(True))
self._controller.disableSkip.handle(lambda: self.skipButton.setEnabled(False))
self._controller.enableCorrectAnyway.handle(lambda: self.correctButton.setEnabled(True))
self._controller.disableCorrectAnyway.handle(lambda: self.correctButton.setEnabled(False))
#make sure user actions are sent to the controller
checkAnswer = lambda: self._controller.checkTriggered(self._userAnswer)
self.checkButton.clicked.connect(checkAnswer)
self.inputLineEdit.returnPressed.connect(checkAnswer)
self.correctButton.clicked.connect(self._controller.correctAnywayTriggered)
self.skipButton.clicked.connect(self._controller.skipTriggered)
self.inputLineEdit.textEdited.connect(self._controller.userIsTyping)
#make character input work
letterChosen.handle(self.addLetter)
def _buildUi(self):
self.correctLabel = QtWidgets.QLabel(self)
self.inputLineEdit = QtWidgets.QLineEdit(self)
self.inputLineEdit.textEdited.connect(self._textEdited)
self.skipButton = QtWidgets.QPushButton(self)
self.checkButton = QtWidgets.QPushButton(self)
self.checkButton.setShortcut(QtCore.Qt.Key_Return)
self.correctButton = QtWidgets.QPushButton(self)
mainLayout = QtWidgets.QGridLayout()
mainLayout.addWidget(self.correctLabel, 0, 0, 1, 3)
mainLayout.addWidget(self.inputLineEdit, 1, 0, 1, 2)
mainLayout.addWidget(self.checkButton, 1, 2)
mainLayout.addWidget(self.correctButton, 2, 1)
mainLayout.addWidget(self.skipButton, 2, 2)
self.setLayout(mainLayout)
def _onFocusInput(self):
def doWork():
if self.inputLineEdit.isVisible():
self.inputLineEdit.setFocus()
#next event loop iteration, since isVisible() might not be
#updated.
QtCore.QTimer.singleShot(0, doWork)
def _showCorrection(self, correction):
self._startFading()
self._showDiff(correction)
def _startFading(self):
self._timeLine = QtCore.QTimeLine(self._getFadeTime(), self)
self._timeLine.setFrameRange(0, 255) #256 color steps
self._timeLine.frameChanged.connect(self._fade)
self._timeLine.finished.connect(self._controller.correctionShowingDone)
self._timeLine.start()
def _showDiff(self, correction):
#show diff
diff = self._buildDiff(correction, self._userAnswer)
if diff:
text = _("Correct answer: <b>{answers}</b> [{diff}]").format(answers=correction, diff=diff)
else:
text = _("Correct answer: <b>{answers}</b>").format(answers=correction)
self.correctLabel.setText(text)
@property
def _userAnswer(self):
return self.inputLineEdit.text()
def _hideCorrection(self):
self._timeLine.stop()
self.inputLineEdit.setStyleSheet("")
self.correctLabel.clear()
def retranslate(self):
self.checkButton.setText(_("Check!"))
self.correctButton.setText(_("Correct anyway"))
self.skipButton.setText(_("Skip"))
def addLetter(self, letter):
# Only the currently visible edit
if self.inputLineEdit.isVisible():
self.inputLineEdit.insert(letter)
self.inputLineEdit.setFocus()
def _textEdited(self, text):
try:
self._end
except AttributeError:
self._end = datetime.datetime.now()
else:
if not text.strip():
del self._end
def updateLessonType(self, lessonType):
self._controller.lessonType = lessonType
def _buildDiff(self, answers, givenAnswer):
#Check if the input looks like the answer or the second answer.
try:
similar = difflib.get_close_matches(givenAnswer, [answers])[0]
except IndexError:
#It doesn't, set similar to None
similar = None
#If they look like each other.
if similar:
#Show the differences graphical
output = ""
for item in difflib.ndiff(givenAnswer, similar):
if item.startswith('+ '):
output += '<span style="color: #1da90b;"><u>%s</u></span>' % item[2:]
elif item.startswith('- '):
output += '<span style="color: #da0f0f;"><s>%s</s></span>' % item[2:]
else:
output += item[2:]
return output
def _fade(self, step):
stylesheet = "QLineEdit {color: rgb(%s, %s, %s, %s)}" % (255, 00, 00, 255-step)
self.inputLineEdit.setStyleSheet(stylesheet)
class InputTypingModule:
_createController = property(lambda self: self._modules.default("active", type="inputTypingLogic").createController)
def __init__(self, moduleManager, *args, **kwargs):
super().__init__(*args, **kwargs)
self._mm = moduleManager
self.type = "typingInput"
self.uses = (
self._mm.mods(type="translator"),
self._mm.mods(type="settings"),
)
self.requires = (
self._mm.mods(type="ui"),
self._mm.mods(type="inputTypingLogic"),
)
self.filesWithTranslations = ("inputTyping.py",)
def enable(self):
global QtCore, QtWidgets
try:
from PyQt5 import QtCore, QtWidgets
except ImportError:
return
installQtClasses()
self._modules = set(self._mm.mods(type="modules")).pop()
self._activeWidgets = set()
#Register the fade duration setting
DEFAULT_VALUE = 4000
try:
self._fadeDurationSetting = self._modules.default(type="settings").registerSetting(**{
"internal_name": "org.openteacher.inputTyping.fadeDuration",
"type": "number",
"defaultValue": DEFAULT_VALUE,
})
except IndexError:
self._fadeDurationSetting = {
"value": DEFAULT_VALUE,
}
#Translations
try:
translator = self._modules.default("active", type="translator")
except IndexError:
pass
else:
translator.languageChanged.handle(self._retranslate)
self._retranslate()
self.active = True
def _retranslate(self):
#Install translator inside the whole of these file
global _
global ngettext
try:
translator = self._modules.default("active", type="translator")
except IndexError:
_, ngettext = str, lambda a, b, n: a if n == 1 else b
else:
_, ngettext = translator.gettextFunctions(
self._mm.resourcePath("translations")
)
#update all active widgets
for ref in self._activeWidgets:
wid = ref()
if wid is not None:
wid.retranslate()
#update the setting
self._fadeDurationSetting.update({
"name": _("Fade duration when wrong (milliseconds)"),
"category": _("Lesson"),
"subcategory": _("Words lesson"),
})
def disable(self):
self.active = False
del self._modules
del self._activeWidgets
del self._fadeDurationSetting
def createWidget(self, letterChosen):
getFadeDuration = lambda: self._fadeDurationSetting["value"]
it = InputTypingWidget(self._createController, getFadeDuration, letterChosen)
self._activeWidgets.add(weakref.ref(it))
it.retranslate()
return it
def init(moduleManager):
return InputTypingModule(moduleManager)
|