6.137. sibl_gui.ui.common

common.py

Platform:
Windows, Linux, Mac Os X.
Description:
This module defines common ui manipulation related objects.

Others:

6.137.1. Module Attributes

sibl_gui.ui.common.LOGGER

6.137.2. Functions

sibl_gui.ui.common.convertImage(image, type)[source]

This definition converts given image to given type.

Parameters:
  • image – Image to convert. ( QImage )
  • type – Type to convert to. ( QImage / QPixmap / QIcon )
Returns:

Converted image. ( QImage / QPixmap / QIcon )

sibl_gui.ui.common.getThumbnailPath(path, size, cacheDirectory=None)[source]

This definition returns given image thumbnail cached path at given size.

Parameters:
  • path – Image path. ( String )
  • size – Thumbnail size. ( String )
  • cacheDirectory – Thumbnails cache directory. ( String )
Returns:

Cached thumbnail path. ( String )

sibl_gui.ui.common.extractThumbnail(path, size=u'Default', image=None, format=u'PNG', quality=-1, cacheDirectory=None)[source]

This definition extract given image thumbnail at given size.

Parameters:
  • path – Image path. ( String )
  • size – Thumbnail size. ( String )
  • image – Image to use instead of given path one. ( QImage )
  • format – Thumbnail format. ( String )
  • quality – Thumbnail quality, -1 to 100. ( Integer )
  • cacheDirectory – Thumbnails cache directory. ( String )
Returns:

Thumbnail image. ( QImage )

sibl_gui.ui.common.loadGraphicsItem(path, type, size=u'Default')[source]

This definition loads a graphic item: QIcon, QImage, QPixmap.

Parameters:
  • path – Image path. ( String )
  • type – QIcon, QImage, QPixmap. ( QObject )
  • size – Image size. ( String )
Returns:

Image. ( QIcon, QImage, QPixmap )

sibl_gui.ui.common.getGraphicsItem(path, type, size=u'Default', asynchronousLoading=True, placeholder=None, imagesCache=None)[source]

This definition returns a display item: QIcon, QImage, QPixmap instance.

Parameters:
  • path – Image path. ( String )
  • type – QIcon, QImage, QPixmap. ( QObject )
  • size – Image size. ( String )
  • asynchronousLoading – Images are loaded asynchronously. ( Boolean )
  • placeholder – Placeholder to use while loading asynchronously. ( QIcon, QImage, QPixmap )
  • imagesCache – Image cache. ( Dictionary / AsynchronousGraphicsItemsCache )
Returns:

Image. ( QIcon, QImage, QPixmap )

sibl_gui.ui.common.getIcon(path, size=u'Default', asynchronousLoading=True, placeholder=None, imagesCache=None)[source]

This definition returns a QIcon instance.

Parameters:
  • path – Icon image path. ( String )
  • size – Image size. ( String )
  • asynchronousLoading – Images are loaded asynchronously. ( Boolean )
  • placeholder – Placeholder to use while loading asynchronously. ( QIcon )
  • imagesCache – Image cache. ( Dictionary / AsynchronousGraphicsItemsCache )
Returns:

QIcon. ( QIcon )

sibl_gui.ui.common.getPixmap(path, size=u'Default', asynchronousLoading=True, placeholder=None, imagesCache=None)[source]

This definition returns a QPixmap instance.

Parameters:
  • path – Icon image path. ( String )
  • size – Image size. ( String )
  • asynchronousLoading – Images are loaded asynchronously. ( Boolean )
  • placeholder – Placeholder to use while loading asynchronously. ( QPixmap )
  • imagesCache – Image cache. ( Dictionary / AsynchronousGraphicsItemsCache )
Returns:

QPixmap. ( QPixmap )

sibl_gui.ui.common.getImage(path, size=u'Default', asynchronousLoading=True, placeholder=None, imagesCache=None)[source]

This definition returns a QImage instance.

Parameters:
  • path – Icon image path. ( String )
  • size – Image size. ( String )
  • asynchronousLoading – Images are loaded asynchronously. ( Boolean )
  • placeholder – Placeholder to use while loading asynchronously. ( QImage )
  • imagesCache – Image cache. ( Dictionary / AsynchronousGraphicsItemsCache )
Returns:

QImage. ( QImage )

sibl_gui.ui.common.createPixmap(width=128, height=128, text=None)[source]

This definition create a default QPixmap instance.

Parameters:
  • width – Pixmap width. ( Integer )
  • height – Pixmap height. ( Integer )
  • text – Pximap text. ( String )
Returns:

QPixmap. ( QPixmap )

sibl_gui.ui.common.getImageInformationsHeader(path, graphicsItem)[source]

This definition returns a sibl_gui.libraries.freeImage.freeImage.ImageInformationsHeader class from given path and graphics item.

Parameters:
  • path – Image path. ( String )
  • graphicsItem – Image graphics item. ( QImage, QPixmap, QIcon )
Returns:

Image informations header. ( ImageInformationsHeader )

sibl_gui.ui.common.filterImagePath(path)[source]

This definition filters the image path.

Parameters:path – Image path. ( String )
Returns:Path. ( String )
sibl_gui.ui.common.getFormatedShotDate(date, time)[source]

This definition returns a formated shot date.

Parameters:
  • date – Ibl Set date key value. ( String )
  • time – Ibl Set time key value. ( String )
Returns:

Current shot date. ( String )

Table Of Contents

Previous topic

6.136. sibl_gui.ui.caches

Next topic

6.138. sibl_gui.ui.models

This Page