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

#include <qappleiconengine_p.h>

Inheritance diagram for QAppleIconEngine:
Collaboration diagram for QAppleIconEngine:

Public Member Functions

 QAppleIconEngine (const QString &iconName)
 ~QAppleIconEngine ()
QIconEngine * clone () const override
 Reimplement this method to return a clone of this icon engine.
QString key () const override
 \variable QIconEngine::ScaledPixmapArgument::size
QString iconName () override
 Returns the name used to create the engine, if available.
bool isNull () override
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.
void virtual_hook (int hookIdentifier, void *data) override
 Additional method to allow extending QIconEngine without adding new virtual methods (and without breaking binary compatibility).
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.

Static Public Member Functions

static QIcon fromTheme (const QString &iconName)
static QList< QSize > availableIconSizes (double aspectRatio=1.0)

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 29 of file qappleiconengine_p.h.

Constructor & Destructor Documentation

◆ QAppleIconEngine()

QAppleIconEngine::QAppleIconEngine ( const QString & iconName)

Definition at line 293 of file qappleiconengine.mm.

◆ ~QAppleIconEngine()

QAppleIconEngine::~QAppleIconEngine ( )

Definition at line 300 of file qappleiconengine.mm.

Member Function Documentation

◆ actualSize()

QSize QAppleIconEngine::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 350 of file qappleiconengine.mm.

◆ availableIconSizes()

QList< QSize > QAppleIconEngine::availableIconSizes ( double aspectRatio = 1.0)
static

Definition at line 331 of file qappleiconengine.mm.

◆ availableSizes()

QList< QSize > QAppleIconEngine::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 344 of file qappleiconengine.mm.

◆ clone()

QIconEngine * QAppleIconEngine::clone ( ) const
overridevirtual

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

Implements QIconEngine.

Definition at line 311 of file qappleiconengine.mm.

◆ fromTheme()

QIcon QAppleIconEngine::fromTheme ( const QString & iconName)
static

Definition at line 306 of file qappleiconengine.mm.

◆ iconName()

QString QAppleIconEngine::iconName ( )
overridevirtual

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

Reimplemented from QIconEngine.

Definition at line 321 of file qappleiconengine.mm.

◆ isNull()

bool QAppleIconEngine::isNull ( )
overridevirtual
Since
5.7

Returns true if this icon engine represent a null QIcon.

Reimplemented from QIconEngine.

Definition at line 326 of file qappleiconengine.mm.

◆ key()

QString QAppleIconEngine::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 316 of file qappleiconengine.mm.

◆ paint()

void QAppleIconEngine::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 430 of file qappleiconengine.mm.

◆ pixmap()

QPixmap QAppleIconEngine::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 362 of file qappleiconengine.mm.

◆ scaledPixmap()

QPixmap QAppleIconEngine::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 406 of file qappleiconengine.mm.

◆ virtual_hook()

void QAppleIconEngine::virtual_hook ( int id,
void * data )
overridevirtual

Additional method to allow extending QIconEngine without adding new virtual methods (and without breaking binary compatibility).

The actual action and format of data depends on id argument which is in fact a constant from IconEngineHook enum.

See also
IconEngineHook

Reimplemented from QIconEngine.

Definition at line 485 of file qappleiconengine.mm.

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