Uranium
Application Framework
UM.Qt.QtApplication.QtApplication Class Reference

Application subclass that provides a Qt application object. More...

Inheritance diagram for UM.Qt.QtApplication.QtApplication:
UM.Application.Application

Public Member Functions

None __init__ (self, str tray_icon_name=None, **kwargs)
 
None addCommandLineOptions (self)
 
None initialize (self)
 
None startSplashWindowPhase (self)
 
None initializeEngine (self)
 
List[QUrl] recentFiles (self)
 
None addFileToRecentFiles (self, str file_name)
 
None run (self)
 Run the main event loop. More...
 
None hideMessage (self, Message message)
 
None showMessage (self, Message message)
 
None showToastMessage (self, str title, str message)
 
None setMainQml (self, str path)
 
None exec_ (self, *Any args, **Any kwargs)
 
None reloadQML (self)
 
None purgeWindows (self)
 
bool isShuttingDown (self)
 
None registerObjects (self, engine)
 
QtRenderer getRenderer (self)
 Return an application-specific Renderer object. More...
 
Optional[MainWindowgetMainWindow (self)
 
None setMainWindow (self, MainWindow window)
 
None setVisible (self, bool visible)
 
bool isVisible (self)
 
Optional[Theme] getTheme (self)
 
None functionEvent (self, QEvent event)
 
bool event (self, QEvent event)
 
None windowClosed (self, bool save_data=True)
 
bool checkWindowMinimizedState (self)
 
Backend getBackend (self)
 Get the backend of the application (the program that does the heavy lifting). More...
 
Backend backend (self)
 
None createSplash (self)
 
None showSplashMessage (self, str message)
 Display text on the splash screen. More...
 
None closeSplash (self)
 Close the splash screen after the application has started. More...
 
Optional["QObject"] createQmlComponent (self, str qml_file_path, Dict[str, "QObject"] context_properties=None)
 Create a QML component from a qml file. More...
 
None deleteAll (self, only_selectable=True)
 Delete all nodes containing mesh data in the scene. More...
 
MeshFileHandler getMeshFileHandler (self)
 Get the MeshFileHandler of this application. More...
 
WorkspaceFileHandler getWorkspaceFileHandler (self)
 
PackageManager getPackageManager (self)
 
"QtApplication" getInstance (cls, *args, **kwargs)
 Gets the instance of this application. More...
 
- Public Member Functions inherited from UM.Application.Application
None __init__ (self, str name, str version, str api_version, str app_display_name="", str build_type="", bool is_debug_mode=False, **kwargs)
 Init method. More...
 
"Version" getAPIVersion (self)
 
None parseCliOptions (self)
 
None startPostSplashWindowPhase (self)
 
bool hasJustUpdatedFromOldVersion (self)
 
def getContainerRegistry (self)
 
str getApplicationLockFilename (self)
 Get the lock filename.
 
None setGlobalContainerStack (self, "ContainerStack" stack)
 
Optional["ContainerStack"] getGlobalContainerStack (self)
 
str getVersion (self)
 Get the version of the application.
 
str getBuildType (self)
 Get the build type of the application.
 
bool getIsDebugMode (self)
 
bool getIsHeadLess (self)
 
bool getUseExternalBackend (self)
 
None hideMessageById (self, int message_id)
 Hide message by ID (as provided by built-in id function)
 
List[MessagegetVisibleMessages (self)
 Get list of all visible messages.
 
str getApplicationName (self)
 Get name of the application. More...
 
str getApplicationDisplayName (self)
 
Preferences getPreferences (self)
 Get the preferences. More...
 
None savePreferences (self)
 
str getApplicationLanguage (self)
 Get the currently used IETF language tag. More...
 
List[str] getRequiredPlugins (self)
 Application has a list of plugins that it must have. More...
 
None setRequiredPlugins (self, List[str] plugin_names)
 Set the plugins that the application must have in order to function. More...
 
None setBackend (self, "Backend" backend)
 Set the backend of the application (the program that does the heavy lifting). More...
 
PluginRegistry getPluginRegistry (self)
 Get the PluginRegistry of this application. More...
 
Controller getController (self)
 Get the Controller of this application. More...
 
OperationStack getOperationStack (self)
 
OutputDeviceManager getOutputDeviceManager (self)
 
None functionEvent (self, CallFunctionEvent event)
 Post a function event onto the event loop. More...
 
None callLater (self, Callable[..., Any] func, *args, **kwargs)
 Call a function the next time the event loop runs. More...
 
threading.Thread getMainThread (self)
 Get the application's main thread. More...
 
None addExtension (self, "Extension" extension)
 
List["Extension"] getExtensions (self)
 

Static Public Attributes

 pluginsLoaded = Signal()
 
 applicationRunning = Signal()
 
 recentFilesChanged = pyqtSignal()
 
 notify
 
 engineCreatedSignal = Signal()
 
 mainWindowChanged = Signal()
 
 result
 Get the backend of the application (the program that does the heavy lifting). More...
 
 constant
 Property used to expose the backend It is made static as the backend is not supposed to change during runtime. More...
 
 splash = None
 Create a class variable so we can manage the splash in the CrashHandler dialog when the Application instance is not yet created, e.g. More...
 
- Static Public Attributes inherited from UM.Application.Application
 applicationShuttingDown = Signal()
 Emitted when the application window was closed and we need to shut down the application.
 
 showMessageSignal = Signal()
 
 hideMessageSignal = Signal()
 
 globalContainerStackChanged = Signal()
 
 workspaceLoaded = Signal()
 
 visibleMessageAdded = Signal()
 
 visibleMessageRemoved = Signal()
 

Additional Inherited Members

- Static Public Member Functions inherited from UM.Application.Application
str getInstallPrefix ()
 
- Public Attributes inherited from UM.Application.Application
 default_theme
 
 change_log_url
 

Detailed Description

Application subclass that provides a Qt application object.

Member Function Documentation

◆ closeSplash()

None UM.Qt.QtApplication.QtApplication.closeSplash (   self)

Close the splash screen after the application has started.

◆ createQmlComponent()

Optional["QObject"] UM.Qt.QtApplication.QtApplication.createQmlComponent (   self,
str  qml_file_path,
Dict[str, "QObject"]   context_properties = None 
)

Create a QML component from a qml file.

Parameters
qml_file_pathThe absolute file path to the root qml file.
context_propertiesOptional dictionary containing the properties that will be set on the context of the qml instance before creation.
Returns
None in case the creation failed (qml error), else it returns the qml instance.
Note
If the creation fails, this function will ensure any errors are logged to the logging service.

◆ deleteAll()

None UM.Qt.QtApplication.QtApplication.deleteAll (   self,
  only_selectable = True 
)

Delete all nodes containing mesh data in the scene.

Parameters
only_selectable.Set this to False to delete objects from all build plates

◆ getBackend()

Backend UM.Qt.QtApplication.QtApplication.getBackend (   self)

Get the backend of the application (the program that does the heavy lifting).

Returns
Backend Backend

Reimplemented from UM.Application.Application.

◆ getInstance()

"QtApplication" UM.Qt.QtApplication.QtApplication.getInstance (   cls,
args,
**  kwargs 
)

Gets the instance of this application.

This is just to further specify the type of Application.getInstance().

Returns
The instance of this application.

Reimplemented from UM.Application.Application.

◆ getMeshFileHandler()

MeshFileHandler UM.Qt.QtApplication.QtApplication.getMeshFileHandler (   self)

Get the MeshFileHandler of this application.

◆ getRenderer()

QtRenderer UM.Qt.QtApplication.QtApplication.getRenderer (   self)

Return an application-specific Renderer object.

Exceptions
NotImplementedError

Reimplemented from UM.Application.Application.

◆ run()

None UM.Qt.QtApplication.QtApplication.run (   self)

Run the main event loop.

This method should be re-implemented by subclasses to start the main event loop.

Exceptions
NotImplementedError

Reimplemented from UM.Application.Application.

◆ showSplashMessage()

None UM.Qt.QtApplication.QtApplication.showSplashMessage (   self,
str  message 
)

Display text on the splash screen.

Member Data Documentation

◆ constant

UM.Qt.QtApplication.QtApplication.constant
static

Property used to expose the backend It is made static as the backend is not supposed to change during runtime.

This makes the connection between backend and QML more reliable than the pyqtSlot above.

Returns
Backend Backend

◆ result

UM.Qt.QtApplication.QtApplication.result
static

Get the backend of the application (the program that does the heavy lifting).

The backend is also a QObject, which can be used from qml.

◆ splash

UM.Qt.QtApplication.QtApplication.splash = None
static

Create a class variable so we can manage the splash in the CrashHandler dialog when the Application instance is not yet created, e.g.

when an error occurs during the initialization


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