6.121. 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.121.1. Module Attributes

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

6.121.2. Classes

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

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[source]

This method is the property for self.__uiResourcesDirectory attribute.

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

This method is the property for self.__uiThumbnailsViewImage attribute.

Returns:self.__uiThumbnailsViewImage. ( String )
uiColumnsViewImage[source]

This method is the property for self.__uiColumnsViewImage attribute.

Returns:self.__uiColumnsViewImage. ( String )
uiDetailsViewImage[source]

This method is the property for self.__uiDetailsViewImage attribute.

Returns:self.__uiDetailsViewImage. ( String )
uiLargestSizeImage[source]

This method is the property for self.__uiLargestSizeImage attribute.

Returns:self.__uiLargestSizeImage. ( String )
uiSmallestSizeImage[source]

This method is the property for self.__uiSmallestSizeImage attribute.

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

This method is the property for self.__extension attribute.

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

This method is the property for self.__editLayout attribute.

Returns:self.__editLayout. ( String )
inspectLayout[source]

This method is the property for self.__editLayout attribute.

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

This method is the property for self.__scriptEditor attribute.

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

This method is the property for self.__collectionsOutliner attribute.

Returns:self.__collectionsOutliner. ( QWidget )
model[source]

This method is the property for self.__model attribute.

Returns:self.__model. ( IblSetsModel )
views[source]

This method is the property for self.__views attribute.

Returns:self.__views. ( Tuple )
viewsPushButtons[source]

This method is the property for self.__viewsPushButtons attribute.

Returns:self.__viewsPushButtons. ( Dictionary )
thumbnailsView[source]

This method is the property for self.__thumbnailsView attribute.

Returns:self.__thumbnailsView. ( QListView )
columnsView[source]

This method is the property for self.__columnsView attribute.

Returns:self.__columnsView. ( QListView )
detailsView[source]

This method is the property for self.__detailsView attribute.

Returns:self.__detailsView. ( QTreeView )
detailsViewHeaders[source]

This method is the property for self.__detailsViewHeaders attribute.

Returns:self.__detailsViewHeaders. ( OrderedDict )
searchContexts[source]

This method is the property for self.__searchContexts attribute.

Returns:self.__searchContexts. ( OrderedDict )
activeSearchContext[source]

This method is the property for self.__activeSearchContext attribute.

Returns:self.__activeSearchContext. ( OrderedDict )
searchContextMenu[source]

This method is the property for self.__searchContextMenu attribute.

Returns:self.__searchContextMenu. ( QMenu )
activate(engine)[source]

This method activates the Component.

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

This method deactivates the Component.

initializeUi()[source]

This method initializes the Component ui.

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

This method uninitializes the Component ui.

addWidget()[source]

This method adds the Component Widget to the engine.

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

This method removes the Component Widget from the engine.

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 )
getActiveView()[source]

This method returns the current active View.

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

This method returns the current active View index.

Returns:Current active View index. ( Integer )
setActiveView(view)[source]

This method sets the active View to given View.

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

This method sets the active View to given index.

Parameters:index – Index. ( Integer )
Returns:Method success. ( Boolean )
setActiveSearchContext(context, *args)[source]

This method sets the active search context.

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

Method succes. ( Boolean )

addContentUi()[source]

This method adds user defined content to the Database.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
addIblSetUi()[source]

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

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
removeIblSetsUi()[source]

This method removes user selected Ibl Sets from the Database.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
updateIblSetsLocationUi()[source]

This method updates user selected Ibl Sets locations.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
addIblSet(name, path, collectionId=None)[source]

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)[source]

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)[source]

This method removes given Ibl Set from the Database.

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

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()[source]

This method returns Database Ibl Sets.

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

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)[source]

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

Parameters:path – Collection path. ( String )
Returns:Collection exists. ( Boolean )
listIblSets()[source]

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)[source]

This method sets the Ibl Sets Model nodes.

Parameters:iblSets – Ibl Sets to set. ( List )
Returns:Method success. ( Boolean )
getIblSetByName(name)[source]

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()[source]

This method returns the current active View selected nodes.

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

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

Returns:View selected Ibl Sets nodes. ( List )
getSelectedIblSets()[source]

This method returns the current active View selected Ibl Sets.

Returns:View selected Ibl Sets. ( List )