HAL - Connections To UI Elements

"""
HAL Button
----------

Button for setting `bit` HAL pin values.

.. table:: Generated HAL Pins

    ========================= ===== =========
    HAL Pin Name              Type  Direction
    ========================= ===== =========
    qtpyvcp.button.enable     bit   in
    qtpyvcp.button.out        bit   out
    ========================= ===== =========
"""

"""
Added btnAsIndicator Setup for HalButton to act as an indicator vs button

You will need to set a stylesheet property for how the indicator will appear when checked for
each HalButton Instance used. 

Example:

HalButton:checked{
background-color: rgb(0,190,0);
font: 12pt "Ubuntu";
border-color: rgb(83, 83, 83);
border-radius: 7px;
color: white;
}

HalButton{
background-color: rgb(17, 0, 30);
font: 12pt "Ubuntu";
border-color: rgb(83, 83, 83);
border-radius: 7px;
color: white;
}
"""

from qtpy.QtCore import Property, QTimer
from qtpy.QtWidgets import QPushButton

from qtpyvcp import hal
from qtpyvcp.widgets import HALWidget


class HalButton(QPushButton, HALWidget):
    """HAL Button"""
    def __init__(self, parent=None):
        super(HalButton, self).__init__(parent)

        self.setText("HAL Button")

        self._enable_pin = None
        self._pressed_pin = None
        self._checked_pin = None

        self._pulse = False
        self._pulse_duration = 100
        self.pulse_timer = None
        
        """ Additonal Variable Added """
        # Used to initalize the value of the btnAsIndicator BOOL
        self._indicator = False

        self.pressed.connect(self.onPress)
        self.released.connect(self.onRelease)
        self.toggled.connect(self.onCheckedStateChanged)

    def onPress(self):
        if self._pressed_pin is not None:
            self._pressed_pin.value = True
        if self._pulse:
            self.pulse_timer.start(self._pulse_duration)

    def onRelease(self):
        if self._pressed_pin is not None:
            self._pressed_pin.value = False

    def onCheckedStateChanged(self, checked):
        if self._checked_pin is not None:
            self._checked_pin.value = checked

    @Property(bool)
    def pulseOnPress(self):
        """If active, when the button is pressed the ``out`` pin will be `True`
        for :class:`.pulseDuration` ms, otherwise the ``out`` pin will
        be `True` for the duration of the button press.
        """
        return self._pulse

    @pulseOnPress.setter
    def pulseOnPress(self, pulse):
        self._pulse = pulse

    """ Add Property btnAsIndicator """
    # Will be present as a HalButton Property
    @Property(bool)
    def btnAsIndicator(self):
        return self._indicator

    """ Setter for new Property """
    # Set btnAsIndicator variable to True or False based on property selection
    @btnAsIndicator.setter
    def btnAsIndicator(self, indicator):
        self._indicator = indicator

    @Property(int)
    def pulseDuration(self):
        """Pulse duration in ms used when :class:`.pulseOnPress` is active."""
        return self._pulse_duration

    @pulseDuration.setter
    def pulseDuration(self, duration):
        self._pulse_duration = duration

    def initialize(self):
        comp = hal.COMPONENTS['qtpyvcp']
        obj_name = str(self.objectName()).replace('_', '-')

        """ NO CHANGE """
        # add button.enable HAL pin
        self._enable_pin = comp.addPin(obj_name + ".enable", "bit", "in")
        self._enable_pin.value = self.isEnabled()
        self._enable_pin.valueChanged.connect(self.setEnabled)

        # add button.out HAL pin
        """ Decide Button Type Out or Indicator """
        # Must bypass setting if no output is required as with an Indicator
        if not self._indicator:
            self._pressed_pin = comp.addPin(obj_name + ".out", "bit", "out")

        """ MAGIC """
        # Here we decide how to handle the Out or Indicator Question???
        # add checkbox.checked HAL pin
        ### If the btnAsIndicator Property is NOT checked then it's an Output
        if not self._indicator:
            self._checked_pin = comp.addPin(obj_name + ".checked", "bit", "out")
            self._checked_pin.value = self.isChecked()
        else:
            # Connect the setChecked method to the HalButton and change from out to in.
            # notice the change to addPin(obj_name + ".checked", "bit", "in")
            # vs addPin(obj_name + ".checked", "bit", "out")
            self._checked_pin = comp.addPin(obj_name + ".checked", "bit", "in")
            self._checked_pin.value = self.isChecked()
            # Set the button to checked
            self._checked_pin.valueChanged.connect(self.setChecked)

        if self._pulse:
            self.pulse_timer = QTimer()
            self.pulse_timer.setSingleShot(True)
            self.pulse_timer.timeout.connect(self.onRelease)

HalLabel:enabled{
background-color: rgb(0,190,0);
font: 12pt "Ubuntu";
border-color: rgb(83, 83, 83);
border-radius: 7px;
color: white;
}

HalLabel{
background-color: rgb(17, 0, 30);
font: 12pt "Ubuntu";
border-color: rgb(83, 83, 83);
border-radius: 7px;
color: white;
}

HalLabel:enabled[indicator="true"]{
background-color: rgb(0,190,0);
font: 12pt "Ubuntu";
border-color: rgb(83, 83, 83);
border-radius: 7px;
color: white;
}

HalLabel[indicator="true"]{
background-color: rgb(17, 0, 30);
font: 12pt "Ubuntu";
border-color: rgb(83, 83, 83);
border-radius: 7px;
color: white;
}