KDECore
KIconTheme Class Reference
Class to use/access icon themes in KDE. More...
#include <kicontheme.h>
Public Member Functions | |
int | defaultSize (KIcon::Group group) const |
int | depth () const |
QString | description () const |
QString | dir () const |
QString | example () const |
bool | hasContext (KIcon::Context context) const |
KIcon | iconPath (const QString &name, int size, KIcon::MatchType match) const |
QStringList | inherits () const |
bool | isHidden () const |
bool | isValid () const |
KIconTheme (const QString &name, const QString &appName=QString::null) | |
QString | linkOverlay () const |
QString | lockOverlay () const |
QString | name () const |
QStringList | queryIcons (int size, KIcon::Context context=KIcon::Any) const |
QStringList | queryIconsByContext (int size, KIcon::Context context=KIcon::Any) const |
QValueList< int > | querySizes (KIcon::Group group) const |
QString | screenshot () const |
QString | shareOverlay () const |
QString | zipOverlay () const |
~KIconTheme () | |
Static Public Member Functions | |
static QString | current () |
static QString | defaultThemeName () |
static QStringList | list () |
static void | reconfigure () |
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 186 of file kicontheme.h.
Constructor & Destructor Documentation
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.
Definition at line 82 of file kicontheme.cpp.
KIconTheme::~KIconTheme | ( | ) |
Definition at line 222 of file kicontheme.cpp.
Member Function Documentation
QString KIconTheme::current | ( | ) | [static] |
Returns the current icon theme.
- Returns:
- the name of the current theme
Definition at line 444 of file kicontheme.cpp.
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.
Definition at line 244 of file kicontheme.cpp.
QString KIconTheme::defaultThemeName | ( | ) | [static] |
Returns the default icon theme.
- Returns:
- the name of the default theme name
- Since:
- 3.1
Definition at line 512 of file kicontheme.cpp.
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 279 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 209 of file kicontheme.h.
QString KIconTheme::dir | ( | ) | const [inline] |
Returns the toplevel theme directory.
- Returns:
- the directory of the theme
Definition at line 253 of file kicontheme.h.
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::null if there is none
Definition at line 237 of file kicontheme.cpp.
bool KIconTheme::hasContext | ( | KIcon::Context | context | ) | const |
Returns true if the theme has any icons for the given context.
- Since:
- 3.5.5
Definition at line 347 of file kicontheme.cpp.
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.
Definition at line 361 of file kicontheme.cpp.
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 259 of file kicontheme.h.
bool KIconTheme::isHidden | ( | ) | const |
The icon theme should be hidden to the user?
- Returns:
- true if the icon theme is hidden
- Since:
- 3.1
Definition at line 232 of file kicontheme.cpp.
bool KIconTheme::isValid | ( | ) | const |
The icon theme exists?
- Returns:
- true if the icon theme is valid
Definition at line 227 of file kicontheme.cpp.
QString KIconTheme::linkOverlay | ( | ) | const |
Returns the name of this theme's link overlay.
- Returns:
- the name of the link overlay
Definition at line 239 of file kicontheme.cpp.
QStringList KIconTheme::list | ( | ) | [static] |
List all icon themes installed on the system, global and local.
- Returns:
- the list of all icon themes
Definition at line 466 of file kicontheme.cpp.
QString KIconTheme::lockOverlay | ( | ) | const |
Returns the name of this theme's lock overlay.
- Returns:
- the name of the lock overlay
Definition at line 240 of file kicontheme.cpp.
QString KIconTheme::name | ( | ) | const [inline] |
The stylized name of the icon theme.
- Returns:
- the (human-readable) name of the theme
Definition at line 202 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
Definition at line 265 of file kicontheme.cpp.
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
Definition at line 318 of file kicontheme.cpp.
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
Definition at line 254 of file kicontheme.cpp.
void KIconTheme::reconfigure | ( | ) | [static] |
QString KIconTheme::screenshot | ( | ) | const |
Return the name of the screenshot.
- Returns:
- the name of the screenshot, QString::null if there is none
Definition at line 238 of file kicontheme.cpp.
QString KIconTheme::shareOverlay | ( | ) | const |
Returns the name of this theme's share overlay.
- Returns:
- the name of the share overlay
- Since:
- 3.1
Definition at line 242 of file kicontheme.cpp.
QString KIconTheme::zipOverlay | ( | ) | const |
Returns the name of this theme's zip overlay.
- Returns:
- the name of the zip overlay
Definition at line 241 of file kicontheme.cpp.
The documentation for this class was generated from the following files: