Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QIconLoaderEngine Class Reference

An icon engine based on icon entries collected by QIconLoader. More...

#include <qiconloader_p.h>

Inheritance diagram for QIconLoaderEngine:
Collaboration diagram for QIconLoaderEngine:

Public Member Functions

 QIconLoaderEngine (const QString &iconName=QString())
 ~QIconLoaderEngine ()
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.
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.
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.
QIconEngine * clone () const override
 Reimplement this method to return a clone of this icon engine.
QString iconName () override
 Returns the name used to create the engine, if available.
bool isNull () override
QPixmap scaledPixmap (const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale) override
QList< QSize > availableSizes (QIcon::Mode mode, QIcon::State state) override
 Returns sizes of all images that are contained in the engine for the specific mode and state.
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 method to allow extending QIconEngine without adding new virtual methods (and without breaking binary compatibility).

Static Public Member Functions

static Q_GUI_EXPORT QIconLoaderEngineEntry * entryForSize (const QThemeIconInfo &info, const QSize &size, int scale=1)

Private Member Functions

QString key () const override
 \variable QIconEngine::ScaledPixmapArgument::size

Friends

class QIconLoader

Additional Inherited Members

Public Types inherited from QIconEngine
enum  IconEngineHook { IsNullHook = 3 , ScaledPixmapHook }
 These enum values are used for virtual_hook() to allow additional queries to icon engine without breaking binary compatibility. More...
Protected Member Functions inherited from QIconEngine
 QIconEngine (const QIconEngine &other)

Detailed Description

An icon engine based on icon entries collected by QIconLoader.

\inmodule QtGui

The design and implementation of QIconLoader is based on the XDG icon specification.

Definition at line 114 of file qiconloader_p.h.

Constructor & Destructor Documentation

◆ QIconLoaderEngine()

QIconLoaderEngine::QIconLoaderEngine ( const QString & iconName = QString())

Definition at line 779 of file qiconloader.cpp.

◆ ~QIconLoaderEngine()

QIconLoaderEngine::~QIconLoaderEngine ( )
default

Member Function Documentation

◆ actualSize()

QSize QIconLoaderEngine::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.

The returned size is in device-independent pixels (This is relevant for high-dpi pixmaps).

Reimplemented from QIconEngine.

Definition at line 907 of file qiconloader.cpp.

◆ availableSizes()

QList< QSize > QIconLoaderEngine::availableSizes ( QIcon::Mode mode,
QIcon::State state )
overridevirtual

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

Reimplemented from QIconEngine.

Definition at line 1001 of file qiconloader.cpp.

◆ clone()

QIconEngine * QIconLoaderEngine::clone ( ) const
overridevirtual

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

Implements QIconEngine.

Definition at line 787 of file qiconloader.cpp.

◆ entryForSize()

QIconLoaderEngineEntry * QIconLoaderEngine::entryForSize ( const QThemeIconInfo & info,
const QSize & size,
int scale = 1 )
static

Definition at line 863 of file qiconloader.cpp.

◆ iconName()

QString QIconLoaderEngine::iconName ( )
overridevirtual

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

Reimplemented from QIconEngine.

Definition at line 984 of file qiconloader.cpp.

◆ isNull()

bool QIconLoaderEngine::isNull ( )
overridevirtual
Since
5.7

Returns true if this icon engine represent a null QIcon.

Reimplemented from QIconEngine.

Definition at line 989 of file qiconloader.cpp.

◆ key()

QString QIconLoaderEngine::key ( ) const
overrideprivatevirtual

\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 979 of file qiconloader.cpp.

◆ paint()

void QIconLoaderEngine::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 798 of file qiconloader.cpp.

◆ pixmap()

QPixmap QIconLoaderEngine::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 973 of file qiconloader.cpp.

◆ scaledPixmap()

QPixmap QIconLoaderEngine::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. The size is given in device-independent pixels.

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

Reimplemented from QIconEngine.

Definition at line 994 of file qiconloader.cpp.

◆ QIconLoader

friend class QIconLoader
friend

Definition at line 141 of file qiconloader_p.h.

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