6.111. sibl_gui.components.addons.preview.preview

preview.py

Platform:
Windows, Linux, Mac Os X.
Description:
Defines the Preview Component Interface class, the ImagesPreviewer class and others images preview related objects.

Others:

6.111.1. Module Attributes

sibl_gui.components.addons.preview.preview.LOGGER
sibl_gui.components.addons.preview.preview.COMPONENT_UI_FILE

6.111.2. Classes

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

Bases: manager.qwidgetComponent.QWidgetComponent

Defines the sibl_gui.components.addons.preview.preview Component Interface class.
It provides a basic image previewer.

Initializes the class.

Parameters:
  • parent (QObject) – Object parent.
  • name (unicode) – Component name.
  • *args (*) – Arguments.
  • **kwargs (**) – Keywords arguments.
uiResourcesDirectory[source]

Property for self.__uiResourcesDirectory attribute.

Returns:self.__uiResourcesDirectory.
Return type:unicode
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
inspector[source]

Property for self.__inspector attribute.

Returns:self.__inspector.
Return type:QWidget
imagesPreviewers[source]

Property for self.__imagesPreviewers attribute.

Returns:self.__imagesPreviewers.
Return type:list
maximumImagesPreviewersInstances[source]

Property for self.__maximumImagesPreviewersInstances attribute.

Returns:self.__maximumImagesPreviewersInstances.
Return type:int
inspectorButtons[source]

Property for self.__inspectorButtons attribute.

Returns:self.__inspectorButtons.
Return type:dict
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
viewIblSetsImagesUi(imageType, *args)[source]

Launches selected Ibl Sets Images Previewer.

Parameters:
  • imageType (unicode) – Image type.
  • *args (*) – Arguments.
Returns:

Method success.

Return type:

bool

Note:

May require user interaction.

viewActiveIblSetImagesUi(imageType, *args)[source]

Launches sibl_gui.components.core.inspector.inspector Component Ibl Set Images Previewer.

Parameters:
  • imageType (unicode) – Image type.
  • *args (*) – Arguments.
Returns:

Method success.

Return type:

bool

Note:

May require user interaction.

viewImages(paths, customPreviewer=None)[source]

Launches an Ibl Set Images Previewer.

Parameters:
  • paths (list) – Image paths.
  • customPreviewer (unicode) – Custom previewer.
addImagesPreviewer(imagesPreviewer)[source]

Adds an Images Previewer.

Parameters:imagesPreviewer (ImagesPreviewer) – Images Previewer.
Returns:Method success.
Return type:bool
removeImagesPreviewer(imagesPreviewer)[source]

Removes an Images Previewer.

Parameters:imagesPreviewer (ImagesPreviewer) – Images Previewer.
getImagesPreviewer(paths)[source]

Launches an Images Previewer.

Parameters:paths (list) – Images paths.
Returns:Method success.
Return type:bool
getProcessCommand(paths, customPreviewer)[source]

Gets process command.

Parameters:
  • paths (unicode) – Paths to preview.
  • customPreviewer (unicode) – Custom browser.
Returns:

Process command.

Return type:

unicode

getIblSetImagesPaths(iblSet, imageType)[source]

Gets Ibl Set images paths.

Parameters:
  • iblSet (IblSet) – Ibl Set.
  • imageType (unicode) – Image type.
Returns:

Images paths.

Return type:

list