| Type: | topoTeacher |
| Uses (at least one of): |
TranslatorModule >
ResultsDialogModule > |
| Requires (at least one of): |
GuiModule >
TopoMapsModule > |
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 | #! /usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright 2011-2012, Milan Boers
# Copyright 2011-2013, Marten de Vries
#
# 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 Order:
Normal, Inversed = range(2)
def installQtClasses():
global TeachLessonOrderChooser, TeachLessonTypeChooser, TeachWidget
class TeachLessonTypeChooser(QtWidgets.QComboBox):
"""The dropdown menu to choose lesson type"""
def __init__(self, teachWidget, *args, **kwargs):
super().__init__(*args, **kwargs)
self.teachWidget = teachWidget
self.retranslate()
def retranslate(self):
with contextlib.suppress(TypeError):
#TypeError: not yet connected (first pass)
self.currentIndexChanged.disconnect(self.changeLessonType)
#save status
i = self.currentIndex()
#update data
self.clear()
self._lessonTypeModules = base._modules.sort("active", type="lessonType")
for lessontype in self._lessonTypeModules:
self.addItem(lessontype.name, lessontype)
#restore status
if i != -1:
self.setCurrentIndex(i)
#re-connect signal
self.currentIndexChanged.connect(self.changeLessonType)
def changeLessonType(self, index):
"""What happens when you change the lesson type"""
if self.teachWidget.inLesson:
self.teachWidget.restartLesson()
@property
def currentLessonType(self):
"""Get the current lesson type"""
return self._lessonTypeModules[self.currentIndex()]
class TeachLessonOrderChooser(QtWidgets.QComboBox):
"""The dropdown menu to choose lesson order"""
def __init__(self, teachWidget, *args, **kwargs):
super().__init__(*args, **kwargs)
self.teachWidget = teachWidget
self.retranslate()
def retranslate(self):
with contextlib.suppress(TypeError):
#TypeError: not yet connected (first pass)
self.currentIndexChanged.disconnect(self.changeLessonOrder)
i = self.currentIndex()
self.clear()
self.addItem(_("Place - Name"), 0)
self.addItem(_("Name - Place"), 1)
if i != -1:
self.setCurrentIndex(i)
self.currentIndexChanged.connect(self.changeLessonOrder)
def changeLessonOrder(self, index):
"""What happens when you change the lesson order"""
if self.teachWidget.inLesson:
self.teachWidget.restartLesson()
class TeachWidget(QtWidgets.QWidget):
"""The teach tab"""
lessonDone = QtCore.pyqtSignal()
listChanged = QtCore.pyqtSignal([object])
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.inLesson = False
## GUI Drawing
# Top
top = QtWidgets.QHBoxLayout()
self.lessonTypeLabel = QtWidgets.QLabel()
self.lessonTypeChooser = TeachLessonTypeChooser(self)
top.addWidget(self.lessonTypeLabel)
top.addWidget(self.lessonTypeChooser)
self.lessonOrderLabel = QtWidgets.QLabel()
self.lessonOrderChooser = TeachLessonOrderChooser(self)
top.addWidget(self.lessonOrderLabel)
top.addWidget(self.lessonOrderChooser)
# Middle
self.mapBox = base._modules.default("active", type="topoMaps").getTeachMap(self)
# Bottom
bottom = QtWidgets.QHBoxLayout()
self.label = QtWidgets.QLabel()
self.answerfield = QtWidgets.QLineEdit()
self.checkanswerbutton = QtWidgets.QPushButton()
self.answerfield.returnPressed.connect(self._checkAnswerButtonClick)
self.answerfield.textEdited.connect(self._answerChanged)
self.checkanswerbutton.clicked.connect(self._checkAnswerButtonClick)
self.questionLabel = QtWidgets.QLabel()
self.progress = QtWidgets.QProgressBar()
bottom.addWidget(self.label)
bottom.addWidget(self.answerfield)
bottom.addWidget(self.checkanswerbutton)
bottom.addWidget(self.questionLabel)
bottom.addWidget(self.progress)
# Total
layout = QtWidgets.QVBoxLayout()
layout.addLayout(top)
layout.addWidget(self.mapBox)
layout.addLayout(bottom)
self.setLayout(layout)
self.retranslate()
def retranslate(self):
self.lessonTypeLabel.setText(_("Lesson type:"))
self.lessonOrderLabel.setText(_("Lesson order:"))
self.label.setText(_("Which place is here?"))
#TRANSLATORS: A button the user clicks to let the computer check the given answer.
self.checkanswerbutton.setText(_("Check"))
self.questionLabel.setText(_("Please click this place:"))
self.lessonTypeChooser.retranslate()
self.lessonOrderChooser.retranslate()
def initiateLesson(self, places, mapPath):
"""Starts the lesson"""
self.places = places
self.mapPath = mapPath
self.lesson = TeachTopoLesson(places, mapPath, self)
self.answerfield.setFocus()
def restartLesson(self):
"""Restarts the lesson"""
self.initiateLesson(self.places, self.mapPath)
def stopLesson(self, showResults=True):
"""Stops the lesson"""
self.lesson.endLesson(showResults)
del self.lesson
def _answerChanged(self):
"""What happens when the answer in the textbox has changed"""
try:
self.lesson.endThinkingTime
except AttributeError:
self.lesson.endThinkingTime = datetime.datetime.now()
else:
if self.answerfield.text() == "":
del self.lesson.endThinkingTime
def _checkAnswerButtonClick(self):
"""What happens when you click the check answer button"""
# Check the answer
self.lesson.checkAnswer()
# Clear the answer field
self.answerfield.clear()
# Focus the answer field
self.answerfield.setFocus()
def setWidgets(self, order):
"""Sets the bottom widgets to either the in-order version (False) or
the inversed-order (True)
"""
if order == Order.Inversed:
self.label.setVisible(False)
self.answerfield.setVisible(False)
self.checkanswerbutton.setVisible(False)
self.questionLabel.setVisible(True)
else:
self.label.setVisible(True)
self.answerfield.setVisible(True)
self.checkanswerbutton.setVisible(True)
self.questionLabel.setVisible(False)
class TeachTopoLesson:
"""The lesson itself"""
def __init__(self, itemList, mapPath, teachWidget, *args, **kwargs):
super().__init__(*args, **kwargs)
self.teachWidget = teachWidget
# Set the map
self.teachWidget.mapBox.setMap(mapPath)
self.teachWidget.mapBox.setInteractive(self.order)
self.itemList = itemList
self.lessonType = self.teachWidget.lessonTypeChooser.currentLessonType.createLessonType(self.itemList,list(range(len(itemList["items"]))))
self.lessonType.newItem.handle(self.nextQuestion)
self.lessonType.lessonDone.handle(self.teachWidget.stopLesson)
self.lessonType.start()
self.teachWidget.inLesson = True
#self.startThinkingTime
#self.endThinkingTime
# Reset the progress bar
self.teachWidget.progress.setValue(0)
self.teachWidget.setWidgets(self.order)
def checkAnswer(self, answer=None):
"""Check whether the given answer was right or wrong"""
# Set endThinkingTime if it hasn't been set yet (this is in Name - Place mode)
try:
self.endThinkingTime
except AttributeError:
self.endThinkingTime = datetime.datetime.now()
active = {
"start": self.startThinkingTime,
"end": self.endThinkingTime
}
if self.order == Order.Inversed:
if self.currentItem == answer:
# Answer was right
self.lessonType.setResult({
"itemId": self.currentItem["id"],
"result": "right",
"active": active
})
# Progress bar
self._updateProgressBar()
else:
# Answer was wrong
self.lessonType.setResult({
"itemId": self.currentItem["id"],
"result": "wrong",
"active": active
})
else:
if self.currentItem["name"] == self.teachWidget.answerfield.text():
# Answer was right
self.lessonType.setResult({
"itemId": self.currentItem["id"],
"result": "right",
"active": active
})
# Progress bar
self._updateProgressBar()
else:
# Answer was wrong
self.lessonType.setResult({
"itemId": self.currentItem["id"],
"result": "wrong",
"active": active
})
self.teachWidget.listChanged.emit(self.itemList)
def nextQuestion(self, item):
"""What happens when the next question should be asked"""
#set the next question
self.currentItem = item
if self.order == Order.Inversed:
#set the question
self.teachWidget.questionLabel.setText(_("Please click this place: ") + self.currentItem["name"])
else:
#set the arrow to the right position
self.teachWidget.mapBox.setArrow(self.currentItem["x"],self.currentItem["y"])
# Set the start of the thinking time to now
self.startThinkingTime = datetime.datetime.now()
# Delete the end of the thinking time
with contextlib.suppress(AttributeError):
del self.endThinkingTime
def endLesson(self, showResults=True):
"""Ends the lesson"""
self.teachWidget.inLesson = False
# Update and go to results widget, only if the test is progressing
try:
self.itemList["tests"][-1]
except IndexError:
pass
else:
if showResults:
with contextlib.suppress(IndexError):
# Go to results widget
module = base._modules.default("active", type="resultsDialog")
module.showResults(self.itemList, "topo", self.itemList["tests"][-1])
self.teachWidget.lessonDone.emit()
def _updateProgressBar(self):
"""Updates the progress bar"""
self.teachWidget.progress.setMaximum(self.lessonType.totalItems+1)
self.teachWidget.progress.setValue(self.lessonType.askedItems)
@property
def order(self):
return self.teachWidget.lessonOrderChooser.currentIndex()
class TopoTeacherModule:
def __init__(self, moduleManager, *args, **kwargs):
super().__init__(*args, **kwargs)
global base
base = self
self._mm = moduleManager
self.type = "topoTeacher"
self.priorities = {
"default": 504,
}
self.uses = (
self._mm.mods(type="translator"),
self._mm.mods(type="resultsDialog"),
)
self.requires = (
self._mm.mods(type="ui"),
self._mm.mods(type="topoMaps"),
)
self.filesWithTranslations = ("topo.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._widgets = set()
#setup translation
try:
translator = self._modules.default("active", type="translator")
except IndexError:
pass
else:
translator.languageChanged.handle(self._retranslate)
translator.languageChangeDone.handle(self._retranslateWhenFirstRetranslateIsOver)
self._retranslate()
self.active = True
def _retranslate(self):
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")
)
def _retranslateWhenFirstRetranslateIsOver(self):
for ref in self._widgets:
widget = ref()
if widget is not None:
widget.retranslate()
def disable(self):
self.active = False
del self._modules
del self._widgets
def createTopoTeacher(self):
tw = TeachWidget()
self._widgets.add(weakref.ref(tw))
return tw
def init(moduleManager):
return TopoTeacherModule(moduleManager)
|