6.96. sibl_gui.components.addons.databaseOperations.databaseOperations

databaseOperations.py

Platform:
Windows, Linux, Mac Os X.
Description:
Defines the DatabaseOperations Component Interface class and others helper objects.

Others:

6.96.1. Module Attributes

sibl_gui.components.addons.databaseOperations.databaseOperations.LOGGER
sibl_gui.components.addons.databaseOperations.databaseOperations.COMPONENT_UI_FILE

6.96.2. Classes

class sibl_gui.components.addons.databaseOperations.databaseOperations.DatabaseType(**kwargs)[source]

Bases: foundations.dataStructures.Structure

Defines a storage object for manipulation methods associated to a given Database type.
See sibl_gui.components.core.database.types module for more informations about the available Database types.

Initializes the class.

Parameters:kwargs (dict) – type, getMethod, updateContentMethod, removeMethod, modelContainer, updateLocationMethod
class sibl_gui.components.addons.databaseOperations.databaseOperations.DatabaseOperations(parent=None, name=None, *args, **kwargs)[source]

Bases: manager.qwidgetComponent.QWidgetComponent

It provides various methods to operate on the Database.

Initializes the class.

Parameters:
  • parent (QObject) – Object parent.
  • name (unicode) – Component name.
  • *args (*) – Arguments.
  • **kwargs (**) – Keywords arguments.
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
preferencesManager[source]

Property for self.__preferencesManager attribute.

Returns:self.__preferencesManager.
Return type:QWidget
iblSetsOutliner[source]

Property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner.
Return type:QWidget
templatesOutliner[source]

Property for self.__templatesOutliner attribute.

Returns:self.__templatesOutliner.
Return type:QWidget
types[source]

Property for self.__types attribute.

Returns:self.__types.
Return type:tuple
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.

Returns:Method success.
Return type:bool
initializeUi()[source]

Initializes the Component ui.

Returns:Method success.
Return type:bool
uninitializeUi()[source]

Uninitializes the Component ui.

Returns:Method success.
Return type:bool
addWidget()[source]

Adds the Component Widget to the engine.

Returns:Method success.
Return type:bool
removeWidget()[source]

Removes the Component Widget from the engine.

Returns:Method success.
Return type:bool
updateDatabase()[source]
Updates the Database.
Each type defined by DatabaseOperations.sibl_gui.components.core.database.types() attribute will have its instances checked and updated by their associated methods.
Returns:Method success.
Return type:bool
removeInvalidData()[source]

Removes invalid data from the Database.

Returns:Method success.
Return type:bool