6.104. sibl_gui.components.addons.preview.preview

preview.py

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

Others:

6.104.1. Module Attributes

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

6.104.2. Classes

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

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the sibl_gui.components.addons.preview.preview Component Interface class.
It provides a basic image previewer.
Parameters:
  • parent – Object parent. ( QObject )
  • name – Component name. ( String )
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
uiResourcesDirectory[source]

This method is the property for self.__uiResourcesDirectory attribute.

Returns:self.__uiResourcesDirectory. ( String )
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 )
preferencesManager[source]

This method is the property for self.__preferencesManager attribute.

Returns:self.__preferencesManager. ( QWidget )
iblSetsOutliner[source]

This method is the property for self.__iblSetsOutliner attribute.

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

This method is the property for self.__inspector attribute.

Returns:self.__inspector. ( QWidget )
imagesPreviewers[source]

This method is the property for self.__imagesPreviewers attribute.

Returns:self.__imagesPreviewers. ( List )
maximumImagesPreviewersInstances[source]

This method is the property for self.__maximumImagesPreviewersInstances attribute.

Returns:self.__maximumImagesPreviewersInstances. ( Integer )
inspectorButtons[source]

This method is the property for self.__inspectorButtons attribute.

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

This method launches selected Ibl Sets Images Previewer.

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

Method success. ( Boolean )

Note :

This method may require user interaction.

viewActiveIblSetImagesUi(imageType, *args)[source]

This method launches sibl_gui.components.core.inspector.inspector Component Ibl Set Images Previewer.

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

Method success. ( Boolean )

Note :

This method may require user interaction.

viewImages(paths, customPreviewer=None)[source]

This method launches an Ibl Set Images Previewer.

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

This method adds an Images Previewer.

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

This method removes an Images Previewer.

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

This method launches an Images Previewer.

Parameters:paths – Images paths. ( List )
Returns:Method success. ( Boolean )
getProcessCommand(paths, customPreviewer)[source]

This method gets process command.

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

Process command. ( String )

getIblSetImagesPaths(iblSet, imageType)[source]

This method gets Ibl Set images paths.

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

Images paths. ( List )