6.130. sibl_gui.components.core.templatesOutliner.templatesOutliner

templatesOutliner.py

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

Others:

6.130.1. Module Attributes

sibl_gui.components.core.templatesOutliner.templatesOutliner.LOGGER
sibl_gui.components.core.templatesOutliner.templatesOutliner.COMPONENT_UI_FILE

6.130.2. Classes

class sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner(parent=None, name=None, *args, **kwargs)[source]

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the sibl_gui.components.core.templatesOutliner.templatesOutliner Component Interface class.
It defines methods for Database Templates management.
Parameters:
  • parent – Object parent. ( QObject )
  • name – Component name. ( String )
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
refreshNodes

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

uiResourcesDirectory[source]

This method is the property for self.__uiResourcesDirectory attribute.

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

This method is the property for self.__uiSoftwareAffixe attribute.

Returns:self.__uiSoftwareAffixe. ( String )
uiUnknownSoftwareImage[source]

This method is the property for self.__uiUnknownSoftwareImage attribute.

Returns:self.__uiUnknownSoftwareImage. ( 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 )
settingsSection[source]

This method is the property for self.__settingsSection attribute.

Returns:self.__settingsSection. ( String )
settingsSeparator[source]

This method is the property for self.__settingsSeparator attribute.

Returns:self.__settingsSeparator. ( String )
scriptEditor[source]

This method is the property for self.__scriptEditor attribute.

Returns:self.__scriptEditor. ( QWidget )
database[source]

This method is the property for self.__database attribute.

Returns:self.__database. ( Object )
model[source]

This method is the property for self.__model attribute.

Returns:self.__model. ( TemplatesModel )
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. ( OrderedDict )
extension[source]

This method is the property for self.__extension attribute.

Returns:self.__extension. ( String )
defaultCollections[source]

This method is the property for self.__defaultCollections attribute.

Returns:self.__defaultCollections. ( Dictionary )
factoryCollection[source]

This method is the property for self.__factoryCollection attribute.

Returns:self.__factoryCollection. ( String )
userCollection[source]

This method is the property for self.__userCollection attribute.

Returns:self.__userCollection. ( String )
templatesInformationsDefaultText[source]

This method is the property for self.__templatesInformationsDefaultText attribute.

Returns:self.__templatesInformationsDefaultText. ( String )
treeViewInnerMargins[source]

This method is the property for self.__treeViewInnerMargins attribute.

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

This method is the property for self.__templatesInformationsText attribute.

Returns:self.__templatesInformationsText. ( 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 decorator is used for exceptions handling.

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

This method initializes the Component ui.

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

This decorator is used for exceptions handling.

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

This method adds the Component Widget to the engine.

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

This decorator is used for exceptions handling.

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

This method is triggered on Framework startup.

Returns:Method success. ( Boolean )
onClose()[source]

This method is triggered on Framework close.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This decorator is used for exceptions handling.

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

This method returns if given Template path exists in the Database.

Parameters:name – Template path. ( String )
Returns:Template exists. ( Boolean )
displayHelpFile(*args, **kwargs)[source]

This decorator is used for exceptions handling.

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

This method returns Database Templates Collections.

Returns:Database Templates Collections. ( List )
filterCollections(pattern, attribute, flags=2)[source]

This method filters the Database Templates Collections on given attribute using given pattern.

Parameters:
  • pattern – Filter pattern. ( String )
  • attribute – Attribute to filter on. ( String )
  • flags – Regex filtering flags. ( Integer )
Returns:

Filtered Database Templates Collections. ( List )

getTemplates()[source]

This method returns Database Templates.

Returns:Database Templates. ( List )
filterTemplates(pattern, attribute, flags=2)[source]

This method filters the Database Templates on given attribute using given pattern.

Parameters:
  • pattern – Filter pattern. ( String )
  • attribute – Attribute to filter on. ( String )
  • flags – Regex filtering flags. ( Integer )
Returns:

Filtered Database Templates. ( List )

listTemplates()[source]

This method lists Database Templates names.

Returns:Database Templates names. ( List )
setTemplates()[source]

This method sets the Templates Model nodes.

getTemplateByName(name)[source]

This method returns Database Template with given name.

Parameters:name – Template name. ( String )
Returns:Database Template. ( Template )
Note :The filtering is actually performed on ‘title’ attributes instead of ‘name’ attributes.
getCollectionByName(name)[source]

This method gets Templates Collection from given Collection name.

Parameters:collection – Collection name. ( String )
Returns:Collection. ( Collection )
getCollectionId(collection)[source]

This method returns given Collection id.

Parameters:collection – Collection to get the id from. ( String )
Returns:Provided Collection id. ( Integer )
getSelectedNodes()[source]

This method returns the View selected nodes.

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

This method returns the View selected Templates nodes.

Returns:View selected Templates nodes. ( List )
getSelectedTemplates()[source]

This method gets the View selected Templates.

Returns:View selected Templates. ( List )