Veronica Berglyd Olsen
178 lines
5.7 KiB
Python
178 lines
5.7 KiB
Python
"""
|
||
novelWriter – Types and Flags
|
||
=============================
|
||
|
||
File History:
|
||
Created: 2024-04-01 [2.4rc1]
|
||
|
||
This file is a part of novelWriter
|
||
Copyright (C) 2024 Veronica Berglyd Olsen and novelWriter contributors
|
||
|
||
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/>.
|
||
"""
|
||
from __future__ import annotations
|
||
|
||
from typing import Any, TypeVar
|
||
|
||
from PyQt6.QtCore import Qt
|
||
from PyQt6.QtGui import QColor, QFont, QPainter, QTextCharFormat, QTextCursor, QTextFormat
|
||
from PyQt6.QtWidgets import QDialog, QDialogButtonBox, QHeaderView, QSizePolicy, QStyle
|
||
|
||
# Qt Alignment Flags
|
||
|
||
QtAlignAbsolute = Qt.AlignmentFlag.AlignAbsolute
|
||
QtAlignCenter = Qt.AlignmentFlag.AlignCenter
|
||
QtAlignCenterTop = Qt.AlignmentFlag.AlignHCenter | Qt.AlignmentFlag.AlignTop
|
||
QtAlignJustify = Qt.AlignmentFlag.AlignJustify
|
||
QtAlignLeft = Qt.AlignmentFlag.AlignLeft
|
||
QtAlignLeftBase = Qt.AlignmentFlag.AlignLeft | Qt.AlignmentFlag.AlignBaseline
|
||
QtAlignLeftMiddle = Qt.AlignmentFlag.AlignLeft | Qt.AlignmentFlag.AlignVCenter
|
||
QtAlignLeftTop = Qt.AlignmentFlag.AlignLeft | Qt.AlignmentFlag.AlignTop
|
||
QtAlignMiddle = Qt.AlignmentFlag.AlignVCenter
|
||
QtAlignRight = Qt.AlignmentFlag.AlignRight
|
||
QtAlignRightBase = Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignBaseline
|
||
QtAlignRightMiddle = Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignVCenter
|
||
QtAlignRightTop = Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignTop
|
||
QtAlignTop = Qt.AlignmentFlag.AlignTop
|
||
|
||
QtVAlignNormal = QTextCharFormat.VerticalAlignment.AlignNormal
|
||
QtVAlignSub = QTextCharFormat.VerticalAlignment.AlignSubScript
|
||
QtVAlignSuper = QTextCharFormat.VerticalAlignment.AlignSuperScript
|
||
|
||
# Qt Text Formats
|
||
|
||
QtPageBreakBefore = QTextFormat.PageBreakFlag.PageBreak_AlwaysBefore
|
||
QtPageBreakAfter = QTextFormat.PageBreakFlag.PageBreak_AlwaysAfter
|
||
|
||
QtPropLineHeight = 1 # QTextBlockFormat.LineHeightTypes.ProportionalHeight
|
||
|
||
# Qt Painter Types
|
||
|
||
QtTransparent = QColor(0, 0, 0, 0)
|
||
QtBlack = QColor(0, 0, 0)
|
||
QtNoBrush = Qt.BrushStyle.NoBrush
|
||
QtNoPen = Qt.PenStyle.NoPen
|
||
QtRoundCap = Qt.PenCapStyle.RoundCap
|
||
QtSolidLine = Qt.PenStyle.SolidLine
|
||
QtPaintAntiAlias = QPainter.RenderHint.Antialiasing
|
||
QtMouseOver = QStyle.StateFlag.State_MouseOver
|
||
QtSelected = QStyle.StateFlag.State_Selected
|
||
|
||
# Qt Colour Types
|
||
|
||
QtHexRgb = QColor.NameFormat.HexRgb
|
||
|
||
# Qt Tree and Table Types
|
||
|
||
QtDecoration = Qt.ItemDataRole.DecorationRole
|
||
QtUserRole = Qt.ItemDataRole.UserRole
|
||
|
||
# Keyboard and Mouse Buttons
|
||
|
||
QtModCtrl = Qt.KeyboardModifier.ControlModifier
|
||
QtModNone = Qt.KeyboardModifier.NoModifier
|
||
QtModShift = Qt.KeyboardModifier.ShiftModifier
|
||
QtMouseLeft = Qt.MouseButton.LeftButton
|
||
QtMouseMiddle = Qt.MouseButton.MiddleButton
|
||
|
||
# Dialog Button Box Types
|
||
|
||
QtAccepted = QDialog.DialogCode.Accepted
|
||
QtRejected = QDialog.DialogCode.Rejected
|
||
|
||
QtDialogApply = QDialogButtonBox.StandardButton.Apply
|
||
QtDialogCancel = QDialogButtonBox.StandardButton.Cancel
|
||
QtDialogClose = QDialogButtonBox.StandardButton.Close
|
||
QtDialogOk = QDialogButtonBox.StandardButton.Ok
|
||
QtDialogReset = QDialogButtonBox.StandardButton.Reset
|
||
QtDialogSave = QDialogButtonBox.StandardButton.Save
|
||
|
||
QtRoleAccept = QDialogButtonBox.ButtonRole.AcceptRole
|
||
QtRoleAction = QDialogButtonBox.ButtonRole.ActionRole
|
||
QtRoleApply = QDialogButtonBox.ButtonRole.ApplyRole
|
||
QtRoleReject = QDialogButtonBox.ButtonRole.RejectRole
|
||
|
||
# Cursor Types
|
||
|
||
QtKeepAnchor = QTextCursor.MoveMode.KeepAnchor
|
||
QtMoveAnchor = QTextCursor.MoveMode.MoveAnchor
|
||
QtMoveLeft = QTextCursor.MoveOperation.Left
|
||
QtMoveRight = QTextCursor.MoveOperation.Right
|
||
|
||
# Size Policy
|
||
|
||
QtSizeExpanding = QSizePolicy.Policy.Expanding
|
||
QtSizeFixed = QSizePolicy.Policy.Fixed
|
||
QtSizeIgnored = QSizePolicy.Policy.Ignored
|
||
QtSizeMinimum = QSizePolicy.Policy.Minimum
|
||
QtSizeMinimumExpanding = QSizePolicy.Policy.MinimumExpanding
|
||
|
||
# Resize Mode
|
||
|
||
QtHeaderStretch = QHeaderView.ResizeMode.Stretch
|
||
QtHeaderToContents = QHeaderView.ResizeMode.ResizeToContents
|
||
QtHeaderFixed = QHeaderView.ResizeMode.Fixed
|
||
|
||
# Scroll Bar Policy
|
||
|
||
QtScrollAlwaysOff = Qt.ScrollBarPolicy.ScrollBarAlwaysOff
|
||
QtScrollAsNeeded = Qt.ScrollBarPolicy.ScrollBarAsNeeded
|
||
|
||
# Maps
|
||
|
||
FONT_WEIGHTS: dict[int, int] = {
|
||
QFont.Weight.Thin: 100,
|
||
QFont.Weight.ExtraLight: 200,
|
||
QFont.Weight.Light: 300,
|
||
QFont.Weight.Normal: 400,
|
||
QFont.Weight.Medium: 500,
|
||
QFont.Weight.DemiBold: 600,
|
||
QFont.Weight.Bold: 700,
|
||
QFont.Weight.ExtraBold: 800,
|
||
QFont.Weight.Black: 900,
|
||
}
|
||
|
||
FONT_STYLE: dict[QFont.Style, str] = {
|
||
QFont.Style.StyleNormal: "normal",
|
||
QFont.Style.StyleItalic: "italic",
|
||
QFont.Style.StyleOblique: "oblique",
|
||
}
|
||
|
||
##
|
||
# Decorators and MetaClasses
|
||
##
|
||
|
||
T_ = TypeVar("T_", bound=object)
|
||
|
||
|
||
def nwDataClass(cls: T_) -> T_:
|
||
"""A simple data class decorator that generates slots automatically
|
||
and creates an init function to match.
|
||
"""
|
||
|
||
def wrap(cls: T_) -> T_:
|
||
fields = tuple(a for a in dir(cls) if not a.startswith("__"))
|
||
values = {a: getattr(cls, a) for a in fields}
|
||
|
||
def init(self: Any) -> None:
|
||
nonlocal values
|
||
for a, v in values.items():
|
||
self.__setattr__(a, v)
|
||
|
||
return type(cls.__class__.__name__, (object,), { # type: ignore
|
||
"__slots__": fields, "__init__": init
|
||
})
|
||
|
||
return wrap(cls)
|