UM.Message.Message Class Reference

Inheritance diagram for UM.Message.Message:

Public Member Functions
def	__init__
def	show (self)
def	visible (self)
def	isDismissable (self)
def	setLifetimeTimer
def	setInactivityTimer
def	addAction
def	getActions (self)
def	getOptionText (self)
def	getOptionState (self)
def	getImageSource (self)
def	getImageCaption (self)
def	getMessageType (self)
def	setText
def	getText (self)
def	setMaxProgress
def	getMaxProgress (self)
def	setProgress
def	getProgress (self)
def	setTitle
def	getTitle (self)
def	hide

Static Public Attributes
tuple	inactivityTimerStop = pyqtSignal()
tuple	inactivityTimerStart = pyqtSignal()
tuple	pyQtActionTriggered = pyqtSignal(QObject, str)
tuple	actionTriggered = Signal()
tuple	optionToggled = Signal()
tuple	titleChanged = Signal()
tuple	textChanged = Signal()
tuple	progressChanged = Signal()

Detailed Description

Class for displaying messages to the user.

Member Function Documentation

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``.

:return: 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!

:return: The maximum value of the progress bar on the message.

:see getProgress

def UM.Message.Message.getMessageType	(		self,
			MessageType
	)

Gets the type of the message.
The message gets a different icon according to its type.
:return: The type of the message (POSITIVE, NEUTRAL, WARNING, ERROR)

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.

:return: The text in the message.

def UM.Message.Message.getTitle	(		self,
			Optional,
			str
	)

Returns the message title.

:return: 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.isDismissable	(		self,
			bool
	)

Can the message be closed by user?

def UM.Message.Message.show	(		self,
			None
	)

Show the message (if not already visible)

def UM.Message.Message.visible	(		self,
			bool
	)

Returns a boolean indicating whether the message is currently visible.

---

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

• UM/Message.py