6.126. sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner

iblSetsOutliner.py

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

Others:

6.126.1. Module Attributes

sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.LOGGER
sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.COMPONENT_UI_FILE

6.126.2. Classes

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

Bases: manager.qwidgetComponent.QWidgetComponent

Defines the sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner Component Interface class.
It defines methods for Database Ibl Sets 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 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.
Return type:int
uiResourcesDirectory[source]

Property for self.__uiResourcesDirectory attribute.

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

Property for self.__uiThumbnailsViewImage attribute.

Returns:self.__uiThumbnailsViewImage.
Return type:unicode
uiColumnsViewImage[source]

Property for self.__uiColumnsViewImage attribute.

Returns:self.__uiColumnsViewImage.
Return type:unicode
uiDetailsViewImage[source]

Property for self.__uiDetailsViewImage attribute.

Returns:self.__uiDetailsViewImage.
Return type:unicode
uiLargestSizeImage[source]

Property for self.__uiLargestSizeImage attribute.

Returns:self.__uiLargestSizeImage.
Return type:unicode
uiSmallestSizeImage[source]

Property for self.__uiSmallestSizeImage attribute.

Returns:self.__uiSmallestSizeImage.
Return type:unicode
uiPanoramicLoadingImage[source]

Property for self.__uiPanoramicLoadingImage attribute.

Returns:self.__uiPanoramicLoadingImage.
Return type:unicode
uiSquareLoadingImage[source]

Property for self.__uiSquareLoadingImage attribute.

Returns:self.__uiSquareLoadingImage.
Return type:unicode
uiSwitchThumbnailsTypeImage[source]

Property for self.__uiSwitchThumbnailsTypeImage attribute.

Returns:self.__uiSwitchThumbnailsTypeImage.
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
extension[source]

Property for self.__extension attribute.

Returns:self.__extension.
Return type:unicode
inspectLayout[source]

Property for self.__inspectLayout attribute.

Returns:self.__inspectLayout.
Return type:unicode
scriptEditor[source]

Property for self.__scriptEditor attribute.

Returns:self.__scriptEditor.
Return type:QWidget
collectionsOutliner[source]

Property for self.__collectionsOutliner attribute.

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

Property for self.__model attribute.

Returns:self.__model.
Return type:IblSetsModel
views[source]

Property for self.__views attribute.

Returns:self.__views.
Return type:tuple
viewsPushButtons[source]

Property for self.__viewsPushButtons attribute.

Returns:self.__viewsPushButtons.
Return type:dict
thumbnailsView[source]

Property for self.__thumbnailsView attribute.

Returns:self.__thumbnailsView.
Return type:QListView
detailsView[source]

Property for self.__detailsView attribute.

Returns:self.__detailsView.
Return type:QTreeView
detailsViewHeaders[source]

Property for self.__detailsViewHeaders attribute.

Returns:self.__detailsViewHeaders.
Return type:OrderedDict
panoramicThumbnails[source]

Property for self.__panoramicThumbnails attribute.

Returns:self.__panoramicThumbnails.
Return type:bool
panoramicThumbnailsSize[source]

Property for self.__panoramicThumbnailsSize attribute.

Returns:self.__panoramicThumbnailsSize.
Return type:unicode
squareThumbnailsSize[source]

Property for self.__squareThumbnailsSize attribute.

Returns:self.__squareThumbnailsSize.
Return type:unicode
thumbnailsMinimumSize[source]

Property for self.__thumbnailsMinimumSize attribute.

Returns:self.__thumbnailsMinimumSize.
Return type:dict
searchContexts[source]

Property for self.__searchContexts attribute.

Returns:self.__searchContexts.
Return type:OrderedDict
activeSearchContext[source]

Property for self.__activeSearchContext attribute.

Returns:self.__activeSearchContext.
Return type:OrderedDict
searchContextMenu[source]

Property for self.__searchContextMenu attribute.

Returns:self.__searchContextMenu.
Return type:QMenu
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
getActiveView()[source]

Returns the current active View.

Returns:Current active View.
Return type:QWidget
getActiveViewIndex()[source]

Returns the current active View index.

Returns:Current active View index.
Return type:int
setActiveView(view)[source]

Sets the active View to given View.

Parameters:view (QWidget) – View.
Returns:Method success.
Return type:bool
setActiveViewIndex(index)[source]

Sets the active View to given index.

Parameters:index (int) – Index.
Returns:Method success.
Return type:bool
setActiveSearchContext(context, *args)[source]

Sets the active search context.

Parameters:
  • context (unicode) – Search context.
  • *args (*) – Arguments.
Returns:

Method succes.

Return type:

bool

setPanoramicThumbnails(state)[source]

Sets the panoramic thumbnails.

Parameters:state (bool) – Panoramic thumbnails.
Returns:Method succes.
Return type:bool
addContentUi()[source]

Adds user defined content to the Database.

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

Adds an user defined Ibl Set to the Database.

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

Removes user selected Ibl Sets from the Database.

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

Updates given Ibl Set location.

Parameters:iblSet (IblSet) – Ibl Set to update.
Returns:Method success.
Return type:bool
Note:May require user interaction.
updateSelectedIblSetsLocationUi()[source]

Updates user selected Ibl Sets locations.

Returns:Method success.
Return type:bool
Note:May require user interaction.
addIblSet(name, path, collectionId=None)[source]

Adds an Ibl Set to the Database.

Parameters:
  • name (unicode) – Ibl Set name.
  • path (unicode) – Ibl Set path.
  • collectionId (int) – Target Collection id.
Returns:

Method success.

Return type:

bool

addDirectory(directory, collectionId=None)[source]

Adds directory Ibl Sets to the Database.

Parameters:
  • directory (unicode) – Directory to add.
  • collectionId (int) – Target Collection id.
Returns:

Method success.

Return type:

bool

removeIblSet(iblSet)[source]

Removes given Ibl Set from the Database.

Parameters:iblSet (IblSet) – Ibl Set to remove.
Returns:Method success.
Return type:bool
updateIblSetLocation(iblSet, file)[source]

Updates given Ibl Set location.

Parameters:
  • iblSet (unicode) – Ibl Set to update.
  • iblSet – New Ibl Set file.
Returns:

Method success.

Return type:

bool

getIblSets()[source]

Returns Database Ibl Sets.

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

Filters the Database Ibl Sets 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.

Return type:

list

iblSetExists(path)[source]

Returns if given Ibl Set path exists in the Database.

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

Lists Database Ibl Sets names.

Returns:Database Ibl Sets names.
Return type:list
Note:The list is actually returned using ‘title’ attributes instead of ‘name’ attributes
setIblSets(iblSets=None)[source]

Sets the Ibl Sets Model nodes.

Parameters:iblSets (list) – Ibl Sets to set.
Returns:Method success.
Return type:bool
getIblSetByName(name)[source]

Returns Database Ibl Set with given name.

Parameters:name (unicode) – Ibl Set name.
Returns:Database Ibl Set.
Return type:IblSet
Note:The filtering is actually performed on ‘title’ attributes instead of ‘name’ attributes.
getSelectedNodes()[source]

Returns the current active View selected nodes.

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

Returns the current active View selected Ibl Sets nodes.

Returns:View selected Ibl Sets nodes.
Return type:list
getSelectedIblSets()[source]

Returns the current active View selected Ibl Sets.

Returns:View selected Ibl Sets.
Return type:list