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)

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

This method is the property for self.__uiResourcesDirectory attribute.

Returns:self.__uiResourcesDirectory. ( String )

engine

This method is the property for self.__engine attribute.

Returns:self.__engine. ( QObject )

settings

This method is the property for self.__settings attribute.

Returns:self.__settings. ( QSettings )

settingsSection

This method is the property for self.__settingsSection attribute.

Returns:self.__settingsSection. ( String )

preferencesManager

This method is the property for self.__preferencesManager attribute.

Returns:self.__preferencesManager. ( QWidget )

iblSetsOutliner

This method is the property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner. ( QWidget )

inspector

This method is the property for self.__inspector attribute.

Returns:self.__inspector. ( QWidget )

imagesPreviewers

This method is the property for self.__imagesPreviewers attribute.

Returns:self.__imagesPreviewers. ( List )

maximumImagesPreviewersInstances

This method is the property for self.__maximumImagesPreviewersInstances attribute.

Returns:self.__maximumImagesPreviewersInstances. ( Integer )

inspectorButtons

This method is the property for self.__inspectorButtons attribute.

Returns:self.__inspectorButtons. ( Dictionary )

activate(engine)

This method activates the Component.

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

deactivate()

This method deactivates the Component.

Returns:Method success. ( Boolean )

initializeUi()

This method initializes the Component ui.

Returns:Method success. ( Boolean )

uninitializeUi()

This method uninitializes the Component ui.

Returns:Method success. ( Boolean )

addWidget()

This method adds the Component Widget to the engine.

Returns:Method success. ( Boolean )

removeWidget()

This method removes the Component Widget from the engine.

Returns:Method success. ( Boolean )

viewIblSetsImagesUi(imageType, *args)

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)

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)

This method launches an Ibl Set Images Previewer.

Parameters:

• paths – Image paths. ( List )
• customPreviewer – Custom previewer. ( String )

addImagesPreviewer(imagesPreviewer)

This method adds an Images Previewer.

Parameters:imagesPreviewer – Images Previewer. ( ImagesPreviewer ) Returns:Method success. ( Boolean )

removeImagesPreviewer(imagesPreviewer)

This method removes an Images Previewer.

Parameters:imagesPreviewer – Images Previewer. ( ImagesPreviewer )

getImagesPreviewer(paths)

This method launches an Images Previewer.

Parameters:paths – Images paths. ( List ) Returns:Method success. ( Boolean )

getProcessCommand(paths, customPreviewer)

This method gets process command.

Parameters:

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

Returns:

Process command. ( String )

getIblSetImagesPaths(iblSet, imageType)

This method gets Ibl Set images paths.

Parameters:

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

Returns:

Images paths. ( List )