Source code for edifice.base_components.check_box

from __future__ import annotations

import typing as tp

from edifice.qt import QT_VERSION

from .base_components import CommandType, Element, QtWidgetElement, _ensure_future, _WidgetTree

if QT_VERSION == "PyQt6" and not tp.TYPE_CHECKING:
    from PyQt6 import QtCore, QtWidgets
else:
    from PySide6 import QtCore, QtWidgets


class EdCheckBox(QtWidgets.QCheckBox):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def nextCheckState(self):
        """
        https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QAbstractButton.html#PySide6.QtWidgets.QAbstractButton.nextCheckState

        We override this because we never want the button checked state to
        be set directly by the user.
        We always want the checked state to be set by the checked prop.
        The user can request a state change, but only the checked prop can
        set the state.
        """
        pass




class CheckBox(QtWidgetElement[EdCheckBox]):
    """Checkbox widget.

    * Underlying Qt Widget
      `QCheckBox <https://doc.qt.io/qtforpython-6/PySide6/QtWidgets/QCheckBox.html>`_

    .. figure:: /image/checkbox_dropdown.png
       :width: 300

       Checkbox on the left.

    A checkbox allows the user to specify some boolean state.

    The :code:`checked` prop determines the check-state of the widget.
    When the user toggles the check state, the :code:`on_change` callback is called
    with the requested new check state.

    Args:
        checked:
            Whether or not the CheckBox is checked.
        text:
            Text for the label of the CheckBox.
        on_change:
            Event handler for when the checked value changes, but
            only when the user checks or unchecks, not when the checked prop
            changes.
    """



    def __init__(
        self,
        checked: bool = False,
        text: str = "",
        on_change: tp.Callable[[bool], None | tp.Awaitable[None]] | None = None,
        **kwargs,
    ):
        super().__init__(**kwargs)
        self._register_props(
            {
                "checked": checked,
                "text": text,
                "on_change": on_change,
            },
        )
        self._register_props(kwargs)


    def _initialize(self):
        self.underlying = EdCheckBox(str(self.props.text))
        size = self.underlying.font().pointSize()
        self._set_size(size * len(self.props.text), size)
        self.underlying.setObjectName(str(id(self)))
        self.underlying.clicked.connect(self._on_clicked)

    def _on_clicked(self, checked):
        if self.props.on_change is not None:
            return _ensure_future(self.props.on_change)(not checked)

    def _set_checked(self, checked: bool):
        widget = tp.cast(EdCheckBox, self.underlying)
        widget.blockSignals(True)
        check_state = QtCore.Qt.CheckState.Checked if checked else QtCore.Qt.CheckState.Unchecked
        widget.setCheckState(check_state)
        widget.blockSignals(False)

    def _qt_update_commands(
        self,
        widget_trees: dict[Element, _WidgetTree],
        newprops,
    ):
        if self.underlying is None:
            self._initialize()
        assert self.underlying is not None
        widget = tp.cast(EdCheckBox, self.underlying)

        commands = super()._qt_update_commands_super(widget_trees, newprops, self.underlying)
        if "text" in newprops:
            commands.append(CommandType(widget.setText, str(newprops.text)))
        if "checked" in newprops:
            commands.append(CommandType(self._set_checked, newprops.checked))
        return commands