6.139. sibl_gui.ui.common

common.py

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

Others:

6.139.1. Module Attributes

sibl_gui.ui.common.LOGGER

6.139.2. Functions

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

This method converts given image to given type.

Parameters:image – Image to convert. ( QImage )
Returns:Converted image. ( QImage / QPixmap / QIcon )
sibl_gui.ui.common.loadGraphicsItem(path, type)[source]

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

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

Graphics item. ( QIcon, QImage, QPixmap )

sibl_gui.ui.common.getGraphicsItem(path, type, asynchronousLoading=True, imagesCache=None)[source]

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

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

Graphic display. ( QIcon, QImage, QPixmap )

sibl_gui.ui.common.getIcon(path, asynchronousLoading=True, imagesCache=None)[source]

This method returns a QIcon instance.

Parameters:
  • path – Icon image path. ( String )
  • asynchronousLoading – Images are loaded asynchronously. ( Boolean )
  • imagesCache – Image cache. ( Dictionary / AsynchronousGraphicsItemsCache )
Returns:

QIcon. ( QIcon )

sibl_gui.ui.common.getPixmap(path, asynchronousLoading=True, imagesCache=None)[source]

This method returns a QPixmap instance.

Parameters:
  • path – Icon image path. ( String )
  • asynchronousLoading – Images are loaded asynchronously. ( Boolean )
  • imagesCache – Image cache. ( Dictionary / AsynchronousGraphicsItemsCache )
Returns:

QPixmap. ( QPixmap )

sibl_gui.ui.common.getImage(path, asynchronousLoading=True, imagesCache=None)[source]

This method returns a QImage instance.

Parameters:
  • path – Icon image path. ( String )
  • asynchronousLoading – Images are loaded asynchronously. ( Boolean )
  • imagesCache – Image cache. ( Dictionary / AsynchronousGraphicsItemsCache )
Returns:

QImage. ( QImage )

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

This method 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 method 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 method filters the image path.

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

This method 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.138. sibl_gui.ui.cache

Next topic

6.140. sibl_gui.ui.models

This Page