Uranium
Application Framework
UM.Application.Application Class Reference

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

Inheritance diagram for UM.Application.Application:
UM.Qt.QtApplication.QtApplication

Public Member Functions

def __init__
 Init method. More...
 
def getPreferences (self)
 
def getContainerRegistry (self)
 
def setGlobalContainerStack
 
def getGlobalContainerStack (self)
 
def hideMessage
 
def showMessage
 
def showToastMessage
 
def getVersion (self)
 Get the version of the application. More...
 
def getStaticVersion (cls)
 
def getBuildType (self)
 Get the buildtype of the application. More...
 
def getIsDebugMode (self)
 
def hideMessageById
 Hide message by ID (as provided by built-in id function)
 
def getVisibleMessages (self)
 Get list of all visible messages.
 
def getCommandLineOption
 
def getApplicationName (self)
 Get name of the application. More...
 
def getPreferences (self)
 Get the preferences. More...
 
def getApplicationLanguage (self)
 Get the currently used IETF language tag. More...
 
def getRequiredPlugins (self)
 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 (self)
 Get the backend of the application (the program that does the heavy lifting). More...
 
def getPluginRegistry (self)
 Get the PluginRegistry of this application. More...
 
def getController (self)
 Get the Controller of this application. More...
 
def getOperationStack (self)
 
def getOutputDeviceManager (self)
 
def preRun (self)
 Includes eg. More...
 
def run (self)
 Run the main event loop. More...
 
def getRenderer (self)
 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 (self)
 Get the application's main thread. More...
 
def getInstance (cls, kwargs)
 Return the singleton instance of the application object.
 
def getCommandlineParser
 
def parseCommandLine (self)
 
def addCommandLineOptions
 Can be overridden to add additional command line options to the parser. More...
 
def addExtension
 
def getExtensions (self)
 

Static Public Member Functions

def getInstallPrefix ()
 

Public Attributes

 default_theme
 

Static Public Attributes

 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()
 

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.

Constructor & Destructor Documentation

◆ __init__()

def UM.Application.Application.__init__ (   self,
  name 
)

Init method.

Parameters
nameThe name of the application.
versionVersion, formatted as major.minor.rev
build_typeAdditional version info on the type of build this is, such as "master".
is_debug_modeWhether to run in debug mode.
parserThe command line parser to use.

Member Function Documentation

◆ addCommandLineOptions()

def UM.Application.Application.addCommandLineOptions (   cls,
  parser 
)

Can be overridden to add additional command line options to the parser.

Parameters
parserThe parser that will parse the command line.

◆ callLater()

def UM.Application.Application.callLater (   self,
  func 
)

Call a function the next time the event loop runs.

You can't get the result of this function directly. It won't block.

Parameters
functionThe function to call.
argsThe positional arguments to pass to the function.
kwargsThe keyword arguments to pass to the function.

◆ functionEvent()

def UM.Application.Application.functionEvent (   self,
  event 
)

Post a function event onto the event loop.

This takes a CallFunctionEvent object and puts it into the actual event loop.

Exceptions
NotImplementedError

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

◆ getApplicationName()

def UM.Application.Application.getApplicationName (   self,
  str 
)

Get name of the application.

Returns
application_name string

◆ getBackend()

def UM.Application.Application.getBackend (   self,
  Backend 
)

Get the backend of the application (the program that does the heavy lifting).

Returns
Backend Backend

◆ getBuildType()

def UM.Application.Application.getBuildType (   self,
  str 
)

Get the buildtype of the application.

Returns
version string

◆ getController()

def UM.Application.Application.getController (   self,
  Controller 
)

Get the Controller of this application.

Returns
Controller 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 PluginRegistry

◆ getPreferences()

def UM.Application.Application.getPreferences (   self,
  Preferences 
)

Get the preferences.

Returns
preferences Preferences

◆ getRenderer()

def UM.Application.Application.getRenderer (   self,
  Renderer 
)

Return an application-specific Renderer object.

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

Returns
version string

◆ preRun()

def UM.Application.Application.preRun (   self,
  None 
)

Includes eg.

last checks before entering the main event loop.

◆ run()

def UM.Application.Application.run (   self,
  None 
)

Run the main event loop.

This method should be re-implemented by subclasses to start the main event loop.

Exceptions
NotImplementedError

◆ setBackend()

def UM.Application.Application.setBackend (   self,
  backend 
)

Set the backend of the application (the program that does the heavy lifting).

◆ setRequiredPlugins()

def UM.Application.Application.setRequiredPlugins (   self,
  plugin_names 
)

Set the plugins that the application must have in order to function.

Parameters
plugin_nameslist List of strings with the names of the required plugins

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