Uranium
Application Framework
 All Classes Namespaces Files Functions Variables Pages
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

def __init__
 
def addCommandLineOptions
 
def initialize
 
def startSplashWindowPhase
 
def initializeEngine
 
def recentFiles
 
def addFileToRecentFiles
 
def run
 
def hideMessage
 
def showMessage
 
def showToastMessage
 
def setMainQml
 
def exec_
 
def reloadQML
 
def purgeWindows
 
def isShuttingDown
 
def registerObjects
 
def getRenderer
 
def getMainWindow
 
def setMainWindow
 
def setVisible
 
def isVisible
 
def getTheme
 
def functionEvent
 
def event
 
def windowClosed
 
def checkWindowMinimizedState
 
def getBackend
 Get the backend of the application (the program that does the heavy lifting). More...
 
def backend
 Property used to expose the backend It is made static as the backend is not supposed to change during runtime. More...
 
def createSplash
 
def showSplashMessage
 Display text on the splash screen. More...
 
def closeSplash
 Close the splash screen after the application has started. More...
 
def createQmlComponent
 Create a QML component from a qml file. More...
 
def deleteAll
 Delete all nodes containing mesh data in the scene. More...
 
def getMeshFileHandler
 Get the MeshFileHandler of this application. More...
 
def getWorkspaceFileHandler
 
def getPackageManager
 
def getInstance
 Gets the instance of this application. More...
 
- Public Member Functions inherited from UM.Application.Application
def __init__
 Init method. More...
 
def addCommandLineOptions
 
def parseCliOptions
 
def initialize
 
def startSplashWindowPhase
 
def startPostSplashWindowPhase
 
def run
 Run the main event loop. More...
 
def getContainerRegistry
 
def getApplicationLockFilename
 Get the lock filename.
 
def setGlobalContainerStack
 
def getGlobalContainerStack
 
def hideMessage
 
def showMessage
 
def showToastMessage
 
def getVersion
 Get the version of the application.
 
def getBuildType
 Get the build type of the application.
 
def getIsDebugMode
 
def getIsHeadLess
 
def getUseExternalBackend
 
def hideMessageById
 Hide message by ID (as provided by built-in id function)
 
def getVisibleMessages
 Get list of all visible messages.
 
def getApplicationName
 Get name of the application. More...
 
def getPreferences
 Get the preferences. More...
 
def savePreferences
 
def getApplicationLanguage
 Get the currently used IETF language tag. More...
 
def getRequiredPlugins
 Application has a list of plugins that it must have. More...
 
def setRequiredPlugins
 Set the plugins that the application must have in order to function. More...
 
def setBackend
 Set the backend of the application (the program that does the heavy lifting). More...
 
def getBackend
 Get the backend of the application (the program that does the heavy lifting). More...
 
def getPluginRegistry
 Get the PluginRegistry of this application. More...
 
def getController
 Get the Controller of this application. More...
 
def getOperationStack
 
def getOutputDeviceManager
 
def getRenderer
 Return an application-specific Renderer object. More...
 
def functionEvent
 Post a function event onto the event loop. More...
 
def callLater
 Call a function the next time the event loop runs. More...
 
def getMainThread
 Get the application's main thread. More...
 
def addExtension
 
def getExtensions
 
def getInstance
 

Static Public Attributes

tuple pluginsLoaded = Signal()
 
tuple applicationRunning = Signal()
 
tuple recentFilesChanged = pyqtSignal()
 
tuple engineCreatedSignal = Signal()
 
tuple mainWindowChanged = Signal()
 
 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
tuple applicationShuttingDown = Signal()
 Emitted when the application window was closed and we need to shut down the application.
 
tuple showMessageSignal = Signal()
 
tuple hideMessageSignal = Signal()
 
tuple globalContainerStackChanged = Signal()
 
tuple workspaceLoaded = Signal()
 
tuple visibleMessageAdded = Signal()
 
tuple visibleMessageRemoved = Signal()
 

Additional Inherited Members

- Static Public Member Functions inherited from UM.Application.Application
def 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

def UM.Qt.QtApplication.QtApplication.backend (   self,
  Backend 
)

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
def UM.Qt.QtApplication.QtApplication.closeSplash (   self,
  None 
)

Close the splash screen after the application has started.

def UM.Qt.QtApplication.QtApplication.createQmlComponent (   self,
  qml_file_path 
)

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.
def UM.Qt.QtApplication.QtApplication.deleteAll (   self,
  only_selectable = True,
  None 
)

Delete all nodes containing mesh data in the scene.

Parameters
only_selectable.Set this to False to delete objects from all build plates
def UM.Qt.QtApplication.QtApplication.getBackend (   self,
  Backend 
)

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.

def UM.Qt.QtApplication.QtApplication.getInstance (   cls,
  args,
  kwargs,
  QtApplication 
)

Gets the instance of this application.

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

Returns
The instance of this application.
def UM.Qt.QtApplication.QtApplication.getMeshFileHandler (   self,
  MeshFileHandler 
)

Get the MeshFileHandler of this application.

def UM.Qt.QtApplication.QtApplication.showSplashMessage (   self,
  message 
)

Display text on the splash screen.

Member Data Documentation

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: