novelWriter 2.7.4__py3-none-any.whl → 2.8b1__py3-none-any.whl

novelwriter/guimain.py

@@ -20,7 +20,7 @@ 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/>.
-"""
+"""  # noqa
 from __future__ import annotations
 
 import logging
@@ -30,7 +30,7 @@ from datetime import datetime
 from pathlib import Path
 from time import time
 
-from PyQt6.QtCore import Qt, QTimer, pyqtSlot
+from PyQt6.QtCore import QEvent, Qt, QTimer, pyqtSlot
 from PyQt6.QtGui import QCloseEvent, QCursor, QIcon, QShortcut
 from PyQt6.QtWidgets import (
     QApplication, QFileDialog, QHBoxLayout, QMainWindow, QMessageBox,
@@ -38,13 +38,14 @@ from PyQt6.QtWidgets import (
 )
 
 from novelwriter import CONFIG, SHARED, __hexversion__, __version__
-from novelwriter.common import formatFileFilter, formatVersion, hexToInt
+from novelwriter.common import formatFileFilter, formatVersion, hexToInt, minmax
 from novelwriter.constants import nwConst
 from novelwriter.dialogs.about import GuiAbout
 from novelwriter.dialogs.preferences import GuiPreferences
 from novelwriter.dialogs.projectsettings import GuiProjectSettings
 from novelwriter.dialogs.wordlist import GuiWordList
 from novelwriter.enum import nwDocAction, nwDocInsert, nwDocMode, nwFocus, nwItemType, nwView
+from novelwriter.extensions.progressbars import NProgressSimple
 from novelwriter.gui.doceditor import GuiDocEditor
 from novelwriter.gui.docviewer import GuiDocViewer
 from novelwriter.gui.docviewerpanel import GuiDocViewerPanel
@@ -67,16 +68,12 @@ logger = logging.getLogger(__name__)
 
 
 class GuiMain(QMainWindow):
-    """Main GUI Window
-
-    The Main GUI window class. It is the entry point of the
-    application, and holds all runtime objects aside from the main
-    Config instance, which is created before the Main GUI.
+    """Main GUI Window.
 
-    The Main GUI is split up into GUI components, assembled in the init
-    function. Also, the project instance and theme instance are created
-    here. These should be passed around to all other objects who need
-    them and new instances of them should generally not be created.
+    The Main GUI window class is the entry point of the application. It
+    is split up into GUI components, assembled in the init function.
+    Tools and dialog windows are created on demand, but may be cached by
+    the Qt library and reused unless explicitly freed after use.
     """
 
     def __init__(self) -> None:
@@ -103,7 +100,7 @@ class GuiMain(QMainWindow):
         SHARED.initSharedData(self)
 
         # Prepare Main Window
-        self.resize(*CONFIG.mainWinSize)
+        self._setWindowSize(CONFIG.mainWinSize)
         self._updateWindowTitle()
 
         nwIcon = CONFIG.assetPath("icons") / "novelwriter.svg"
@@ -169,9 +166,9 @@ class GuiMain(QMainWindow):
         self.splitMain.addWidget(self.splitDocs)
         self.splitMain.setOpaqueResize(False)
         self.splitMain.setHandleWidth(4)
-        self.splitMain.setSizes(CONFIG.mainPanePos)
-        self.splitMain.setCollapsible(0, False)
+        self.splitMain.setSizes([max(s, 100) for s in CONFIG.mainPanePos])
         self.splitMain.setCollapsible(0, False)
+        self.splitMain.setCollapsible(1, False)
         self.splitMain.setStretchFactor(1, 0)
         self.splitMain.setStretchFactor(1, 1)
 
@@ -185,6 +182,10 @@ class GuiMain(QMainWindow):
         self.splitView.setVisible(False)
         self.docEditor.closeSearch()
 
+        # Progress Bar
+        self.mainProgress = NProgressSimple(self)
+        self.mainProgress.setFixedHeight(2)
+
         # Assemble Main Window Elements
         self.mainBox = QHBoxLayout()
         self.mainBox.addWidget(self.sideBar)
@@ -192,8 +193,14 @@ class GuiMain(QMainWindow):
         self.mainBox.setContentsMargins(0, 0, 0, 0)
         self.mainBox.setSpacing(0)
 
+        self.outerBox = QVBoxLayout()
+        self.outerBox.addLayout(self.mainBox)
+        self.outerBox.addWidget(self.mainProgress)
+        self.outerBox.setContentsMargins(0, 0, 0, 0)
+        self.outerBox.setSpacing(0)
+
         self.mainWidget = QWidget(self)
-        self.mainWidget.setLayout(self.mainBox)
+        self.mainWidget.setLayout(self.outerBox)
 
         self.setMenuBar(self.mainMenu)
         self.setCentralWidget(self.mainWidget)
@@ -316,13 +323,10 @@ class GuiMain(QMainWindow):
         self.mainStatus.setStatusMessage(self.tr("novelWriter is ready ..."))
         CONFIG.splashMessage("novelWriter is ready ...")
 
-        return
-
     def initMain(self) -> None:
         """Initialise elements that depend on user settings."""
         self.asProjTimer.setInterval(int(CONFIG.autoSaveProj*1000))
         self.asDocTimer.setInterval(int(CONFIG.autoSaveDoc*1000))
-        return
 
     def postLaunchTasks(self, cmdOpen: str | None) -> None:
         """Process tasks after the main window has been created."""
@@ -344,8 +348,6 @@ class GuiMain(QMainWindow):
         # before showing any dialogs
         QTimer.singleShot(50, self.showPostLaunchDialogs)
 
-        return
-
     @pyqtSlot()
     def showPostLaunchDialogs(self) -> None:
         """Show post launch dialogs."""
@@ -363,8 +365,6 @@ class GuiMain(QMainWindow):
             ).format(f"<a href='{nwConst.URL_RELEASES}'>", "</a>")
             SHARED.info(f"{trVersion}<br>{trRelease}")
 
-        return
-
     ##
     #  Project Actions
     ##
@@ -497,7 +497,8 @@ class GuiMain(QMainWindow):
 
         # Check if we need to rebuild the index
         if SHARED.project.index.indexBroken:
-            SHARED.info(self.tr("The project index is outdated or broken. Rebuilding index."))
+            if not SHARED.project.index.indexUpgrade:
+                SHARED.warn(self.tr("The project index is broken. Rebuilding index."))
             self.rebuildIndex()
 
         # Make sure the changed status is set to false on things opened
@@ -527,7 +528,6 @@ class GuiMain(QMainWindow):
                 SHARED.setFocusMode(False)
             self.saveDocument()
             self.docEditor.clearEditor()
-        return
 
     def openDocument(
         self,
@@ -584,7 +584,6 @@ class GuiMain(QMainWindow):
                 self.openDocument(nHandle, tLine=1, doScroll=True)
             elif wrapAround:
                 self.openDocument(fHandle, tLine=1, doScroll=True)
-        return
 
     def saveDocument(self, force: bool = False) -> None:
         """Save the current documents."""
@@ -592,13 +591,11 @@ class GuiMain(QMainWindow):
             self.docEditor.saveCursorPosition()
             if force or self.docEditor.docChanged:
                 self.docEditor.saveText()
-        return
 
     @pyqtSlot()
     def forceSaveDocument(self) -> None:
         """Save document even of it has not changed."""
         self.saveDocument(force=True)
-        return
 
     def viewDocument(self, tHandle: str | None = None, sTitle: str | None = None) -> bool:
         """Load a document for viewing in the view panel."""
@@ -733,7 +730,7 @@ class GuiMain(QMainWindow):
 
         return
 
-    def rebuildIndex(self, beQuiet: bool = False) -> None:
+    def rebuildIndex(self) -> None:
         """Rebuild the entire index."""
         if SHARED.hasProject:
             logger.info("Rebuilding index ...")
@@ -750,10 +747,7 @@ class GuiMain(QMainWindow):
             self._updateStatusWordCount()
             QApplication.restoreOverrideCursor()
 
-            if not beQuiet:
-                SHARED.info(self.tr("The project index has been successfully rebuilt."))
-
-        return
+            SHARED.info(self.tr("The project index has been successfully rebuilt."))
 
     ##
     #  Main Dialogs
@@ -765,7 +759,6 @@ class GuiMain(QMainWindow):
         dialog = GuiWelcome(self)
         dialog.openProjectRequest.connect(self._openProjectFromWelcome)
         dialog.exec()
-        return
 
     @pyqtSlot()
     def showPreferencesDialog(self) -> None:
@@ -773,7 +766,6 @@ class GuiMain(QMainWindow):
         dialog = GuiPreferences(self)
         dialog.newPreferencesReady.connect(self._processConfigChanges)
         dialog.exec()
-        return
 
     @pyqtSlot()
     @pyqtSlot(int)
@@ -783,7 +775,6 @@ class GuiMain(QMainWindow):
             dialog = GuiProjectSettings(self, gotoPage=focusTab)
             dialog.newProjectSettingsReady.connect(self._processProjectSettingsChanges)
             dialog.exec()
-        return
 
     @pyqtSlot()
     def showNovelDetailsDialog(self) -> None:
@@ -792,7 +783,6 @@ class GuiMain(QMainWindow):
             dialog = GuiNovelDetails(self)
             dialog.activateDialog()
             dialog.updateValues()
-        return
 
     @pyqtSlot()
     def showBuildManuscriptDialog(self) -> None:
@@ -802,7 +792,6 @@ class GuiMain(QMainWindow):
                 dialog = GuiManuscript(self)
             dialog.activateDialog()
             dialog.loadContent()
-        return
 
     @pyqtSlot()
     def showProjectWordListDialog(self) -> None:
@@ -811,7 +800,6 @@ class GuiMain(QMainWindow):
             dialog = GuiWordList(self)
             dialog.newWordListReady.connect(self._processWordListChanges)
             dialog.exec()
-        return
 
     @pyqtSlot()
     def showWritingStatsDialog(self) -> None:
@@ -821,31 +809,32 @@ class GuiMain(QMainWindow):
                 dialog = GuiWritingStats(self)
             dialog.activateDialog()
             dialog.populateGUI()
-        return
 
     @pyqtSlot()
     def showAboutNWDialog(self) -> None:
         """Show the novelWriter about dialog."""
         dialog = GuiAbout(self)
         dialog.exec()
-        return
 
     @pyqtSlot()
     def showAboutQtDialog(self) -> None:
         """Show the Qt about dialog."""
         msgBox = QMessageBox(self)
         msgBox.aboutQt(self, "About Qt")
-        return
 
     @pyqtSlot()
     def showDictionariesDialog(self) -> None:
-        """Show the download dictionaries dialog."""
+        """Show the download dictionaries dialog and update language
+        list when closed.
+        """
         dialog = GuiDictionaries(self)
         dialog.activateDialog()
         if not dialog.initDialog():
             dialog.close()
             SHARED.error(self.tr("Could not initialise the dialog."))
-        return
+            return
+
+        dialog.finished.connect(self.mainMenu.updateSpellCheckLanguages)
 
     ##
     #  Main Window Actions
@@ -902,16 +891,50 @@ class GuiMain(QMainWindow):
 
         return not self.splitView.isVisible()
 
+    def checkThemeUpdate(self) -> None:
+        """Load theme if mode changed."""
+        if SHARED.theme.loadTheme():
+            self.refreshThemeColors(syntax=True)
+            self.docEditor.initEditor()
+            self.docViewer.initViewer()
+
+    def refreshThemeColors(self, syntax: bool = False, force: bool = False) -> None:
+        """Refresh the GUI theme."""
+        SHARED.theme.loadTheme(force=force)
+        SHARED.project.updateTheme()
+        self.setPalette(QApplication.palette())
+        self.docEditor.updateTheme()
+        self.docViewer.updateTheme()
+        self.docViewerPanel.updateTheme()
+        self.sideBar.updateTheme()
+        self.projView.updateTheme()
+        self.novelView.updateTheme()
+        self.projSearch.updateTheme()
+        self.outlineView.updateTheme()
+        self.itemDetails.updateTheme()
+        self.mainStatus.updateTheme()
+        SHARED.project.tree.refreshAllItems()
+
+        if dialog := SHARED.findTopLevelWidget(GuiManuscript):
+            dialog.updateTheme()
+
+        if syntax:
+            self.docEditor.updateSyntaxColors()
+
     ##
     #  Events
     ##
 
+    def changeEvent(self, event: QEvent) -> None:
+        """Capture application change events."""
+        if int(event.type()) == 210:  # ThemeChange
+            self.checkThemeUpdate()
+
     def closeEvent(self, event: QCloseEvent) -> None:
         """Capture the closing event of the GUI and call the close
         function to handle all the close process steps.
         """
         event.accept() if self.closeMain() else event.ignore()
-        return
 
     ##
     #  Public Slots
@@ -919,30 +942,26 @@ class GuiMain(QMainWindow):
 
     @pyqtSlot()
     def toggleFullScreenMode(self) -> None:
-        """Toggle full screen mode"""
+        """Toggle full screen mode."""
         self.setWindowState(self.windowState() ^ Qt.WindowState.WindowFullScreen)
-        return
 
     @pyqtSlot()
     def closeDocEditor(self) -> None:
         """Close the document editor. This does not hide the editor."""
         self.closeDocument()
         SHARED.project.data.setLastHandle(None, "editor")
-        return
 
     @pyqtSlot()
     def closeDocViewer(self) -> None:
         """Close the document viewer."""
         self.closeViewerPanel()
         SHARED.project.data.setLastHandle(None, "viewer")
-        return
 
     @pyqtSlot()
     def toggleFocusMode(self) -> None:
         """Toggle focus mode."""
         if self.docEditor.docHandle:
             SHARED.setFocusMode(not SHARED.focusMode)
-        return
 
     ##
     #  Private Slots
@@ -960,7 +979,6 @@ class GuiMain(QMainWindow):
                 docViewer = True
             self.docEditor.changeFocusState(docEditor)
             self.docViewer.changeFocusState(docViewer)
-        return
 
     @pyqtSlot(bool)
     def _focusModeChanged(self, focusMode: bool) -> None:
@@ -991,7 +1009,6 @@ class GuiMain(QMainWindow):
 
         if cursorVisible:
             self.docEditor.ensureCursorVisibleNoCentre()
-        return
 
     @pyqtSlot(nwFocus)
     def _switchFocus(self, paneNo: nwFocus) -> None:
@@ -1017,16 +1034,16 @@ class GuiMain(QMainWindow):
             fP = self.projView.treeHasFocus()
             fN = self.novelView.treeHasFocus()
 
-            self._changeView(nwView.EDITOR)
+            self._changeView(nwView.EDITOR, exitFocus=True)
             if (vM and ((vP and fP) or (vN and not fN))) or (not vM and vN):
-                self._changeView(nwView.NOVEL)
+                self._changeView(nwView.NOVEL, exitFocus=True)
                 self.novelView.setTreeFocus()
             else:
-                self._changeView(nwView.PROJECT)
+                self._changeView(nwView.PROJECT, exitFocus=True)
                 self.projView.setTreeFocus()
 
         elif paneNo == nwFocus.DOCUMENT:
-            self._changeView(nwView.EDITOR)
+            self._changeView(nwView.EDITOR, exitFocus=True)
             hasViewer = self.splitView.isVisible()
             if hasViewer and self.docEditor.anyFocus():
                 self.docViewer.setFocus()
@@ -1036,11 +1053,9 @@ class GuiMain(QMainWindow):
                 self.docEditor.setFocus()
 
         elif paneNo == nwFocus.OUTLINE:
-            self._changeView(nwView.OUTLINE)
+            self._changeView(nwView.OUTLINE, exitFocus=True)
             self.outlineView.setTreeFocus()
 
-        return
-
     @pyqtSlot(bool, bool, bool, bool)
     def _processConfigChanges(self, restart: bool, tree: bool, theme: bool, syntax: bool) -> None:
         """Refresh GUI based on flags from the Preferences dialog."""
@@ -1054,23 +1069,7 @@ class GuiMain(QMainWindow):
             self.novelView.refreshCurrentTree()
 
         if theme:
-            SHARED.theme.loadTheme()
-            self.setPalette(QApplication.palette())
-            self.docEditor.updateTheme()
-            self.docViewer.updateTheme()
-            self.docViewerPanel.updateTheme()
-            self.sideBar.updateTheme()
-            self.projView.updateTheme()
-            self.novelView.updateTheme()
-            self.projSearch.updateTheme()
-            self.outlineView.updateTheme()
-            self.itemDetails.updateTheme()
-            self.mainStatus.updateTheme()
-            SHARED.project.tree.refreshAllItems()
-
-        if syntax:
-            SHARED.theme.loadSyntax()
-            self.docEditor.updateSyntaxColors()
+            self.refreshThemeColors(syntax=syntax, force=True)
 
         self.docEditor.initEditor()
         self.docViewer.initViewer()
@@ -1088,8 +1087,6 @@ class GuiMain(QMainWindow):
                 "Some changes will not be applied until novelWriter has been restarted."
             ))
 
-        return
-
     @pyqtSlot()
     def _processProjectSettingsChanges(self) -> None:
         """Refresh data dependent on project settings."""
@@ -1097,7 +1094,6 @@ class GuiMain(QMainWindow):
         SHARED.updateSpellCheckLanguage()
         self.itemDetails.refreshDetails()
         self._updateWindowTitle(SHARED.project.data.name)
-        return
 
     @pyqtSlot()
     def _processWordListChanges(self) -> None:
@@ -1105,7 +1101,6 @@ class GuiMain(QMainWindow):
         logger.debug("Reloading word list")
         SHARED.updateSpellCheckLanguage(reload=True)
         self.docEditor.spellCheckDocument()
-        return
 
     @pyqtSlot(str, nwDocMode)
     def _followTag(self, tag: str, mode: nwDocMode) -> None:
@@ -1124,7 +1119,6 @@ class GuiMain(QMainWindow):
                 self.openDocument(tHandle, sTitle=sTitle)
             elif mode == nwDocMode.VIEW:
                 self.viewDocument(tHandle=tHandle, sTitle=sTitle)
-        return
 
     @pyqtSlot(Path)
     def _openProjectFromWelcome(self, path: Path) -> None:
@@ -1133,7 +1127,6 @@ class GuiMain(QMainWindow):
         self.openProject(path)
         if not SHARED.hasProject:
             self.showWelcomeDialog()
-        return
 
     @pyqtSlot(str, nwDocMode, str, bool)
     def _openDocument(self, tHandle: str, mode: nwDocMode, sTitle: str, setFocus: bool) -> None:
@@ -1143,7 +1136,6 @@ class GuiMain(QMainWindow):
                 self.openDocument(tHandle, sTitle=sTitle, changeFocus=setFocus)
             elif mode == nwDocMode.VIEW:
                 self.viewDocument(tHandle=tHandle, sTitle=sTitle)
-        return
 
     @pyqtSlot(str, int, int, bool)
     def _openDocumentSelection(
@@ -1152,7 +1144,6 @@ class GuiMain(QMainWindow):
         """Open a document and select a section of the text."""
         if self.openDocument(tHandle, changeFocus=changeFocus):
             self.docEditor.setCursorSelection(selStart, selLength)
-        return
 
     @pyqtSlot()
     def _reloadViewer(self) -> None:
@@ -1161,11 +1152,13 @@ class GuiMain(QMainWindow):
             # If the two panels have the same document, save any changes in the editor
             self.saveDocument()
         self.docViewer.reloadText()
-        return
 
     @pyqtSlot(nwView)
-    def _changeView(self, view: nwView) -> None:
+    def _changeView(self, view: nwView, exitFocus: bool = False) -> None:
         """Handle the requested change of view from the GuiViewBar."""
+        if exitFocus:
+            SHARED.setFocusMode(False)
+
         if view == nwView.EDITOR:
             # Only change the main stack, but not the project stack
             self.mainStack.setCurrentWidget(self.splitMain)
@@ -1189,8 +1182,6 @@ class GuiMain(QMainWindow):
         isNovel = self.projStack.currentWidget() == self.novelView
         self.novelView.setActive(isMain and isNovel)
 
-        return
-
     @pyqtSlot(nwDocAction)
     def _passDocumentAction(self, action: nwDocAction) -> None:
         """Pass on a document action to the editor or viewer based on
@@ -1200,7 +1191,6 @@ class GuiMain(QMainWindow):
             self.docEditor.docAction(action)
         elif self.docViewer.hasFocus():
             self.docViewer.docAction(action)
-        return
 
     @pyqtSlot(str)
     @pyqtSlot(nwDocInsert)
@@ -1210,14 +1200,12 @@ class GuiMain(QMainWindow):
         """
         if self.docEditor.hasFocus():
             self.docEditor.insertText(content)
-        return
 
     @pyqtSlot()
     def _toggleViewerPanelVisibility(self) -> None:
         """Toggle the visibility of the document viewer panel."""
         CONFIG.showViewerPanel = not CONFIG.showViewerPanel
         self.docViewerPanel.setVisible(CONFIG.showViewerPanel)
-        return
 
     @pyqtSlot()
     def _timeTick(self) -> None:
@@ -1233,7 +1221,6 @@ class GuiMain(QMainWindow):
                 self._updateStatusWordCount()
                 if CONFIG.memInfo:  # pragma: no cover
                     self.mainStatus.memInfo()
-        return
 
     @pyqtSlot()
     def _autoSaveProject(self) -> None:
@@ -1244,7 +1231,6 @@ class GuiMain(QMainWindow):
         if doSave:
             logger.debug("Auto-saving project")
             self.saveProject(autoSave=True)
-        return
 
     @pyqtSlot()
     def _autoSaveDocument(self) -> None:
@@ -1252,7 +1238,6 @@ class GuiMain(QMainWindow):
         if SHARED.hasProject and self.docEditor.docChanged:
             logger.debug("Auto-saving document")
             self.saveDocument()
-        return
 
     @pyqtSlot()
     def _updateStatusWordCount(self) -> None:
@@ -1282,8 +1267,6 @@ class GuiMain(QMainWindow):
 
             self.mainStatus.setProjectStats(cTotal, cTotal - iTotal)
 
-        return
-
     @pyqtSlot()
     def _keyPressReturn(self) -> None:
         """Process a return or enter keypress in the main window."""
@@ -1291,7 +1274,6 @@ class GuiMain(QMainWindow):
             self.projSearch.processReturn()
         else:
             self.openSelectedItem()
-        return
 
     @pyqtSlot()
     def _keyPressEscape(self) -> None:
@@ -1300,7 +1282,6 @@ class GuiMain(QMainWindow):
             self.docEditor.closeSearch()
         elif SHARED.focusMode:
             SHARED.setFocusMode(False)
-        return
 
     @pyqtSlot(int)
     def _mainStackChanged(self, index: int) -> None:
@@ -1308,7 +1289,6 @@ class GuiMain(QMainWindow):
         if self.mainStack.widget(index) == self.outlineView:
             if SHARED.hasProject:
                 self.outlineView.refreshTree()
-        return
 
     @pyqtSlot(int)
     def _projStackChanged(self, index: int) -> None:
@@ -1320,13 +1300,19 @@ class GuiMain(QMainWindow):
         elif widget == self.novelView:
             sHandle, _ = self.novelView.getSelectedHandle()
         self.itemDetails.updateViewBox(sHandle)
-        return
 
     ##
     #  Internal Functions
     ##
 
+    def _setWindowSize(self, size: list[int]) -> None:
+        """Set the main window size."""
+        if len(size) == 2 and (screen := SHARED.mainScreen):
+            availSize = screen.availableSize()
+            width = minmax(size[0], 900, availSize.width())
+            height = minmax(size[1], 500, availSize.height())
+            self.resize(width, height)
+
     def _updateWindowTitle(self, projName: str | None = None) -> None:
         """Set the window title and add the project's name."""
         self.setWindowTitle(" - ".join(filter(None, [projName, CONFIG.appName])))
-        return