.TH "KIconTheme" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIconTheme \- Class to use/access icon themes in \fBKDE\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kicontheme.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKIconTheme\fP (const \fBQString\fP &name, const \fBQString\fP &appName=QString::null)"
.br
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBdescription\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBexample\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBscreenshot\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBlinkOverlay\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBzipOverlay\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBlockOverlay\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBshareOverlay\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBdir\fP () const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBinherits\fP () const "
.br
.ti -1c
.RI "bool \fBisValid\fP () const "
.br
.ti -1c
.RI "bool \fBisHidden\fP () const "
.br
.ti -1c
.RI "int \fBdepth\fP () const "
.br
.ti -1c
.RI "int \fBdefaultSize\fP (\fBKIcon::Group\fP group) const "
.br
.ti -1c
.RI "\fBQValueList\fP< int > \fBquerySizes\fP (\fBKIcon::Group\fP group) const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBqueryIcons\fP (int size, \fBKIcon::Context\fP context=KIcon::Any) const "
.br
.ti -1c
.RI "\fBQStringList\fP \fBqueryIconsByContext\fP (int size, \fBKIcon::Context\fP context=KIcon::Any) const "
.br
.ti -1c
.RI "\fBKIcon\fP \fBiconPath\fP (const \fBQString\fP &name, int size, \fBKIcon::MatchType\fP match) const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBQStringList\fP \fBlist\fP ()"
.br
.ti -1c
.RI "static \fBQString\fP \fBcurrent\fP ()"
.br
.ti -1c
.RI "static void \fBreconfigure\fP ()"
.br
.ti -1c
.RI "static \fBQString\fP \fBdefaultThemeName\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
Class to use/access icon themes in \fBKDE\fP. 

This class is used by the iconloader but can be used by others too. 
.PP
\fBSee also:\fP
.RS 4
\fBKIconLoader\fP 
.RE
.PP

.PP
Definition at line 179 of file kicontheme.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KIconTheme::KIconTheme (const \fBQString\fP & name, const \fBQString\fP & appName = \fCQString::null\fP)"
.PP
Load an icon theme by name. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP the name of the theme (e.g. 'hicolor' or 'keramik') 
.br
\fIappName\fP the name of the application. Can be null. This argument allows applications to have themed application icons. 
.RE
.PP

.PP
Definition at line 82 of file kicontheme.cpp.
.PP
References QPtrList::append(), QValueList::begin(), QMap::contains(), dir(), KGlobal::dirs(), QValueList::end(), QFile::exists(), KStandardDirs::exists(), QPtrList::first(), QString::isEmpty(), name(), QPtrList::next(), KSharedConfig::openConfig(), KConfigBase::readBoolEntry(), KConfigBase::readEntry(), KConfigBase::readIntListEntry(), KConfigBase::readListEntry(), KConfigBase::readNumEntry(), KConfigBase::readPathEntry(), KConfigBase::readPathListEntry(), KStandardDirs::resourceDirs(), QPtrList::setAutoDelete(), and KConfigBase::setGroup().
.SH "Member Function Documentation"
.PP 
.SS "\fBQString\fP KIconTheme::name () const\fC [inline]\fP"
.PP
The stylized name of the icon theme. 
.PP
\fBReturns:\fP
.RS 4
the (human-readable) name of the theme 
.RE
.PP

.PP
Definition at line 195 of file kicontheme.h.
.PP
Referenced by iconPath(), and KIconTheme().
.SS "\fBQString\fP KIconTheme::description () const\fC [inline]\fP"
.PP
A description for the icon theme. 
.PP
\fBReturns:\fP
.RS 4
a human-readable description of the theme, QString::null if there is none 
.RE
.PP

.PP
Definition at line 202 of file kicontheme.h.
.SS "\fBQString\fP KIconTheme::example () const"
.PP
Return the name of the 'example' icon. 
.PP
This can be used to present the theme to the user. 
.PP
\fBReturns:\fP
.RS 4
the name of the example icon, QString::null if there is none 
.RE
.PP

.PP
Definition at line 233 of file kicontheme.cpp.
.SS "\fBQString\fP KIconTheme::screenshot () const"
.PP
Return the name of the screenshot. 
.PP
\fBReturns:\fP
.RS 4
the name of the screenshot, QString::null if there is none 
.RE
.PP

.PP
Definition at line 234 of file kicontheme.cpp.
.SS "\fBQString\fP KIconTheme::linkOverlay () const"
.PP
Returns the name of this theme's link overlay. 
.PP
\fBReturns:\fP
.RS 4
the name of the link overlay 
.RE
.PP

.PP
Definition at line 235 of file kicontheme.cpp.
.PP
Referenced by KIconLoader::loadIcon().
.SS "\fBQString\fP KIconTheme::zipOverlay () const"
.PP
Returns the name of this theme's zip overlay. 
.PP
\fBReturns:\fP
.RS 4
the name of the zip overlay 
.RE
.PP

.PP
Definition at line 237 of file kicontheme.cpp.
.PP
Referenced by KIconLoader::loadIcon().
.SS "\fBQString\fP KIconTheme::lockOverlay () const"
.PP
Returns the name of this theme's lock overlay. 
.PP
\fBReturns:\fP
.RS 4
the name of the lock overlay 
.RE
.PP

.PP
Definition at line 236 of file kicontheme.cpp.
.PP
Referenced by KIconLoader::loadIcon().
.SS "\fBQString\fP KIconTheme::shareOverlay () const"
.PP
Returns the name of this theme's share overlay. 
.PP
\fBReturns:\fP
.RS 4
the name of the share overlay 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 238 of file kicontheme.cpp.
.PP
Referenced by KIconLoader::loadIcon().
.SS "\fBQString\fP KIconTheme::dir () const\fC [inline]\fP"
.PP
Returns the toplevel theme directory. 
.PP
\fBReturns:\fP
.RS 4
the directory of the theme 
.RE
.PP

.PP
Definition at line 246 of file kicontheme.h.
.PP
Referenced by iconPath(), KIconTheme(), list(), queryIcons(), and queryIconsByContext().
.SS "\fBQStringList\fP KIconTheme::inherits () const\fC [inline]\fP"
.PP
The themes this icon theme falls back on. 
.PP
\fBReturns:\fP
.RS 4
a list of icon themes that are used as fall-backs 
.RE
.PP

.PP
Definition at line 252 of file kicontheme.h.
.SS "bool KIconTheme::isValid () const"
.PP
The icon theme exists? 
.PP
\fBReturns:\fP
.RS 4
true if the icon theme is valid 
.RE
.PP

.PP
Definition at line 223 of file kicontheme.cpp.
.PP
References QPtrList::isEmpty().
.PP
Referenced by list().
.SS "bool KIconTheme::isHidden () const"
.PP
The icon theme should be hidden to the user? 
.PP
\fBReturns:\fP
.RS 4
true if the icon theme is hidden 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 228 of file kicontheme.cpp.
.SS "int KIconTheme::depth () const\fC [inline]\fP"
.PP
The minimum display depth required for this theme. 
.PP
This can either be 8 or 32. 
.PP
\fBReturns:\fP
.RS 4
the minimum bpp (8 or 32) 
.RE
.PP

.PP
Definition at line 272 of file kicontheme.h.
.SS "int KIconTheme::defaultSize (\fBKIcon::Group\fP group) const"
.PP
The default size of this theme for a certain icon group. 
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP The icon group. See \fBKIcon::Group\fP. 
.RE
.PP
\fBReturns:\fP
.RS 4
The default size in pixels for the given icon group. 
.RE
.PP

.PP
Definition at line 240 of file kicontheme.cpp.
.SS "\fBQValueList\fP< int > KIconTheme::querySizes (\fBKIcon::Group\fP group) const"
.PP
Query available sizes for a group. 
.PP
\fBParameters:\fP
.RS 4
\fIgroup\fP The icon group. See \fBKIcon::Group\fP. 
.RE
.PP
\fBReturns:\fP
.RS 4
a list of available sized for the given group 
.RE
.PP

.PP
Definition at line 250 of file kicontheme.cpp.
.SS "\fBQStringList\fP KIconTheme::queryIcons (int size, \fBKIcon::Context\fP context = \fCKIcon::Any\fP) const"
.PP
Query available icons for a size and context. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP the size of the icons 
.br
\fIcontext\fP the context of the icons 
.RE
.PP
\fBReturns:\fP
.RS 4
the list of icon names 
.RE
.PP

.PP
Definition at line 261 of file kicontheme.cpp.
.PP
References QPtrListIterator::current(), dir(), and QPtrListIterator::toFirst().
.SS "\fBQStringList\fP KIconTheme::queryIconsByContext (int size, \fBKIcon::Context\fP context = \fCKIcon::Any\fP) const"
.PP
Query available icons for a context and preferred size. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP the size of the icons 
.br
\fIcontext\fP the context of the icons 
.RE
.PP
\fBReturns:\fP
.RS 4
the list of icon names 
.RE
.PP

.PP
Definition at line 314 of file kicontheme.cpp.
.PP
References QPtrListIterator::current(), and dir().
.SS "\fBKIcon\fP KIconTheme::iconPath (const \fBQString\fP & name, int size, \fBKIcon::MatchType\fP match) const"
.PP
Lookup an icon in the theme. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP The name of the icon, without extension. 
.br
\fIsize\fP The desired size of the icon. 
.br
\fImatch\fP The matching mode. \fBKIcon::MatchExact\fP returns an icon only if matches exactly. \fBKIcon::MatchBest\fP returns the best matching icon. 
.RE
.PP
\fBReturns:\fP
.RS 4
A \fBKIcon\fP class that describes the icon. If an icon is found, 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKIcon::isValid\fP will return true, and false otherwise. 
.RE
.PP

.PP
Definition at line 343 of file kicontheme.cpp.
.PP
References KIcon::context, QPtrListIterator::current(), dir(), QString::isEmpty(), name(), KIcon::path, KIcon::size, KIcon::threshold, and KIcon::type.
.SS "\fBQStringList\fP KIconTheme::list ()\fC [static]\fP"
.PP
List all icon themes installed on the system, global and local. 
.PP
\fBReturns:\fP
.RS 4
the list of all icon themes 
.RE
.PP

.PP
Definition at line 448 of file kicontheme.cpp.
.PP
References dir(), KGlobal::dirs(), QDir::entryList(), QDir::exists(), isValid(), and KStandardDirs::resourceDirs().
.SS "\fBQString\fP KIconTheme::current ()\fC [static]\fP"
.PP
Returns the current icon theme. 
.PP
\fBReturns:\fP
.RS 4
the name of the current theme 
.RE
.PP

.PP
Definition at line 426 of file kicontheme.cpp.
.PP
References KGlobal::config(), defaultThemeName(), and KConfigBase::readEntry().
.SS "void KIconTheme::reconfigure ()\fC [static]\fP"
.PP
Reconfigure the theme. 
.PP
Definition at line 481 of file kicontheme.cpp.
.PP
Referenced by KInstance::newIconLoader().
.SS "\fBQString\fP KIconTheme::defaultThemeName ()\fC [static]\fP"
.PP
Returns the default icon theme. 
.PP
\fBReturns:\fP
.RS 4
the name of the default theme name 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 490 of file kicontheme.cpp.
.PP
References QString::fromLatin1().
.PP
Referenced by current().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
