RTC Toolkit  2.0.0
Public Member Functions | Public Attributes | List of all members
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

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

Public Attributes

 ui
 

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__()

def gui.taskfeedback.TaskFeedback.__init__ (   self,
  parent = None,
args,
**  kwargs 
)

Initializer for TaskFeedback.

   @param[in] parent The QObject that is the parent of this object

Member Function Documentation

◆ install_filter_on()

def 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()

def 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()

def 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()

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

Shows an info message.

This message will automatically dissapear after 7 seconds.

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

Member Data Documentation

◆ ui

gui.taskfeedback.TaskFeedback.ui

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