QIconEngine¶
The
QIconEngine
class provides an abstract base class forQIcon
renderers. More…
Synopsis¶
Functions¶
def
isNull
()def
scaledPixmap
(size, mode, state, scale)
Virtual functions¶
def
actualSize
(size, mode, state)def
addFile
(fileName, size, mode, state)def
addPixmap
(pixmap, mode, state)def
availableSizes
([mode=QIcon.Normal[, state=QIcon.Off]])def
clone
()def
iconName
()def
key
()def
paint
(painter, rect, mode, state)def
pixmap
(size, mode, state)def
read
(in)def
write
(out)
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 thepixmap()
function (the default implementation simply usespaint()
to achieve this). TheaddPixmap()
function can be used to add new pixmaps to the icon engine, and is used byQIcon
to add specialized custom pixmaps.The
paint()
,pixmap()
, andaddPixmap()
functions are all virtual, and can therefore be reimplemented in subclasses ofQIconEngine
.See also
QIconEnginePlugin
- class PySide2.QtGui.QIconEngine¶
PySide2.QtGui.QIconEngine(other)
- param other:
Constructs the icon engine.
- PySide2.QtGui.QIconEngine.IconEngineHook¶
These enum values are used for
virtual_hook()
to allow additional queries to icon engine without breaking binary compatibility.Constant
Description
QIconEngine.AvailableSizesHook
Allows to query the sizes of the contained pixmaps for pixmap-based engines. The
data
argument of thevirtual_hook()
function is aAvailableSizesArgument
pointer that should be filled with icon sizes. Engines that work in terms of a scalable, vectorial format normally return an empty list.QIconEngine.IconNameHook
Allows to query the name used to create the icon, for example when instantiating an icon using
fromTheme()
.QIconEngine.IsNullHook
Allow to query if this engine represents a null icon. The
data
argument of thevirtual_hook()
is a pointer to a bool that can be set to true if the icon is null. This enum value was added in Qt 5.7.QIconEngine.ScaledPixmapHook
Provides a way to get a pixmap that is scaled according to the given scale (typically equal to the device pixel ratio). The
data
argument of thevirtual_hook()
function is aScaledPixmapArgument
pointer that contains both the input and output arguments. This enum value was added in Qt 5.9.See also
virtual_hook()
- PySide2.QtGui.QIconEngine.actualSize(size, mode, state)¶
- Parameters:
size –
PySide2.QtCore.QSize
mode –
Mode
state – State
- Return type:
Returns the actual size of the icon the engine provides for the requested
size
,mode
andstate
. The default implementation returns the givensize
.
- PySide2.QtGui.QIconEngine.addFile(fileName, size, mode, state)¶
- Parameters:
fileName – str
size –
PySide2.QtCore.QSize
mode –
Mode
state – State
Called by
addFile()
. Adds a specialized pixmap from the file with the givenfileName
,size
,mode
andstate
. 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.
- PySide2.QtGui.QIconEngine.addPixmap(pixmap, mode, state)¶
- Parameters:
pixmap –
PySide2.QtGui.QPixmap
mode –
Mode
state – State
Called by
addPixmap()
. Adds a specializedpixmap
for the givenmode
andstate
. 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.
- PySide2.QtGui.QIconEngine.availableSizes([mode=QIcon.Normal[, state=QIcon.Off]])¶
-
Returns sizes of all images that are contained in the engine for the specific
mode
andstate
.Note
This is a helper method and the actual work is done by the
virtual_hook()
method, hence this method depends on icon engine support and may not work with all icon engines.
- PySide2.QtGui.QIconEngine.clone()¶
- Return type:
Reimplement this method to return a clone of this icon engine.
- PySide2.QtGui.QIconEngine.iconName()¶
- Return type:
str
Returns the name used to create the engine, if available.
Note
This is a helper method and the actual work is done by the
virtual_hook()
method, hence this method depends on icon engine support and may not work with all icon engines.
- PySide2.QtGui.QIconEngine.isNull()¶
- Return type:
bool
Returns true if this icon engine represent a null
QIcon
.Note
This is a helper method and the actual work is done by the
virtual_hook()
method, hence this method depends on icon engine support and may not work with all icon engines.
- PySide2.QtGui.QIconEngine.key()¶
- Return type:
str
Returns a key that identifies this icon engine.
- PySide2.QtGui.QIconEngine.paint(painter, rect, mode, state)¶
- Parameters:
painter –
PySide2.QtGui.QPainter
rect –
PySide2.QtCore.QRect
mode –
Mode
state – State
Uses the given
painter
to paint the icon with the requiredmode
andstate
into the rectanglerect
.
- PySide2.QtGui.QIconEngine.pixmap(size, mode, state)¶
- Parameters:
size –
PySide2.QtCore.QSize
mode –
Mode
state – State
- Return type:
Returns the icon as a pixmap with the required
size
,mode
, andstate
. The default implementation creates a new pixmap and callspaint()
to fill it.
- PySide2.QtGui.QIconEngine.read(in)¶
- Parameters:
- Return type:
bool
Reads icon engine contents from the
QDataStream
in
. Returns true if the contents were read; otherwise returnsfalse
.QIconEngine
‘s default implementation always return false.
- PySide2.QtGui.QIconEngine.scaledPixmap(size, mode, state, scale)¶
- Parameters:
size –
PySide2.QtCore.QSize
mode –
Mode
state – State
scale – float
- Return type:
Returns a pixmap for the given
size
,mode
,state
andscale
.The
scale
argument is typically equal to the device pixel ratio of the display.Note
This is a helper method and the actual work is done by the
virtual_hook()
method, hence this method depends on icon engine support and may not work with all icon engines.Note
Some engines may cast
scale
to an integer.See also
ScaledPixmapArgument
- PySide2.QtGui.QIconEngine.write(out)¶
- Parameters:
- Return type:
bool
Writes the contents of this engine to the
QDataStream
out
. Returnstrue
if the contents were written; otherwise returnsfalse
.QIconEngine
‘s default implementation always return false.
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.