---

KIconTheme Class Reference

#include <kicontheme.h>

List of all members.

Public Methods
	KIconTheme (const QString &name, const QString &appName=QString::null)
QString	name () const
QString	description () const
QString	example () const
QString	screenshot () const
QString	linkOverlay () const
QString	zipOverlay () const
QString	lockOverlay () const
QString	shareOverlay () const
QString	dir () const
QStringList	inherits () const
bool	isValid () const
bool	isHidden () const
int	depth () const
int	defaultSize (KIcon::Group group) const
QValueList< int >	querySizes (KIcon::Group group) const
QStringList	queryIcons (int size, KIcon::Context context=KIcon::Any) const
QStringList	queryIconsByContext (int size, KIcon::Context context=KIcon::Any) const
KIcon	iconPath (const QString &name, int size, KIcon::MatchType match) const
Static Public Methods
QStringList	list ()
QString	current ()
void	reconfigure ()
QString	defaultThemeName ()

---

Detailed Description

Class to use/access icon themes in KDE. This class is used by the iconloader but can be used by others too.

See also:

KIconLoader

Definition at line 155 of file kicontheme.h.

---

Constructor & Destructor Documentation

KIconTheme::KIconTheme (  const QString &    name, const QString &    appName = QString::null )

Load an icon theme by name. Parameters: name  the name of the theme (e.g. "hicolor" or "keramik") appName  the name of the application. Can be null. This argument allows applications to have themed application icons.

---

Member Function Documentation

QString KIconTheme::current (    )  [static]

Returns the current icon theme. Returns: the name of the current theme

int KIconTheme::defaultSize (  KIcon::Group    group )  const

The default size of this theme for a certain icon group. Parameters: group  The icon group. See KIcon::Group. Returns: The default size in pixels for the given icon group.

QString KIconTheme::defaultThemeName (    )  [static]

Returns the default icon theme. Returns: the name of the default theme name Since: 3.1

int KIconTheme::depth (    )  const [inline]

The minimum display depth required for this theme. This can either be 8 or 32. Returns: the minimum bpp (8 or 32) Definition at line 248 of file kicontheme.h.

QString KIconTheme::description (    )  const [inline]

A description for the icon theme. Returns: a human-readable description of the theme, QString::null if there is none Definition at line 178 of file kicontheme.h.

QString KIconTheme::dir (    )  const [inline]

Returns the toplevel theme directory. Returns: the directory of the theme Definition at line 222 of file kicontheme.h.

QString KIconTheme::example (    )

Return the name of the "example" icon. This can be used to present the theme to the user. Returns: the name of the example icon, QString::null if there is none

KIcon KIconTheme::iconPath (  const QString &    name, int    size, KIcon::MatchType    match )  const

Lookup an icon in the theme. Parameters: name  The name of the icon, without extension. size  The desired size of the icon. match  The matching mode. KIcon::MatchExact returns an icon only if matches exactly. KIcon::MatchBest returns the best matching icon. Returns: A KIcon class that describes the icon. If an icon is found, See also: KIcon::isValid will return true, and false otherwise.

QStringList KIconTheme::inherits (    )  const [inline]

The themes this icon theme falls back on. Returns: a list of icon themes that are used as fall-backs Definition at line 228 of file kicontheme.h.

bool KIconTheme::isHidden (    )

The icon theme should be hidden to the user? Returns: true if the icon theme is hidden Since: 3.1

bool KIconTheme::isValid (    )

The icon theme exists? Returns: true if the icon theme is valid

QString KIconTheme::linkOverlay (    )

Returns the name of this theme's link overlay. Returns: the name of the link overlay

QStringList KIconTheme::list (    )  [static]

List all icon themes installed on the system, global and local. Returns: the list of all icon themes

QString KIconTheme::lockOverlay (    )

Returns the name of this theme's lock overlay. Returns: the name of the lock overlay

QString KIconTheme::name (    )  const [inline]

The stylized name of the icon theme. Returns: the (human-readable) name of the theme Definition at line 171 of file kicontheme.h.

QStringList KIconTheme::queryIcons (  int    size, KIcon::Context    context = KIcon::Any )  const

Query available icons for a size and context. Parameters: size  the size of the icons context  the context of the icons Returns: the list of icon names

QStringList KIconTheme::queryIconsByContext (  int    size, KIcon::Context    context = KIcon::Any )  const

Query available icons for a context and preferred size. Parameters: size  the size of the icons context  the context of the icons Returns: the list of icon names

QValueList<int> KIconTheme::querySizes (  KIcon::Group    group )  const

Query available sizes for a group. Parameters: group  The icon group. See KIcon::Group. Returns: a list of available sized for the given group

void KIconTheme::reconfigure (    )  [static]

Reconfigure the theme.

QString KIconTheme::screenshot (    )

Return the name of the screenshot. Returns: the name of the screenshot, QString::null if there is none

QString KIconTheme::shareOverlay (    )

Returns the name of this theme's share overlay. Returns: the name of the share overlay Since: 3.1

QString KIconTheme::zipOverlay (    )

Returns the name of this theme's zip overlay. Returns: the name of the zip overlay

---

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

• kicontheme.h

---