6.117. sibl_gui.components.core.collectionsOutliner.collectionsOutliner

collectionsOutliner.py

Platform:
Windows, Linux, Mac Os X.
Description:
Defines the CollectionsOutliner Component Interface class.

Others:

6.117.1. Module Attributes

sibl_gui.components.core.collectionsOutliner.collectionsOutliner.LOGGER
sibl_gui.components.core.collectionsOutliner.collectionsOutliner.COMPONENT_UI_FILE

6.117.2. Classes

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

Bases: manager.qwidgetComponent.QWidgetComponent

It defines methods for Database Collections management.

Initializes the class.

Parameters:
  • parent (QObject) – Object parent.
  • name (unicode) – Component name.
  • *args (*) – Arguments.
  • **kwargs (**) – Keywords arguments.
refreshNodes

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

uiResourcesDirectory[source]

Property for self.__uiResourcesDirectory attribute.

Returns:self.__uiResourcesDirectory.
Return type:unicode
uiDefaultCollectionImage[source]

Property for self.__uiDefaultCollectionImage attribute.

Returns:self.__uiDefaultCollectionImage.
Return type:unicode
uiUserCollectionImage[source]

Property for self.__uiUserCollectionImage attribute.

Returns:self.__uiUserCollectionImage.
Return type:unicode
dockArea[source]

Property for self.__dockArea attribute.

Returns:self.__dockArea.
Return type:int
engine[source]

Property for self.__engine attribute.

Returns:self.__engine.
Return type:QObject
settings[source]

Property for self.__settings attribute.

Returns:self.__settings.
Return type:QSettings
settingsSection[source]

Property for self.__settingsSection attribute.

Returns:self.__settingsSection.
Return type:unicode
settingsSeparator[source]

Property for self.__settingsSeparator attribute.

Returns:self.__settingsSeparator.
Return type:unicode
iblSetsOutliner[source]

Property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner.
Return type:QWidget
model[source]

Property for self.__model attribute.

Returns:self.__model.
Return type:CollectionsModel
view[source]

Property for self.__view attribute.

Returns:self.__view.
Return type:QWidget
overallCollection[source]

Property for self.__overallCollection attribute.

Returns:self.__overallCollection.
Return type:unicode
defaultCollection[source]

Property for self.__defaultCollection attribute.

Returns:self.__defaultCollection.
Return type:unicode
iblSetsCountLabel[source]

Property for self.__iblSetsCountLabel attribute.

Returns:self.__iblSetsCountLabel.
Return type:unicode
headers[source]

Property for self.__headers attribute.

Returns:self.__headers.
Return type:OrderedDict
activate(engine)[source]

Activates the Component.

Parameters:engine (QObject) – Engine to attach the Component to.
Returns:Method success.
Return type:bool
deactivate()[source]

Deactivates the Component.

initializeUi()[source]

Initializes the Component ui.

Returns:Method success.
Return type:bool
uninitializeUi()[source]

Uninitializes the Component ui.

addWidget()[source]

Adds the Component Widget to the engine.

Returns:Method success.
Return type:bool
removeWidget()[source]

Removes the Component Widget from the engine.

onStartup()[source]

Defines the slot triggered on Framework startup.

Returns:Method success.
Return type:bool
onClose()[source]

Defines the slot triggered on Framework close.

Returns:Method success.
Return type:bool
addContentUi()[source]

Adds user defined content to the Database.

Returns:Method success.
Return type:bool
Note:May require user interaction.
addCollectionUi()[source]

Adds an user defined Collection to the Database.

Returns:Collection name.
Return type:unicode
Note:May require user interaction.
removeCollectionsUi()[source]

Removes user selected Collections from the Database.

Returns:Method success.
Return type:bool
Note:May require user interaction.
addCollection(name, comment=u'Double click to set a comment!')[source]

Adds a Collection to the Database.

Parameters:
  • name (unicode) – Collection name.
  • collection (unicode) – Collection name.
Returns:

Method success.

Return type:

bool

removeCollection(collection)[source]

Removes given Collection from the Database.

Parameters:collection (Collection) – Collection to remove.
Returns:Method success.
Return type:bool
getCollections()[source]

Returns Database Ibl Sets Collections.

Returns:Database Ibl Sets Collections.
Return type:list
filterCollections(pattern, attribute, flags=2)[source]

Filters the Database Ibl Sets Collections on given attribute using given pattern.

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

Filtered Database Ibl Sets Collections.

Return type:

list

collectionExists(name)[source]

Returns if given Collection name exists in the Database.

Parameters:name (unicode) – Collection name.
Returns:Collection exists.
Return type:bool
listCollections()[source]

Lists Database Ibl Sets Collections names.

Returns:Database Ibl Sets Collections names.
Return type:list
setCollections()[source]

Sets the Collections Model nodes.

getCollectionByName(name)[source]

Returns Database Ibl Sets Collection with given name.

Parameters:name (unicode) – Collection name.
Returns:Database Ibl Sets Collection.
Return type:Collection
getCollectionsIblSets(collections)[source]

Gets given Collections Ibl Sets.

Parameters:collections (list) – Collections to get Ibl Sets from.
Returns:Ibl Sets list.
Return type:list
getCollectionId(collection)[source]

Returns given Collection id.

Parameters:collection (unicode) – Collection to get the id from.
Returns:Provided Collection id.
Return type:int
getSelectedNodes()[source]

Returns the View selected nodes.

Returns:View selected nodes.
Return type:dict
getSelectedCollectionsNodes()[source]

Returns the View selected Collections nodes.

Returns:View selected Collections nodes.
Return type:list
getSelectedCollections()[source]

Gets the View selected Collections.

Returns:View selected Collections.
Return type:list