kimagecache.h

Go to the documentation of this file.

/*
 * This file is part of the KDE project.
 * Copyright © 2010 Michael Pyne <mpyne@kde.org>
 *
 * 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 KIMAGECACHE_H
#define KIMAGECACHE_H

#include <kdeui_export.h>
#include <kshareddatacache.h>

#include <time.h>

class QImage;
class QPixmap;

class KDEUI_EXPORT KImageCache : public KSharedDataCache
{
    public:
    KImageCache(const QString &cacheName,
                unsigned defaultCacheSize,
                unsigned expectedItemSize = 0);

    ~KImageCache();

    bool insertPixmap(const QString &key, const QPixmap &pixmap);

    bool insertImage(const QString &key, const QImage &image);

    bool findPixmap(const QString &key, QPixmap *destination) const;

    bool findImage(const QString &key, QImage *destination) const;

    void clear();

    time_t lastModifiedTime() const;

    bool pixmapCaching() const;

    void setPixmapCaching(bool enable);

    int pixmapCacheLimit() const;

    void setPixmapCacheLimit(int size);

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

#endif /* KIMAGECACHE_H */