UI ToggleSwitch for Enable/disable states

Author: nvandamme

ui/opensnitch/plugins/list_subscriptions/_gui.py

@@ -119,6 +119,223 @@ def initStyleOption(self, option, index):
         )
 
 
+class ToggleSwitch(QtWidgets.QCheckBox):
+    def __init__(
+        self,
+        text: str = "",
+        parent: QtWidgets.QWidget | None = None,
+    ):
+        super().__init__(text, parent)
+        self._base_text = text
+        self._track_width = 38
+        self._track_height = 22
+        self._thumb_diameter = 16
+        self._label_gap = 8
+        self._outer_padding = 4
+        self._paint_margin = 1.5
+        self._focus_margin = 2.0
+        self.setCursor(QtCore.Qt.CursorShape.PointingHandCursor)
+        self.setFocusPolicy(QtCore.Qt.FocusPolicy.StrongFocus)
+        self.setSizePolicy(
+            QtWidgets.QSizePolicy.Policy.Preferred,
+            QtWidgets.QSizePolicy.Policy.Fixed,
+        )
+        self.setContentsMargins(
+            self._outer_padding,
+            self._outer_padding,
+            self._outer_padding,
+            self._outer_padding,
+        )
+        self.toggled.connect(self._refresh_geometry)
+        font = self.font()
+        font.setBold(True)
+        self.setFont(font)
+        self._refresh_geometry(self.isChecked())
+
+    def sizeHint(self) -> QtCore.QSize:
+        metrics = self.fontMetrics()
+        label_text = self._display_text()
+        text_width = metrics.horizontalAdvance(label_text) if label_text else 0
+        width = self._track_width + int(self._focus_margin * 2) + text_width
+        if text_width:
+            width += self._label_gap
+        margins = self.contentsMargins()
+        width += margins.left() + margins.right()
+        height = max(
+            metrics.height(),
+            self._track_height + int(self._focus_margin * 2),
+        )
+        height += margins.top() + margins.bottom()
+        return QtCore.QSize(width, height)
+
+    def minimumSizeHint(self) -> QtCore.QSize:
+        return self.sizeHint()
+
+    def hitButton(self, pos: QtCore.QPoint) -> bool:
+        return self.rect().contains(pos)
+
+    def _refresh_geometry(self, _checked: bool):
+        self.setMinimumHeight(self.sizeHint().height())
+        self.updateGeometry()
+        self.update()
+
+    def _display_text(self) -> str:
+        base = (self._base_text or "").strip()
+        if base.lower() == "enable list subscriptions plugin":
+            state = QC.translate(
+                "stats",
+                "enabled" if self.isChecked() else "disabled",
+            )
+            return QC.translate(
+                "stats",
+                "List subscriptions plugin {0}",
+            ).format(state)
+        if base.lower() in {"enabled", "disabled"}:
+            return QC.translate(
+                "stats",
+                "Enabled" if self.isChecked() else "Disabled",
+            )
+        return base
+
+    def paintEvent(self, event: QtGui.QPaintEvent):  # type: ignore[override]
+        del event
+        painter = QtGui.QPainter(self)
+        painter.setRenderHint(QtGui.QPainter.RenderHint.Antialiasing)
+
+        margins = self.contentsMargins()
+        content_rect = self.rect().adjusted(
+            margins.left(),
+            margins.top(),
+            -margins.right(),
+            -margins.bottom(),
+        )
+        track_x = content_rect.left() + self._paint_margin + self._focus_margin
+        track_y = (
+            content_rect.top()
+            + (content_rect.height() - self._track_height) / 2.0
+            + self._paint_margin
+        )
+        track_rect = QtCore.QRectF(
+            track_x,
+            track_y,
+            self._track_width - (self._paint_margin * 2.0),
+            self._track_height - (self._paint_margin * 2.0),
+        )
+        thumb_margin = (track_rect.height() - self._thumb_diameter) / 2.0
+        thumb_left_off = track_rect.left() + thumb_margin
+        thumb_left_on = track_rect.right() - thumb_margin - self._thumb_diameter
+        thumb_rect = QtCore.QRectF(
+            thumb_left_on if self.isChecked() else thumb_left_off,
+            track_rect.top() + thumb_margin,
+            self._thumb_diameter,
+            self._thumb_diameter,
+        )
+
+        palette = self.palette()
+        is_dark = palette.color(QtGui.QPalette.ColorRole.Window).lightness() < 128
+        if self.isEnabled():
+            off_role = (
+                QtGui.QPalette.ColorRole.Midlight
+                if is_dark
+                else QtGui.QPalette.ColorRole.Mid
+            )
+            border_role = (
+                QtGui.QPalette.ColorRole.Light
+                if is_dark
+                else QtGui.QPalette.ColorRole.Dark
+            )
+            track_color = (
+                palette.color(QtGui.QPalette.ColorRole.Highlight)
+                if self.isChecked()
+                else palette.color(off_role)
+            )
+            thumb_color = palette.color(QtGui.QPalette.ColorRole.Base)
+            text_color = palette.color(QtGui.QPalette.ColorRole.WindowText)
+            border_color = palette.color(border_role)
+        else:
+            track_color = palette.color(QtGui.QPalette.ColorRole.Dark)
+            thumb_color = palette.color(QtGui.QPalette.ColorRole.Mid)
+            text_color = palette.color(QtGui.QPalette.ColorRole.Mid)
+            border_color = palette.color(QtGui.QPalette.ColorRole.Mid)
+
+        border_pen = QtGui.QPen(border_color)
+        border_pen.setWidth(1)
+        painter.setPen(border_pen)
+        painter.setBrush(track_color)
+        radius = track_rect.height() / 2.0
+        painter.drawRoundedRect(track_rect, radius, radius)
+        thumb_border_pen = QtGui.QPen(border_color)
+        thumb_border_pen.setWidth(1)
+        painter.setPen(thumb_border_pen)
+        painter.setBrush(thumb_color)
+        painter.drawEllipse(thumb_rect)
+
+        label_text = self._display_text()
+        if label_text:
+            text_rect = QtCore.QRectF(
+                track_rect.right() + self._label_gap,
+                content_rect.top(),
+                max(0.0, content_rect.right() - track_rect.right() - self._label_gap),
+                content_rect.height(),
+            )
+            painter.setPen(text_color)
+            painter.drawText(
+                text_rect,
+                int(
+                    QtCore.Qt.AlignmentFlag.AlignLeft
+                    | QtCore.Qt.AlignmentFlag.AlignVCenter
+                ),
+                label_text,
+            )
+
+        if self.hasFocus():
+            focus_pen = QtGui.QPen(palette.color(QtGui.QPalette.ColorRole.Highlight))
+            focus_pen.setWidth(1)
+            painter.setPen(focus_pen)
+            painter.setBrush(QtCore.Qt.BrushStyle.NoBrush)
+            painter.drawRoundedRect(
+                track_rect.adjusted(
+                    -self._focus_margin,
+                    -self._focus_margin,
+                    self._focus_margin,
+                    self._focus_margin,
+                ),
+                radius + self._focus_margin,
+                radius + self._focus_margin,
+            )
+
+
+def _replace_checkbox_with_toggle(
+    checkbox: QtWidgets.QCheckBox,
+) -> ToggleSwitch:
+    toggle = ToggleSwitch(checkbox.text(), checkbox.parentWidget())
+    toggle.setObjectName(checkbox.objectName())
+    toggle.setChecked(checkbox.isChecked())
+    toggle.setEnabled(checkbox.isEnabled())
+    toggle.setToolTip(checkbox.toolTip())
+    toggle.setStatusTip(checkbox.statusTip())
+    toggle.setWhatsThis(checkbox.whatsThis())
+    toggle.setAccessibleName(checkbox.accessibleName())
+    toggle.setAccessibleDescription(checkbox.accessibleDescription())
+    toggle.setSizePolicy(checkbox.sizePolicy())
+    toggle.setMinimumSize(checkbox.minimumSize())
+    toggle.setMaximumSize(checkbox.maximumSize())
+    margins = checkbox.contentsMargins()
+    toggle.setContentsMargins(
+        max(toggle.contentsMargins().left(), margins.left()),
+        max(toggle.contentsMargins().top(), margins.top()),
+        max(toggle.contentsMargins().right(), margins.right()),
+        max(toggle.contentsMargins().bottom(), margins.bottom()),
+    )
+    parent = checkbox.parentWidget()
+    layout = parent.layout() if parent is not None else None
+    if layout is not None:
+        layout.replaceWidget(checkbox, toggle)
+    checkbox.hide()
+    checkbox.deleteLater()
+    return toggle
+
+
 class SubscriptionDialog(QtWidgets.QDialog, SubscriptionDialogUI):
     _url_test_finished = QtCore.pyqtSignal(bool, str)
 
@@ -245,6 +462,7 @@ def __init__(
 
     def _build_ui(self):
         self.setupUi(self)
+        self.enabled_check = _replace_checkbox_with_toggle(self.enabled_check)
         self._set_dialog_message("", error=False)
         self.rootLayout.setContentsMargins(0, 0, 0, 0)
         self.rootLayout.setSpacing(0)
@@ -847,7 +1065,7 @@ def _build_ui(self):
         expanding = QtWidgets.QSizePolicy.Policy.Expanding
         fixed = QtWidgets.QSizePolicy.Policy.Fixed
 
-        self.enabled_value = QtWidgets.QCheckBox(QC.translate("stats", "Enabled"))
+        self.enabled_value = ToggleSwitch(QC.translate("stats", "Enabled"))
         self.enabled_value.setSizePolicy(expanding, fixed)
 
         self.group_value = QtWidgets.QComboBox()
@@ -1261,6 +1479,9 @@ def closeEvent(self, event: QtGui.QCloseEvent):  # type: ignore
 
     def _build_ui(self):
         self.setupUi(self)
+        self.enable_plugin_check = _replace_checkbox_with_toggle(
+            self.enable_plugin_check
+        )
         self.setWindowTitle(QC.translate("stats", "List subscriptions"))
         self.resize(1180, 680)
         self.rootLayout.setContentsMargins(0, 0, 0, 0)