• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KIconCache Class Reference

#include <kiconcache.h>

Inheritance diagram for KIconCache:

Inheritance graph
[legend]

List of all members.


Detailed Description

Icon cache for KDE.

Note that this is the KDE-wide cache for storing icons and should only be used by KIconLoader. If you want to cache your own pixmaps you should look at KPixmapCache instead.

Definition at line 44 of file kiconcache.h.


Public Member Functions

 KIconCache ()
virtual ~KIconCache ()
bool find (const QString &key, QPixmap &pix, QString *path)
void insert (const QString &key, const QPixmap &pix, const QString &path)
virtual bool find (const QString &key, QPixmap &pix)
virtual void insert (const QString &key, const QPixmap &pix)
int defaultIconSize (KIconLoader::Group group) const
void setThemeInfo (const QList< KIconTheme * > &themes)

Static Public Member Functions

static void deleteCache ()

Protected Member Functions

virtual bool loadCustomIndexHeader (QDataStream &stream)
virtual void writeCustomIndexHeader (QDataStream &stream)
virtual bool loadCustomData (QDataStream &stream)
virtual bool writeCustomData (QDataStream &stream)
QSet< QString > existingIconThemeDirs (const QStringList &themeNames) const
unsigned int mostRecentMTime (const QSet< QString > &dirNames) const

Friends

class Private

Constructor & Destructor Documentation

KIconCache::KIconCache (  )  [explicit]

Constucts the icon cache object.

Definition at line 102 of file kiconcache.cpp.

KIconCache::~KIconCache (  )  [virtual]

Definition at line 110 of file kiconcache.cpp.


Member Function Documentation

bool KIconCache::find ( const QString &  key,
QPixmap &  pix,
QString *  path 
)

Definition at line 264 of file kiconcache.cpp.

void KIconCache::insert ( const QString &  key,
const QPixmap &  pix,
const QString &  path 
)

Definition at line 277 of file kiconcache.cpp.

bool KIconCache::find ( const QString &  key,
QPixmap &  pix 
) [virtual]

Tries to load pixmap with the specified key from cache.

Returns:
true when pixmap was found and loaded from cache, false otherwise

Reimplemented from KPixmapCache.

Definition at line 284 of file kiconcache.cpp.

void KIconCache::insert ( const QString &  key,
const QPixmap &  pix 
) [virtual]

Insert specified pixmap into the cache.

If the cache already contains pixmap with the specified key then it is overwritten.

Reimplemented from KPixmapCache.

Definition at line 290 of file kiconcache.cpp.

void KIconCache::deleteCache (  )  [static]

Deletes the icon cache.

Definition at line 115 of file kiconcache.cpp.

int KIconCache::defaultIconSize ( KIconLoader::Group  group  )  const

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

Parameters:
group The icon group. See KIconLoader::Group.
Returns:
The default size in pixels for the given icon group.

Definition at line 227 of file kiconcache.cpp.

void KIconCache::setThemeInfo ( const QList< KIconTheme * > &  themes  ) 

Definition at line 237 of file kiconcache.cpp.

bool KIconCache::loadCustomIndexHeader ( QDataStream &  stream  )  [protected, virtual]

Can be used by subclasses to write custom data into cache's header.

Reimplemented from KPixmapCache.

Definition at line 120 of file kiconcache.cpp.

void KIconCache::writeCustomIndexHeader ( QDataStream &  stream  )  [protected, virtual]

Can be used by subclasses to load custom data from cache's header.

Reimplemented from KPixmapCache.

Definition at line 166 of file kiconcache.cpp.

bool KIconCache::loadCustomData ( QDataStream &  stream  )  [protected, virtual]

Can be used by subclasses to write custom data into the the stream.

Reimplemented from KPixmapCache.

Definition at line 296 of file kiconcache.cpp.

bool KIconCache::writeCustomData ( QDataStream &  stream  )  [protected, virtual]

Can be used by subclasses to load custom data from the the stream.

Reimplemented from KPixmapCache.

Definition at line 307 of file kiconcache.cpp.

QSet< QString > KIconCache::existingIconThemeDirs ( const QStringList &  themeNames  )  const [protected]

Definition at line 188 of file kiconcache.cpp.

unsigned int KIconCache::mostRecentMTime ( const QSet< QString > &  dirNames  )  const [protected]

Definition at line 214 of file kiconcache.cpp.


Friends And Related Function Documentation

friend class Private [friend]

Reimplemented from KPixmapCache.

Definition at line 86 of file kiconcache.h.


The documentation for this class was generated from the following files:
  • kiconcache.h
  • kiconcache.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   WTF
  • KJSEmbed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  •   core
  • Phonon
  •   Backend
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal