QIconEngine¶

PyQt5.QtGui.QIconEngine

Description¶

The QIconEngine class provides an abstract base class for QIcon renderers.

An icon engine provides the rendering functions for a QIcon. Each icon has a corresponding icon engine that is responsible for drawing the icon with a requested size, mode and state.

The icon is rendered by the paint() function, and the icon can additionally be obtained as a pixmap with the pixmap() function (the default implementation simply uses paint() to achieve this). The addPixmap() function can be used to add new pixmaps to the icon engine, and is used by QIcon to add specialized custom pixmaps.

The paint(), pixmap(), and addPixmap() functions are all virtual, and can therefore be reimplemented in subclasses of QIconEngine.

Classes¶

AvailableSizesArgument

ScaledPixmapArgument

Enums¶

IconEngineHook

TODO

Member	Value	Description
AvailableSizesHook	TODO	TODO
IconNameHook	TODO	TODO
IsNullHook	TODO	TODO
ScaledPixmapHook	TODO	TODO

Methods¶

__init__(): TODO

__init__(QIconEngine): TODO

actualSize(QSize, Mode, State) → QSize: Returns the actual size of the icon the engine provides for the requested size, mode and state. The default implementation returns the given size.

addFile(str, QSize, Mode, State): Called by addFile(). Adds a specialized pixmap from the file with the given fileName, size, mode and state. The default pixmap-based engine stores any supplied file names, and it loads the pixmaps on demand instead of using scaled pixmaps if the size of a pixmap matches the size of icon requested. Custom icon engines that implement scalable vector formats are free to ignores any extra files.

addPixmap(QPixmap, Mode, State): Called by addPixmap(). Adds a specialized pixmap for the given mode and state. The default pixmap-based engine stores any supplied pixmaps, and it uses them instead of scaled pixmaps if the size of a pixmap matches the size of icon requested. Custom icon engines that implement scalable vector formats are free to ignores any extra pixmaps.

availableSizes(mode: Mode = Normal, state: State = Off) → List[QSize]: TODO

clone() → QIconEngine: TODO

iconName() → str: TODO

isNull() → bool: TODO

key() → str: TODO

paint(QPainter, QRect, Mode, State): TODO

pixmap(QSize, Mode, State) → QPixmap: Returns the icon as a pixmap with the required size, mode, and state. The default implementation creates a new pixmap and calls paint() to fill it.

read(QDataStream) → bool: TODO

scaledPixmap(QSize, Mode, State, float) → QPixmap: TODO

write(QDataStream) → bool: TODO