""" novelWriter – Custom Widget: Modified Widgets ============================================= File History: Created: 2024-02-01 [2.3b1] NComboBox Created: 2024-02-01 [2.3b1] NSpinBox Created: 2024-02-01 [2.3b1] NDoubleSpinBox Created: 2024-05-01 [2.5b1] NToolDialog Created: 2024-05-01 [2.5b1] NNonBlockingDialog This file is a part of novelWriter Copyright 2018–2024, 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 . """ from __future__ import annotations from enum import Enum from typing import TYPE_CHECKING from PyQt5.QtCore import QSize, Qt, pyqtSignal, pyqtSlot from PyQt5.QtGui import QMouseEvent, QWheelEvent from PyQt5.QtWidgets import ( QApplication, QComboBox, QDialog, QDoubleSpinBox, QLabel, QSpinBox, QToolButton, QWidget ) from novelwriter import CONFIG, SHARED from novelwriter.types import QtMouseLeft if TYPE_CHECKING: # pragma: no cover from novelwriter.guimain import GuiMain class NDialog(QDialog): def softDelete(self) -> None: """Since calling deleteLater is sometimes not safe from Python, as the C++ object can be deleted before the Python process is done with the object, we instead set the dialog's parent to None so that it gets garbage collected when it runs out of scope. """ self.setParent(None) # type: ignore return @pyqtSlot() def reject(self) -> None: """Overload the reject slot and also call close.""" super().reject() self.close() return class NToolDialog(NDialog): def __init__(self, parent: GuiMain) -> None: super().__init__(parent=parent) self.setModal(False) if CONFIG.osDarwin: self.setWindowFlag(Qt.WindowType.Tool) return def activateDialog(self) -> None: """Helper function to activate dialog on various systems.""" self.show() if CONFIG.osWindows: self.activateWindow() self.raise_() QApplication.processEvents() return class NNonBlockingDialog(NDialog): def __init__(self, parent: QWidget | None = None) -> None: super().__init__(parent=parent) self.setModal(True) return def activateDialog(self) -> None: """Helper function to activate dialog on various systems.""" self.show() if CONFIG.osWindows: self.activateWindow() self.raise_() QApplication.processEvents() return class NComboBox(QComboBox): def __init__(self, parent: QWidget | None = None) -> None: super().__init__(parent=parent) self.setFocusPolicy(Qt.FocusPolicy.StrongFocus) return def wheelEvent(self, event: QWheelEvent) -> None: if self.hasFocus(): super().wheelEvent(event) else: event.ignore() return def setCurrentData(self, data: str | int | Enum, default: str | int | Enum) -> None: """Set the current index from data, with a fallback.""" idx = self.findData(data) self.setCurrentIndex(self.findData(default) if idx < 0 else idx) return class NSpinBox(QSpinBox): def __init__(self, parent: QWidget | None = None) -> None: super().__init__(parent=parent) self.setFocusPolicy(Qt.FocusPolicy.StrongFocus) return def wheelEvent(self, event: QWheelEvent) -> None: if self.hasFocus(): super().wheelEvent(event) else: event.ignore() return class NDoubleSpinBox(QDoubleSpinBox): def __init__( self, parent: QWidget | None = None, *, min: float = 0.0, max: float = 15.0, step: float = 0.1, prec: int = 2, ) -> None: super().__init__(parent=parent) self.setFocusPolicy(Qt.FocusPolicy.StrongFocus) self.setMinimum(min) self.setMaximum(max) self.setSingleStep(step) self.setDecimals(prec) return def wheelEvent(self, event: QWheelEvent) -> None: if self.hasFocus(): super().wheelEvent(event) else: event.ignore() return class NIconToolButton(QToolButton): def __init__(self, parent: QWidget, iconSize: QSize, icon: str | None = None) -> None: super().__init__(parent=parent) self.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly) self.setIconSize(iconSize) self.setPopupMode(QToolButton.ToolButtonPopupMode.InstantPopup) if icon: self.setThemeIcon(icon) return def setThemeIcon(self, iconKey: str) -> None: """Set an icon from the current theme.""" self.setIcon(SHARED.theme.getIcon(iconKey)) return class NIconToggleButton(QToolButton): def __init__(self, parent: QWidget, iconSize: QSize, icon: str | None = None) -> None: super().__init__(parent=parent) self.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly) self.setIconSize(iconSize) self.setPopupMode(QToolButton.ToolButtonPopupMode.InstantPopup) self.setCheckable(True) self.setStyleSheet("border: none; background: transparent;") if icon: self.setThemeIcon(icon) return def setThemeIcon(self, iconKey: str) -> None: """Set an icon from the current theme.""" iconSize = self.iconSize() self.setIcon(SHARED.theme.getToggleIcon(iconKey, (iconSize.width(), iconSize.height()))) return class NClickableLabel(QLabel): mouseClicked = pyqtSignal() def mousePressEvent(self, event: QMouseEvent) -> None: """Capture a left mouse click and emit its signal.""" if event.button() == QtMouseLeft: self.mouseClicked.emit() return super().mousePressEvent(event)