Annotate config class and extensions

novelwriter/extensions/switch.py

@@ -23,9 +23,9 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
 """
 from __future__ import annotations
 
-from PyQt5.QtGui import QPainter
-from PyQt5.QtCore import Qt, QRectF, QPropertyAnimation, pyqtProperty
-from PyQt5.QtWidgets import QSizePolicy, QAbstractButton
+from PyQt5.QtGui import QMouseEvent, QPainter, QPaintEvent, QResizeEvent
+from PyQt5.QtCore import QEvent, QPropertyAnimation, QRectF, Qt, pyqtProperty
+from PyQt5.QtWidgets import QAbstractButton, QSizePolicy, QWidget
 
 from novelwriter import CONFIG
 from novelwriter.constants import nwUnicode
@@ -33,7 +33,8 @@ from novelwriter.constants import nwUnicode
 
 class NSwitch(QAbstractButton):
 
-    def __init__(self, parent=None, width=None, height=None):
+    def __init__(self, parent: QWidget | None = None,
+                 width: int | None = None, height: int | None = None) -> None:
         super().__init__(parent=parent)
 
         if width is None:
@@ -64,12 +65,12 @@ class NSwitch(QAbstractButton):
     #  Properties
     ##
 
-    @pyqtProperty(int)
-    def offset(self):
+    @pyqtProperty(int)  # type: ignore
+    def offset(self) -> int:  # type: ignore
         return self._offset
 
-    @offset.setter
-    def offset(self, offset):
+    @offset.setter  # type: ignore
+    def offset(self, offset: int):
         self._offset = offset
         self.update()
         return
@@ -78,33 +79,30 @@ class NSwitch(QAbstractButton):
     #  Getters and Setters
     ##
 
-    def setChecked(self, checked):
-        """Overload setChecked to also alter the offset.
-        """
+    def setChecked(self, checked: bool) -> None:
+        """Overload setChecked to also alter the offset."""
         super().setChecked(checked)
         if checked:
-            self.offset = self._xW - self._xR
+            self._offset = self._xW - self._xR
         else:
-            self.offset = self._xR
+            self._offset = self._xR
         return
 
     ##
     #  Events
     ##
 
-    def resizeEvent(self, event):
-        """Overload resize to ensure correct offset.
-        """
+    def resizeEvent(self, event: QResizeEvent) -> None:
+        """Overload resize to ensure correct offset."""
         super().resizeEvent(event)
         if self.isChecked():
-            self.offset = self._xW - self._xR
+            self._offset = self._xW - self._xR
         else:
-            self.offset = self._xR
+            self._offset = self._xR
         return
 
-    def paintEvent(self, event):
-        """Drawing the switch itself.
-        """
+    def paintEvent(self, event: QPaintEvent) -> None:
+        """Drawing the switch itself."""
         qPaint = QPainter(self)
         qPaint.setRenderHint(QPainter.Antialiasing, True)
         qPaint.setPen(Qt.NoPen)
@@ -134,27 +132,26 @@ class NSwitch(QAbstractButton):
         qPaint.drawRoundedRect(0, 0, self._xW, self._xH, self._xR, self._xR)
 
         qPaint.setBrush(thumbBrush)
-        qPaint.drawEllipse(self.offset - self._rR, self._rB, self._rH, self._rH)
+        qPaint.drawEllipse(self._offset - self._rR, self._rB, self._rH, self._rH)
 
         theFont = qPaint.font()
         theFont.setPixelSize(self._xT)
         qPaint.setPen(textColor)
         qPaint.setFont(theFont)
         qPaint.drawText(
-            QRectF(self.offset - self._rR, self._rB, self._rH, self._rH),
+            QRectF(self._offset - self._rR, self._rB, self._rH, self._rH),
             Qt.AlignCenter, thumbText
         )
 
         return
 
-    def mouseReleaseEvent(self, event):
-        """Animate the switch on mouse release.
-        """
+    def mouseReleaseEvent(self, event: QMouseEvent) -> None:
+        """Animate the switch on mouse release."""
         super().mouseReleaseEvent(event)
         if event.button() == Qt.LeftButton:
             doAnim = QPropertyAnimation(self, b"offset", self)
             doAnim.setDuration(120)
-            doAnim.setStartValue(self.offset)
+            doAnim.setStartValue(self._offset)
             if self.isChecked():
                 doAnim.setEndValue(self._xW - self._xR)
             else:
@@ -162,9 +159,8 @@ class NSwitch(QAbstractButton):
             doAnim.start()
         return
 
-    def enterEvent(self, event):
-        """Change the cursor when hovering the button.
-        """
+    def enterEvent(self, event: QEvent) -> None:
+        """Change the cursor when hovering the button."""
         self.setCursor(Qt.PointingHandCursor)
         super().enterEvent(event)
         return