Uranium
Application Framework
UM.Message.Message Class Reference

Class for displaying messages to the user. More...

Inheritance diagram for UM.Message.Message:
UM.ConfigurationErrorMessage.ConfigurationErrorMessage

Public Member Functions

None __init__ (self, str text="", int lifetime=30, bool dismissable=True, float progress=None, Optional[str] title=None, parent=None, bool use_inactivity_timer=True, str image_source="", str image_caption="", str option_text="", bool option_state=True)
 Class for displaying messages to the user. More...
 
None show (self)
 Show the message (if not already visible)
 
bool visible (self)
 Returns a boolean indicating whether the message is currently visible. More...
 
bool isDismissable (self)
 Can the message be closed by user?
 
None setLifetimeTimer (self, QTimer timer)
 Set the lifetime timer of the message. More...
 
None setInactivityTimer (self, QTimer inactivity_timer)
 Set the inactivity timer of the message. More...
 
def addAction (self, str action_id, str name, str icon, str description, int button_style=ActionButtonStyle.DEFAULT, int button_align=ActionButtonAlignment.ALIGN_RIGHT)
 Add an action to the message Actions are useful for making messages that require input from the user. More...
 
List[Dict[str, Union[str, int]]] getActions (self)
 Get the list of actions to display buttons for on the message. More...
 
str getOptionText (self)
 
bool getOptionState (self)
 
str getImageSource (self)
 
str getImageCaption (self)
 
None setText (self, str text)
 Changes the text on the message. More...
 
str getText (self)
 Returns the text in the message. More...
 
None setMaxProgress (self, float max_progress)
 Sets the maximum numerical value of the progress bar on the message. More...
 
float getMaxProgress (self)
 Gets the maximum value of the progress bar on the message. More...
 
None setProgress (self, float progress)
 Changes the state of the progress bar. More...
 
Optional[float] getProgress (self)
 Returns the current progress. More...
 
None setTitle (self, str title)
 Changes the message title. More...
 
Optional[str] getTitle (self)
 Returns the message title. More...
 
None hide (self, send_signal=True)
 Hides this message. More...
 

Static Public Attributes

 inactivityTimerStop = pyqtSignal()
 
 inactivityTimerStart = pyqtSignal()
 
 actionTriggered = Signal()
 
 optionToggled = Signal()
 
 progressChanged = Signal()
 Signal that gets emitted whenever the state of the progress bar on this message changes. More...
 

Detailed Description

Class for displaying messages to the user.

Constructor & Destructor Documentation

◆ __init__()

None UM.Message.Message.__init__ (   self,
str   text = "",
int   lifetime = 30,
bool   dismissable = True,
float   progress = None,
Optional[str]   title = None,
  parent = None,
bool   use_inactivity_timer = True,
str   image_source = "",
str   image_caption = "",
str   option_text = "",
bool   option_state = True 
)

Class for displaying messages to the user.

Even though the lifetime can be set, in certain cases it can still have a lifetime if nothing happens with the the message. We define the following cases;

  • A message is dismissible; No timeout (set by lifetime or inactivity)
  • A message is set to not dismissible, without progress; We force the dismissible property to be true
  • A message is set to not dismissible, with progress; After 30 seconds of no progress updates we hide the message.
    Parameters
    textText that needs to be displayed in the message
    lifetimeHow long should the message be displayed (in seconds). if lifetime is 0, it will never automatically be destroyed.
    dismissibleCan the user dismiss the message?
    titlePhrase that will be shown above the message
    image_sourcean absolute path where an image can be found to be displayed (QUrl.toLocalFile()) can be used for that.
    image_captionText to be displayed below the image (or anywhere really, it's up tot the QML to handle that) \progress Is there nay progress to be displayed? if -1, it's seen as indeterminate

Member Function Documentation

◆ addAction()

def UM.Message.Message.addAction (   self,
str  action_id,
str  name,
str  icon,
str  description,
int   button_style = ActionButtonStyle.DEFAULT,
int   button_align = ActionButtonAlignment.ALIGN_RIGHT 
)

Add an action to the message Actions are useful for making messages that require input from the user.

Parameters
action_id
nameThe displayed name of the action
iconSource of the icon to be used
button_styleDescription the button style (used for Button and Link)
button_alignDefine horizontal position of the action item

◆ getActions()

List[Dict[str, Union[str, int]]] UM.Message.Message.getActions (   self)

Get the list of actions to display buttons for on the message.

Each action is a dictionary with the elements provided in addAction.

Returns
A list of actions.

◆ getMaxProgress()

float UM.Message.Message.getMaxProgress (   self)

Gets the maximum value of the progress bar on the message.

Note that this is not the current value of the progress bar!

Returns
The maximum value of the progress bar on the message.
See also
getProgress

◆ getProgress()

Optional[float] UM.Message.Message.getProgress (   self)

Returns the current progress.

This should be a value between 0 and the value of getMaxProgress(). If no progress is set (because the message doesn't have it) None is returned

◆ getText()

str UM.Message.Message.getText (   self)

Returns the text in the message.

Returns
The text in the message.

◆ getTitle()

Optional[str] UM.Message.Message.getTitle (   self)

Returns the message title.

Returns
The message title.

◆ hide()

None UM.Message.Message.hide (   self,
  send_signal = True 
)

Hides this message.

While the message object continues to exist in memory, it appears to the user that it is gone.

◆ setInactivityTimer()

None UM.Message.Message.setInactivityTimer (   self,
QTimer  inactivity_timer 
)

Set the inactivity timer of the message.

This function is required as the QTimer needs to be created on a QThread.

◆ setLifetimeTimer()

None UM.Message.Message.setLifetimeTimer (   self,
QTimer  timer 
)

Set the lifetime timer of the message.

This is used by the QT application once the message is shown. If the lifetime is set to 0, no timer is added. This function is required as the QTimer needs to be created on a QThread.

◆ setMaxProgress()

None UM.Message.Message.setMaxProgress (   self,
float  max_progress 
)

Sets the maximum numerical value of the progress bar on the message.

If the reported progress hits this number, the bar will appear filled.

◆ setProgress()

None UM.Message.Message.setProgress (   self,
float  progress 
)

Changes the state of the progress bar.

Parameters
progressThe new progress to display to the user. This should be between 0 and the value of getMaxProgress().

◆ setText()

None UM.Message.Message.setText (   self,
str  text 
)

Changes the text on the message.

Parameters
textThe new text for the message. Please ensure that this text is internationalised.

◆ setTitle()

None UM.Message.Message.setTitle (   self,
str  title 
)

Changes the message title.

Parameters
textThe new title for the message. Please ensure that this text is internationalised.

◆ visible()

bool UM.Message.Message.visible (   self)

Returns a boolean indicating whether the message is currently visible.

Member Data Documentation

◆ progressChanged

UM.Message.Message.progressChanged = Signal()
static

Signal that gets emitted whenever the state of the progress bar on this message changes.


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