6.110. sibl_gui.components.addons.preview.imagesPreviewer

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.110.1. Module Attributes

sibl_gui.components.addons.preview.imagesPreviewer.LOGGER
sibl_gui.components.addons.preview.imagesPreviewer.UI_FILE

6.110.2. Classes

class sibl_gui.components.addons.preview.imagesPreviewer.Image_QGraphicsItem(parent=None, image=None)[source]

Bases: PyQt4.QtGui.QGraphicsItem

Defines a QGraphicsItem subclass used
to display given QImage.

Initializes the class.

Parameters:
  • parent (QObject) – Object parent.
  • image (QImage) – Image.
image[source]

Property for self.__image attribute.

Returns:self.__image.
Return type:QImage
width[source]

Property for self.__width attribute.

Returns:self.__width.
Return type:int
height[source]

Property for self.__height attribute.

Returns:self.__height.
Return type:int
boundingRect()[source]

Reimplements the QGraphicsItem.boundingRect() method.

paint(painter, options, widget)[source]

Reimplements the QGraphicsItem.paint() method.

Parameters:
  • painter (QPainter) – QPainter
  • options (QStyleOptionGraphicsItem) – QStyleOptionGraphicsItem
  • widget (QWidget) – QWidget
class sibl_gui.components.addons.preview.imagesPreviewer.ImagesPreviewer(parent, paths=None, *args, **kwargs)[source]

Bases: foundations.ui.common.QWidget

Defines the Application images previewer.
It defines methods to navigate through the list of given images ( List of images paths ), zoom in / out and fit the displayed image, etc...

Initializes the class.

Parameters:
  • parent (QObject) – Object parent.
  • paths (tuple or list) – Images paths.
  • *args (*) – Arguments.
  • **kwargs (**) – Keywords arguments.
container[source]

Property for self.__container attribute.

Returns:self.__container.
Return type:QObject
paths[source]

Property for self.__paths attribute.

Returns:self.__paths.
Return type:tuple or list
uiResourcesDirectory[source]

Property for self.__uiResourcesDirectory attribute.

Returns:self.__uiResourcesDirectory.
Return type:unicode
uiPreviousImage[source]

Property for self.__uiPreviousImage attribute.

Returns:self.__uiPreviousImage.
Return type:unicode
uiNextImage[source]

Property for self.__uiNextImage attribute.

Returns:self.__uiNextImage.
Return type:unicode
uiZoomOutImage[source]

Property for self.__uiZoomOutImage attribute.

Returns:self.__uiZoomOutImage.
Return type:unicode
uiZoomInImage[source]

Property for self.__uiZoomInImage attribute.

Returns:self.__uiZoomInImage.
Return type:unicode
graphicsSceneBackgroundColor[source]

Property for self.__graphicsSceneBackgroundColor attribute.

Returns:self.__graphicsSceneBackgroundColor.
Return type:QColor
graphicsSceneWidth[source]

Property for self.__graphicsSceneWidth attribute.

Returns:self.__graphicsSceneWidth.
Return type:int
graphicsSceneHeight[source]

Property for self.__graphicsSceneHeight attribute.

Returns:self.__graphicsSceneHeight.
Return type:object
minimumZoomFactor[source]

Property for self.__minimumZoomFactor attribute.

Returns:self.__minimumZoomFactor.
Return type:float
maximumZoomFactor[source]

Property for self.__maximumZoomFactor attribute.

Returns:self.__maximumZoomFactor.
Return type:float
wheelZoomFactor[source]

Property for self.__wheelZoomFactor attribute.

Returns:self.__wheelZoomFactor.
Return type:float
keyZoomFactor[source]

Property for self.__keyZoomFactor attribute.

Returns:self.__keyZoomFactor.
Return type:float
graphicsView[source]

Property for self.__graphicsView attribute.

Returns:self.__graphicsView.
Return type:QGraphicsView
graphicsScene[source]

Property for self.__graphicsScene attribute.

Returns:self.__graphicsScene.
Return type:QGraphicsScene
displayGraphicsItem[source]

Property for self.__displayGraphicsItem attribute.

Returns:self.__displayGraphicsItem.
Return type:QGraphicsItem
show()[source]

Reimplements the QWidget.show() method.

closeEvent(event)[source]

Reimplements the QWidget.closeEvent() method.

Parameters:event (QEvent) – QEvent
wheelEvent(event)[source]

Reimplements the QWidget.wheelEvent() method.

Parameters:event (QEvent) – QEvent
keyPressEvent(event)[source]

Reimplements the QWidget.keyPressEvent() method.

Parameters:event (QEvent) – QEvent
loadImage(index=0)[source]

Loads the display image in the View.

Parameters:index (int) – Index to load.
Returns:Method success.
Return type:bool
scaleView(scaleFactor)[source]

Scales the Previewer view.

Parameters:scaleFactor (float) – Float
Returns:Method success.
Return type:bool
fitWindow()[source]

Fits the View window.

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

Fits the image to the View.

Returns:Method success.
Return type:bool
loopThroughImages(backward=False)[source]

Loops through View images.

Parameters:backward (bool) – Looping backward.
Returns:Method success.
Return type:bool