Uranium
Application Framework
UM.ConfigurationErrorMessage.ConfigurationErrorMessage Class Reference
Inheritance diagram for UM.ConfigurationErrorMessage.ConfigurationErrorMessage:
UM.Message.Message

Public Member Functions

def __init__ (self, application, *args, **kwargs)
 
def addFaultyContainers (self, Union[Iterable, str] faulty_containers, *args)
 
"ConfigurationErrorMessage" getInstance (cls, *args, **kwargs)
 
- Public Member Functions inherited from UM.Message.Message
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, MessageType message_type=MessageType.NEUTRAL)
 
None show (self)
 
bool visible (self)
 
bool isDismissable (self)
 
None setLifetimeTimer (self, QTimer timer)
 
None setInactivityTimer (self, QTimer inactivity_timer)
 
def addAction (self, str action_id, str name, str icon, str description, int button_style=ActionButtonStyle.DEFAULT, int button_align=ActionButtonAlignment.ALIGN_RIGHT)
 
List[Dict[str, Union[str, int]]] getActions (self)
 
str getOptionText (self)
 
bool getOptionState (self)
 
str getImageSource (self)
 
str getImageCaption (self)
 
MessageType getMessageType (self)
 
None setText (self, str text)
 
str getText (self)
 
None setMaxProgress (self, float max_progress)
 
float getMaxProgress (self)
 
None setProgress (self, Optional[float] progress)
 
Optional[float] getProgress (self)
 
None setTitle (self, str title)
 
Optional[str] getTitle (self)
 
None hide (self, send_signal=True)
 

Additional Inherited Members

- Static Public Attributes inherited from UM.Message.Message
 inactivityTimerStop = pyqtSignal()
 
 inactivityTimerStart = pyqtSignal()
 
 pyQtActionTriggered = pyqtSignal(QObject, str)
 
 actionTriggered = Signal()
 
 optionToggled = Signal()
 
 titleChanged = Signal()
 
 textChanged = Signal()
 
 progressChanged = Signal()
 

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,
  text,
lifetime,
**  dismissable 
)
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.

:param text: Text that needs to be displayed in the message
:param lifetime: How long should the message be displayed (in seconds).
    if lifetime is 0, it will never automatically be destroyed.
:param dismissable: Can the user dismiss the message?
:param title: Phrase that will be shown above the message.
:param image_source: an absolute path where an image can be found to be
displayed (QUrl.toLocalFile()) can be used for that.
:param image_caption: Text to be displayed below the image (or anywhere
really, it's up to the QML to handle that).
:param progress: Is there any progress to be displayed? if -1, it's seen
as indeterminate.
:param message_type: Defines the type of message according to the MessageType enum (POSITIVE, NEUTRAL, WARNING,
ERROR, default: NEUTRAL). Depending on the type, an icon appears next to the message title. The NEUTRAL messages
contain no icon.

Reimplemented from UM.Message.Message.


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