| Type: | wordsEnterer |
| Uses (at least one of): |
TranslatorModule >
SpellCheckModule > CharsKeyboardModule > |
| Requires (at least one of): |
GuiModule >
JavascriptComposerModule > WordsStringComposerModule > WordsStringParserModule > JavascriptParserModule > |
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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 | #! /usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright 2011-2013, Marten de Vries
# Copyright 2011, Cas Widdershoven
# Copyright 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 contextlib
class EmptyLesson:
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.list = {}
def installQtClasses():
global SpellingHighlighter, WordsTableView, WordsTableModel, EnterWidget
class SpellingHighlighter(QtGui.QSyntaxHighlighter):
_format = QtGui.QTextCharFormat()
_format.setUnderlineColor(QtCore.Qt.red)
_format.setUnderlineStyle(QtGui.QTextCharFormat.SpellCheckUnderline)
def __init__(self, checkWord, splitWords, *args, **kwargs):
super().__init__(*args, **kwargs)
self._checkWord = checkWord
self._splitWords = splitWords
def highlightBlock(self, text):
if text.endswith(u"…"):
#might not be the best tokenization, but better than
#what enchant can do in this situation...
if u" " in text:
text = text.rsplit(u" ", 1)[0]
else:
text = u""
for word, pos in self._splitWords(text):
if not self._checkWord(word):
self.setFormat(pos, len(word), self._format)
class WordsTableItemDelegate(QtWidgets.QStyledItemDelegate):
"""A default delegate, with the difference that it installs an event
filter for some non-default keys. The equals key and return key
are, from the perspective of Qt, equal to the tab key. It
also allows callers to access the current editor via the
currentEditor property, and paints html when displaying.
Next to that, it offers spell checking. Set the
'checkQuestion' and 'checkAnswer' properties to a function
that checks one word before using this class because of that.
"""
def eventFilter(self, object, event):
if (event.type() == QtCore.QEvent.KeyPress and event.key() in (QtCore.Qt.Key_Equal, QtCore.Qt.Key_Return)):
event = QtGui.QKeyEvent(
event.type(),
QtCore.Qt.Key_Tab,
event.modifiers(),
event.text(),
event.isAutoRepeat(),
event.count()
)
return super().eventFilter(object, event)
def paint(self, painter, option, index):
self.initStyleOption(option, index)
#set up document with syntax highlighting
document = QtGui.QTextDocument()
check = lambda item: True
split = lambda words: []
with contextlib.suppress(AttributeError):
if index.column() == 0:
check = self.checkQuestion
split = self.splitQuestion
elif index.column() == 1:
check = self.checkAnswer
split = self.splitAnswer
SpellingHighlighter(check, split, document)
#get elided text
text = option.widget.fontMetrics().elidedText(option.text, option.textElideMode, option.rect.width() - document.documentMargin())
#set elided text
document.setHtml(text)
#calculate place to start rendering
yPos = option.rect.center().y() - option.widget.fontMetrics().height() / 2 - document.documentMargin()
startPoint = QtCore.QPoint(option.rect.x(), yPos)
#move to place to start rendering, render, and move back.
painter.translate(startPoint)
document.drawContents(painter)
painter.translate(-startPoint)
def createEditor(self, parent, option, index):
self.currentEditor = super().createEditor(
parent, option, index
)
return self.currentEditor
class WordsTableView(QtWidgets.QTableView):
def __init__(self, createChecker, *args, **kwargs):
super().__init__(*args, **kwargs)
self._createChecker = createChecker
self.setItemDelegate(WordsTableItemDelegate())
self.setAlternatingRowColors(True)
self.setSortingEnabled(True)
def _questionLanguageChanged(self):
try:
lang = self.model().lesson.list["questionLanguage"]
except KeyError:
pass
else:
checker = self._createChecker(lang)
self.itemDelegate().checkQuestion = checker.check
self.itemDelegate().splitQuestion = checker.split
self._wholeModelChanged()
def _answerLanguageChanged(self):
try:
lang = self.model().lesson.list["answerLanguage"]
except KeyError:
pass
else:
checker = self._createChecker(lang)
self.itemDelegate().checkAnswer = checker.check
self.itemDelegate().splitAnswer = checker.split
self._wholeModelChanged()
def _wholeModelChanged(self):
self.model().dataChanged.emit(
self.model().index(0, 0),
self.model().index(self.model().rowCount() -1, self.model().columnCount() -1)
)
def setModel(self, *args, **kwargs):
with contextlib.suppress(AttributeError):
#AttributeError: first time.
self.model().modelReset.disconnect(self._modelReset)
self.model().questionLanguageChanged.disconnect(self._questionLanguageChanged)
self.model().answerLanguageChanged.disconnect(self._answerLanguageChanged)
result = super().setModel(*args, **kwargs)
self.model().modelReset.connect(self._modelReset)
self.model().questionLanguageChanged.connect(self._questionLanguageChanged)
self.model().answerLanguageChanged.connect(self._answerLanguageChanged)
#setting the model is 'resetting' too.
self._modelReset()
return result
def _modelReset(self):
self._questionLanguageChanged()
self._answerLanguageChanged()
#If the model is empty, let the user start editing
#(model has always one starting row.)
if self.model().rowCount() == 1:
i = self.model().createIndex(0, 0)
self.setCurrentIndex(i)
self.edit(i)
def moveCursor(self, cursorAction, modifiers):
"""Reimplentation of moveCursor that makes sure that tab only
moves between the questions and answers column (so not the
comment column). This way, inserting words is way faster.
"""
if cursorAction not in (QtWidgets.QAbstractItemView.MoveNext, QtWidgets.QAbstractItemView.MovePrevious):
return super().moveCursor(cursorAction, modifiers)
if self.model().columnCount() == 0 or self.model().rowCount() == 0:
return QtCore.QModelIndex()
row = self.currentIndex().row()
column = self.currentIndex().column()
if cursorAction == QtWidgets.QAbstractItemView.MoveNext:
column += 1
if column > 1:
column = 0
row += 1
if row > self.model().rowCount() -1:
row = 0
elif cursorAction == QtWidgets.QAbstractItemView.MovePrevious:
column -= 1
if column < 0:
column = 1
row -= 1
if row < 0:
row = self.model().rowCount() -1
return self.model().index(row, column)
class WordsTableModel(QtCore.QAbstractTableModel):
questionLanguageChanged = QtCore.pyqtSignal()
answerLanguageChanged = QtCore.pyqtSignal()
QUESTIONS, ANSWERS, COMMENT, COMMENT_AFTER_ANSWERING = range(4)
def __init__(self, compose, parse, *args, **kwargs):
super().__init__(*args, **kwargs)
self.updateLesson(EmptyLesson())
self._compose = compose
self._parse = parse
self._headers = ["", "", "", ""]
def retranslate(self):
self._headers = [_("Questions"), _("Answers"), _("Comment"), _("Comment after answering")]
def updateLesson(self, lesson):
self.beginResetModel()
self.lesson = lesson
try:
self.indexes = list(range(len(self.lesson.list["items"])))
except KeyError:
self.indexes = []
self.endResetModel()
def sort(self, column, order):
items = self.lesson.list.get("items", [])
if column == self.QUESTIONS:
sortedItems = sorted(items, key=lambda word: word.get("questions", []))
elif column == self.ANSWERS:
sortedItems = sorted(items, key=lambda word: word.get("answers", []))
elif column == self.COMMENT:
sortedItems = sorted(items, key=lambda word: word.get("comment", u""))
elif column == self.COMMENT_AFTER_ANSWERING:
sortedItems = sorted(items, key=lambda word: word.get("commentAfterAnswering", u""))
if order == QtCore.Qt.DescendingOrder:
sortedItems.reverse()
self.layoutAboutToBeChanged.emit()
self.indexes = [self.lesson.list["items"].index(item) for item in sortedItems]
self.layoutChanged.emit()
def updateTitle(self, title):
self.lesson.list["title"] = title
self.lesson.changed = True
def updateQuestionLanguage(self, questionLanguage):
self.lesson.list["questionLanguage"] = questionLanguage
self.questionLanguageChanged.emit()
self.lesson.changed = True
def updateAnswerLanguage(self, answerLanguage):
self.lesson.list["answerLanguage"] = answerLanguage
self.answerLanguageChanged.emit()
self.lesson.changed = True
def headerData(self, section, orientation, role):
if role != QtCore.Qt.DisplayRole:
return
if orientation == QtCore.Qt.Horizontal:
return self._headers[section]
elif orientation == QtCore.Qt.Vertical:
return section +1
def rowCount(self, parent=None):
try:
return len(self.lesson.list["items"]) +1
except KeyError:
return 1
def columnCount(self, parent=None):
return 4
def data(self, index, role=QtCore.Qt.DisplayRole):
if not (index.isValid() and
role in (QtCore.Qt.DisplayRole, QtCore.Qt.EditRole)):
return
try:
listIndex = self.indexes[index.row()]
except IndexError:
return u"" #last (empty) row
else:
word = self.lesson.list["items"][listIndex]
if index.column() == self.QUESTIONS:
return self._compose(word.get("questions", []))
elif index.column() == self.ANSWERS:
return self._compose(word.get("answers", []))
elif index.column() == self.COMMENT:
return word.get("comment", u"")
elif index.column() == self.COMMENT_AFTER_ANSWERING:
return word.get("commentAfterAnswering", u"")
def flags(self, index):
return (
QtCore.Qt.ItemIsEnabled |
QtCore.Qt.ItemIsSelectable |
QtCore.Qt.ItemIsEditable
)
def setData(self, index, value, role=QtCore.Qt.EditRole):
if not (index.isValid() and role == QtCore.Qt.EditRole):
return False
#add 'items' key to the list if not there already, since setData needs it.
if "items" not in self.lesson.list:
self.lesson.list["items"] = []
while True:
#repeat because this does two things:
#- add a row if needed
#- enter the data in that row (and then break the loop)
try:
listIndex = self.indexes[index.row()]
except IndexError:
#insert row
if not value:
return False
word = {"created": datetime.datetime.now()}
try:
word["id"] = self.lesson.list["items"][-1]["id"] +1
except IndexError:
word["id"] = 0
self.beginInsertRows(
QtCore.QModelIndex(),
self.rowCount(),
self.rowCount()
)
self.lesson.list["items"].append(word)
self.indexes.append(self.lesson.list["items"].index(word))
self.endInsertRows()
else:
#set data
word = self.lesson.list["items"][listIndex]
if index.column() == self.QUESTIONS:
word["questions"] = self._parse(value)
elif index.column() == self.ANSWERS:
word["answers"] = self._parse(value)
elif index.column() == self.COMMENT:
word["comment"] = value.strip()
if not len(word["comment"]):
del word["comment"]
elif index.column() == self.COMMENT_AFTER_ANSWERING:
word["commentAfterAnswering"] = value.strip()
if not len(word["commentAfterAnswering"]):
del word["commentAfterAnswering"]
break
self.lesson.changed = True
return True
def removeRow(self, row, parent=QtCore.QModelIndex()):
listIndex = self.indexes[row]
self.beginRemoveRows(parent, row, row)
del self.indexes[row]
#update self.indexes
for i in range(len(self.indexes)):
if self.indexes[i] > listIndex:
self.indexes[i] -= 1
del self.lesson.list["items"][listIndex]
self.lesson.changed = True
self.endRemoveRows()
class EnterWidget(QtWidgets.QSplitter):
def __init__(self, createChecker, keyboardWidget, compose, parse, *args, **kwargs):
super().__init__(*args, **kwargs)
#Initialize all widgets
self._buildUi(createChecker, keyboardWidget)
#Install the table model
self._wordsTableModel = WordsTableModel(compose, parse)
self._wordsTableView.setModel(self._wordsTableModel)
self._connectSignals()
@property
def lesson(self):
return self._wordsTableModel.lesson
def updateLesson(self, lesson):
self._wordsTableModel.updateLesson(lesson)
self._titleTextBox.setText(lesson.list.get("title", u""))
self._questionLanguageTextBox.setText(lesson.list.get("questionLanguage", u""))
self._answerLanguageTextBox.setText(lesson.list.get("answerLanguage", u""))
def removeSelectedRows(self):
while True:
try:
i = self._wordsTableView.selectedIndexes()[0]
except IndexError:
break
try:
self._wordsTableModel.removeRow(i.row())
except IndexError:
#trying to remove the empty add row isn't going to work
break
def addLetter(self, letter):
i = self._wordsTableView.currentIndex()
if not i.isValid():
return
data = self._wordsTableModel.data(i) + letter
self._wordsTableModel.setData(i, data)
self._wordsTableView.edit(i)
self._wordsTableView.itemDelegate().currentEditor.deselect()
def _buildUi(self, createChecker, keyboardWidget):
self._titleLabel = QtWidgets.QLabel()
self._titleTextBox = QtWidgets.QLineEdit(self)
self._questionLanguageTextBox = QtWidgets.QLineEdit(self)
self._questionLanguageLabel = QtWidgets.QLabel()
self._answerLanguageTextBox = QtWidgets.QLineEdit(self)
self._answerLanguageLabel = QtWidgets.QLabel()
self._wordsTableView = WordsTableView(createChecker)
topLayout = QtWidgets.QGridLayout()
topLayout.addWidget(self._titleLabel, 0, 0)
topLayout.addWidget(self._titleTextBox, 0, 1)
topLayout.addWidget(self._questionLanguageLabel, 1, 0)
topLayout.addWidget(self._questionLanguageTextBox, 1, 1)
topLayout.addWidget(self._answerLanguageLabel, 2, 0)
topLayout.addWidget(self._answerLanguageTextBox, 2, 1)
leftLayout = QtWidgets.QVBoxLayout()
leftLayout.addLayout(topLayout)
leftLayout.addWidget(self._wordsTableView)
leftLayoutWidget = QtWidgets.QWidget()
leftLayoutWidget.setLayout(leftLayout)
if keyboardWidget is not None:
self._keyboardWidget = keyboardWidget
self._removeSelectedRowsButton = QtWidgets.QPushButton(self)
shortcut = QtWidgets.QShortcut(QtGui.QKeySequence.Delete, self)
shortcut.activated.connect(self._removeSelectedRowsButton.animateClick)
rightLayout = QtWidgets.QVBoxLayout()
with contextlib.suppress(AttributeError):
rightLayout.addWidget(self._keyboardWidget)
rightLayout.addWidget(self._removeSelectedRowsButton)
rightLayoutWidget = QtWidgets.QWidget()
rightLayoutWidget.setLayout(rightLayout)
self.addWidget(leftLayoutWidget)
self.addWidget(rightLayoutWidget)
self.setStretchFactor(0, 255)
self.setStretchFactor(1, 1)
def retranslate(self):
self._titleLabel.setText(_("Title:"))
self._questionLanguageLabel.setText(_("Question language:"))
self._answerLanguageLabel.setText(_("Answer language:"))
self._removeSelectedRowsButton.setText(_("Remove selected row(s)"))
self._wordsTableModel.retranslate()
def _connectSignals(self):
self._removeSelectedRowsButton.clicked.connect(
self.removeSelectedRows
)
with contextlib.suppress(AttributeError):
self._keyboardWidget.letterChosen.handle(self.addLetter)
self._titleTextBox.textEdited.connect(
self._wordsTableModel.updateTitle
)
self._questionLanguageTextBox.textEdited.connect(
self._wordsTableModel.updateQuestionLanguage
)
self._answerLanguageTextBox.textEdited.connect(
self._wordsTableModel.updateAnswerLanguage
)
class WordsEntererModule:
def __init__(self, moduleManager, *args, **kwargs):
super().__init__(*args, **kwargs)
self._mm = moduleManager
self.type = "wordsEnterer"
self.priorities = {
"default": 450,
}
self.uses = (
self._mm.mods(type="translator"),
self._mm.mods(type="spellChecker"),
self._mm.mods(type="charsKeyboard"),
)
self.requires = (
self._mm.mods(type="ui"),
self._mm.mods(type="wordsStringComposer"),
self._mm.mods(type="wordsStringParser"),
)
self.filesWithTranslations = ("words.py",)
@property
def _charsKeyboard(self):
try:
return self._modules.default(
"active",
type="charsKeyboard"
).createWidget()
except IndexError:
return
@property
def _compose(self):
return self._modules.default(
"active",
type="wordsStringComposer"
).compose
@property
def _parse(self):
return self._modules.default(
"active",
type="wordsStringParser"
).parse
@property
def _createChecker(self):
try:
return self._modules.default("active", type="spellChecker").createChecker
except IndexError:
class Fallback:
def __init__(self, *args, **kwargs):
pass
def check(self, item):
#'everything is a well spelled word'
return True
def split(self, words):
#'no words in there'
return []
return Fallback
def createWordsEnterer(self):
ew = EnterWidget(
self._createChecker,
self._charsKeyboard,
self._compose,
self._parse
)
self._activeWidgets.add(weakref.ref(ew))
self._retranslate()
return ew
def enable(self):
global QtCore, QtGui, QtWidgets
try:
from PyQt5 import QtCore, QtGui, QtWidgets
except ImportError:
return
installQtClasses()
self._modules = set(self._mm.mods(type="modules")).pop()
self._activeWidgets = set()
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):
#Translations
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")
)
for widget in self._activeWidgets:
r = widget()
if r is not None:
r.retranslate()
def disable(self):
self.active = False
del self._modules
del self._activeWidgets
def init(moduleManager):
return WordsEntererModule(moduleManager)
|