Veronica Berglyd Olsen
6d7ca2bb86
* Update instructions and readmes * Cleanup in base files * Cleanup in core files * Cleanup in gui files * Cleanup in dialog files * Cleanup in tools files * Cleanup in test files
290 lines
10 KiB
Python
290 lines
10 KiB
Python
"""
|
||
novelWriter – GUI About Box
|
||
===========================
|
||
The about novelWriter dialog box
|
||
|
||
File History:
|
||
Created: 2020-05-21 [0.5.2]
|
||
|
||
This file is a part of novelWriter
|
||
Copyright 2018–2021, Veronica Berglyd Olsen
|
||
|
||
This program 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.
|
||
|
||
This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
||
"""
|
||
|
||
import nw
|
||
import os
|
||
import logging
|
||
|
||
from datetime import datetime
|
||
|
||
from PyQt5.QtGui import QCursor
|
||
from PyQt5.QtCore import Qt
|
||
from PyQt5.QtWidgets import (
|
||
qApp, QDialog, QHBoxLayout, QVBoxLayout, QDialogButtonBox, QTabWidget,
|
||
QTextBrowser, QLabel
|
||
)
|
||
|
||
logger = logging.getLogger(__name__)
|
||
|
||
|
||
class GuiAbout(QDialog):
|
||
|
||
def __init__(self, theParent):
|
||
QDialog.__init__(self, theParent)
|
||
|
||
logger.debug("Initialising GuiAbout ...")
|
||
self.setObjectName("GuiAbout")
|
||
|
||
self.mainConf = nw.CONFIG
|
||
self.theParent = theParent
|
||
self.theTheme = theParent.theTheme
|
||
|
||
self.outerBox = QVBoxLayout()
|
||
self.innerBox = QHBoxLayout()
|
||
self.innerBox.setSpacing(self.mainConf.pxInt(16))
|
||
|
||
self.setWindowTitle(self.tr("About novelWriter"))
|
||
self.setMinimumWidth(self.mainConf.pxInt(650))
|
||
self.setMinimumHeight(self.mainConf.pxInt(600))
|
||
|
||
nPx = self.mainConf.pxInt(96)
|
||
self.nwIcon = QLabel()
|
||
self.nwIcon.setPixmap(self.theParent.theTheme.getPixmap("novelwriter", (nPx, nPx)))
|
||
self.lblName = QLabel("<b>novelWriter</b>")
|
||
self.lblVers = QLabel("v%s" % nw.__version__)
|
||
self.lblDate = QLabel(datetime.strptime(nw.__date__, "%Y-%m-%d").strftime("%x"))
|
||
|
||
self.leftBox = QVBoxLayout()
|
||
self.leftBox.setSpacing(self.mainConf.pxInt(4))
|
||
self.leftBox.addWidget(self.nwIcon, 0, Qt.AlignCenter)
|
||
self.leftBox.addWidget(self.lblName, 0, Qt.AlignCenter)
|
||
self.leftBox.addWidget(self.lblVers, 0, Qt.AlignCenter)
|
||
self.leftBox.addWidget(self.lblDate, 0, Qt.AlignCenter)
|
||
self.leftBox.addStretch(1)
|
||
self.innerBox.addLayout(self.leftBox)
|
||
|
||
# Pages
|
||
self.pageAbout = QTextBrowser()
|
||
self.pageAbout.setOpenExternalLinks(True)
|
||
self.pageAbout.document().setDocumentMargin(self.mainConf.pxInt(16))
|
||
|
||
self.pageNotes = QTextBrowser()
|
||
self.pageNotes.setOpenExternalLinks(True)
|
||
self.pageNotes.document().setDocumentMargin(self.mainConf.pxInt(16))
|
||
|
||
self.pageLicense = QTextBrowser()
|
||
self.pageLicense.setOpenExternalLinks(True)
|
||
self.pageLicense.document().setDocumentMargin(self.mainConf.pxInt(16))
|
||
|
||
# Main Tab Area
|
||
self.tabBox = QTabWidget()
|
||
self.tabBox.addTab(self.pageAbout, self.tr("About"))
|
||
self.tabBox.addTab(self.pageNotes, self.tr("Release"))
|
||
self.tabBox.addTab(self.pageLicense, self.tr("Licence"))
|
||
self.innerBox.addWidget(self.tabBox)
|
||
|
||
# OK Button
|
||
self.buttonBox = QDialogButtonBox(QDialogButtonBox.Ok)
|
||
self.buttonBox.accepted.connect(self._doClose)
|
||
|
||
self.outerBox.addLayout(self.innerBox)
|
||
self.outerBox.addWidget(self.buttonBox)
|
||
self.setLayout(self.outerBox)
|
||
|
||
logger.debug("GuiAbout initialisation complete")
|
||
|
||
return
|
||
|
||
def populateGUI(self):
|
||
"""Populate tabs with text.
|
||
"""
|
||
qApp.setOverrideCursor(QCursor(Qt.WaitCursor))
|
||
self._setStyleSheet()
|
||
self._fillAboutPage()
|
||
self._fillNotesPage()
|
||
self._fillLicensePage()
|
||
qApp.restoreOverrideCursor()
|
||
return
|
||
|
||
def showReleaseNotes(self):
|
||
"""Show the release notes.
|
||
"""
|
||
self.tabBox.setCurrentWidget(self.pageNotes)
|
||
return
|
||
|
||
##
|
||
# Internal Functions
|
||
##
|
||
|
||
def _fillAboutPage(self):
|
||
"""Generate the content for the About page.
|
||
"""
|
||
aboutMsg = (
|
||
"<h2>{title1}</h2>"
|
||
"<p>{copy}</p>"
|
||
"<p>{link}</p>"
|
||
"<p>{intro}</p>"
|
||
"<p>{license1}</p>"
|
||
"<p>{license2}</p>"
|
||
"<p>{license3}</p>"
|
||
"<h3>{title2}</h3>"
|
||
"<p>{credits}</p>"
|
||
).format(
|
||
title1=self.tr("About novelWriter"),
|
||
copy=nw.__copyright__,
|
||
link=self.tr("Website: {0}").format(f"<a href='{nw.__url__}'>{nw.__domain__}</a>"),
|
||
title2=self.tr("Credits"),
|
||
credits=self._wrapTable([
|
||
(self.tr("Developer"), "Veronica Berglyd Olsen"),
|
||
(self.tr("Concept"), "Veronica Berglyd Olsen, Marian Lückhof"),
|
||
(self.tr("i18n"), "Bruno Meneguello"),
|
||
]),
|
||
intro=self.tr(
|
||
"novelWriter is a markdown-like text editor designed for organising and "
|
||
"writing novels. It is written in Python 3 with a Qt5 GUI, using PyQt5."
|
||
),
|
||
license1=self.tr(
|
||
"novelWriter 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."
|
||
),
|
||
license2=self.tr(
|
||
"novelWriter 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."
|
||
),
|
||
license3=self.tr(
|
||
"See the Licence tab for the full licence text, or visit the "
|
||
"GNU website at {0} for more details."
|
||
).format(
|
||
"<a href='https://www.gnu.org/licenses/gpl-3.0.html'>GPL v3.0</a>"
|
||
),
|
||
)
|
||
|
||
aboutMsg += "<h4>%s</h4><p>%s</p>" % (
|
||
self.tr("Translations"),
|
||
self._wrapTable([
|
||
("English", "Veronica Berglyd Olsen"),
|
||
("Français", "Jan Lüdke (jyhelle)"),
|
||
("Norsk Bokmål", "Veronica Berglyd Olsen"),
|
||
("Português", "Bruno Meneguello"),
|
||
("简体中文", "Qianzhi Long"),
|
||
])
|
||
)
|
||
|
||
theTheme = self.theParent.theTheme
|
||
theIcons = self.theParent.theTheme.theIcons
|
||
if theTheme.themeName and theTheme.themeAuthor != "N/A":
|
||
licURL = f"<a href='{theTheme.themeLicenseUrl}'>{theTheme.themeLicense}</a>"
|
||
aboutMsg += "<h4>%s</h4><p>%s</p>" % (
|
||
self.tr("Theme: {0}").format(theTheme.themeName),
|
||
self._wrapTable([
|
||
(self.tr("Author"), theTheme.themeAuthor),
|
||
(self.tr("Credit"), theTheme.themeCredit),
|
||
(self.tr("Licence"), licURL),
|
||
])
|
||
)
|
||
|
||
if theIcons.themeName:
|
||
licURL = f"<a href='{theIcons.themeLicenseUrl}'>{theIcons.themeLicense}</a>"
|
||
aboutMsg += "<h4>%s</h4><p>%s</p>" % (
|
||
self.tr("Icons: {0}").format(theIcons.themeName),
|
||
self._wrapTable([
|
||
(self.tr("Author"), theIcons.themeAuthor),
|
||
(self.tr("Credit"), theIcons.themeCredit),
|
||
(self.tr("Licence"), licURL),
|
||
])
|
||
)
|
||
|
||
if theTheme.syntaxName:
|
||
licURL = f"<a href='{theTheme.syntaxLicenseUrl}'>{theTheme.syntaxLicense}</a>"
|
||
aboutMsg += "<h4>%s</h4><p>%s</p>" % (
|
||
self.tr("Syntax: {0}").format(theTheme.syntaxName),
|
||
self._wrapTable([
|
||
(self.tr("Author"), theTheme.syntaxAuthor),
|
||
(self.tr("Credit"), theTheme.syntaxCredit),
|
||
(self.tr("Licence"), licURL),
|
||
])
|
||
)
|
||
|
||
self.pageAbout.setHtml(aboutMsg)
|
||
|
||
return
|
||
|
||
def _fillNotesPage(self):
|
||
"""Load the content for the Release Notes page.
|
||
"""
|
||
docPath = os.path.join(self.mainConf.assetPath, "text", "release_notes.htm")
|
||
if os.path.isfile(docPath):
|
||
with open(docPath, mode="r", encoding="utf-8") as inFile:
|
||
helpText = inFile.read()
|
||
self.pageNotes.setHtml(helpText)
|
||
else:
|
||
self.pageNotes.setHtml("Error loading release notes text ...")
|
||
return
|
||
|
||
def _fillLicensePage(self):
|
||
"""Load the content for the Licence page.
|
||
"""
|
||
docPath = os.path.join(self.mainConf.assetPath, "text", "gplv3_en.htm")
|
||
if os.path.isfile(docPath):
|
||
with open(docPath, mode="r", encoding="utf-8") as inFile:
|
||
helpText = inFile.read()
|
||
self.pageLicense.setHtml(helpText)
|
||
else:
|
||
self.pageLicense.setHtml("Error loading licence text ...")
|
||
return
|
||
|
||
def _wrapTable(self, theData):
|
||
"""Wrap a list of label/value tuples in a html table.
|
||
"""
|
||
theTable = []
|
||
for aLabel, aValue in theData:
|
||
theTable.append(
|
||
f"<tr><td><b>{aLabel}:</b></td><td>{aValue}</td></tr>"
|
||
)
|
||
return "<table>%s</table>" % "".join(theTable)
|
||
|
||
def _setStyleSheet(self):
|
||
"""Set stylesheet for all browser tabs
|
||
"""
|
||
styleSheet = (
|
||
"h1, h2, h3, h4 {{"
|
||
" color: rgb({hColR},{hColG},{hColB});"
|
||
"}}\n"
|
||
"a {{"
|
||
" color: rgb({hColR},{hColG},{hColB});"
|
||
"}}\n"
|
||
"td {{"
|
||
" padding-right: 0.8em;"
|
||
"}}\n"
|
||
).format(
|
||
hColR=self.theParent.theTheme.colHead[0],
|
||
hColG=self.theParent.theTheme.colHead[1],
|
||
hColB=self.theParent.theTheme.colHead[2],
|
||
)
|
||
self.pageAbout.document().setDefaultStyleSheet(styleSheet)
|
||
self.pageNotes.document().setDefaultStyleSheet(styleSheet)
|
||
self.pageLicense.document().setDefaultStyleSheet(styleSheet)
|
||
|
||
return
|
||
|
||
def _doClose(self):
|
||
self.close()
|
||
return
|
||
|
||
# END Class GuiAbout
|