Uranium
Application Framework
UM.ConfigurationErrorMessage.ConfigurationErrorMessage Class Reference

This is a specialised message that shows errors in the configuration. More...

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

Public Member Functions

def __init__ (self, args, kwargs)
 Creates an instance of this object. More...
 
def addFaultyContainers
 Show more containers which we know are faulty. More...
 
def getInstance (cls)
 Creates an instance of this class if one doesn't exist yet. More...
 
- Public Member Functions inherited from UM.Message.Message
def __init__ (self, text="", lifetime=30, dismissable=True, progress=None, title=None, parent=None, use_inactivity_timer=True)
 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 setLifetimeTimer (self, timer)
 Set the lifetime timer of the message. More...
 
def setInactivityTimer (self, inactivity_timer)
 Set the inactivity timer of the message. More...
 
def addAction (self, action_id, name, icon, description, button_style=ActionButtonStyle.DEFAULT, button_align=ActionButtonStyle.BUTTON_ALIGN_RIGHT)
 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 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 setTitle
 Changes the message title. More...
 
def getTitle (self)
 Returns the message title. More...
 
def hide (self, send_signal=True)
 Hides this message. More...
 

Additional Inherited Members

- Static Public Attributes inherited from UM.Message.Message
 inactivityTimerStop = pyqtSignal()
 
 inactivityTimerStart = pyqtSignal()
 
 actionTriggered = Signal()
 
 progressChanged = Signal()
 Signal that gets emitted whenever the state of the progress bar on this message changes. More...
 

Detailed Description

This is a specialised message that shows errors in the configuration.

This class coalesces all errors in the configuration. Whenever there are new errors the message gets updated (and shown if it was hidden).

Constructor & Destructor Documentation

◆ __init__()

def UM.ConfigurationErrorMessage.ConfigurationErrorMessage.__init__ (   self,
  args,
  kwargs 
)

Creates an instance of this object.

This initializer forces the Singleton pattern by checking if there is an instance first and giving an error if there is already an instance.

Member Function Documentation

◆ addFaultyContainers()

def UM.ConfigurationErrorMessage.ConfigurationErrorMessage.addFaultyContainers (   self,
  faulty_containers 
)

Show more containers which we know are faulty.

◆ getInstance()

def UM.ConfigurationErrorMessage.ConfigurationErrorMessage.getInstance (   cls,
  ConfigurationErrorMessage 
)

Creates an instance of this class if one doesn't exist yet.

If an instance does exist, this gets that instance.


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