KIconTheme Class

Member Function Documentation

[explicit] KIconTheme::KIconTheme(const QString &name, const QString &appName = QString(), const QString &basePathHint = QString())

Load an icon theme by name.

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.

basePathHint optional hint where to search the app themes. This is appended at the end of the search paths

[static] QString KIconTheme::current()

Returns the current icon theme.

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

The default size of this theme for a certain icon group.

group The icon group. See KIconLoader::Group.

Returns The default size in pixels for the given icon group.

[static] QString KIconTheme::defaultThemeName()

Returns the name of the default theme name

int KIconTheme::depth() const

The minimum display depth required for this theme. This can either be 8 or 32.

Returns the minimum bpp (8 or 32)

QString KIconTheme::description() const

A description for the icon theme.

Returns a human-readable description of the theme, QString() if there is none

QString KIconTheme::dir() const

Returns the toplevel theme directory.

QString KIconTheme::example() const

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() if there is none

[since 5.22] bool KIconTheme::followsColorScheme() const

If true, this theme is made of SVG icons that will be colorized following the system color scheme. This is necessary for monochrome themes that should look visible on both light and dark color schemes.

Returns true if the SVG will be colorized with a stylesheet.

This function was introduced in 5.22.

[static, since 5.23] void KIconTheme::forceThemeForTests(const QString &themeName)

Force a current theme and disable automatic resolution of the current theme in favor of the forced theme.

To reset a forced theme, simply set an empty themeName.

themeName name of the theme to force as current theme, or an empty string to unset theme forcing.

This function was introduced in 5.23.

See also current.

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

Returns true if the theme has any icons for the given context.

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

Lookup an icon in the theme.

name The name of the icon, with extension.

size The desired size of the icon.

match The matching mode. KIconLoader::MatchExact returns an icon only if matches exactly. KIconLoader::MatchBest returns the best matching icon.

Returns An absolute path to the file of the icon if it's found, QString() otherwise.

KIconLoader::isValid will return true, and false otherwise.

[since 5.48] QString KIconTheme::iconPath(const QString &name, int size, KIconLoader::MatchType match, qreal scale) const

Lookup an icon in the theme.

name The name of the icon, with extension.

size The desired size of the icon.

match The matching mode. KIconLoader::MatchExact returns an icon only if matches exactly. KIconLoader::MatchBest returns the best matching icon.

scale The scale of the icon group.

Returns An absolute path to the file of the icon if it's found, QString() otherwise.

KIconLoader::isValid will return true, and false otherwise.

This function was introduced in 5.48.

[since 5.22] QString KIconTheme::iconPathByName(const QString &name, int size, KIconLoader::MatchType match) const

Lookup an icon in the theme.

name The name of the icon, without extension.

size The desired size of the icon.

match The matching mode. KIconLoader::MatchExact returns an icon only if matches exactly. KIconLoader::MatchBest returns the best matching icon.

Returns An absolute path to the file of the icon if it's found, QString() otherwise.

KIconLoader::isValid will return true, and false otherwise.

This function was introduced in 5.22.

[since 5.48] QString KIconTheme::iconPathByName(const QString &name, int size, KIconLoader::MatchType match, qreal scale) const

Lookup an icon in the theme.

name The name of the icon, without extension.

size The desired size of the icon.

match The matching mode. KIconLoader::MatchExact returns an icon only if matches exactly. KIconLoader::MatchBest returns the best matching icon.

scale The scale of the icon group.

Returns An absolute path to the file of the icon if it's found, QString() otherwise.

KIconLoader::isValid will return true, and false otherwise.

This function was introduced in 5.48.

QStringList KIconTheme::inherits() const

The themes this icon theme falls back on.

Returns a list of icon themes that are used as fall-backs

[static, since 6.3] void KIconTheme::initTheme()

Enforces the Breeze icon theme (including our KIconEngine for re-coloring).

If the user has configured a different icon set, that one will be taken.

(following the settings in the application configuration with fallback to kdeglobals)

Must be called before the construction of the first Q(Core)Application, as it might need to modify plugin loading and installs a startup function.

If the application is already using the KDE platform theme, the icon set will not be touched and the platform theme will ensure proper theming.

Does setup the needed KColorSchemeManager to follow the system color mode starting with version 6.6.

This function was introduced in 6.3.

QString KIconTheme::internalName() const

The internal name of the icon theme (same as the name argument passed to the constructor).

Returns the internal name of the theme

bool KIconTheme::isHidden() const

The icon theme should be hidden to the user?

Returns true if the icon theme is hidden

bool KIconTheme::isValid() const

The icon theme exists?

Returns true if the icon theme is valid

[static] QStringList KIconTheme::list()

List all icon themes installed on the system, global and local.

Returns the list of all icon themes

QString KIconTheme::name() const

The stylized name of the icon theme.

Returns the (human-readable) name of the theme

[since 6.11] QStringList KIconTheme::queryIcons() const

Query all available icons.

Returns the list of icon names

This function was introduced in 6.11.

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

Query available icons for a size and context.

size the size of the icons

context the context of the icons

Returns the list of icon names

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

Query available icons for a context and preferred size.

size the size of the icons

context the context of the icons

Returns the list of icon names

QList<int> KIconTheme::querySizes(KIconLoader::Group group) const

Query available sizes for a group.

group The icon group. See KIconLoader::Group.

Returns a list of available sizes for the given group

[static] void KIconTheme::reconfigure()

Reconfigure the theme.

QString KIconTheme::screenshot() const

Returns the name of the screenshot, QString() if there is none