4.10. umbra.components.factory.componentsManagerUi.componentsManagerUi

componentsManagerUi.py

Platform:
Windows, Linux, Mac Os X.
Description:
This module defines the ComponentsManagerUi Component Interface class.

Others:

4.10.1. Module Attributes

umbra.components.factory.componentsManagerUi.componentsManagerUi.LOGGER
umbra.components.factory.componentsManagerUi.componentsManagerUi.COMPONENT_UI_FILE

4.10.2. Classes

class umbra.components.factory.componentsManagerUi.componentsManagerUi.ComponentsManagerUi(parent=None, name=None, *args, **kwargs)[source]

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the umbra.components.factory.componentsManagerUi.componentsManagerUi Component Interface class.
It defines methods to interact with the manager.componentsManager.Manager class Application instance Components.
Parameters:
  • parent – Object parent. ( QObject )
  • name – Component name. ( String )
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
refreshNodes

This signal is emited by the ComponentsManagerUi class when ComponentsManagerUi.model class property model Nodes nodes needs to be refreshed. ( pyqtSignal )

activatedComponent

This signal is emited by the ComponentsManagerUi class when a Component is activated. ( pyqtSignal )

Returns:Activated Component name. ( String )
deactivatedComponent

This signal is emited by the ComponentsManagerUi class when a Component is deactivated. ( pyqtSignal )

Returns:Deactivated Component name. ( String )
reloadedComponent

This signal is emited by the ComponentsManagerUi class when a Component is reloaded. ( pyqtSignal )

Returns:Reloaded Component name. ( String )
uiResourcesDirectory[source]

This method is the property for self.__uiResourcesDirectory attribute.

Returns:self.__uiResourcesDirectory. ( String )
uiActivatedImage[source]

This method is the property for self.__uiActivatedImage attribute.

Returns:self.__uiActivatedImage. ( String )
uiDeactivatedImage[source]

This method is the property for self.__uiDeactivatedImage attribute.

Returns:self.__uiDeactivatedImage. ( String )
uiCategoryAffixe[source]

This method is the property for self.__uiCategoryAffixe attribute.

Returns:self.__uiCategoryAffixe. ( String )
dockArea[source]

This method is the property for self.__dockArea attribute.

Returns:self.__dockArea. ( Integer )
engine[source]

This method is the property for self.__engine attribute.

Returns:self.__engine. ( QObject )
settings[source]

This method is the property for self.__settings attribute.

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

This method is the property for self.__model attribute.

Returns:self.__model. ( ComponentsModel )
view[source]

This method is the property for self.__view attribute.

Returns:self.__view. ( QWidget )
headers[source]

This method is the property for self.__headers attribute.

Returns:self.__headers. ( List )
treeViewInnerMargins[source]

This method is the property for self.__treeViewInnerMargins attribute.

Returns:self.__treeViewInnerMargins. ( Integer )
componentsInformationsDefaultText[source]

This method is the property for self.__componentsInformationsDefaultText attribute.

Returns:self.__componentsInformationsDefaultText. ( String )
componentsInformationsText[source]

This method is the property for self.__componentsInformationsText attribute.

Returns:self.__componentsInformationsText. ( String )
activate(engine)[source]

This method activates the Component.

Parameters:engine – Engine to attach the Component to. ( QObject )
Returns:Method success. ( Boolean )
deactivate(*args, **kwargs)[source]

This method deactivates the Component.

initializeUi()[source]

This method initializes the Component ui.

Returns:Method success. ( Boolean )
uninitializeUi(*args, **kwargs)[source]

This method uninitializes the Component ui.

addWidget()[source]

This method adds the Component Widget to the engine.

Returns:Method success. ( Boolean )
removeWidget(*args, **kwargs)[source]

This method removes the Component Widget from the engine.

onStartup()[source]

This method is triggered on Framework startup.

Returns:Method success. ( Boolean )
activateComponentsUi(*args, **kwargs)[source]

This decorator is used to encapsulate a processing operation.

Parameters:
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
deactivateComponentsUi(*args, **kwargs)[source]

This decorator is used to encapsulate a processing operation.

Parameters:
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
reloadComponentsUi(*args, **kwargs)[source]

This decorator is used to encapsulate a processing operation.

Parameters:
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
activateComponent(*args, **kwargs)[source]

This method activates given Component.

Parameters:name – Component name. ( String )
Returns:Method success. ( Boolean )
deactivateComponent(*args, **kwargs)[source]

This method deactivates given Component.

Parameters:name – Component name. ( String )
Returns:Method success. ( Boolean )
reloadComponent(*args, **kwargs)[source]

This method reloads given Component.

Parameters:name – Component name. ( String )
Returns:Method success. ( Boolean )
getComponents()[source]

This method returns the Components.

Returns:Components. ( List )
listComponents()[source]

This method lists the Components names.

Returns:Components names. ( List )
setComponents()[source]

This method sets the Components Model nodes.

getSelectedNodes()[source]

This method returns the View selected nodes.

Returns:View selected nodes. ( Dictionary )
getSelectedComponentsNodes()[source]

This method returns the View selected Components nodes.

Returns:View selected Components nodes. ( List )
getSelectedComponents()[source]

This method gets the View selected Components.

Returns:View selected Components. ( List )