6.108. sibl_gui.components.addons.searchDatabase.searchDatabase

searchDatabase.py

Platform:
Windows, Linux, Mac Os X.
Description:
This module defines the SearchDatabase Component Interface class.

Others:

6.108.1. Module Attributes

sibl_gui.components.addons.searchDatabase.searchDatabase.LOGGER
sibl_gui.components.addons.searchDatabase.searchDatabase.COMPONENT_UI_FILE

6.108.2. Classes

class sibl_gui.components.addons.searchDatabase.searchDatabase.SearchDatabase(parent=None, name=None, *args, **kwargs)[source]

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the sibl_gui.components.addons.searchDatabase.searchDatabase Component Interface class.
It provides methods for the user to search into the Database using various filters.
Parameters:
  • parent – Object parent. ( QObject )
  • name – Component name. ( String )
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
dockArea[source]

This method is the property for self.__dockArea attribute.

Returns:self.__dockArea. ( Integer )
viewSpacing[source]

This method is the property for self.__viewSpacing attribute.

Returns:self.__viewSpacing. ( Integer )
engine[source]

This method is the property for self.__engine attribute.

Returns:self.__engine. ( QObject )
iblSetsOutliner[source]

This method is the property for self.__iblSetsOutliner attribute.

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

This method is the property for self.__collectionsOutliner attribute.

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

This method is the property for self.__view attribute.

Returns:self.__view. ( QWidget )
cloudExcludedTags[source]

This method is the property for self.__cloudExcludedTags attribute.

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

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

This method initializes the Component ui.

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

This method uninitializes the Component ui.

Returns:Method success. ( Boolean )
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.

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

This method sets the user defined pattern matching Ibl Sets and updates sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner Component Model content.

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

This method sets the user defined time matching Ibl Sets and updates sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner Component Model content.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
setTagsCloudMatchingIblsSets(pattern, flags=2)[source]

This method sets the pattern matching Ibl Sets and updates sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner Component Model content.

Parameters:
  • pattern – Filtering pattern. ( String )
  • flags – Regex filtering flags. ( Integer )
Returns:

Method success. ( Boolean )

setTimeMatchingIblSets(timeLow, timeHigh)[source]

This method sets the time matching Ibl Sets and updates sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner Component Model content.

Parameters:
  • timeLow – Time low. ( QTime )
  • timeHigh – Time high. ( QTime )
Returns:

Method success. ( Boolean )