KIconEngine Class Reference

#include <KIconEngine>

Inheritance diagram for KIconEngine:

Public Member Functions
	KIconEngine (const QString &iconName, const KIconColors &colors, KIconLoader *iconLoader)
	KIconEngine (const QString &iconName, KIconLoader *iconLoader)
	KIconEngine (const QString &iconName, KIconLoader *iconLoader, const QStringList &overlays)
	~KIconEngine () override
QSize	actualSize (const QSize &size, QIcon::Mode mode, QIcon::State state) override
QList< QSize >	availableSizes (QIcon::Mode mode, QIcon::State state) const override
QIconEngine *	clone () const override
QString	iconName () const override
QString	key () const override
void	paint (QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state) override
QPixmap	pixmap (const QSize &size, QIcon::Mode mode, QIcon::State state) override
bool	read (QDataStream &in) override
void	virtual_hook (int id, void *data) override
bool	write (QDataStream &out) const override
Public Member Functions inherited from QIconEngine
virtual void	addFile (const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state)
virtual void	addPixmap (const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state)
bool	isNull () const const
QPixmap	scaledPixmap (const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale)

Additional Inherited Members
Public Types inherited from QIconEngine
enum	IconEngineHook
Public Attributes inherited from QIconEngine
	AvailableSizesHook
	IconNameHook
	IsNullHook
	ScaledPixmapHook

Detailed Description

A class to provide rendering of KDE icons.

Currently, this class is not much more than a wrapper around QIconEngine. However, it should not be difficult to extend with features such as SVG rendered icons.

Icon themes specifying a KDE-Extensions string list setting, will limit themselves to checking these extensions exclusively, in the order specified in the setting.

Author

Hamish Rodda rodda.nosp@m.@kde.nosp@m..org

Definition at line 34 of file kiconengine.h.

Constructor & Destructor Documentation

KIconEngine() [1/3]

KIconEngine::KIconEngine	(	const QString &	iconName,
		KIconLoader *	iconLoader,
		const QStringList &	overlays
	)

Constructs an icon engine for a KDE named icon.

Parameters

iconName	the name of the icon to load
iconLoader	The KDE icon loader that this engine is to use.
overlays	Add one or more overlays to the icon. See KIconLoader::Overlays.

See also

KIconLoader

Definition at line 28 of file kiconengine.cpp.

KIconEngine() [2/3]

KIconEngine::KIconEngine	(	const QString &	iconName,
		KIconLoader *	iconLoader
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 35 of file kiconengine.cpp.

KIconEngine() [3/3]

KIconEngine::KIconEngine	(	const QString &	iconName,
		const KIconColors &	colors,
		KIconLoader *	iconLoader
	)

Constructs an icon engine for a KDE named icon with a specific palette.

Parameters

iconName	the name of the icon to load
colors	defines the colors we want to be applied on this icon
iconLoader	The KDE icon loader that this engine is to use.

Definition at line 41 of file kiconengine.cpp.

~KIconEngine()

KIconEngine::~KIconEngine ( )

override

Destructor.

Definition at line 47 of file kiconengine.cpp.

Member Function Documentation

actualSize()

QSize KIconEngine::actualSize ( const QSize &  size, QIcon::Mode  mode, QIcon::State  state  )

overridevirtual

Reimplementation.

Reimplemented from QIconEngine.

Definition at line 68 of file kiconengine.cpp.

availableSizes()

QList<QSize> KIconEngine::availableSizes ( QIcon::Mode  mode, QIcon::State  state  ) const

overridevirtual

Reimplementation.

Reimplemented from QIconEngine.

iconName()

QString KIconEngine::iconName ( ) const

overridevirtual

Reimplementation.

Reimplemented from QIconEngine.

Definition at line 145 of file kiconengine.cpp.

paint()

void KIconEngine::paint ( QPainter *  painter, const QRect &  rect, QIcon::Mode  mode, QIcon::State  state  )

overridevirtual

Reimplementation.

Implements QIconEngine.

Definition at line 73 of file kiconengine.cpp.

pixmap()

QPixmap KIconEngine::pixmap ( const QSize &  size, QIcon::Mode  mode, QIcon::State  state  )

overridevirtual

Reimplementation.

Reimplemented from QIconEngine.

Definition at line 140 of file kiconengine.cpp.

---

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

• kiconengine.h
• kiconengine.cpp