#include <qiconengine_p.h>

Inheritance diagram for QProxyIconEngine:

Collaboration diagram for QProxyIconEngine:

Public Member Functions
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.
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.
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().
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.
QList< QSize >	availableSizes (QIcon::Mode mode=QIcon::Normal, QIcon::State state=QIcon::Off) override
	Returns sizes of all images that are contained in the engine for the specific mode and state.
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
void	virtual_hook (int id, 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.

Protected Member Functions
virtual QIconEngine *	proxiedEngine () const =0
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 28 of file qiconengine_p.h.

Member Function Documentation

◆ actualSize()

QSize QProxyIconEngine::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 315 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ addFile()

void QProxyIconEngine::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 330 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ addPixmap()

void QProxyIconEngine::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 325 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ availableSizes()

QList< QSize > QProxyIconEngine::availableSizes	(	QIcon::Mode	mode = QIcon::Normal,
		QIcon::State	state = QIcon::Off )

overridevirtual

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

Reimplemented from QIconEngine.

Definition at line 355 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ clone()

QIconEngine * QProxyIconEngine::clone ( ) const

overridevirtual

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

Implements QIconEngine.

Reimplemented in QThemeIconEngine.

Definition at line 340 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ iconName()

QString QProxyIconEngine::iconName ( )

overridevirtual

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

Reimplemented from QIconEngine.

Definition at line 360 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ isNull()

bool QProxyIconEngine::isNull ( )

overridevirtual

Since: 5.7

Returns true if this icon engine represent a null QIcon.

Reimplemented from QIconEngine.

Definition at line 365 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ key()

QString QProxyIconEngine::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 QThemeIconEngine.

Definition at line 335 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ paint()

void QProxyIconEngine::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 310 of file qiconengine.cpp.

◆ pixmap()

QPixmap QProxyIconEngine::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 320 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ proxiedEngine()

virtual QIconEngine * QProxyIconEngine::proxiedEngine ( ) const

protectedpure virtual

Implemented in QThemeIconEngine.

Referenced by actualSize(), addFile(), addPixmap(), availableSizes(), clone(), iconName(), isNull(), key(), pixmap(), read(), scaledPixmap(), virtual_hook(), and write().

Here is the caller graph for this function:

◆ read()

bool QProxyIconEngine::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.

Reimplemented in QThemeIconEngine.

Definition at line 345 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ scaledPixmap()

QPixmap QProxyIconEngine::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 370 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ virtual_hook()

void QProxyIconEngine::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 375 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

◆ write()

bool QProxyIconEngine::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.

Reimplemented in QThemeIconEngine.

Definition at line 350 of file qiconengine.cpp.

References proxiedEngine().

Here is the call graph for this function:

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

qtbase/src/gui/image/qiconengine_p.h (a452e2254644ffbed289fdf051eaf41d7e6a3b0d)
qtbase/src/gui/image/qiconengine.cpp (245bdc8ec31755d6ab38b796014bdcab6a1d17ae)

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ actualSize()

◆ addFile()

◆ addPixmap()

◆ availableSizes()

◆ clone()

◆ iconName()

◆ isNull()

◆ key()

◆ paint()

◆ pixmap()

◆ proxiedEngine()

◆ read()

◆ scaledPixmap()

◆ virtual_hook()

◆ write()