UM.Message.Message Class Reference

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

Public Member Functions
def	__init__ (self, text="", lifetime=30, dismissable=True, progress=None, type=MessageType.Info)
	Class for displaying messages to the user. More...
def	show (self)
	Show the message (if not already visible)
def	isDismissable (self)
	Can the message be closed by user?
def	setTimer (self, timer)
	Set the lifetime timer of the message. More...
def	addAction (self, action_id, name, icon, description)
	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	setText
	Changes the text on the message. More...
def	getText (self)
	Returns the text in the message. More...
def	getType (self)
def	setMaxProgress (self, max_progress)
	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 (self, progress)
	Changes the state of the progress bar. More...
def	getProgress (self)
	Returns the current progress. More...
def	hide (self)
	Hides this message. More...

Static Public Attributes
	actionTriggered = 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__()

def UM.Message.Message.__init__	(		self,
			text = "",
			lifetime = 30,
			dismissable = True,
			progress = None,
			type = MessageType.Info
	)

Class for displaying messages to the user.

Parameters

text	Text that needs to be displayed in the message
lifetime	How long should the message be displayed (in seconds). if lifetime is 0, it will never automatically be destroyed.
dismissible	Can the user dismiss the message? Is there nay progress to be displayed? if -1, it's seen as indeterminate

Member Function Documentation

addAction()

def UM.Message.Message.addAction	(		self,
			action_id,
			name,
			icon,
			description
	)

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

Parameters

action_id
name	The displayed name of the action
icon	Source of the icon to be used
description	Description of the item (used for mouse over, etc)

getActions()

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

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

def UM.Message.Message.getProgress

(

self

)

Returns the current progress.

This should be a value between 0 and the value of getMaxProgress().

getText()

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

Returns the text in the message.

Returns

The text in the message.

hide()

def UM.Message.Message.hide

(

self

)

Hides this message.

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

setMaxProgress()

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.

setProgress()

def UM.Message.Message.setProgress	(		self,
			progress
	)

Changes the state of the progress bar.

Parameters

progress

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

setText()

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

Changes the text on the message.

Parameters

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

setTimer()

def UM.Message.Message.setTimer	(		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.

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:

• UM/Message.py