RTC Toolkit 6.0.0
Loading...
Searching...
No Matches
gui.taskfeedback.TaskFeedback Class Reference

Widget that contains a message, a transparent colored background, and a close button. More...

Inheritance diagram for gui.taskfeedback.TaskFeedback:

Public Member Functions

 __init__ (self, parent=None)
 Initializer for TaskFeedback.
 
 on_closeButton_clicked (self)
 Executed when the closeButton is pressed.
 
 show_info (self, str message)
 Shows an info message.
 
 show_error (self, str message)
 Shows an error message.
 
 install_filter_on (self, QObject obj)
 Installs a ResizeFilter on another QObject.
 

Public Attributes

 ui = Ui_TaskFeedback()
 
 hide
 

Protected Attributes

 _resize_filter = None
 
 _timer = QTimer()
 
str _msg = ""
 

Detailed Description

Widget that contains a message, a transparent colored background, and a close button.

It automatically closes after a timeout, or can stay opened until closed.

Constructor & Destructor Documentation

◆ __init__()

gui.taskfeedback.TaskFeedback.__init__ ( self,
parent = None )

Initializer for TaskFeedback.

Parameters
[in]parentThe QObject that is the parent of this object

Member Function Documentation

◆ install_filter_on()

gui.taskfeedback.TaskFeedback.install_filter_on ( self,
QObject obj )

Installs a ResizeFilter on another QObject.

This allows the widget to have the same size as another one, without having it on a layout.

Parameters
[in]objQObject to monitor ResizeEvents on.

◆ on_closeButton_clicked()

gui.taskfeedback.TaskFeedback.on_closeButton_clicked ( self)

Executed when the closeButton is pressed.

Note
The Signal clicked from closeButton is auto-connected to this Slot during the call to ui.setupUi in the init

◆ show_error()

gui.taskfeedback.TaskFeedback.show_error ( self,
str message )

Shows an error message.

The message needs to be closed manually.

Parameters
[in]messageA string that contains the message to show

◆ show_info()

gui.taskfeedback.TaskFeedback.show_info ( self,
str message )

Shows an info message.

This message will automatically disappear after 7 seconds.

Parameters
[in]messageA string that contains the message to show

Member Data Documentation

◆ _msg

str gui.taskfeedback.TaskFeedback._msg = ""
protected

◆ _resize_filter

gui.taskfeedback.TaskFeedback._resize_filter = None
protected

◆ _timer

gui.taskfeedback.TaskFeedback._timer = QTimer()
protected

◆ hide

gui.taskfeedback.TaskFeedback.hide

◆ ui

gui.taskfeedback.TaskFeedback.ui = Ui_TaskFeedback()

The documentation for this class was generated from the following file: