Source code for pydm.widgets.pushbutton
import hashlib
from qtpy.QtGui import QColor
from qtpy.QtWidgets import QPushButton, QMessageBox, QInputDialog, QLineEdit, QStyle
from qtpy.QtCore import Slot
from qtpy import QtDesigner
from .base import PyDMWritableWidget, PostParentClassInitSetup
from pydm.utilities import IconFont
import logging
from pydm.utilities import ACTIVE_QT_WRAPPER, QtWrapperTypes
if ACTIVE_QT_WRAPPER == QtWrapperTypes.PYSIDE6:
from PySide6.QtCore import Property
else:
from PyQt5.QtCore import pyqtProperty as Property
logger = logging.getLogger(__name__)
[docs]class PyDMPushButton(QPushButton, PyDMWritableWidget):
"""
Basic PushButton to send a fixed value.
The PyDMPushButton is meant to hold a specific value, and send that value
to a channel when it is clicked, much like the MessageButton does in EDM.
The PyDMPushButton works in two different modes of operation, first, a
fixed value can be given to the :attr:`.pressValue` attribute, whenever the
button is clicked a signal containing this value will be sent to the
connected channel. This is the default behavior of the button. However, if
the :attr:`.relativeChange` is set to True, the fixed value will be added
to the current value of the channel. This means that the button will
increment a channel by a fixed amount with every click, a consistent
relative move
Parameters
----------
parent : QObject, optional
Parent of PyDMPushButton
label : str, optional
String to place on button
icon : QIcon, optional
An Icon to display on the PyDMPushButton
pressValue : int, float, str
Value to be sent when the button is clicked
relative : bool, optional
Choice to have the button perform a relative put, instead of always
setting to an absolute value
init_channel : str, optional
ID of channel to manipulate
"""
DEFAULT_CONFIRM_MESSAGE = "Are you sure you want to proceed?"
def __init__(
self, parent=None, label=None, icon=None, pressValue=None, releaseValue=None, relative=False, init_channel=None
):
if icon:
QPushButton.__init__(self, icon, label, parent)
elif label:
QPushButton.__init__(self, label, parent)
else:
QPushButton.__init__(self, parent)
PyDMWritableWidget.__init__(self, init_channel=init_channel)
self._pressValue = pressValue
self._releaseValue = releaseValue
self._relative = relative
self._alarm_sensitive_border = False
self._show_confirm_dialog = False
self._confirm_message = PyDMPushButton.DEFAULT_CONFIRM_MESSAGE
self._password_protected = False
self._password = ""
self._protected_password = ""
self._write_when_release = False
self._released = False
self.clicked.connect(self.sendValue)
# Standard icons (which come with the qt install, and work cross-platform),
# and icons from the "Font Awesome" icon set (https://fontawesome.com/)
# can not be set with a widget's "icon" property in designer, only in python.
# so we provide our own property to specify standard icons and set them with python in the prop's setter.
self._pydm_icon_name = ""
# The color of "Font Awesome" icons can be set,
# but standard icons are already colored and can not be set.
self._pydm_icon_color = QColor(90, 90, 90)
# Execute setup calls that must be done here in the widget class's __init__,
# and after it's parent __init__ calls have completed.
# (so we can avoid pyside6 throwing an error, see func def for more info)
PostParentClassInitSetup(self)
# On pyside6, we need to expilcity call pydm's base class's eventFilter() call or events
# will not propagate to the parent classes properly.
[docs] def readPyDMIcon(self) -> str:
"""
Name of icon to be set from Qt provided standard icons or from the fontawesome icon-set.
See "enum QStyle::StandardPixmap" in Qt's QStyle documentation for full list of usable standard icons.
See https://fontawesome.com/icons?d=gallery for list of usable fontawesome icons.
Returns
-------
str
"""
return self._pydm_icon_name
[docs] def setPyDMIcon(self, value: str) -> None:
"""
Name of icon to be set from Qt provided standard icons or from the "Font Awesome" icon-set.
See "enum QStyle::StandardPixmap" in Qt's QStyle documentation for full list of usable standard icons.
See https://fontawesome.com/icons?d=gallery for list of usable "Font Awesome" icons.
Parameters
----------
value : str
"""
if self._pydm_icon_name == value:
return
# We don't know if user is trying to use a standard icon or an icon from "Font Awesome",
# so 1st try to create a Font Awesome one, which hits exception if icon name is not valid.
try:
icon_f = IconFont()
i = icon_f.icon(value, color=self._pydm_icon_color)
self.setIcon(i)
except Exception:
icon = getattr(QStyle, value, None)
if icon:
self.setIcon(self.style().standardIcon(icon))
self._pydm_icon_name = value
PyDMIcon = Property(str, readPyDMIcon, setPyDMIcon)
[docs] def readPyDMIconColor(self) -> QColor:
"""
The color of the icon (color is only applied if using icon from the "Font Awesome" set)
Returns
-------
QColor
"""
return self._pydm_icon_color
[docs] def setPyDMIconColor(self, state_color: QColor) -> None:
"""
The color of the icon (color is only applied if using icon from the "Font Awesome" set)
Parameters
----------
new_color : QColor
"""
if state_color != self._pydm_icon_color:
self._pydm_icon_color = state_color
# apply the new color
try:
icon_f = IconFont()
i = icon_f.icon(self._pydm_icon_name, color=self._pydm_icon_color)
self.setIcon(i)
except Exception:
return
PyDMIconColor = Property(QColor, readPyDMIconColor, setPyDMIconColor)
[docs] def readPasswordProtected(self):
"""
Whether or not this button is password protected.
Returns
-------
bool
"""
return self._password_protected
[docs] def setPasswordProtected(self, value):
"""
Whether or not this button is password protected.
Parameters
----------
value : bool
"""
if self._password_protected != value:
self._password_protected = value
passwordProtected = Property(bool, readPasswordProtected, setPasswordProtected)
[docs] def readPassword(self) -> str:
"""
Password to be encrypted using SHA256.
.. warning::
To avoid issues exposing the password this method
always returns an empty string.
Returns
-------
str
"""
return ""
[docs] def setPassword(self, value) -> None:
"""
Password to be encrypted using SHA256.
Parameters
----------
value : str
The password to be encrypted
"""
if value is not None and value != "":
sha = hashlib.sha256()
sha.update(value.encode())
# Use the setter as it also checks whether the existing password is the same with the
# new one, and only updates if the new password is different
self.protectedPassword = sha.hexdigest()
# Make sure designer knows it should save the protectedPassword field
formWindow = QtDesigner.QDesignerFormWindowInterface.findFormWindow(self)
if formWindow:
formWindow.cursor().setProperty("protectedPassword", self.protectedPassword)
password = Property(str, readPassword, setPassword)
[docs] def readProtectedPassword(self) -> str:
"""
The encrypted password.
Returns
-------
str
"""
return self._protected_password
def setProtectedPassword(self, value) -> None:
if self._protected_password != value:
self._protected_password = value
protectedPassword = Property(str, readProtectedPassword, setProtectedPassword)
[docs] def readShowConfirmDialog(self) -> bool:
"""
Whether or not to display a confirmation dialog.
Returns
-------
bool
"""
return self._show_confirm_dialog
[docs] def setShowConfirmDialog(self, value) -> None:
"""
Whether or not to display a confirmation dialog.
Parameters
----------
value : bool
"""
if self._show_confirm_dialog != value:
self._show_confirm_dialog = value
showConfirmDialog = Property(bool, readShowConfirmDialog, setShowConfirmDialog)
[docs] def readConfirmMessage(self) -> str:
"""
Message to be displayed at the Confirmation dialog.
Returns
-------
str
"""
return self._confirm_message
[docs] def setConfirmMessage(self, value) -> None:
"""
Message to be displayed at the Confirmation dialog.
Parameters
----------
value : str
"""
if self._confirm_message != value:
self._confirm_message = value
confirmMessage = Property(str, readConfirmMessage, setConfirmMessage)
[docs] def readPressValue(self) -> str:
"""
This property holds the value to send back through the channel.
The type of this value does not matter because it is automatically
converted to match the preexisting value type of the channel. However,
the sign of the value matters for both the fixed and relative modes.
Returns
-------
str
"""
return str(self._pressValue)
[docs] def setPressValue(self, value) -> None:
"""
This property holds the value to send back through the channel.
The type of this value does not matter because it is automatically
converted to match the preexisting value type of the channel. However,
the sign of the value matters for both the fixed and relative modes.
Parameters
----------
value : str
"""
if str(value) != self._pressValue:
self._pressValue = str(value)
pressValue = Property(str, readPressValue, setPressValue)
[docs] def readReleaseValue(self) -> str:
"""
This property holds the value to send back through the channel.
The type of this value does not matter because it is automatically
converted to match the preexisting value type of the channel. However,
the sign of the value matters for both the fixed and relative modes.
Returns
-------
str
"""
return str(self._releaseValue)
[docs] def setReleaseValue(self, value) -> None:
"""
This property holds the value to send back through the channel.
The type of this value does not matter because it is automatically
converted to match the preexisting value type of the channel. However,
the sign of the value matters for both the fixed and relative modes.
Parameters
----------
value : str
"""
if str(value) != self._releaseValue:
self._releaseValue = str(value)
releaseValue = Property(str, readReleaseValue, setReleaseValue)
[docs] def readRelativeChange(self) -> bool:
"""
The mode of operation of the PyDMPushButton.
If set to True, the :attr:`pressValue` will be added to the current
value of the channel. If False, the :attr:`pressValue` will be sent
without any operation.
This flag will be ignored if the connected channel sends a str type
value to :meth:`.receiveValue`. This is designed to eliminate the
undesirable behavior of concatenating strings as opposed to doing
mathematical addition.
Returns
-------
bool
"""
return self._relative
[docs] def setRelativeChange(self, choice) -> None:
"""
The mode of operation of the PyDMPushButton.
If set to True, the :attr:`pressValue` will be added to the current
value of the channel. If False, the :attr:`pressValue` will be sent
without any operation.
This flag will be ignored if the connected channel sends a str type
value to :meth:`.receiveValue`. This is designed to eliminate the
undesirable behavior of concatenating strings as opposed to doing
mathematical addition.
Parameters
----------
choice : bool
"""
if self._relative != choice:
self._relative = choice
relativeChange = Property(bool, readRelativeChange, setRelativeChange)
[docs] def confirm_dialog(self, is_release=False):
"""
Show the confirmation dialog with the proper message in case
```showConfirmMessage``` is True.
Returns
-------
bool
True if the message was confirmed or if ```showCofirmMessage```
is False.
"""
if self._show_confirm_dialog:
if self._confirm_message == "":
self._confirm_message = PyDMPushButton.DEFAULT_CONFIRM_MESSAGE
msg = QMessageBox()
msg.setIcon(QMessageBox.Question)
if is_release:
pass
msg.setText(self._confirm_message)
# Force "Yes" button to be on the right (as on macOS) to follow common design practice
msg.setStyleSheet("button-layout: 1") # MacLayout
msg.setStandardButtons(QMessageBox.Yes | QMessageBox.No)
msg.setDefaultButton(QMessageBox.No)
ret = msg.exec_()
if ret == QMessageBox.No:
return False
return True
[docs] def validate_password(self):
"""
If the widget is ```passwordProtected```, this method will prompt
the user for the correct password.
Returns
-------
bool
True in case the password was correct of if the widget is not
password protected.
"""
if not self._password_protected:
return True
pwd, ok = QInputDialog().getText(None, "Authentication", "Please enter your password:", QLineEdit.Password, "")
pwd = str(pwd)
if not ok or pwd == "":
return False
sha = hashlib.sha256()
sha.update(pwd.encode())
pwd_encrypted = sha.hexdigest()
if pwd_encrypted != self._protected_password:
msg = QMessageBox()
msg.setIcon(QMessageBox.Critical)
msg.setText("Invalid password.")
msg.setWindowTitle("Error")
msg.setStandardButtons(QMessageBox.Ok)
msg.setDefaultButton(QMessageBox.Ok)
msg.setEscapeButton(QMessageBox.Ok)
msg.exec_()
return False
return True
[docs] @Slot()
def sendValue(self):
"""
Send a new value to the channel.
This function interprets the settings of the PyDMPushButton and sends
the appropriate value out through the :attr:`.send_value_signal`.
Returns
-------
None if any of the following condition is False:
1. There's no new value (pressValue) for the widget
2. There's no initial or current value for the widget
3. The confirmation dialog returns No as the user's answer to the dialog
4. The password validation dialog returns a validation error
Otherwise, return the value sent to the channel:
1. The value sent to the channel is the same as the pressValue if the existing
channel type is a str, or the relative flag is False
2. The value sent to the channel is the sum of the existing value and the pressValue
if the relative flag is True, and the channel type is not a str
"""
self._released = False
val = self.__execute_send(self._pressValue)
if self._show_confirm_dialog or self._password_protected:
self.__execute_send(self._releaseValue, is_release=True)
return val
def __execute_send(self, new_value, skip_confirm=False, skip_password=False, is_release=False):
"""
Execute the send operation for push and release.
Parameters
----------
new_value : int, float or str
skip_confirm : bool, Default False
Whether or not to skip the confirmation dialog.
skip_password : bool, Default False
Whether or not to skip the password dialog.
is_release : bool, Default False
Whether or not this method is being invoked to handle a release
event.
Returns
-------
"""
send_value = None
if new_value is None or self.value is None:
return None
if is_release and not self._write_when_release:
return None
if not skip_confirm:
if not self.confirm_dialog(is_release=is_release):
return None
if not skip_password:
if not self.validate_password():
return None
if not self._relative or self.channeltype == str:
send_value = new_value
self.send_value_signal[self.channeltype].emit(self.channeltype(send_value))
else:
send_value = self.value + self.channeltype(new_value)
self.send_value_signal[self.channeltype].emit(send_value)
return send_value
[docs] @Slot()
def sendReleaseValue(self):
"""
Send new release value to the channel.
This function interprets the settings of the PyDMPushButton and sends
the appropriate value out through the :attr:`.send_value_signal`.
Returns
-------
None if any of the following condition is False:
1. There's no new value (releaseValue) for the widget
2. There's no initial or current value for the widget
3. The confirmation dialog returns No as the user's answer to the dialog
4. The password validation dialog returns a validation error
5. writeWhenRelease is False
Otherwise, return the value sent to the channel:
1. The value sent to the channel is the same as the pressValue if the existing
channel type is a str, or the relative flag is False
2. The value sent to the channel is the sum of the existing value and the pressValue
if the relative flag is True, and the channel type is not a str
"""
self._released = True
if self._show_confirm_dialog or self._password_protected:
# This will be handled via our friend sendValue
return
self.__execute_send(self._releaseValue, is_release=True)
[docs] @Slot(int)
@Slot(float)
@Slot(str)
def updatePressValue(self, value):
"""
Update the pressValue of a function by passing a signal to the
PyDMPushButton.
This is useful to dynamically change the pressValue of the button
during runtime. This enables the applied value to be linked to the
state of a different widget, say a QLineEdit or QSlider
Parameters
----------
value : int, float or str
"""
try:
self.pressValue = self.channeltype(value)
except (ValueError, TypeError):
logger.error("'{0}' is not a valid pressValue for '{1}'.".format(value, self.channel))
[docs] def readWriteWhenRelease(self) -> bool:
"""
Whether or not to write releaseValue on release
Returns
-------
bool
"""
return self._write_when_release
[docs] def setWriteWhenRelease(self, value) -> None:
"""
Whether or not to write releaseValue on release
Parameters
----------
value : bool
"""
if self._write_when_release != value:
self._write_when_release = value
# update widget behavior based on write when release value
if self._write_when_release:
self.clicked.disconnect()
self.pressed.connect(self.sendValue)
self.released.connect(self.sendReleaseValue)
writeWhenRelease = Property(bool, readWriteWhenRelease, setWriteWhenRelease)
[docs] @Slot(int)
@Slot(float)
@Slot(str)
def updateReleaseValue(self, value):
"""
Update the releaseValue of a function by passing a signal to the
PyDMPushButton.
This is useful to dynamically change the releaseValue of the button
during runtime. This enables the applied value to be linked to the
state of a different widget, say a QLineEdit or QSlider
Parameters
----------
value : int, float or str
"""
try:
self.releaseValue = self.channeltype(value)
except (ValueError, TypeError):
logger.error("'{0}' is not a valid releaseValue for '{1}'.".format(value, self.channel))