| Type: | lesson |
| Uses (at least one of): |
DataTypeIconsModule >
TranslatorModule > TestsViewerModule > |
| Requires (at least one of): |
GuiModule >
EventModule > WordsEntererModule > WordsTeacherModule > LessonDialogsModule > ButtonRegisterModule > |
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 | #! /usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright 2011-2013, Marten de Vries
# Copyright 2011-2012, Cas Widdershoven
# Copyright 2011-2012, 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 weakref
import contextlib
DATA_TYPE = "words"
class Lesson:
def __init__(self, fileTab, Event, okToClose, onTabChanged, enterWidget, teachWidget, resultsWidget=None, *args, **kwargs):
super().__init__(*args, **kwargs)
self.fileTab = fileTab
self.fileTab.closeRequested.handle(self.stop)
self.fileTab.tabChanged.handle(self._tabChanged)
self.stopped = Event()
self.changedEvent = Event()
self._okToClose = okToClose
self._onTabChanged = onTabChanged
self._enterWidget = enterWidget
self._teachWidget = teachWidget
if resultsWidget:
self._resultsWidget = resultsWidget
self._teachWidget.lessonDone.connect(self._lessonDone)
self._teachWidget.listChanged.connect(self._updateResultsWidgetWrapper)
self.list = {}
self.resources = {}
self.changed = False
self.dataType = DATA_TYPE
self.retranslate()
def addTeachSideWidget(self, widget):
self._teachWidget.addSideWidget(widget)
def removeTeachSideWidget(self, widget):
self._teachWidget.removeSideWidget(widget)
@property
def list(self):
return self._list
@list.setter
def list(self, list):
self._list = list
self._enterWidget.updateLesson(self)
self._teachWidget.updateLesson(self)
self._updateUi()
@property
def changed(self):
return self._changed
@changed.setter
def changed(self, value):
self._changed = value
self._updateUi()
self.changedEvent.send()
def _updateUi(self):
self._updateTabTitle()
self._updateResultsWidget()
def _updateTabTitle(self):
title = self.list.get("title", "") or _("Unnamed")
self.fileTab.title = _("Word lesson: %s") % title
retranslate = _updateTabTitle
def _lessonDone(self):
self.fileTab.currentTab = self._enterWidget
def _updateResultsWidgetWrapper(self, list):
self._updateResultsWidget()
def _updateResultsWidget(self):
with contextlib.suppress(AttributeError):
self._resultsWidget.updateList(self.list, DATA_TYPE)
def stop(self):
#close current lesson (if one). Just reuse all the logic.
self.fileTab.currentTab = self._enterWidget
self._tabChanged()
if self.fileTab.currentTab == self._teachWidget:
#the tab change wasn't allowed.
return False
#ask if the user wants to save
if self.changed:
if not self._okToClose(parent=self.fileTab.currentTab):
return False
#it's ok, just close.
self.fileTab.close()
self.stopped.send()
return True
def _tabChanged(self):
"""First do checks that apply to all lessons. In case they don't
show any problems, the callback with word specific checks is
called.
"""
#FIXME > 3.1: move into separate module since this uses QtWidgets?
def callback():
#words specific checks
for item in self._enterWidget.lesson.list["items"]:
if not item.get("questions", []) or not item.get("answers", []):
QtWidgets.QMessageBox.critical(
self._teachWidget,
_("Empty question or answer"),
_("Please enter at least one question and one answer for every word.")
)
self.fileTab.currentTab = self._enterWidget
break
#generic checks
self._onTabChanged(self.fileTab, self._enterWidget, self._teachWidget, callback)
class WordsLessonModule:
def __init__(self, moduleManager, *args, **kwargs):
super().__init__(*args, **kwargs)
self._mm = moduleManager
self.type = "lesson"
x = 493
self.priorities = {
"all": x,
"selfstudy": x,
"student@home": x,
"student@school": x,
"teacher": x,
"words-only": x,
"code-documentation": x,
"test-suite": x,
"default": -1,
}
self.requires = (
self._mm.mods(type="ui"),
self._mm.mods(type="event"),
self._mm.mods(type="wordsEnterer"),
self._mm.mods(type="wordsTeacher"),
self._mm.mods(type="lessonDialogs"),
self._mm.mods(type="buttonRegister"),
)
self.uses = (
self._mm.mods(type="dataTypeIcons"),
self._mm.mods(type="translator"),
self._mm.mods(type="testsViewer"),
)
self.filesWithTranslations = ("words.py",)
def enable(self):
global QtWidgets
try:
from PyQt5 import QtWidgets
except ImportError:
return
self.dataType = DATA_TYPE
self._modules = set(self._mm.mods(type="modules")).pop()
self._uiModule = self._modules.default("active", type="ui")
self._lessons = set()
self._button = self._modules.default("active", type="buttonRegister").registerButton("create")
self._button.clicked.handle(self.createLesson)
try:
iconPath = self._modules.default("active", type="dataTypeIcons").findIcon(DATA_TYPE)
except (IndexError, KeyError):
pass
else:
self._button.changeIcon.send(iconPath)
#reasonable priority
self._button.changePriority.send(self.priorities["all"])
try:
translator = self._modules.default("active", type="translator")
except IndexError:
pass
else:
translator.languageChanged.handle(self._retranslate)
self._retranslate()
self.lessonCreated = self._modules.default(type="event").createEvent()
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")
)
self._button.changeText.send(_("Create words lesson"))
for ref in self._lessons:
lesson = ref()
if lesson:
lesson.retranslate()
def disable(self):
self.active = False
self._modules.default("active", type="buttonRegister").unregisterButton(self._button)
del self.dataType
del self._modules
del self._uiModule
del self._lessons
del self.lessonCreated
del self._button
_createEvent = property(
lambda self: self._modules.default(type="event").createEvent
)
_lessonDialogs = property(
lambda self: self._modules.default("active", type="lessonDialogs")
)
def createLesson(self):
#create widgets
self.enterWidget = self._modules.default(
"active",
type="wordsEnterer"
).createWordsEnterer()
self.teachWidget = self._modules.default(
"active",
type="wordsTeacher"
).createWordsTeacher()
widgets = [
self.enterWidget,
self.teachWidget,
]
try:
resultsWidget = self._modules.default(
"active",
type="testsViewer"
).createTestsViewer()
except IndexError:
pass
else:
widgets.append(resultsWidget)
self.fileTab = self._uiModule.addFileTab(*widgets)
lesson = Lesson(
self.fileTab,
self._createEvent,
self._lessonDialogs.okToClose,
self._lessonDialogs.onTabChanged,
*widgets
)
self._lessons.add(weakref.ref(lesson))
self.lessonCreated.send(lesson)
return lesson
def init(moduleManager):
return WordsLessonModule(moduleManager)
|