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

#include <qfonticonengine_p.h>

Inheritance diagram for QFontIconEngine:
Collaboration diagram for QFontIconEngine:

Public Member Functions

 QFontIconEngine (const QString &iconName, const QFont &font)
 ~QFontIconEngine ()
QString iconName () override
 Returns the name used to create the engine, if available.
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.
QList< QSize > availableSizes (QIcon::Mode, QIcon::State) override
 Returns sizes of all images that are contained in the engine for the specific 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.
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 method to allow extending QIconEngine without adding new virtual methods (and without breaking binary compatibility).

Protected Member Functions

virtual QString string () const
virtual glyph_t glyph () const
Protected Member Functions inherited from QIconEngine
 QIconEngine (const QIconEngine &other)

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...

Detailed Description

Definition at line 27 of file qfonticonengine_p.h.

Constructor & Destructor Documentation

◆ QFontIconEngine()

QFontIconEngine::QFontIconEngine ( const QString & iconName,
const QFont & font )

Definition at line 25 of file qfonticonengine.cpp.

◆ ~QFontIconEngine()

QFontIconEngine::~QFontIconEngine ( )
default

Member Function Documentation

◆ actualSize()

QSize QFontIconEngine::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 69 of file qfonticonengine.cpp.

◆ availableSizes()

QList< QSize > QFontIconEngine::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 64 of file qfonticonengine.cpp.

◆ clone()

QIconEngine * QFontIconEngine::clone ( ) const
overridevirtual

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

Implements QIconEngine.

Reimplemented in QWindowsIconEngine, and WinFontIconEngine.

Definition at line 35 of file qfonticonengine.cpp.

◆ glyph()

glyph_t QFontIconEngine::glyph ( ) const
protectedvirtual

Definition at line 189 of file qfonticonengine.cpp.

◆ iconName()

QString QFontIconEngine::iconName ( )
overridevirtual

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

Reimplemented from QIconEngine.

Definition at line 45 of file qfonticonengine.cpp.

◆ isNull()

bool QFontIconEngine::isNull ( )
overridevirtual
Since
5.7

Returns true if this icon engine represent a null QIcon.

Reimplemented from QIconEngine.

Definition at line 50 of file qfonticonengine.cpp.

◆ key()

QString QFontIconEngine::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.

Reimplemented in QWindowsIconEngine, and WinFontIconEngine.

Definition at line 40 of file qfonticonengine.cpp.

◆ paint()

void QFontIconEngine::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.

Reimplemented in WinFontIconEngine.

Definition at line 124 of file qfonticonengine.cpp.

◆ pixmap()

QPixmap QFontIconEngine::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 98 of file qfonticonengine.cpp.

◆ scaledPixmap()

QPixmap QFontIconEngine::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 103 of file qfonticonengine.cpp.

◆ string()

QString QFontIconEngine::string ( ) const
protectedvirtual

Reimplemented in QAndroidPlatformIconEngine, QWindowsIconEngine, and WinFontIconEngine.

Definition at line 184 of file qfonticonengine.cpp.

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