6.119. sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner

iblSetsOutliner.py

Platform:

Windows, Linux, Mac Os X.

Description:

This module defines the IblSetsOutliner Component Interface class.

Others:

6.119.1. Module Attributes

sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.LOGGER

sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.COMPONENT_UI_FILE

6.119.2. Classes

class sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.IblSetsOutliner(parent=None, name=None, *args, **kwargs)

Bases: manager.qwidgetComponent.QWidgetComponent

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

It defines methods for Database Ibl Sets management.

Parameters:

• parent – Object parent. ( QObject )
• name – Component name. ( String )
• *args – Arguments. ( * )
• **kwargs – Keywords arguments. ( ** )

refreshNodes

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

activeViewChanged

This signal is emited by the IblSetsOutliner class when the current active View is changed. ( pyqtSignal )

Returns:Current active view index. ( Integer )

uiResourcesDirectory

This method is the property for self.__uiResourcesDirectory attribute.

Returns:self.__uiResourcesDirectory. ( String )

uiThumbnailsViewImage

This method is the property for self.__uiThumbnailsViewImage attribute.

Returns:self.__uiThumbnailsViewImage. ( String )

uiColumnsViewImage

This method is the property for self.__uiColumnsViewImage attribute.

Returns:self.__uiColumnsViewImage. ( String )

uiDetailsViewImage

This method is the property for self.__uiDetailsViewImage attribute.

Returns:self.__uiDetailsViewImage. ( String )

uiLargestSizeImage

This method is the property for self.__uiLargestSizeImage attribute.

Returns:self.__uiLargestSizeImage. ( String )

uiSmallestSizeImage

This method is the property for self.__uiSmallestSizeImage attribute.

Returns:self.__uiSmallestSizeImage. ( String )

uiPanoramicLoadingImage

This method is the property for self.__uiPanoramicLoadingImage attribute.

Returns:self.__uiPanoramicLoadingImage. ( String )

uiSquareLoadingImage

This method is the property for self.__uiSquareLoadingImage attribute.

Returns:self.__uiSquareLoadingImage. ( String )

uiSwitchThumbnailsTypeImage

This method is the property for self.__uiSwitchThumbnailsTypeImage attribute.

Returns:self.__uiSwitchThumbnailsTypeImage. ( 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 )

extension

This method is the property for self.__extension attribute.

Returns:self.__extension. ( String )

inspectLayout

This method is the property for self.__inspectLayout attribute.

Returns:self.__inspectLayout. ( String )

scriptEditor

This method is the property for self.__scriptEditor attribute.

Returns:self.__scriptEditor. ( QWidget )

collectionsOutliner

This method is the property for self.__collectionsOutliner attribute.

Returns:self.__collectionsOutliner. ( QWidget )

model

This method is the property for self.__model attribute.

Returns:self.__model. ( IblSetsModel )

views

This method is the property for self.__views attribute.

Returns:self.__views. ( Tuple )

viewsPushButtons

This method is the property for self.__viewsPushButtons attribute.

Returns:self.__viewsPushButtons. ( Dictionary )

thumbnailsView

This method is the property for self.__thumbnailsView attribute.

Returns:self.__thumbnailsView. ( QListView )

detailsView

This method is the property for self.__detailsView attribute.

Returns:self.__detailsView. ( QTreeView )

detailsViewHeaders

This method is the property for self.__detailsViewHeaders attribute.

Returns:self.__detailsViewHeaders. ( OrderedDict )

panoramicThumbnails

This method is the property for self.__panoramicThumbnails attribute.

Returns:self.__panoramicThumbnails. ( Boolean )

panoramicThumbnailsSize

This method is the property for self.__panoramicThumbnailsSize attribute.

Returns:self.__panoramicThumbnailsSize. ( String )

squareThumbnailsSize

This method is the property for self.__squareThumbnailsSize attribute.

Returns:self.__squareThumbnailsSize. ( String )

thumbnailsMinimumSize

This method is the property for self.__thumbnailsMinimumSize attribute.

Returns:self.__thumbnailsMinimumSize. ( Dictionary )

searchContexts

This method is the property for self.__searchContexts attribute.

Returns:self.__searchContexts. ( OrderedDict )

activeSearchContext

This method is the property for self.__activeSearchContext attribute.

Returns:self.__activeSearchContext. ( OrderedDict )

searchContextMenu

This method is the property for self.__searchContextMenu attribute.

Returns:self.__searchContextMenu. ( QMenu )

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 )

getActiveView()

This method returns the current active View.

Returns:Current active View. ( QWidget )

getActiveViewIndex()

This method returns the current active View index.

Returns:Current active View index. ( Integer )

setActiveView(view)

This method sets the active View to given View.

Parameters:view – View. ( QWidget ) Returns:Method success. ( Boolean )

setActiveViewIndex(index)

This method sets the active View to given index.

Parameters:index – Index. ( Integer ) Returns:Method success. ( Boolean )

setActiveSearchContext(context, *args)

This method sets the active search context.

Parameters:

• context – Search context. ( String )
• *args – Arguments. ( * )

Returns:

Method succes. ( Boolean )

setPanoramicThumbnails(state)

This method sets the panoramic thumbnails.

Parameters:state – Panoramic thumbnails. ( Boolean ) Returns:Method succes. ( Boolean )

addContentUi()

This method adds user defined content to the Database.

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

addIblSetUi()

This method adds an user defined Ibl Set to the Database.

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

removeIblSetsUi()

This method removes user selected Ibl Sets from the Database.

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

updateIblSetLocationUi(iblSet)

This method updates given Ibl Set location.

Parameters:iblSet – Ibl Set to update. ( IblSet ) Returns:Method success. ( Boolean ) Note :This method may require user interaction.

updateSelectedIblSetsLocationUi()

This method updates user selected Ibl Sets locations.

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

addIblSet(name, path, collectionId=None)

This method adds an Ibl Set to the Database.

Parameters:

• name – Ibl Set name. ( String )
• path – Ibl Set path. ( String )
• collectionId – Target Collection id. ( Integer )

Returns:

Method success. ( Boolean )

addDirectory(directory, collectionId=None)

This method adds directory Ibl Sets to the Database.

Parameters:

• directory – Directory to add. ( String )
• collectionId – Target Collection id. ( Integer )

Returns:

Method success. ( Boolean )

removeIblSet(iblSet)

This method removes given Ibl Set from the Database.

Parameters:iblSet – Ibl Set to remove. ( IblSet ) Returns:Method success. ( Boolean )

updateIblSetLocation(iblSet, file)

This method updates given Ibl Set location.

Parameters:

• iblSet – Ibl Set to update. ( IblSet )
• iblSet – New Ibl Set file. ( String )

Returns:

Method success. ( Boolean )

getIblSets()

This method returns Database Ibl Sets.

Returns:Database Ibl Sets. ( List )

filterIblSets(pattern, attribute, flags=2)

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

iblSetExists(path)

This method returns if given Ibl Set path exists in the Database.

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

listIblSets()

This method lists Database Ibl Sets names.

Returns:Database Ibl Sets names. ( List ) Note :The list is actually returned using ‘title’ attributes instead of ‘name’ attributes

setIblSets(iblSets=None)

This method sets the Ibl Sets Model nodes.

Parameters:iblSets – Ibl Sets to set. ( List ) Returns:Method success. ( Boolean )

getIblSetByName(name)

This method returns Database Ibl Set with given name.

Parameters:name – Ibl Set name. ( String ) Returns:Database Ibl Set. ( IblSet ) Note :The filtering is actually performed on ‘title’ attributes instead of ‘name’ attributes.

getSelectedNodes()

This method returns the current active View selected nodes.

Returns:View selected nodes. ( Dictionary )

getSelectedIblSetsNodes()

This method returns the current active View selected Ibl Sets nodes.

Returns:View selected Ibl Sets nodes. ( List )

getSelectedIblSets()

This method returns the current active View selected Ibl Sets.

Returns:View selected Ibl Sets. ( List )