novelWriter 2.3rc1__py3-none-any.whl → 2.4__py3-none-any.whl

novelwriter/gui/theme.py

@@ -29,20 +29,24 @@ import logging
 from math import ceil
 from pathlib import Path
 
-from PyQt5.QtCore import Qt
-from PyQt5.QtWidgets import qApp
+from PyQt5.QtCore import QSize, Qt
 from PyQt5.QtGui import (
     QPalette, QColor, QIcon, QFont, QFontMetrics, QFontDatabase, QPixmap
 )
+from PyQt5.QtWidgets import QApplication
 
 from novelwriter import CONFIG
+from novelwriter.common import NWConfigParser, cssCol, minmax
+from novelwriter.constants import nwLabels
 from novelwriter.enum import nwItemClass, nwItemLayout, nwItemType
 from novelwriter.error import logException
-from novelwriter.common import NWConfigParser, minmax
-from novelwriter.constants import nwLabels
 
 logger = logging.getLogger(__name__)
 
+STYLES_FLAT_TABS = "flatTabWidget"
+STYLES_MIN_TOOLBUTTON = "minimalToolButton"
+STYLES_BIG_TOOLBUTTON = "bigToolButton"
+
 
 # =============================================================================================== #
 #  Gui Theme Class
@@ -70,9 +74,9 @@ class GuiTheme:
         self.isLightTheme     = True
 
         # GUI
-        self.statNone    = QColor(120, 120, 120)
-        self.statUnsaved = QColor(200, 15, 39)
-        self.statSaved   = QColor(2, 133, 37)
+        self.statNone    = QColor(0, 0, 0)
+        self.statUnsaved = QColor(0, 0, 0)
+        self.statSaved   = QColor(0, 0, 0)
         self.helpText    = QColor(0, 0, 0)
 
         # Loaded Syntax Settings
@@ -106,6 +110,7 @@ class GuiTheme:
         self.colError  = QColor(0, 0, 0)
         self.colRepTag = QColor(0, 0, 0)
         self.colMod    = QColor(0, 0, 0)
+        self.colMark   = QColor(255, 255, 255, 128)
 
         # Class Setup
         # ===========
@@ -119,6 +124,7 @@ class GuiTheme:
         self._syntaxList: list[tuple[str, str]] = []
         self._availThemes: dict[str, Path] = {}
         self._availSyntax: dict[str, Path] = {}
+        self._styleSheets: dict[str, str] = {}
 
         self._listConf(self._availSyntax, CONFIG.assetPath("syntax"))
         self._listConf(self._availThemes, CONFIG.assetPath("themes"))
@@ -138,31 +144,42 @@ class GuiTheme:
         self.getHeaderDecorationNarrow = self.iconCache.getHeaderDecorationNarrow
 
         # Extract Other Info
-        self.guiDPI = qApp.primaryScreen().logicalDotsPerInchX()
-        self.guiScale = qApp.primaryScreen().logicalDotsPerInchX()/96.0
+        self.guiDPI = QApplication.primaryScreen().logicalDotsPerInchX()
+        self.guiScale = QApplication.primaryScreen().logicalDotsPerInchX()/96.0
         CONFIG.guiScale = self.guiScale
         logger.debug("GUI DPI: %.1f", self.guiDPI)
         logger.debug("GUI Scale: %.2f", self.guiScale)
 
         # Fonts
-        self.guiFont = qApp.font()
+        self.guiFont = QApplication.font()
+        self.guiFontB = QApplication.font()
+        self.guiFontB.setBold(True)
 
         qMetric = QFontMetrics(self.guiFont)
+        fHeight = qMetric.height()
+        fAscent = qMetric.ascent()
         self.fontPointSize = self.guiFont.pointSizeF()
-        self.fontPixelSize = int(round(qMetric.height()))
-        self.baseIconSize = int(round(qMetric.ascent()))
+        self.fontPixelSize = int(round(fHeight))
+        self.baseIconHeight = int(round(fAscent))
+        self.baseButtonHeight = int(round(1.35*fAscent))
         self.textNHeight = qMetric.boundingRect("N").height()
         self.textNWidth = qMetric.boundingRect("N").width()
 
+        self.baseIconSize = QSize(self.baseIconHeight, self.baseIconHeight)
+        self.buttonIconSize = QSize(int(0.9*self.baseIconHeight), int(0.9*self.baseIconHeight))
+
         # Monospace Font
         self.guiFontFixed = QFont()
         self.guiFontFixed.setPointSizeF(0.95*self.fontPointSize)
-        self.guiFontFixed.setFamily(QFontDatabase.systemFont(QFontDatabase.FixedFont).family())
+        self.guiFontFixed.setFamily(
+            QFontDatabase.systemFont(QFontDatabase.SystemFont.FixedFont).family()
+        )
 
         logger.debug("GUI Font Family: %s", self.guiFont.family())
         logger.debug("GUI Font Point Size: %.2f", self.fontPointSize)
         logger.debug("GUI Font Pixel Size: %d", self.fontPixelSize)
-        logger.debug("GUI Base Icon Size: %d", self.baseIconSize)
+        logger.debug("GUI Base Icon Height: %d", self.baseIconHeight)
+        logger.debug("GUI Base Button Height: %d", self.baseButtonHeight)
         logger.debug("Text 'N' Height: %d", self.textNHeight)
         logger.debug("Text 'N' Width: %d", self.textNWidth)
 
@@ -210,6 +227,10 @@ class GuiTheme:
             logException()
             return False
 
+        # Reset Palette
+        self._guiPalette = QApplication.style().standardPalette()
+        self._resetGuiColors()
+
         # Main
         sec = "Main"
         if parser.has_section(sec):
@@ -239,8 +260,6 @@ class GuiTheme:
             self._setPalette(parser, sec, "highlightedtext", QPalette.ColorRole.HighlightedText)
             self._setPalette(parser, sec, "link",            QPalette.ColorRole.Link)
             self._setPalette(parser, sec, "linkvisited",     QPalette.ColorRole.LinkVisited)
-        else:
-            self._guiPalette = qApp.style().standardPalette()
 
         # GUI
         sec = "GUI"
@@ -269,7 +288,10 @@ class GuiTheme:
         self.iconCache.loadTheme(self.themeIcons or defaultIcons)
 
         # Apply Styles
-        qApp.setPalette(self._guiPalette)
+        QApplication.setPalette(self._guiPalette)
+
+        # Reset stylesheets so that they are regenerated
+        self._buildStyleSheets(self._guiPalette)
 
         return True
 
@@ -329,6 +351,7 @@ class GuiTheme:
             self.colError  = self._parseColour(confParser, cnfSec, "errorline")
             self.colRepTag = self._parseColour(confParser, cnfSec, "replacetag")
             self.colMod    = self._parseColour(confParser, cnfSec, "modifier")
+            self.colMark   = self._parseColour(confParser, cnfSec, "texthighlight")
 
         return True
 
@@ -344,7 +367,7 @@ class GuiTheme:
             if themeName:
                 self._themeList.append((themeKey, themeName))
 
-        self._themeList = sorted(self._themeList, key=lambda x: x[1])
+        self._themeList = sorted(self._themeList, key=_sortTheme)
 
         return self._themeList
 
@@ -360,14 +383,26 @@ class GuiTheme:
             if syntaxName:
                 self._syntaxList.append((syntaxKey, syntaxName))
 
-        self._syntaxList = sorted(self._syntaxList, key=lambda x: x[1])
+        self._syntaxList = sorted(self._syntaxList, key=_sortTheme)
 
         return self._syntaxList
 
+    def getStyleSheet(self, name: str) -> str:
+        """Load a standard style sheet."""
+        return self._styleSheets.get(name, "")
+
     ##
     #  Internal Functions
     ##
 
+    def _resetGuiColors(self) -> None:
+        """Reset GUI colours to default values."""
+        self.statNone    = QColor(120, 120, 120)
+        self.statUnsaved = QColor(200, 15, 39)
+        self.statSaved   = QColor(2, 133, 37)
+        self.helpText    = QColor(0, 0, 0)
+        return
+
     def _setGuiFont(self) -> None:
         """Update the GUI's font style from settings."""
         font = QFont()
@@ -378,14 +413,14 @@ class GuiTheme:
                 font.setFamily("Arial")
                 font.setPointSize(10)
             else:
