Uranium
Application Framework
|
Public Member Functions | |
None | __init__ (self, str tray_icon_name=None, **kwargs) |
None | addCommandLineOptions (self) |
None | initialize (self, bool check_if_trusted=False) |
bool | isQmlEngineInitialized (self) |
None | startSplashWindowPhase (self) |
None | readPreferencesFromConfiguration (self) |
None | initializeEngine (self) |
List[QUrl] | recentFiles (self) |
List[FileProvider] | fileProviders (self) |
None | addFileToRecentFiles (self, str file_name) |
None | run (self) |
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) |
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) |
Backend | backend (self) |
None | createSplash (self) |
None | showSplashMessage (self, str message) |
None | closeSplash (self) |
Optional["QObject"] | createQmlComponent (self, str qml_file_path, Dict[str, "QObject"] context_properties=None) |
None | deleteAll (self, only_selectable=True) |
None | resetWorkspace (self) |
MeshFileHandler | getMeshFileHandler (self) |
WorkspaceFileHandler | getWorkspaceFileHandler (self) |
PackageManager | getPackageManager (self) |
"HttpRequestManager" | getHttpRequestManager (self) |
"QtApplication" | getInstance (cls, *args, **kwargs) |
str | applicationDisplayName (self) |
![]() | |
"Version" | getAPIVersion (self) |
WorkspaceMetadataStorage | getWorkspaceMetadataStorage (self) |
WorkspaceMetadataStorage | getCurrentWorkspaceInformation (self) |
None | parseCliOptions (self) |
None | startPostSplashWindowPhase (self) |
bool | hasJustUpdatedFromOldVersion (self) |
ContainerRegistry | getContainerRegistry (self) |
str | getApplicationLockFilename (self) |
None | setGlobalContainerStack (self, Optional["ContainerStack"] stack) |
Optional["ContainerStack"] | getGlobalContainerStack (self) |
str | getVersion (self) |
str | getBuildType (self) |
bool | getIsDebugMode (self) |
bool | getIsHeadLess (self) |
bool | getUseExternalBackend (self) |
None | hideMessageById (self, int message_id) |
List[Message] | getVisibleMessages (self) |
str | getApplicationName (self) |
str | getApplicationDisplayName (self) |
Preferences | getPreferences (self) |
None | savePreferences (self) |
str | getApplicationLanguage (self) |
List[str] | getRequiredPlugins (self) |
None | setRequiredPlugins (self, List[str] plugin_names) |
None | setBackend (self, "Backend" backend) |
PluginRegistry | getPluginRegistry (self) |
Controller | getController (self) |
OperationStack | getOperationStack (self) |
OutputDeviceManager | getOutputDeviceManager (self) |
None | callLater (self, Callable[..., Any] func, *args, **kwargs) |
threading.Thread | getMainThread (self) |
None | addExtension (self, "Extension" extension) |
List["Extension"] | getExtensions (self) |
None | addFileProvider (self, "FileProvider" file_provider) |
List["FileProvider"] | getFileProviders (self) |
Static Public Attributes | |
pluginsLoaded = Signal() | |
applicationRunning = Signal() | |
recentFilesChanged = pyqtSignal() | |
fileProvidersChanged = pyqtSignal() | |
engineCreatedSignal = Signal() | |
mainWindowChanged = Signal() | |
Optional | splash = None |
![]() | |
applicationShuttingDown = Signal() | |
showMessageSignal = Signal() | |
hideMessageSignal = Signal() | |
globalContainerStackChanged = Signal() | |
workspaceLoaded = Signal() | |
visibleMessageAdded = Signal() | |
visibleMessageRemoved = Signal() | |
Protected Member Functions | |
bool | _isPathSecure (self, str path) |
None | _displayLoadingPluginSplashMessage (self, Optional[str] plugin_id) |
None | _onJobFinished (self, Job job) |
None | _onMainWindowStateChanged (self, int window_state) |
QSplashScreen | _createSplashScreen (self) |
float | _screenScaleFactor (self) |
![]() | |
None | _loadPlugins (self) |
Protected Attributes | |
_default_language | |
_package_manager | |
_mesh_file_handler | |
_workspace_file_handler | |
_job_queue | |
_onJobFinished | |
_version_upgrade_manager | |
_configuration_error_message | |
_displayLoadingPluginSplashMessage | |
_preferences_filename | |
_just_updated_from_old_version | |
_app_name | |
_tray_icon | |
_tray_icon_widget | |
_tray_icon_name | |
_qml_engine | |
_main_qml | |
_qml_engine_initialized | |
_recent_files | |
_renderer | |
_onMainWindowStateChanged | |
_main_window | |
_theme | |
_is_shutting_down | |
_http_network_request_manager | |
![]() | |
_api_version | |
_app_name | |
_app_display_name | |
_version | |
_build_type | |
_is_debug_mode | |
_is_headless | |
_use_external_backend | |
_just_updated_from_old_version | |
_config_lock_filename | |
_cli_args | |
_cli_parser | |
_main_thread | |
_default_language | |
_preferences_filename | |
_preferences | |
_extensions | |
_file_providers | |
_required_plugins | |
_package_manager_class | |
_package_manager | |
_plugin_registry | |
_container_registry_class | |
_container_registry | |
_global_container_stack | |
_file_provider_model | |
_controller | |
_backend | |
_output_device_manager | |
_operation_stack | |
_visible_messages | |
_message_lock | |
_app_install_dir | |
_workspace_metadata_storage | |
_current_workspace_information | |
Additional Inherited Members | |
![]() | |
str | getAppFolderPrefix () |
str | getInstallPrefix () |
![]() | |
default_theme | |
setBackend | |
addExtension | |
addFileProvider | |
Application subclass that provides a Qt application object.
None UM.Qt.QtApplication.QtApplication.__init__ | ( | self, | |
str | name = None, | ||
** | version ) |
Init method :param name: :type{string} The name of the application. :param version: :type{string} Version, formatted as major.minor.rev :param build_type: Additional version info on the type of build this is, such as "master". :param is_debug_mode: Whether to run in debug mode.
Reimplemented from UM.Application.Application.
None UM.Qt.QtApplication.QtApplication.addCommandLineOptions | ( | self | ) |
Reimplemented from UM.Application.Application.
Backend UM.Qt.QtApplication.QtApplication.backend | ( | self | ) |
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 :type{Backend}
None UM.Qt.QtApplication.QtApplication.closeSplash | ( | self | ) |
Close the splash screen after the application has started.
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. :param qml_file_path:: The absolute file path to the root qml file. :param context_properties:: Optional dictionary containing the properties that will be set on the context of the qml instance before creation. :return: 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.
None UM.Qt.QtApplication.QtApplication.deleteAll | ( | self, | |
only_selectable = True ) |
Delete all nodes containing mesh data in the scene. :param only_selectable:. Set this to False to delete objects from all build plates
None UM.Qt.QtApplication.QtApplication.functionEvent | ( | self, | |
QEvent | event ) |
Post a function event onto the event loop. This takes a CallFunctionEvent object and puts it into the actual event loop. :exception NotImplementedError
Reimplemented from UM.Application.Application.
Backend UM.Qt.QtApplication.QtApplication.getBackend | ( | self | ) |
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.
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(). :return: The instance of this application.
Reimplemented from UM.Application.Application.
MeshFileHandler UM.Qt.QtApplication.QtApplication.getMeshFileHandler | ( | self | ) |
Get the MeshFileHandler of this application.
QtRenderer UM.Qt.QtApplication.QtApplication.getRenderer | ( | self | ) |
Return an application-specific Renderer object. :exception NotImplementedError
Reimplemented from UM.Application.Application.
None UM.Qt.QtApplication.QtApplication.hideMessage | ( | self, | |
Message | message ) |
Reimplemented from UM.Application.Application.
None UM.Qt.QtApplication.QtApplication.initialize | ( | self, | |
bool | check_if_trusted = False ) |
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. :exception NotImplementedError:
Reimplemented from UM.Application.Application.
None UM.Qt.QtApplication.QtApplication.showMessage | ( | self, | |
Message | message ) |
Reimplemented from UM.Application.Application.
None UM.Qt.QtApplication.QtApplication.showSplashMessage | ( | self, | |
str | message ) |
Display text on the splash screen.
None UM.Qt.QtApplication.QtApplication.showToastMessage | ( | self, | |
str | title, | ||
str | message ) |
Reimplemented from UM.Application.Application.
None UM.Qt.QtApplication.QtApplication.startSplashWindowPhase | ( | self | ) |
Reimplemented from UM.Application.Application.