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

def __init__
 Class for displaying messages to the user. More...
 
def show (self)
 Show the message (if not already visible)
 
def visible (self)
 Returns a boolean indicating whether the message is currently visible. More...
 
def isDismissable (self)
 Can the message be closed by user?
 
def setLifetimeTimer
 Set the lifetime timer of the message. More...
 
def setInactivityTimer
 Set the inactivity timer of the message. More...
 
def addAction
 Add an action to the message Actions are useful for making messages that require input from the user. More...
 
def getActions (self)
 Get the list of actions to display buttons for on the message. More...
 
def getOptionText (self)
 
def getOptionState (self)
 
def getImageSource (self)
 
def getImageCaption (self)
 
def setText
 Changes the text on the message. More...
 
def getText (self)
 Returns the text in the message. More...
 
def setMaxProgress
 Sets the maximum numerical value of the progress bar on the message. More...
 
def getMaxProgress (self)
 Gets the maximum value of the progress bar on the message. More...
 
def setProgress
 Changes the state of the progress bar. More...
 
def getProgress (self)
 Returns the current progress. More...
 
def setTitle
 Changes the message title. More...
 
def getTitle (self)
 Returns the message title. More...
 
def hide
 Hides this message. More...
 

Static Public Attributes

tuple inactivityTimerStop = pyqtSignal()
 
tuple inactivityTimerStart = pyqtSignal()
 
tuple actionTriggered = Signal()
 
tuple optionToggled = Signal()
 
tuple 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

def UM.Message.Message.__init__ (   self,
  text 
)

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) Is there nay progress to be displayed? if -1, it's seen as indeterminate

Member Function Documentation

def UM.Message.Message.addAction (   self,
  action_id 
)

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
def UM.Message.Message.getActions (   self,
  List,
  Dict,
  str,
  Union,
  str,
  int 
)

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.
def UM.Message.Message.getMaxProgress (   self,
  float 
)

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
def UM.Message.Message.getProgress (   self,
  Optional,
  float 
)

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

def UM.Message.Message.getText (   self,
  str 
)

Returns the text in the message.

Returns
The text in the message.
def UM.Message.Message.getTitle (   self,
  Optional,
  str 
)

Returns the message title.

Returns
The message title.
def UM.Message.Message.hide (   self,
  send_signal = True,
  None 
)

Hides this message.

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

def UM.Message.Message.setInactivityTimer (   self,
  inactivity_timer 
)

Set the inactivity timer of the message.

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

def UM.Message.Message.setLifetimeTimer (   self,
  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.

def UM.Message.Message.setMaxProgress (   self,
  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.

def UM.Message.Message.setProgress (   self,
  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().
def UM.Message.Message.setText (   self,
  text 
)

Changes the text on the message.

Parameters
textThe new text for the message. Please ensure that this text is internationalised.
def UM.Message.Message.setTitle (   self,
  title 
)

Changes the message title.

Parameters
textThe new title for the message. Please ensure that this text is internationalised.
def UM.Message.Message.visible (   self,
  bool 
)

Returns a boolean indicating whether the message is currently visible.

Member Data Documentation

tuple 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: