4.21. umbra.engine

engine.py

Platform:
Windows, Linux, Mac Os X.
Description:
This module is the main Umbra package module.
It defines various classes, methods and definitions to run, maintain and exit the Application.
The main Application object is the Umbra class.

Others:

4.21.1. Module Attributes

umbra.engine.LOGGER
umbra.engine.SESSION_HEADER_TEXT

4.21.2. Functions

umbra.engine.showProcessing(message=u'')[source]

This decorator is used for a processing operation.

Parameters:message – Operation description. ( String )
Returns:Object. ( Object )
umbra.engine.encapsulateProcessing(object)[source]

This decorator is used to encapsulate a processing operation.

Parameters:object – Object to decorate. ( Object )
Returns:Object. ( Object )
umbra.engine.setUserApplicationDataDirectory(path)[source]

This definition sets the Application data directory.

Parameters:path – Starting point for the directories tree creation. ( String )
Returns:Definition success. ( Boolean )
umbra.engine.getCommandLineParametersParser()[source]

This definition returns the command line parameters parser.

Returns:Parser. ( Parser )
umbra.engine.run(engine, parameters, componentsPaths=None, requisiteComponents=None, visibleComponents=None)[source]

This definition starts the Application.

Parameters:
  • engine – Engine. ( QObject )
  • parameters – Command line parameters. ( Tuple )
  • componentsPaths – Components componentsPaths. ( Tuple / List )
  • requisiteComponents – Requisite components names. ( Tuple / List )
  • visibleComponents – Visible components names. ( Tuple / List )
Returns:

Definition success. ( Boolean )

umbra.engine.exit(exitCode=0)[source]

This definition exits the Application.

Parameters:exitCode – Exit code. ( Integer )

4.21.3. Classes

class umbra.engine.Umbra(parent=None, componentsPaths=None, requisiteComponents=None, visibleComponents=None, *args, **kwargs)[source]

Bases: foundations.ui.common.QWidget

This class is the main class of the Umbra package.

Parameters:
  • componentsPaths – Components componentsPaths. ( Tuple / List )
  • requisiteComponents – Requisite components names. ( Tuple / List )
  • visibleComponents – Visible components names. ( Tuple / List )
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
verbosityLevelChanged

This signal is emited by the Umbra class when the current verbosity level has changed. ( pyqtSignal )

Returns:Current verbosity level. ( Integer )
contentDropped

This signal is emited by the Umbra class when it receives dropped content. ( pyqtSignal )

Returns:Event. ( QEvent )
sizeChanged

This signal is emited by the Umbra class when its size changes. ( pyqtSignal )

Returns:Event. ( QEvent )
timer[source]

This method is the property for self.__timer attribute.

Returns:self.__timer. ( QTimer )
requestsStack[source]

This method is the property for self.__requestsStack attribute.

Returns:self.__requestsStack. ( collections.deque )
componentsPaths[source]

This method is the property for self.__componentsPaths attribute.

Returns:self.__componentsPaths. ( Tuple / List )
requisiteComponents[source]

This method is the property for self.__requisiteComponents attribute.

Returns:self.__requisiteComponents. ( Tuple / List )
visibleComponents[source]

This method is the property for self.__visibleComponents attribute.

Returns:self.__visibleComponents. ( Tuple / List )
patchesManager[source]

This method is the property for self.__patchesManager attribute.

Returns:self.__patchesManager. ( ActionsManager )
componentsManager[source]

This method is the property for self.__componentsManager attribute.

Returns:self.__componentsManager. ( ComponentsManager )
notificationsManager[source]

This method is the property for self.__notificationsManager attribute.

Returns:self.__notificationsManager. ( NotificationsManager )
actionsManager[source]

This method is the property for self.__actionsManager attribute.

Returns:self.__actionsManager. ( ActionsManager )
fileSystemEventsManager[source]

This method is the property for self.__fileSystemEventsManager attribute.

Returns:self.__fileSystemEventsManager. ( FileSystemEventsManager )
layoutsManager[source]

This method is the property for self.__layoutsManager attribute.

Returns:self.__layoutsManager. ( LayoutsManager )
userApplicationDataDirectory[source]

This method is the property for self.__userApplicationDataDirectory attribute.

Returns:self.__userApplicationDataDirectory. ( String )
loggingSessionHandler[source]

This method is the property for self.__loggingSessionHandler attribute.

Returns:self.__loggingSessionHandler. ( Handler )
loggingFileHandler[source]

This method is the property for self.__loggingFileHandler attribute.

Returns:self.__loggingFileHandler. ( Handler )
loggingConsoleHandler[source]

This method is the property for self.__loggingConsoleHandler attribute.

Returns:self.__loggingConsoleHandler. ( Handler )
loggingSessionHandlerStream[source]

This method is the property for self.__loggingSessionHandlerStream attribute.

Returns:self.__loggingSessionHandlerStream. ( StreamObject )
settings[source]

This method is the property for self.__settings attribute.

Returns:self.__settings. ( QSettings )
verbosityLevel[source]

This method is the property for self.__verbosityLevel attribute.

Returns:self.__verbosityLevel. ( Integer )
parameters[source]

This method is the property for self.__parameters attribute.

Returns:self.__parameters. ( Object )
arguments[source]

This method is the property for self.__arguments attribute.

Returns:self.__arguments. ( List )
workerThreads[source]

This method is the property for self.__workerThreads attribute.

Returns:self.__workerThreads. ( List )
isProcessing[source]

This method is the property for self.__isProcessing attribute.

Returns:self.__isProcessing. ( Boolean )
locals[source]

This method is the property for self.__locals attribute.

Returns:self.__locals. ( Dictionary )
dragEnterEvent(event)[source]

This method reimplements the QWidget.dragEnterEvent() method.

Parameters:event – QEvent. ( QEvent )
dragMoveEvent(event)[source]

This method reimplements the QWidget.dragMoveEvent() method.

Parameters:event – QEvent. ( QEvent )
dropEvent(event)[source]

This method reimplements the QWidget.dropEvent() method.

Parameters:event – QEvent. ( QEvent )
show()[source]

This method reimplements the QWidget.show() method.

closeEvent(event)[source]

This method reimplements the QWidget.closeEvent() method.

Parameters:event – QEvent. ( QEvent )
resizeEvent(event)[source]

This method reimplements the QWidget.resizeEvent() method.

Parameters:event – QEvent. ( QEvent )
setVerbosityLevel(verbosityLevel)[source]

This method sets the Application verbosity level.

Parameters:verbosityLevel – Verbosity level. ( Integer )
Returns:Method success. ( Boolean )
Note :The expected verbosity level value is an integer between 0 to 4.
setVisualStyle(fullScreenStyle=False)[source]

This method sets the Application visual style.

Parameters:fullScreenStyle – Use fullscreen stylesheet file. ( Boolean )
Returns:Method success. ( Boolean )
isFullScreen()[source]

This method returns if Application is in fullscreen state.

Returns:FullScreen state. ( Boolean )
toggleFullScreen(*args)[source]

This method toggles Application fullscreen state.

Parameters:*args – Arguments. ( * )
Returns:Method success. ( Boolean )
processEvents(flags=0)[source]

This method process Application events.

Parameters:flags – Events flags. ( Integer )
Returns:Method success. ( Boolean )
setProcessingMessage(message, warning=True)[source]

This method sets the processing operation message.

Parameters:
  • message – Operation description. ( String )
  • warning – Emit warning message. ( Integer )
Returns:

Method success. ( Boolean )

startProcessing(message, steps=0, warning=True)[source]

This method registers the start of a processing operation.

Parameters:
  • message – Operation description. ( String )
  • steps – Operation steps. ( Integer )
  • warning – Emit warning message. ( Integer )
Returns:

Method success. ( Boolean )

stepProcessing(warning=True)[source]

This method steps the processing operation progress indicator.

Parameters:warning – Emit warning message. ( Integer )
Returns:Method success. ( Boolean )
stopProcessing(warning=True)[source]

This method registers the end of a processing operation.

Parameters:warning – Emit warning message. ( Integer )
Returns:Method success. ( Boolean )
garbageCollect()[source]

This method triggers the garbage collecting.

Returns:Number of unreachable objects found. ( Integer )
quit(exitCode=0, event=None)[source]

This method quits the Application.

Parameters:
  • exitCode – Exit code. ( Integer )
  • event – QEvent. ( QEvent )

Table Of Contents

Previous topic

4.20. umbra.components.factory.scriptEditor.workers

Next topic

4.22. umbra.exceptions

This Page