bec/bec_widgets
0
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-13 11:11:49 +02:00
Code Activity

feat(qt_utils): added warning utility with simple API to setup warning message

Browse Source
This commit is contained in:
wyzula_j
2024-07-16 17:34:35 +02:00
parent 9ce2279533
commit 5d1879e8e7
1 changed files with 46 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
bec_widgets/qt_utils/error_popups.py
View File

@ -5,6 +5,37 @@ from qtpy.QtCore import QObject, Qt, Signal, Slot
from qtpy.QtWidgets import QApplication, QMessageBox, QPushButton, QVBoxLayout, QWidget from qtpy.QtWidgets import QApplication, QMessageBox, QPushButton, QVBoxLayout, QWidget
class WarningPopupUtility(QObject):
"""
Utility class to show warning popups in the application.
"""
def __init__(self, parent=None):
super().__init__(parent)
@Slot(str, str, str, QWidget)
def show_warning_message(self, title, message, detailed_text, widget):
msg = QMessageBox(widget)
msg.setIcon(QMessageBox.Warning)
msg.setWindowTitle(title)
msg.setText(message)
msg.setStandardButtons(QMessageBox.Ok)
msg.setDetailedText(detailed_text)
msg.exec_()
def show_warning(self, title: str, message: str, detailed_text: str, widget: QWidget = None):
"""
Show a warning message with the given title, message, and detailed text.
Args:
title (str): The title of the warning message.
message (str): The main text of the warning message.
detailed_text (str): The detailed text to show when the user expands the message.
widget (QWidget): The parent widget for the message box.
"""
self.show_warning_message(title, message, detailed_text, widget)
class ErrorPopupUtility(QObject): class ErrorPopupUtility(QObject):
""" """
Utility class to manage error popups in the application to show error messages to the users. Utility class to manage error popups in the application to show error messages to the users.
@ -137,6 +168,7 @@ class ExampleWidget(QWidget): # pragma: no cover
def __init__(self, parent=None): def __init__(self, parent=None):
super().__init__(parent=parent) super().__init__(parent=parent)
self.init_ui() self.init_ui()
self.warning_utility = WarningPopupUtility(self)
def init_ui(self): def init_ui(self):
self.layout = QVBoxLayout(self) self.layout = QVBoxLayout(self)
@ -151,6 +183,11 @@ class ExampleWidget(QWidget): # pragma: no cover
self.normal_button.clicked.connect(self.method_without_error_handling) self.normal_button.clicked.connect(self.method_without_error_handling)
self.layout.addWidget(self.normal_button) self.layout.addWidget(self.normal_button)
# Button to trigger warning popup
self.warning_button = QPushButton("Trigger Warning", self)
self.warning_button.clicked.connect(self.trigger_warning)
self.layout.addWidget(self.warning_button)
@error_managed @error_managed
def method_with_error_handling(self): def method_with_error_handling(self):
"""This method raises an error and the exception is handled by the decorator.""" """This method raises an error and the exception is handled by the decorator."""
@ -160,6 +197,15 @@ class ExampleWidget(QWidget): # pragma: no cover
"""This method raises an error and the exception is not handled here.""" """This method raises an error and the exception is not handled here."""
raise ValueError("This is an unhandled error.") raise ValueError("This is an unhandled error.")
def trigger_warning(self):
"""Trigger a warning using the WarningPopupUtility."""
self.warning_utility.show_warning(
title="Warning",
message="This is a warning message.",
detailed_text="This is the detailed text of the warning message.",
widget=self,
)
if __name__ == "__main__": # pragma: no cover if __name__ == "__main__": # pragma: no cover