Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QWindowsIconEngine Class Reference

#include <qwindowsiconengine.h>

+ Inheritance diagram for QWindowsIconEngine:
+ Collaboration diagram for QWindowsIconEngine:

Public Member Functions

 QWindowsIconEngine (const QString &iconName)
 
 ~QWindowsIconEngine ()
 
QIconEngineclone () const override
 Reimplement this method to return a clone of this icon engine.
 
QString key () const override
 \variable QIconEngine::ScaledPixmapArgument::size
 
QString iconName () override
 
bool isNull () override
 
QList< QSizeavailableSizes (QIcon::Mode, QIcon::State) override
 
QSize actualSize (const QSize &size, QIcon::Mode mode, QIcon::State state) override
 Returns the actual size of the icon the engine provides for the requested size, mode and state.
 
QPixmap pixmap (const QSize &size, QIcon::Mode mode, QIcon::State state) override
 Returns the icon as a pixmap with the required size, mode, and state.
 
QPixmap scaledPixmap (const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale) override
 
void paint (QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state) override
 Uses the given painter to paint the icon with the required mode and state into the rectangle rect.
 
- Public Member Functions inherited from QIconEngine
 QIconEngine ()
 
virtual ~QIconEngine ()
 Destroys the icon engine.
 
virtual void addPixmap (const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state)
 Called by QIcon::addPixmap().
 
virtual void addFile (const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state)
 Called by QIcon::addFile().
 
virtual bool read (QDataStream &in)
 Reads icon engine contents from the QDataStream in.
 
virtual bool write (QDataStream &out) const
 Writes the contents of this engine to the QDataStream out.
 
virtual void virtual_hook (int id, void *data)
 

Additional Inherited Members

- Public Types inherited from QIconEngine
enum  IconEngineHook { IsNullHook = 3 , ScaledPixmapHook }
 
- Protected Member Functions inherited from QIconEngine
 QIconEngine (const QIconEngine &other)
 

Detailed Description

Definition at line 14 of file qwindowsiconengine.h.

Constructor & Destructor Documentation

◆ QWindowsIconEngine()

QWindowsIconEngine::QWindowsIconEngine ( const QString & iconName)

Definition at line 297 of file qwindowsiconengine.cpp.

Referenced by clone().

+ Here is the caller graph for this function:

◆ ~QWindowsIconEngine()

QWindowsIconEngine::~QWindowsIconEngine ( )

Definition at line 303 of file qwindowsiconengine.cpp.

Member Function Documentation

◆ actualSize()

QSize QWindowsIconEngine::actualSize ( const QSize & size,
QIcon::Mode mode,
QIcon::State state )
overridevirtual

Returns the actual size of the icon the engine provides for the requested size, mode and state.

The default implementation returns the given size.

Reimplemented from QIconEngine.

Definition at line 338 of file qwindowsiconengine.cpp.

References QIconEngine::actualSize(), and state.

+ Here is the call graph for this function:

◆ availableSizes()

QList< QSize > QWindowsIconEngine::availableSizes ( QIcon::Mode mode,
QIcon::State state )
overridevirtual
Since
4.5

Returns sizes of all images that are contained in the engine for the specific mode and state.

Reimplemented from QIconEngine.

Definition at line 333 of file qwindowsiconengine.cpp.

◆ clone()

QIconEngine * QWindowsIconEngine::clone ( ) const
overridevirtual

Reimplement this method to return a clone of this icon engine.

Implements QIconEngine.

Definition at line 306 of file qwindowsiconengine.cpp.

References QWindowsIconEngine().

+ Here is the call graph for this function:

◆ iconName()

QString QWindowsIconEngine::iconName ( )
overridevirtual
Since
4.7

Returns the name used to create the engine, if available.

Reimplemented from QIconEngine.

Definition at line 316 of file qwindowsiconengine.cpp.

◆ isNull()

bool QWindowsIconEngine::isNull ( )
overridevirtual
Since
5.7

Returns true if this icon engine represent a null QIcon.

Reimplemented from QIconEngine.

Definition at line 321 of file qwindowsiconengine.cpp.

References QString::at(), fontMetrics, QString::isEmpty(), and QString::size().

+ Here is the call graph for this function:

◆ key()

QString QWindowsIconEngine::key ( ) const
overridevirtual

\variable QIconEngine::ScaledPixmapArgument::size

The requested size of the pixmap.

\variable QIconEngine::ScaledPixmapArgument::mode

The requested mode of the pixmap.

See also
QIcon::Mode

\variable QIconEngine::ScaledPixmapArgument::state

The requested state of the pixmap.

See also
QIcon::State

\variable QIconEngine::ScaledPixmapArgument::scale

The requested scale of the pixmap.

\variable QIconEngine::ScaledPixmapArgument::pixmap

The pixmap that is the best match for the given \l size, \l mode, \l state, and \l scale. This is an output parameter that is set after calling \l virtual_hook().

Returns a key that identifies this icon engine.

Reimplemented from QIconEngine.

Definition at line 311 of file qwindowsiconengine.cpp.

◆ paint()

void QWindowsIconEngine::paint ( QPainter * painter,
const QRect & rect,
QIcon::Mode mode,
QIcon::State state )
overridevirtual

Uses the given painter to paint the icon with the required mode and state into the rectangle rect.

Implements QIconEngine.

Definition at line 365 of file qwindowsiconengine.cpp.

References QIcon::Active, QPalette::Active, Qt::AlignCenter, QIcon::Disabled, QPalette::Disabled, QPainter::drawText(), QPalette::HighlightedText, QIcon::Normal, painter, palette, Q_UNUSED, rect, QPainter::restore(), QPainter::save(), QIcon::Selected, QPainter::setFont(), QPainter::setPen(), state, and QPalette::Text.

+ Here is the call graph for this function:

◆ pixmap()

QPixmap QWindowsIconEngine::pixmap ( const QSize & size,
QIcon::Mode mode,
QIcon::State state )
overridevirtual

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.

Reimplemented from QIconEngine.

Definition at line 343 of file qwindowsiconengine.cpp.

References scaledPixmap(), and state.

+ Here is the call graph for this function:

◆ scaledPixmap()

QPixmap QWindowsIconEngine::scaledPixmap ( const QSize & size,
QIcon::Mode mode,
QIcon::State state,
qreal scale )
overridevirtual
Since
5.9

Returns a pixmap for the given size, mode, state and scale.

The scale argument is typically equal to the \l {High DPI} {device pixel ratio} of the display.

Note
Some engines may cast scale to an integer.
See also
ScaledPixmapArgument

Reimplemented from QIconEngine.

Definition at line 348 of file qwindowsiconengine.cpp.

References cacheKey(), QPixmap::devicePixelRatio(), QPixmap::fill(), paint, painter, QPixmap::setDevicePixelRatio(), QPixmap::size(), state, and Qt::transparent.

Referenced by pixmap().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

The documentation for this class was generated from the following files: