Helper base class for retrieving icons for files for usage by QFileIconProvider and related. More...

#include <qabstractfileiconengine_p.h>

Inheritance diagram for QAbstractFileIconEngine:

Collaboration diagram for QAbstractFileIconEngine:

Public Member Functions
	QAbstractFileIconEngine (const QFileInfo &info, QPlatformTheme::IconOptions opts)

QPixmap	pixmap (const QSize &size, QIcon::Mode mode, QIcon::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, qreal scale) override

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.

QFileInfo	fileInfo () const

QPlatformTheme::IconOptions	options () const

Public Member Functions inherited from QPixmapIconEngine
	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, bool sizeOnly)

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

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.

Public Member Functions inherited from QIconEngine
	QIconEngine ()

virtual	~QIconEngine ()
	Destroys the icon engine.

virtual void	paint (QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state)=0
	Uses the given painter to paint the icon with the required mode and state into the rectangle rect.

virtual QSize	actualSize (const QSize &size, QIcon::Mode mode, QIcon::State state)
	Returns the actual size of the icon the engine provides for the requested size, mode and state.

virtual QPixmap	pixmap (const QSize &size, QIcon::Mode mode, QIcon::State state)
	Returns the icon as a pixmap with the required size, mode, and state.

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 QString	key () const
	\variable QIconEngine::ScaledPixmapArgument::size

virtual QIconEngine *	clone () const =0
	Reimplement this method to return a clone of this icon engine.

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 QList< QSize >	availableSizes (QIcon::Mode mode=QIcon::Normal, QIcon::State state=QIcon::Off)

virtual QString	iconName ()

virtual bool	isNull ()

virtual QPixmap	scaledPixmap (const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale)

virtual void	virtual_hook (int id, void *data)

Static Public Member Functions
template<class It >
static QList< QSize >	toSizeList (It i1, It i2)

Protected Member Functions
virtual QPixmap	filePixmap (const QSize &size, QIcon::Mode mode, QIcon::State)=0

virtual QString	cacheKey () const

Protected Member Functions inherited from QIconEngine
	QIconEngine (const QIconEngine &other)

Additional Inherited Members
Public Types inherited from QIconEngine
enum	IconEngineHook { IsNullHook = 3 , ScaledPixmapHook }

Detailed Description

Helper base class for retrieving icons for files for usage by QFileIconProvider and related.

Reimplement availableSizes() and new virtual filePixmap() and return icons created with this engine from QPlatformTheme::fileIcon().

Note: The class internally caches pixmaps for files by suffix (with the exception of some files on Windows), but not for directories (since directory icons may have overlay icons on Windows). You might want to cache pixmaps for directories in your implementation.