KIconLoader Class Reference

Iconloader for KDE. More...

#include <kiconloader.h>


Public Member Functions
void	addAppDir (const QString &appname)
void	addExtraDesktopThemes ()
bool	alphaBlending (KIcon::Group group) const
int	currentSize (KIcon::Group group) const
void	enableDelayedIconSetLoading (bool enable)
bool	extraDesktopThemesAdded () const
bool	hasContext (KIcon::Context context) const
KIconEffect *	iconEffect () const
QString	iconPath (const QString &name, int group_or_size, bool canReturnNull=false) const
bool	isDelayedIconSetLoadingEnabled () const
	KIconLoader (const QString &appname=QString::null, KStandardDirs *dirs=0)
QStringList	loadAnimated (const QString &name, KIcon::Group group, int size=0) const
QPixmap	loadIcon (const QString &name, KIcon::Group group, int size=0, int state=KIcon::DefaultState, QString *path_store=0L, bool canReturnNull=false) const
QIconSet	loadIconSet (const QString &name, KIcon::Group group, int size=0)
QIconSet	loadIconSet (const QString &name, KIcon::Group group, int size, bool canReturnNull)
QIconSet	loadIconSet (const QString &name, KIcon::Group group, int size, bool canReturnNull, bool immediateExistenceCheck)
QMovie	loadMovie (const QString &name, KIcon::Group group, int size=0) const
QString	moviePath (const QString &name, KIcon::Group group, int size=0) const
QStringList	queryIcons (int group_or_size, KIcon::Context context=KIcon::Any) const
QStringList	queryIconsByContext (int group_or_size, KIcon::Context context=KIcon::Any) const
QStringList	queryIconsByDir (const QString &iconsDir) const
void	reconfigure (const QString &_appname, KStandardDirs *_dirs)
KIconTheme *	theme () const
	~KIconLoader ()
Static Public Member Functions
static QPixmap	unknown ()
Related Functions
(Note that these are not member functions.)
QPixmap	BarIcon (const QString &name, KInstance *instance)
QPixmap	BarIcon (const QString &name, int size=0, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
QIconSet	BarIconSet (const QString &name, int size=0, KInstance *instance=KGlobal::instance())
QPixmap	DesktopIcon (const QString &name, KInstance *instance)
QPixmap	DesktopIcon (const QString &name, int size=0, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
QIconSet	DesktopIconSet (const QString &name, int size=0, KInstance *instance=KGlobal::instance())
int	IconSize (KIcon::Group group, KInstance *instance=KGlobal::instance())
QPixmap	MainBarIcon (const QString &name, KInstance *instance)
QPixmap	MainBarIcon (const QString &name, int size=0, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
QIconSet	MainBarIconSet (const QString &name, int size=0, KInstance *instance=KGlobal::instance())
QPixmap	SmallIcon (const QString &name, KInstance *instance)
QPixmap	SmallIcon (const QString &name, int size=0, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
QIconSet	SmallIconSet (const QString &name, int size=0, KInstance *instance=KGlobal::instance())
QPixmap	UserIcon (const QString &name, KInstance *instance)
QPixmap	UserIcon (const QString &name, int state=KIcon::DefaultState, KInstance *instance=KGlobal::instance())
QIconSet	UserIconSet (const QString &name, KInstance *instance=KGlobal::instance())

Detailed Description

Iconloader for KDE.

KIconLoader will load the current icon theme and all its base themes. Icons will be searched in any of these themes. Additionally, it caches icons and applies effects according the the user's preferences.

In KDE, it is encouraged to load icons by "Group". An icon group is a location on the screen where icons are being used. Standard groups are: Desktop, Toolbar, MainToolbar, Small and Panel. Each group has some centrally configured properties bound to it, including the icon size and effects. This makes it possible to offer a consistent icon look in all KDE applications.

The standard groups are defined below.

KIcon::Desktop: Icons in the iconview of konqueror, kdesktop and similar apps.
KIcon::Toolbar: Icons in toolbars.
KIcon::MainToolbar: Icons in the main toolbars.
KIcon::Small: Various small (typical 16x16) places: titlebars, listviews and menu entries.
KIcon::Panel: Icons in kicker's panel

The icons are stored on disk in an icon theme or in a standalone directory. The icon theme directories contain multiple sizes and/or depths for the same icon. The iconloader will load the correct one based on the icon group and the current theme. Icon themes are stored globally in share/icons, or, application specific in share/apps/$appdir/icons.

The standalone directories contain just one version of an icon. The directories that are searched are: $appdir/pics and $appdir/toolbar. Icons in these directories can be loaded by using the special group "User".

Definition at line 77 of file kiconloader.h.

Constructor & Destructor Documentation

KIconLoader::KIconLoader	(	const QString &	appname = `QString::null`,
		KStandardDirs *	dirs = `0`
	)

Constructs an iconloader.

Parameters:

	appname	Add the data directories of this application to the icon search path for the "User" group. The default argument adds the directories of the current application.
	dirs	the KStandardDirs object to use. If null the global one is used

Usually, you use the default iconloader, which can be accessed via KGlobal::iconLoader(), so you hardly ever have to create an iconloader object yourself. That one is the current KInstance's (typically KApplication's) iconloader.

See also:: KGlobal::iconLoader()
KInstance::iconLoader()

Definition at line 128 of file kiconloader.cpp.

KIconLoader::~KIconLoader ( )

Cleanup.

Definition at line 261 of file kiconloader.cpp.

Member Function Documentation

void KIconLoader::addAppDir ( const QString & appname )

Adds appname to the list of application specific directories.

Parameters:

appname

The application name.

Definition at line 293 of file kiconloader.cpp.

void KIconLoader::addExtraDesktopThemes ( )

Adds all the default themes from other desktops at the end of the list of icon themes.

Since:: 3.1

Definition at line 345 of file kiconloader.cpp.

bool KIconLoader::alphaBlending ( KIcon::Group group ) const

Checks whether the user wants to blend the icons with the background using the alpha channel information for a given group.

Parameters:

group

the group to check

Returns:: true if alpha blending is desired

Deprecated:

Definition at line 1121 of file kiconloader.cpp.

int KIconLoader::currentSize ( KIcon::Group group ) const

Returns the current size of the group.

Parameters:

group

the group to check.

Returns:: the current size for an icon group.

Definition at line 1003 of file kiconloader.cpp.

void KIconLoader::enableDelayedIconSetLoading ( bool enable )

Enables on-demand icon loading for QIconSets using QIconFactory.

Icons loaded via loadIconSet() will be loaded as soon as they need to be displayed, not earlier.

Note that enabling or disabling this only affects loadIconSet() calls after this setting is changed.

The default is disabled, as the iconloader object must not be destroyed before all those iconsets are destroyed.

(Some broken applications use temporary KIconLoader objects). Every KInstance 's iconloader has this feature enabled.

Parameters:

enable

true to enable delayed icon loading, false to disable

See also:: isDelayedIconSetLoadingEnabled()
QIconFactory

Since:: 3.1

Definition at line 283 of file kiconloader.cpp.

bool KIconLoader::extraDesktopThemesAdded ( ) const

Returns if the default icon themes of other desktops have been added to the list of icon themes where icons are searched.

Since:: 3.1

Definition at line 396 of file kiconloader.cpp.

bool KIconLoader::hasContext ( KIcon::Context context ) const

For internal use only.

Definition at line 1107 of file kiconloader.cpp.

KIconEffect * KIconLoader::iconEffect ( ) const

Returns a pointer to the KIconEffect object used by the icon loader.

Returns:: the KIconEffect.

Definition at line 1116 of file kiconloader.cpp.

QString KIconLoader::iconPath	(	const QString &	name,
		int	group_or_size,
		bool	canReturnNull = `false`
	)			const

Returns the path of an icon.

Parameters:

	name	The name of the icon, without extension. If an absolute path is supplied for this parameter, iconPath will return it directly.
	group_or_size	If positive, search icons whose size is specified by the icon group `group_or_size`. If negative, search icons whose size is - `group_or_size`. See KIcon::Group and KIcon::StdSizes
	canReturnNull	Can return a null string? If not, a path to the "unknown" icon will be returned.

Returns:: the path of an icon, can be null or the "unknown" icon when not found, depending on canReturnNull.

Definition at line 510 of file kiconloader.cpp.

bool KIconLoader::isDelayedIconSetLoadingEnabled ( ) const

Checks whether delayed loading for QIconSet is enabled.

Returns:: whether icons for QIconSets will be loaded on demand.

See also:: enableDelayedIconSetLoading()
QIconFactory

Since:: 3.1

Definition at line 288 of file kiconloader.cpp.

QStringList KIconLoader::loadAnimated	(	const QString &	name,
		KIcon::Group	group,
		int	size = `0`
	)			const

Loads an animated icon as a series of still frames.

If you want to load a .mng animation as QMovie instead, please use loadMovie() instead.

Parameters:

	name	The name of the icon.
	group	The icon group. See loadIcon().
	size	Override the default size for `group`. See KIcon::StdSizes.

Returns:: A QStringList containing the absolute path of all the frames making up the animation.

Definition at line 946 of file kiconloader.cpp.

QPixmap KIconLoader::loadIcon	(	const QString &	name,
		KIcon::Group	group,
		int	size = `0`,
		int	state = `KIcon::DefaultState`,
		QString *	path_store = `0L`,
		bool	canReturnNull = `false`
	)			const

Loads an icon.

It will try very hard to find an icon which is suitable. If no exact match is found, a close match is searched. If neither an exact nor a close match is found, a null pixmap or the "unknown" pixmap is returned, depending on the value of the canReturnNull parameter.

Parameters:

	name	The name of the icon, without extension.
	group	The icon group. This will specify the size of and effects to be applied to the icon.
	size	If nonzero, this overrides the size specified by `group`. See KIcon::StdSizes.
	state	The icon state: `DefaultState`, `ActiveState` or `DisabledState`. Depending on the user's preferences, the iconloader may apply a visual effect to hint about its state.
	path_store	If not null, the path of the icon is stored here.
	canReturnNull	Can return a null pixmap? If false, the "unknown" pixmap is returned when no appropriate icon has been found.

Returns:: the QPixmap. Can be null when not found, depending on canReturnNull.

Definition at line 577 of file kiconloader.cpp.

QIconSet KIconLoader::loadIconSet	(	const QString &	name,
		KIcon::Group	group,
		int	size = `0`
	)

Creates an icon set, that will do on-demand loading of the icon.

Loading itself is done by calling loadIcon .

Parameters:

	name	The name of the icon, without extension.
	group	The icon group. This will specify the size of and effects to be applied to the icon.
	size	If nonzero, this overrides the size specified by `group`. See KIcon::StdSizes.

Returns:: the icon set. Can be null when not found

Definition at line 1138 of file kiconloader.cpp.

QIconSet KIconLoader::loadIconSet	(	const QString &	name,
		KIcon::Group	group,
		int	size,
		bool	canReturnNull
	)

Creates an icon set, that will do on-demand loading of the icon.

Loading itself is done by calling loadIcon .

Parameters:

	name	The name of the icon, without extension.
	group	The icon group. This will specify the size of and effects to be applied to the icon.
	size	If nonzero, this overrides the size specified by `group`. See KIcon::StdSizes.
	canReturnNull	Can return a null iconset? If false, iconset containing the "unknown" pixmap is returned when no appropriate icon has been found.

Returns:: the icon set. Can be null when not found, depending on canReturnNull.

Since:: 3.1

Definition at line 1133 of file kiconloader.cpp.

QIconSet KIconLoader::loadIconSet	(	const QString &	name,
		KIcon::Group	group,
		int	size,
		bool	canReturnNull,
		bool	immediateExistenceCheck
	)

Creates an icon set, that will do on-demand loading of the icon.

Loading itself is done by calling loadIcon .

Parameters:

	name	The name of the icon, without extension.
	group	The icon group. This will specify the size of and effects to be applied to the icon.
	size	If nonzero, this overrides the size specified by `group`. See KIcon::StdSizes.
	canReturnNull	Can return a null iconset? If false, iconset containing the "unknown" pixmap is returned when no appropriate icon has been found.
	immediateExistenceCheck	If true on-demand icon loading will be disabled for canReturnNull and a null iconset may be returned immediately

Returns:: the icon set. Can be null when not found, depending on canReturnNull.

Since:: 3.5

Definition at line 1163 of file kiconloader.cpp.

QMovie KIconLoader::loadMovie	(	const QString &	name,
		KIcon::Group	group,
		int	size = `0`
	)			const

Loads an animated icon.

Parameters:

	name	The name of the icon.
	group	The icon group. See loadIcon().
	size	Override the default size for `group`. See KIcon::StdSizes.

Returns:: A QMovie object. Can be null if not found.

Definition at line 890 of file kiconloader.cpp.

QString KIconLoader::moviePath	(	const QString &	name,
		KIcon::Group	group,
		int	size = `0`
	)			const

Returns the path to an animated icon.

Parameters:

	name	The name of the icon.
	group	The icon group. See loadIcon().
	size	Override the default size for `group`. See KIcon::StdSizes.

Returns:: the full path to the movie, ready to be passed to QMovie's constructor. Empty string if not found.

Definition at line 902 of file kiconloader.cpp.

QStringList KIconLoader::queryIcons	(	int	group_or_size,
		KIcon::Context	context = `KIcon::Any`
	)			const

Queries all available icons for a specific group, having a specific context.

Parameters:

	group_or_size	If positive, search icons whose size is specified by the icon group `group_or_size`. If negative, search icons whose size is - `group_or_size`. See KIcon::Group and KIcon::StdSizes
	context	The icon context.

Returns:: a list of all icons

Definition at line 1067 of file kiconloader.cpp.

QStringList KIconLoader::queryIconsByContext	(	int	group_or_size,
		KIcon::Context	context = `KIcon::Any`
	)			const

Queries all available icons for a specific context.

Parameters:

	group_or_size	The icon preferred group or size. If available at this group or size, those icons will be returned, in other case, icons of undefined size will be returned. Positive numbers are groups, negative numbers are negated sizes. See KIcon::Group and KIcon::StdSizes
	context	The icon context.

Returns:: A QStringList containing the icon names available for that context

Definition at line 1026 of file kiconloader.cpp.

QStringList KIconLoader::queryIconsByDir ( const QString & iconsDir ) const

Returns a list of all icons (*.png or *.xpm extension) in the given directory.

Parameters:

iconsDir

the directory to search in

Returns:: A QStringList containing the icon paths

Since:: 3.1

Definition at line 1015 of file kiconloader.cpp.

void KIconLoader::reconfigure	(	const QString &	_appname,
		KStandardDirs *	_dirs
	)

Called by KInstance::newIconLoader to reconfigure the icon loader.

Parameters:

	_appname	the new application name
	_dirs	the new standard directories. If 0, the directories from KGlobal will be taken.

Definition at line 160 of file kiconloader.cpp.

KIconTheme * KIconLoader::theme ( ) const

Returns a pointer to the current theme.

Can be used to query available and default sizes for groups.

Returns:: a pointer to the current theme. 0 if no theme set.

Definition at line 997 of file kiconloader.cpp.

QPixmap KIconLoader::unknown ( ) [static]

Returns the unknown icon.

An icon that is used when no other icon can be found.

Returns:: the unknown pixmap

Definition at line 1383 of file kiconloader.cpp.

Friends And Related Function Documentation

QPixmap BarIcon	(	const QString &	name,
		KInstance *	instance
	)			`[related]`

Load a toolbar icon.

Definition at line 1313 of file kiconloader.cpp.

QPixmap BarIcon	(	const QString &	name,
		int	size = `0`,
		int	state = `KIcon::DefaultState`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a toolbar icon.

Definition at line 1306 of file kiconloader.cpp.

QIconSet BarIconSet	(	const QString &	name,
		int	size = `0`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a toolbar icon, and apply the necessary effects to get an IconSet.

Definition at line 1318 of file kiconloader.cpp.

QPixmap DesktopIcon	(	const QString &	name,
		KInstance *	instance
	)			`[related]`

Load a desktop icon.

Definition at line 1295 of file kiconloader.cpp.

QPixmap DesktopIcon	(	const QString &	name,
		int	size = `0`,
		int	state = `KIcon::DefaultState`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a desktop icon.

Definition at line 1288 of file kiconloader.cpp.

QIconSet DesktopIconSet	(	const QString &	name,
		int	size = `0`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a desktop icon, and apply the necessary effects to get an IconSet.

Definition at line 1300 of file kiconloader.cpp.

int IconSize	(	KIcon::Group	group,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Returns the current icon size for a specific group.

Definition at line 1377 of file kiconloader.cpp.

QPixmap MainBarIcon	(	const QString &	name,
		KInstance *	instance
	)			`[related]`

Load a main toolbar icon.

Definition at line 1349 of file kiconloader.cpp.

QPixmap MainBarIcon	(	const QString &	name,
		int	size = `0`,
		int	state = `KIcon::DefaultState`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a main toolbar icon.

Definition at line 1342 of file kiconloader.cpp.

QIconSet MainBarIconSet	(	const QString &	name,
		int	size = `0`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a main toolbar icon, and apply the effects to get an IconSet.

Definition at line 1354 of file kiconloader.cpp.

QPixmap SmallIcon	(	const QString &	name,
		KInstance *	instance
	)			`[related]`

Load a small icon.

Definition at line 1331 of file kiconloader.cpp.

QPixmap SmallIcon	(	const QString &	name,
		int	size = `0`,
		int	state = `KIcon::DefaultState`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a small icon.

Definition at line 1324 of file kiconloader.cpp.

QIconSet SmallIconSet	(	const QString &	name,
		int	size = `0`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a small icon, and apply the necessary effects to get an IconSet.

Definition at line 1336 of file kiconloader.cpp.

QPixmap UserIcon	(	const QString &	name,
		KInstance *	instance
	)			`[related]`

Load a user icon. User icons are searched in $appdir/pics.

Definition at line 1366 of file kiconloader.cpp.

QPixmap UserIcon	(	const QString &	name,
		int	state = `KIcon::DefaultState`,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a user icon. User icons are searched in $appdir/pics.

Definition at line 1360 of file kiconloader.cpp.

QIconSet UserIconSet	(	const QString &	name,
		KInstance *	instance = `KGlobal::instance()`
	)			`[related]`

Load a user icon, and apply the effects to get an IconSet.

Definition at line 1371 of file kiconloader.cpp.

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

KDECore

KIconLoader Class Reference

Public Member Functions

Static Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

KDECore

API Reference