kpixmapcache.h

Go to the documentation of this file.

/*
 *
 * This file is part of the KDE project.
 * Copyright (C) 2007 Rivo Laks <rivolaks@hot.ee>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License version 2 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef KPIXMAPCACHE_H
#define KPIXMAPCACHE_H

#include <kdeui_export.h>

#include <QtCore/QList>
#include <QtCore/QSet>
#include <QtCore/QSize>

class QString;
class QPixmap;


class KDEUI_EXPORT KPixmapCache
{
public:
    explicit KPixmapCache(const QString& name);
    virtual ~KPixmapCache();

    virtual bool find(const QString& key, QPixmap& pix);

    virtual void insert(const QString& key, const QPixmap& pix);

    QPixmap loadFromFile(const QString& filename);

    QPixmap loadFromSvg(const QString& filename, const QSize& size = QSize());

    unsigned int timestamp() const;

    void setTimestamp(unsigned int time);

    // KDE5 Get rid of QPixmapCache and use a sane cache instead.
    void setUseQPixmapCache(bool use);

    bool useQPixmapCache() const;

    int size() const;

    int cacheLimit() const;

    void setCacheLimit(int kbytes);

    enum RemoveStrategy { 
                          RemoveOldest,
                          RemoveSeldomUsed,
                          RemoveLeastRecentlyUsed
                        };
    RemoveStrategy removeEntryStrategy() const;

    void setRemoveEntryStrategy(RemoveStrategy strategy);

    bool isEnabled() const;

    bool isValid() const;

    // KDE5: Static function oh how I hate you, this makes it very difficult to perform
    // appropriate locking and synchronization to actually remove the cache.
    static void deleteCache(const QString& name);

    void discard();

    void removeEntries(int newsize = 0);

protected:
    // KDE5: rename to ensureInitialized()
    // KDE5: Make private or move to Private
    void ensureInited() const;

    virtual bool loadCustomData(QDataStream& stream);

    virtual bool writeCustomData(QDataStream& stream);

    virtual bool loadCustomIndexHeader(QDataStream& stream);

    virtual void writeCustomIndexHeader(QDataStream& stream);

    void setValid(bool valid);

    bool recreateCacheFiles();

private:
    class Private;
    friend class Private;
    Private * const d; 
};

#endif // KPIXMAPCACHE_H