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
QPixmapIconEngine Class Reference

#include <qicon_p.h>

Inheritance diagram for QPixmapIconEngine:
Collaboration diagram for QPixmapIconEngine:

Public Member Functions

 QPixmapIconEngine ()
 QPixmapIconEngine (const QPixmapIconEngine &)
 ~QPixmapIconEngine ()
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.
QPixmap scaledPixmap (const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale) override
QPixmapIconEngineEntry * bestMatch (const QSize &size, qreal scale, QIcon::Mode mode, QIcon::State 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.
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.
void addPixmap (const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state) override
 Called by QIcon::addPixmap().
void addFile (const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state) override
 Called by QIcon::addFile().
bool isNull () override
QString key () const override
 \variable QIconEngine::ScaledPixmapArgument::size
QIconEngine * clone () const override
 Reimplement this method to return a clone of this icon engine.
bool read (QDataStream &in) override
 Reads icon engine contents from the QDataStream in.
bool write (QDataStream &out) const override
 Writes the contents of this engine to the QDataStream out.
Public Member Functions inherited from QIconEngine
 QIconEngine ()
virtual ~QIconEngine ()
 Destroys the icon engine.
virtual QString iconName ()
 Returns the name used to create the engine, if available.
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 QSize adjustSize (const QSize &expectedSize, QSize size)

Friends

class QIconThemeEngine
Q_GUI_EXPORT QDataStream & operator<< (QDataStream &s, const QIcon &icon)

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

Definition at line 72 of file qicon_p.h.

Constructor & Destructor Documentation

◆ QPixmapIconEngine() [1/2]

QPixmapIconEngine::QPixmapIconEngine ( )

Definition at line 169 of file qicon.cpp.

◆ QPixmapIconEngine() [2/2]

QPixmapIconEngine::QPixmapIconEngine ( const QPixmapIconEngine & other)

Definition at line 173 of file qicon.cpp.

◆ ~QPixmapIconEngine()

QPixmapIconEngine::~QPixmapIconEngine ( )

Definition at line 178 of file qicon.cpp.

Member Function Documentation

◆ actualSize()

QSize QPixmapIconEngine::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 393 of file qicon.cpp.

◆ addFile()

void QPixmapIconEngine::addFile ( const QString & fileName,
const QSize & size,
QIcon::Mode mode,
QIcon::State state )
overridevirtual

Called by QIcon::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.

Reimplemented from QIconEngine.

Definition at line 454 of file qicon.cpp.

◆ addPixmap()

void QPixmapIconEngine::addPixmap ( const QPixmap & pixmap,
QIcon::Mode mode,
QIcon::State state )
overridevirtual

Called by QIcon::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.

Reimplemented from QIconEngine.

Definition at line 424 of file qicon.cpp.

◆ adjustSize()

QSize QPixmapIconEngine::adjustSize ( const QSize & expectedSize,
QSize size )
inlinestatic

Definition at line 92 of file qicon_p.h.

◆ availableSizes()

QList< QSize > QPixmapIconEngine::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.

Reimplemented in QWindowsFileIconEngine, and QWindowsFileIconEngine.

Definition at line 408 of file qicon.cpp.

◆ bestMatch()

QPixmapIconEngineEntry * QPixmapIconEngine::bestMatch ( const QSize & size,
qreal scale,
QIcon::Mode mode,
QIcon::State state )

Definition at line 254 of file qicon.cpp.

◆ clone()

QIconEngine * QPixmapIconEngine::clone ( ) const
overridevirtual

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

Implements QIconEngine.

Definition at line 512 of file qicon.cpp.

◆ isNull()

bool QPixmapIconEngine::isNull ( )
overridevirtual
Since
5.7

Returns true if this icon engine represent a null QIcon.

Reimplemented from QIconEngine.

Definition at line 502 of file qicon.cpp.

◆ key()

QString QPixmapIconEngine::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 507 of file qicon.cpp.

◆ paint()

void QPixmapIconEngine::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 182 of file qicon.cpp.

◆ pixmap()

QPixmap QPixmapIconEngine::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 334 of file qicon.cpp.

◆ read()

bool QPixmapIconEngine::read ( QDataStream & in)
overridevirtual

Reads icon engine contents from the QDataStream in.

Returns true if the contents were read; otherwise returns false.

QIconEngine's default implementation always return false.

Reimplemented from QIconEngine.

Definition at line 517 of file qicon.cpp.

◆ scaledPixmap()

QPixmap QPixmapIconEngine::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 339 of file qicon.cpp.

◆ write()

bool QPixmapIconEngine::write ( QDataStream & out) const
overridevirtual

Writes the contents of this engine to the QDataStream out.

Returns true if the contents were written; otherwise returns false.

QIconEngine's default implementation always return false.

Reimplemented from QIconEngine.

Definition at line 548 of file qicon.cpp.

◆ operator<<

Q_GUI_EXPORT QDataStream & operator<< ( QDataStream & s,
const QIcon & icon )
friend

Definition at line 1919 of file qicon.cpp.

◆ QIconThemeEngine

friend class QIconThemeEngine
friend

Definition at line 114 of file qicon_p.h.

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