Skip to content

PythonQt.Qt.QIconEngine

QIconEngine

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

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.

Source: https://doc.qt.io/archives/qt-5.15/qiconengine.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
AvailableSizesHook attribute Any (shared captured text)
IconEngineHook attribute type Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text)
IconNameHook attribute Any (shared captured text)
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
actualSize function (self, size: Any, mode: Any, state: Any) -> Any X.actualSize(size, mode, state) -> PythonQt.QtCore.QSize (shared captured text)
addFile function (self, fileName: str, size: Any, mode: Any, state: Any) -> None X.addFile(fileName, size, mode, state) (shared captured text)
addPixmap function (self, pixmap: Any, mode: Any, state: Any) -> None X.addPixmap(pixmap, mode, state) (shared captured text)
availableSizes function (self, mode: Any, state: Any) -> tuple X.availableSizes(mode, state) -> tuple (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
clone function (self) -> Any X.clone() -> PythonQt.QtGui.QIconEngine (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
iconName function (self) -> str X.iconName() -> str (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
key function (self) -> str X.key() -> str (shared captured text)
paint function (self, painter: Any, rect: Any, mode: Any, state: Any) -> None X.paint(painter, rect, mode, state) (shared captured text)
pixmap function (self, size: Any, mode: Any, state: Any) -> Any X.pixmap(size, mode, state) -> PythonQt.QtGui.QPixmap (shared captured text)
read function (self, *args: Any, **kwargs: Any) -> bool X.read(in) -> bool (shared captured text)
virtual_hook function (self, id: Any, data: Any) -> Any X.virtual_hook(id, data) (shared captured text)
write function (self, out: Any) -> bool X.write(out) -> bool (shared captured text)