UM.Qt.QtApplication.QtApplication Class Reference

Inheritance diagram for UM.Qt.QtApplication.QtApplication:

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)
str	version (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	makeRenderer (self)
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["QQuickWindow"]	createQmlSubWindow (self, str qml_file_path, Dict[str, "QObject"] context_properties=None)
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)
Public Member Functions inherited from UM.Application.Application
None	__init__ (self, str name, str version, str latest_url, str api_version, str app_display_name="", str build_type="", bool is_debug_mode=False, **kwargs)
"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
Static Public Attributes inherited from UM.Application.Application
	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)
None	_onWindowVisibleChange (self, bool visible)
QSplashScreen	_createSplashScreen (self)
float	_screenScaleFactor (self)
Protected Member Functions inherited from UM.Application.Application
None	_loadPlugins (self)

Protected Attributes
list	_qml_import_paths = []
str	_main_qml = "main.qml"
Optional[QQmlApplicationEngine]	_qml_engine = None
Optional[MainWindow]	_main_window = None
Optional[str]	_tray_icon_name = tray_icon_name
Optional[str]	_tray_icon = None
Optional[QSystemTrayIcon]	_tray_icon_widget = None
Optional[Theme]	_theme = None
Optional[QtRenderer]	_renderer = None
list	_sub_windows = []
Optional[JobQueue]	_job_queue = None
Optional[VersionUpgradeManager]	_version_upgrade_manager = None
bool	_is_shutting_down = False
list	_recent_files = []
Optional[ConfigurationErrorMessage]	_configuration_error_message = None
Optional[HttpRequestManager]	_http_network_request_manager = None
	_mesh_file_handler = MeshFileHandler(self)
	_workspace_file_handler = WorkspaceFileHandler(self)
	_onJobFinished
	_displayLoadingPluginSplashMessage
bool	_qml_engine_initialized = True
	_onMainWindowStateChanged
	_onWindowVisibleChange
Protected Attributes inherited from UM.Application.Application
	_api_version = Version(api_version)
	_app_name = name
	_app_display_name = app_display_name if app_display_name else name
	_version = version
	_build_type = build_type
	_is_debug_mode = is_debug_mode
bool	_is_headless = False
bool	_use_external_backend = False
bool	_just_updated_from_old_version = False
str	_config_lock_filename = "{name}.lock".format(name = self._app_name)
	_cli_args = None
	_cli_parser = argparse.ArgumentParser(prog = self._app_name, add_help = False)
	_main_thread = threading.current_thread()
	_default_language = locale.getdefaultlocale()[0]
	_preferences_filename = None
	_preferences = None
list	_extensions = []
list	_file_providers = []
list	_required_plugins = []
	_package_manager_class = PackageManager
	_package_manager = None
	_plugin_registry = None
	_container_registry_class = ContainerRegistry
	_container_registry = None
	_global_container_stack = None
	_file_provider_model = FileProviderModel(application = self)
	_controller = None
	_backend = None
	_output_device_manager = None
	_operation_stack = None
list	_visible_messages = []
	_message_lock = threading.Lock()
str	_app_install_dir = self.getInstallPrefix()
	_workspace_metadata_storage = WorkspaceMetadataStorage()
	_current_workspace_information = WorkspaceMetadataStorage()

Additional Inherited Members
Static Public Member Functions inherited from UM.Application.Application
str	getAppFolderPrefix ()
str	getInstallPrefix ()
Public Attributes inherited from UM.Application.Application
	default_theme = self._app_name
str	change_log_url = "https://github.com/Ultimaker/Uranium"
str	beta_change_log_url = "https://github.com/Ultimaker/Uranium"
str	latest_url = latest_url
	setBackend
	addExtension
	addFileProvider

Detailed Description

Application subclass that provides a Qt application object.

Member Function Documentation

addCommandLineOptions()

None UM.Qt.QtApplication.QtApplication.addCommandLineOptions

(

self

)

Reimplemented from UM.Application.Application.

backend()

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}

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.
: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.

createQmlSubWindow()

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

Create a QML window from a QML file. This method uses createQmlComponent internally, but adds a few specific
features for windows management:
    * The created object is a QQuickWindow instance
    * The transient parent of the window is explicitly set to be the main window
    * The window ownership is handled and it will be destroyed as soon as it's no longer visible,
      so the caller should not keep a reference to it
: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: The created QQuickWindow instance, or None in case the creation failed (qml error)

deleteAll()

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

functionEvent()

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.

getBackend()

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.

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().
:return: 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.
:exception NotImplementedError

Reimplemented from UM.Application.Application.

hideMessage()

None UM.Qt.QtApplication.QtApplication.hideMessage	(		self,
		Message	message )

Reimplemented from UM.Application.Application.

initialize()

None UM.Qt.QtApplication.QtApplication.initialize	(		self,
		bool	check_if_trusted = False )

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.
:exception NotImplementedError:

Reimplemented from UM.Application.Application.

showMessage()

None UM.Qt.QtApplication.QtApplication.showMessage	(		self,
		Message	message )

Reimplemented from UM.Application.Application.

showSplashMessage()

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

Display text on the splash screen.

showToastMessage()

None UM.Qt.QtApplication.QtApplication.showToastMessage	(		self,
		str	title,
		str	message )

Reimplemented from UM.Application.Application.

startSplashWindowPhase()

None UM.Qt.QtApplication.QtApplication.startSplashWindowPhase

(

self

)

Reimplemented from UM.Application.Application.

---

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

• UM/Qt/QtApplication.py