6.110. sibl_gui.components.core.collectionsOutliner.collectionsOutliner

collectionsOutliner.py

Platform:

Windows, Linux, Mac Os X.

Description:

This module defines the CollectionsOutliner Component Interface class.

Others:

6.110.1. Module Attributes

sibl_gui.components.core.collectionsOutliner.collectionsOutliner.LOGGER

sibl_gui.components.core.collectionsOutliner.collectionsOutliner.COMPONENT_UI_FILE

6.110.2. Classes

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

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the sibl_gui.components.core.collectionsOutliner.collectionsOutliner Component Interface class.

It defines methods for Database Collections management.

Parameters:

• parent – Object parent. ( QObject )
• name – Component name. ( String )
• *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

This method is the property for self.__uiResourcesDirectory attribute.

Returns:self.__uiResourcesDirectory. ( String )

uiDefaultCollectionImage

This method is the property for self.__uiDefaultCollectionImage attribute.

Returns:self.__uiDefaultCollectionImage. ( String )

uiUserCollectionImage

This method is the property for self.__uiUserCollectionImage attribute.

Returns:self.__uiUserCollectionImage. ( String )

dockArea

This method is the property for self.__dockArea attribute.

Returns:self.__dockArea. ( Integer )

engine

This method is the property for self.__engine attribute.

Returns:self.__engine. ( QObject )

settings

This method is the property for self.__settings attribute.

Returns:self.__settings. ( QSettings )

settingsSection

This method is the property for self.__settingsSection attribute.

Returns:self.__settingsSection. ( String )

settingsSeparator

This method is the property for self.__settingsSeparator attribute.

Returns:self.__settingsSeparator. ( String )

iblSetsOutliner

This method is the property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner. ( QWidget )

model

This method is the property for self.__model attribute.

Returns:self.__model. ( CollectionsModel )

view

This method is the property for self.__view attribute.

Returns:self.__view. ( QWidget )

overallCollection

This method is the property for self.__overallCollection attribute.

Returns:self.__overallCollection. ( String )

defaultCollection

This method is the property for self.__defaultCollection attribute.

Returns:self.__defaultCollection. ( String )

iblSetsCountLabel

This method is the property for self.__iblSetsCountLabel attribute.

Returns:self.__iblSetsCountLabel. ( String )

headers

This method is the property for self.__headers attribute.

Returns:self.__headers. ( OrderedDict )

activate(engine)

This method activates the Component.

Parameters:engine – Engine to attach the Component to. ( QObject ) Returns:Method success. ( Boolean )

deactivate()

This method deactivates the Component.

initializeUi()

This method initializes the Component ui.

Returns:Method success. ( Boolean )

uninitializeUi()

This method uninitializes the Component ui.

addWidget()

This method adds the Component Widget to the engine.

Returns:Method success. ( Boolean )

removeWidget()

This method removes the Component Widget from the engine.

onStartup()

This method is triggered on Framework startup.

Returns:Method success. ( Boolean )

onClose()

This method is triggered on Framework close.

Returns:Method success. ( Boolean )

addContentUi()

This method adds user defined content to the Database.

Returns:Method success. ( Boolean ) Note :This method may require user interaction.

addCollectionUi()

This method adds an user defined Collection to the Database.

Returns:Collection name. ( String ) Note :This method may require user interaction.

removeCollectionsUi()

This method removes user selected Collections from the Database.

Returns:Method success. ( Boolean ) Note :This method may require user interaction.

addCollection(name, comment='Double click to set a comment!')

This method adds a Collection to the Database.

Parameters:

• name – Collection name. ( String )
• collection – Collection name. ( String )

Returns:

Method success. ( Boolean )

removeCollection(collection)

This method removes given Collection from the Database.

Parameters:collection – Collection to remove. ( Collection ) Returns:Method success. ( Boolean )

getCollections()

This method returns Database Ibl Sets Collections.

Returns:Database Ibl Sets Collections. ( List )

filterCollections(pattern, attribute, flags=2)

This method filters the Database Ibl Sets 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 Ibl Sets Collections. ( List )

collectionExists(name)

This method returns if given Collection name exists in the Database.

Parameters:name – Collection name. ( String ) Returns:Collection exists. ( Boolean )

listCollections()

This method lists Database Ibl Sets Collections names.

Returns:Database Ibl Sets Collections names. ( List )

setCollections()

This method sets the Collections Model nodes.

getCollectionByName(name)

This method returns Database Ibl Sets Collection with given name.

Parameters:name – Collection name. ( String ) Returns:Database Ibl Sets Collection. ( Collection )

getCollectionsIblSets(collections)

This method gets given Collections Ibl Sets.

Parameters:collections – Collections to get Ibl Sets from. ( List ) Returns:Ibl Sets list. ( List )

getCollectionId(collection)

This method returns given Collection id.

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

getSelectedNodes()

This method returns the View selected nodes.

Returns:View selected nodes. ( Dictionary )

getSelectedCollectionsNodes()

This method returns the View selected Collections nodes.

Returns:View selected Collections nodes. ( List )

getSelectedCollections()

This method gets the View selected Collections.

Returns:View selected Collections. ( List )