Uranium
Application Framework
UM.Application.Application Class Reference
Inheritance diagram for UM.Application.Application:
UM.Qt.QtApplication.QtApplication

Public Member Functions

def __init__
 
def getAPIVersion (self)
 
def getWorkspaceMetadataStorage (self)
 
def getCurrentWorkspaceInformation (self)
 
def addCommandLineOptions (self)
 
def parseCliOptions (self)
 
def initialize (self)
 
def startSplashWindowPhase (self)
 
def startPostSplashWindowPhase (self)
 
def hasJustUpdatedFromOldVersion (self)
 
def run (self)
 
def getContainerRegistry (self)
 
def getApplicationLockFilename (self)
 
def setGlobalContainerStack
 
def getGlobalContainerStack (self)
 
def hideMessage
 
def showMessage
 
def showToastMessage
 
def getVersion (self)
 
def getBuildType (self)
 
def getIsDebugMode (self)
 
def getIsHeadLess (self)
 
def getUseExternalBackend (self)
 
def hideMessageById
 
def getVisibleMessages (self)
 
def getApplicationName (self)
 
def getApplicationDisplayName (self)
 
def getPreferences (self)
 
def savePreferences (self)
 
def getApplicationLanguage (self)
 
def getRequiredPlugins (self)
 
def setRequiredPlugins
 
def setBackend
 
def getBackend (self)
 
def getPluginRegistry (self)
 
def getController (self)
 
def getOperationStack (self)
 
def getOutputDeviceManager (self)
 
def getRenderer (self)
 
def functionEvent
 
def callLater
 
def getMainThread (self)
 
def addExtension
 
def getExtensions (self)
 
def addFileProvider
 
def getFileProviders (self)
 
def getInstance (cls, args, kwargs)
 

Static Public Member Functions

def getAppFolderPrefix ()
 
def getInstallPrefix ()
 

Public Attributes

 default_theme
 

Static Public Attributes

 applicationShuttingDown = Signal()
 
 showMessageSignal = Signal()
 
 hideMessageSignal = Signal()
 
 globalContainerStackChanged = Signal()
 
 workspaceLoaded = Signal()
 
 visibleMessageAdded = Signal()
 
 visibleMessageRemoved = Signal()
 

Detailed Description

Central object responsible for running the main event loop and creating other central objects.

The Application object is a central object for accessing other important objects. It is also
responsible for starting the main event loop. It is passed on to plugins so it can be easily
used to access objects required for those plugins.

Member Function Documentation

◆ getApplicationLanguage()

def UM.Application.Application.getApplicationLanguage (   self,
  str 
)
Get the currently used IETF language tag.
The returned tag is during runtime used to translate strings.
:returns: Language tag.

◆ getApplicationLockFilename()

def UM.Application.Application.getApplicationLockFilename (   self,
  str 
)
Get the lock filename

◆ getApplicationName()

def UM.Application.Application.getApplicationName (   self,
  str 
)
Get name of the application.
:returns: app_name

◆ getBackend()

def UM.Application.Application.getBackend (   self,
  Backend 
)
Get the backend of the application (the program that does the heavy lifting).
:returns: Backend

◆ getBuildType()

def UM.Application.Application.getBuildType (   self,
  str 
)
Get the build type of the application

◆ getController()

def UM.Application.Application.getController (   self,
  Controller 
)
Get the Controller of this application.
:returns: Controller

◆ getMainThread()

def UM.Application.Application.getMainThread (   self,
  threading,
  Thread 
)
Get the application's main thread.

◆ getPluginRegistry()

def UM.Application.Application.getPluginRegistry (   self,
  PluginRegistry 
)
Get the PluginRegistry of this application.
:returns: PluginRegistry

◆ getPreferences()

def UM.Application.Application.getPreferences (   self,
  Preferences 
)
Get the preferences.
:return: preferences

◆ getRenderer()

def UM.Application.Application.getRenderer (   self,
  Renderer 
)
Return an application-specific Renderer object.
:exception NotImplementedError

◆ getRequiredPlugins()

def UM.Application.Application.getRequiredPlugins (   self,
  List,
  str 
)
Application has a list of plugins that it *must* have. If it does not have these, it cannot function.
These plugins can not be disabled in any way.

◆ getVersion()

def UM.Application.Application.getVersion (   self,
  str 
)
Get the version of the application

◆ getVisibleMessages()

def UM.Application.Application.getVisibleMessages (   self,
  List,
  Message 
)
Get list of all visible messages

◆ run()

def UM.Application.Application.run (   self)
Run the main event loop.
This method should be re-implemented by subclasses to start the main event loop.
:exception NotImplementedError:

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