eric6.UI.PixmapCache

Module implementing a pixmap cache for icons.

Global Attributes

pixCache

Classes

PixmapCache Class implementing a pixmap cache for icons.

Functions

addSearchPath Module function to add a path to the search path.
getCombinedIcon Module function to retrieve a symbolic link icon.
getIcon Module function to retrieve an icon.
getPixmap Module function to retrieve a pixmap.
getSymlinkIcon Module function to retrieve a symbolic link icon.


PixmapCache

Class implementing a pixmap cache for icons.

Derived from

object

Class Attributes

SupportedExtensions

Class Methods

None

Methods

PixmapCache Constructor
addSearchPath Public method to add a path to the search path.
getPixmap Public method to retrieve a pixmap.

Static Methods

None

PixmapCache (Constructor)

PixmapCache()

Constructor

PixmapCache.addSearchPath

addSearchPath(path)

Public method to add a path to the search path.

path
path to add (string)

PixmapCache.getPixmap

getPixmap(key, size=None)

Public method to retrieve a pixmap.

key (str)
name of the wanted pixmap
size (QSize)
requested size
Returns:
the requested pixmap
Return Type:
QPixmap
Up


addSearchPath

addSearchPath(path, cache=pixCache)

Module function to add a path to the search path.

path
path to add (string)
cache
reference to the pixmap cache object (PixmapCache)
Up


getCombinedIcon

getCombinedIcon(keys, size=None, cache=pixCache)

Module function to retrieve a symbolic link icon.

keys (list of str)
list of names of icons
size (QSize)
requested size of individual icons
cache (PixmapCache)
reference to the pixmap cache object
Returns:
the requested icon
Return Type:
QIcon
Up


getIcon

getIcon(key, size=None, cache=pixCache)

Module function to retrieve an icon.

key (str)
name of the wanted pixmap
size (QSize)
requested size
cache (PixmapCache)
reference to the pixmap cache object
Returns:
the requested icon
Return Type:
QIcon
Up


getPixmap

getPixmap(key, size=None, cache=pixCache)

Module function to retrieve a pixmap.

key (str)
name of the wanted pixmap
size (QSize)
requested size
cache (PixmapCache)
reference to the pixmap cache object
Returns:
the requested pixmap
Return Type:
QPixmap
Up


getSymlinkIcon

getSymlinkIcon(key, size=None, cache=pixCache)

Module function to retrieve a symbolic link icon.

key (str)
name of the wanted pixmap
size (QSize)
requested size
cache (PixmapCache)
reference to the pixmap cache object
Returns:
the requested icon
Return Type:
QIcon
Up