class KIconTheme

Class to use/access icon themes in KDE. More...

Definition#include <kicontheme.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods


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

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

KIconTheme

Load an icon theme by name.

Parameters:
namethe name of the theme (e.g. "hicolor" or "keramik")
appNamethe name of the application. Can be null. This argument allows applications to have themed application icons.

 ~KIconTheme ()

~KIconTheme

QString  name ()

name

[const]

The stylized name of the icon theme.

Returns: the (human-readable) name of the theme

QString  description ()

description

[const]

A description for the icon theme.

Returns: a human-readable description of the theme, QString::null if there is none

QString  example ()

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

QString  screenshot ()

screenshot

[const]

Return the name of the screenshot.

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

QString  linkOverlay ()

linkOverlay

[const]

Returns the name of this theme's link overlay.

Returns: the name of the link overlay

QString  zipOverlay ()

zipOverlay

[const]

Returns the name of this theme's zip overlay.

Returns: the name of the zip overlay

QString  lockOverlay ()

lockOverlay

[const]

Returns the name of this theme's lock overlay.

Returns: the name of the lock overlay

QString  shareOverlay ()

shareOverlay

[const]

Returns the name of this theme's share overlay.

Returns: the name of the share overlay

QString  dir ()

dir

[const]

Returns the toplevel theme directory.

Returns: the directory of the theme

QStringList  inherits ()

inherits

[const]

The themes this icon theme falls back on.

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

bool  isValid ()

isValid

[const]

The icon theme exists?

Returns: true if the icon theme is valid

bool  isHidden ()

isHidden

[const]

The icon theme should be hidden to the user?

Returns: true if the icon theme is hidden

int  depth ()

depth

[const]

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

Returns: the minimum bpp (8 or 32)

int  defaultSize (KIcon::Group group)

defaultSize

[const]

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

Parameters:
groupThe icon group. See KIcon::Group.

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

QValueList  querySizes (KIcon::Group group)

querySizes

[const]

Query available sizes for a group.

Parameters:
groupThe icon group. See KIcon::Group.

Returns: a list of available sized for the given group

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

queryIcons

[const]

Query available icons for a size and context.

Parameters:
sizethe size of the icons
contextthe context of the icons

Returns: the list of icon names

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

queryIconsByContext

[const]

Query available icons for a context and preferred size.

Parameters:
sizethe size of the icons
contextthe context of the icons

Returns: the list of icon names

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

iconPath

[const]

Lookup an icon in the theme.

Parameters:
nameThe name of the icon, without extension.
sizeThe desired size of the icon.
matchThe 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: isValid, will, return, true, and, false, otherwise.

QStringList  list ()

list

[static]

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

Returns: the list of all icon themes

QString  current ()

current

[static]

Returns the current icon theme.

Returns: the name of the current theme

void  reconfigure ()

reconfigure

[static]

Reconfigure the theme.

QString  defaultThemeName ()

defaultThemeName

[static]

Returns the default icon theme.

Returns: the name of the default theme name


Generated by: caleb on tcdevel on Tue Jan 28 12:54:04 2003, using kdoc $.