-                font = fontDB.systemFont(QFontDatabase.GeneralFont)
+                font = fontDB.systemFont(QFontDatabase.SystemFont.GeneralFont)
             CONFIG.guiFont = font.family()
             CONFIG.guiFontSize = font.pointSize()
         else:
             font.setFamily(CONFIG.guiFont)
             font.setPointSize(CONFIG.guiFontSize)
 
-        qApp.setFont(font)
+        QApplication.setFont(font)
 
         return
 
@@ -410,6 +445,41 @@ class GuiTheme:
         self._guiPalette.setColor(value, self._parseColour(parser, section, name))
         return
 
+    def _buildStyleSheets(self, palette: QPalette) -> None:
+        """Build default style sheets."""
+        self._styleSheets = {}
+
+        aPx = CONFIG.pxInt(2)
+        bPx = CONFIG.pxInt(4)
+        cPx = CONFIG.pxInt(6)
+        dPx = CONFIG.pxInt(8)
+
+        tCol = palette.text().color()
+        hCol = palette.highlight().color()
+
+        # Flat Tab Widget and Tab Bar:
+        self._styleSheets[STYLES_FLAT_TABS] = (
+            "QTabWidget::pane {border: 0;} "
+            f"QTabWidget QTabBar::tab {{border: 0; padding: {bPx}px {dPx}px;}} "
+            f"QTabWidget QTabBar::tab:selected {{color: {cssCol(hCol)};}} "
+        )
+
+        # Minimal Tool Button
+        self._styleSheets[STYLES_MIN_TOOLBUTTON] = (
+            f"QToolButton {{padding: {aPx}px; margin: 0; border: none; background: transparent;}} "
+            f"QToolButton:hover {{border: none; background: {cssCol(tCol, 48)};}} "
+            "QToolButton::menu-indicator {image: none;} "
+        )
+
+        # Big Tool Button
+        self._styleSheets[STYLES_BIG_TOOLBUTTON] = (
+            f"QToolButton {{padding: {cPx}px; margin: 0; border: none; background: transparent;}} "
+            f"QToolButton:hover {{border: none; background: {cssCol(tCol, 48)};}} "
+            "QToolButton::menu-indicator {image: none;} "
+        )
+
+        return
+
 # End Class GuiTheme
 
 
@@ -437,7 +507,7 @@ class GuiIcons:
         "build_excluded", "build_filtered", "build_included", "proj_chapter", "proj_details",
         "proj_document", "proj_folder", "proj_note", "proj_nwx", "proj_section", "proj_scene",
         "proj_stats", "proj_title", "status_idle", "status_lang", "status_lines", "status_stats",
-        "status_time", "view_build", "view_editor", "view_novel", "view_outline",
+        "status_time", "view_build", "view_editor", "view_novel", "view_outline", "view_search",
 
         # Class Icons
         "cls_archive", "cls_character", "cls_custom", "cls_entity", "cls_none", "cls_novel",
@@ -448,8 +518,8 @@ class GuiIcons:
         "search_regex", "search_word",
 
         # Format Icons
-        "fmt_bold", "fmt_bold-md", "fmt_italic", "fmt_italic-md", "fmt_strike", "fmt_strike-md",
-        "fmt_subscript", "fmt_superscript", "fmt_underline",
+        "fmt_bold", "fmt_bold-md", "fmt_italic", "fmt_italic-md", "fmt_mark", "fmt_strike",
+        "fmt_strike-md", "fmt_subscript", "fmt_superscript", "fmt_underline",
 
         # General Button Icons
         "add", "add_document", "backward", "bookmark", "browse", "checked", "close", "cross",
@@ -460,6 +530,7 @@ class GuiIcons:
         # Switches
         "sticky-on", "sticky-off",
         "bullet-on", "bullet-off",
+        "unfold-show", "unfold-hide",
 
         # Decorations
         "deco_doc_h0", "deco_doc_h1", "deco_doc_h2", "deco_doc_h3", "deco_doc_h4", "deco_doc_more",
@@ -470,6 +541,7 @@ class GuiIcons:
     TOGGLE_ICON_KEYS: dict[str, tuple[str, str]] = {
         "sticky": ("sticky-on", "sticky-off"),
         "bullet": ("bullet-on", "bullet-off"),
+        "unfold": ("unfold-show", "unfold-hide"),
     }
 
     IMAGE_MAP: dict[str, tuple[str, str]] = {
@@ -491,6 +563,9 @@ class GuiIcons:
         self._confName = "icons.conf"
         self._iconPath = CONFIG.assetPath("icons")
 
+        # None Icon
+        self._noIcon = QIcon(str(self._iconPath / "none.svg"))
+
         # Icon Theme Meta
         self.themeName        = ""
         self.themeDescription = ""
@@ -621,13 +696,13 @@ class GuiIcons:
     def getToggleIcon(self, name: str, size: tuple[int, int]) -> QIcon:
         """Return a toggle icon from the icon buffer. or load it."""
         if name in self.TOGGLE_ICON_KEYS:
-            pOne  = self.getPixmap(self.TOGGLE_ICON_KEYS[name][0], size)
+            pOne = self.getPixmap(self.TOGGLE_ICON_KEYS[name][0], size)
             pTwo = self.getPixmap(self.TOGGLE_ICON_KEYS[name][1], size)
             icon = QIcon()
             icon.addPixmap(pOne, QIcon.Mode.Normal, QIcon.State.On)
             icon.addPixmap(pTwo, QIcon.Mode.Normal, QIcon.State.Off)
             return icon
-        return QIcon()
+        return self._noIcon
 
     def getPixmap(self, name: str, size: tuple[int, int]) -> QPixmap:
         """Return an icon from the icon buffer as a QPixmap. If it
@@ -638,7 +713,7 @@ class GuiIcons:
     def getItemIcon(self, tType: nwItemType, tClass: nwItemClass,
                     tLayout: nwItemLayout, hLevel: str = "H0") -> QIcon:
         """Get the correct icon for a project item based on type, class
-        and header level
+        and heading level
         """
         iconName = None
         if tType == nwItemType.ROOT:
@@ -659,14 +734,14 @@ class GuiIcons:
             elif tLayout == nwItemLayout.NOTE:
                 iconName = "proj_note"
         if iconName is None:
-            return QIcon()
+            return self._noIcon
 
         return self.getIcon(iconName)
 
     def getHeaderDecoration(self, hLevel: int) -> QPixmap:
-        """Get the decoration for a specific header level."""
+        """Get the decoration for a specific heading level."""
         if not self._headerDec:
-            iPx = self.mainTheme.baseIconSize
+            iPx = self.mainTheme.baseIconHeight
             self._headerDec = [
                 self.loadDecoration("deco_doc_h0", h=iPx),
                 self.loadDecoration("deco_doc_h1", h=iPx),
@@ -677,9 +752,9 @@ class GuiIcons:
         return self._headerDec[minmax(hLevel, 0, 4)]
 
     def getHeaderDecorationNarrow(self, hLevel: int) -> QPixmap:
-        """Get the narrow decoration for a specific header level."""
+        """Get the narrow decoration for a specific heading level."""
         if not self._headerDecNarrow:
-            iPx = self.mainTheme.baseIconSize
+            iPx = self.mainTheme.baseIconHeight
             self._headerDecNarrow = [
                 self.loadDecoration("deco_doc_h0_n", h=iPx),
                 self.loadDecoration("deco_doc_h1_n", h=iPx),
@@ -700,7 +775,7 @@ class GuiIcons:
         """
         if name not in self.ICON_KEYS:
             logger.error("Requested unknown icon name '%s'", name)
-            return QIcon()
+            return self._noIcon
 
         # If we just want the app icons, return right away
         if name == "novelwriter":
@@ -716,7 +791,7 @@ class GuiIcons:
         # If we didn't find one, give up and return an empty icon
         logger.warning("Did not load an icon for '%s'", name)
 
-        return QIcon()
+        return self._noIcon
 
 # END Class GuiIcons
 
@@ -725,6 +800,13 @@ class GuiIcons:
 #  Module Functions
 # =============================================================================================== #
 
+
+def _sortTheme(data: tuple[str, str]) -> str:
+    """Key function for theme sorting."""
+    key, name = data
+    return f"*{name}" if key.startswith("default_") else name
+
+
 def _loadInternalName(confParser: NWConfigParser, confFile: str | Path) -> str:
     """Open a conf file and read the 'name' setting."""
     try: