This module provides the documentation dialog.
| Type: | documentation |
| Uses (at least one of): |
TranslatorModule >
|
| Requires (at least one of): |
MetadataModule >
GuiModule > UserDocumentationModule > UserDocumentationWrapperModule > QtWebEngineWebEngineModule > QtWebKitWebEngineModule > |
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 | #! /usr/bin/env python3
# -*- coding: utf-8 -*-
# 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 weakref
import os
def installQtClasses():
global OpenTeacherWebPage, DocumentationDialog
class DocumentationDialog(QtWidgets.QWidget):
"""The documentation dialog. It shows the (html) user
documentation of OpenTeacher. First it tries to fetch the
online resource (it can be newer), otherwise it uses the
offline fallback.
"""
def __init__(self, View, url, userAgent, getFallbackHtml):
super().__init__()
self.url = url
self.userAgent = userAgent
self.getFallbackHtml = getFallbackHtml
self.view = View()
self.view.onFinished.handle(self.updateStatus)
vbox = QtWidgets.QVBoxLayout()
vbox.setContentsMargins(0, 0, 0, 0)
vbox.addWidget(self.view.widget)
self.setLayout(vbox)
def updateStatus(self, ok):
if not ok:
html = self.getFallbackHtml()
self.view.setHtml(html)
def retranslate(self):
self.setWindowTitle(_("Documentation"))
#self.page is retranslated by the updateLanguage call done on a
#higher level
def updateLanguage(self, language):
headers = {
b'Accept-Language': language.encode('ascii'),
b'User-Agent': self.userAgent.encode('ascii'),
}
self.view.request(self.url, headers)
class DocumentationModule:
"""This module provides the documentation dialog."""
def __init__(self, moduleManager, *args, **kwargs):
super().__init__(*args, **kwargs)
self._mm = moduleManager
self.type = "documentation"
self.requires = (
self._mm.mods(type="metadata"),
self._mm.mods(type="ui"),
self._mm.mods(type="userDocumentation"),
self._mm.mods(type="userDocumentationWrapper"),
self._mm.mods(type='webEngine'),
)
self.uses = (
self._mm.mods(type="translator"),
)
self.filesWithTranslations = ("documentation.py",)
def _getFallbackHtml(self):
userDocumentationModule = self._modules.default("active", type="userDocumentation")
userDocumentationWrapperModule = self._modules.default("active", type="userDocumentationWrapper")
baseUrl = "file://" + os.path.abspath(userDocumentationModule.resourcesPath)
html = userDocumentationModule.getHtml(baseUrl)
return userDocumentationWrapperModule.wrap(html)
def show(self):
uiModule = self._modules.default("active", type="ui")
createView = self._modules.default('active', type='webEngine').createView
dialog = DocumentationDialog(
createView,
self._metadata["documentationUrl"],
self._metadata["userAgent"],
self._getFallbackHtml,
)
tab = uiModule.addCustomTab(dialog)
dialog.tab = tab
tab.closeRequested.handle(tab.close)
self._activeDialogs.add(weakref.ref(dialog))
self._retranslate()
def enable(self):
global QtWidgets
try:
from PyQt5 import QtWidgets
except ImportError:
return
installQtClasses()
self._modules = set(self._mm.mods(type="modules")).pop()
self._metadata = self._modules.default("active", type="metadata").metadata
self._activeDialogs = set()
#load translator
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):
#load translator
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
language = "en"
else:
_, ngettext = translator.gettextFunctions(
self._mm.resourcePath("translations")
)
language = translator.language
for ref in self._activeDialogs:
dialog = ref()
if dialog is not None:
dialog.retranslate()
dialog.updateLanguage(language)
dialog.tab.title = dialog.windowTitle()
def disable(self):
self.active = False
del self._modules
del self._metadata
del self._activeDialogs
def init(moduleManager):
return DocumentationModule(moduleManager)
|