Uranium
Application Framework
|
Application subclass that provides a Qt application object. More...
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[MainWindow] | getMainWindow (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. | |
None | closeSplash (self) |
Close the splash screen after the application has started. | |
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. | |
WorkspaceFileHandler | getWorkspaceFileHandler (self) |
PackageManager | getPackageManager (self) |
"QtApplication" | getInstance (cls, *args, **kwargs) |
Gets the instance of this application. More... | |
![]() | |
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[Message] | getVisibleMessages (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). | |
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. | |
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... | |
![]() | |
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 | |
![]() | |
str | getInstallPrefix () |
![]() | |
default_theme | |
change_log_url | |
Application subclass that provides a Qt application object.
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.
qml_file_path | The absolute file path to the root qml file. |
context_properties | Optional dictionary containing the properties that will be set on the context of the qml instance before creation. |
None UM.Qt.QtApplication.QtApplication.deleteAll | ( | self, | |
only_selectable = True |
|||
) |
Delete all nodes containing mesh data in the scene.
only_selectable. | Set this to False to delete objects from all build plates |
Backend UM.Qt.QtApplication.QtApplication.getBackend | ( | self | ) |
Get the backend of the application (the program that does the heavy lifting).
Reimplemented from UM.Application.Application.
"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().
Reimplemented from UM.Application.Application.
QtRenderer UM.Qt.QtApplication.QtApplication.getRenderer | ( | self | ) |
Return an application-specific Renderer object.
NotImplementedError |
Reimplemented from UM.Application.Application.
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.
NotImplementedError |
Reimplemented from UM.Application.Application.
|
static |
|
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.
|
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