kiconeffect.h

Go to the documentation of this file.

/* vi: ts=8 sts=4 sw=4
 *
 * This file is part of the KDE project, module kdecore.
 * Copyright (C) 2000 Geert Jansen <jansen@kde.org>
 * Copyright (C) 2007 Daniel M. Duley <daniel.duley@verizon.net>
 * with minor additions and based on ideas from
 * Torsten Rahn <torsten@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 KICONEFFECT_H
#define KICONEFFECT_H

#include <kdeui_export.h>

#include <QtGui/QImage>
#include <QtGui/QPixmap>
#include <QtGui/QColor>
#include <QtCore/QRect>

class KIconEffectPrivate;

class KDEUI_EXPORT KIconEffect
{
public:
    KIconEffect();
    ~KIconEffect();

    enum Effects { NoEffect, ToGray, Colorize, ToGamma, DeSaturate,
                   ToMonochrome,
                   LastEffect };

    void init();

    bool hasEffect(int group, int state) const;

     QString fingerprint(int group, int state) const;

    QImage apply(const QImage &src, int group, int state) const;

    QImage apply(const QImage &src, int effect, float value, const QColor &rgb, bool trans) const;
    QImage apply(const QImage &src, int effect, float value, const QColor &rgb, const QColor &rgb2, bool trans) const;

    QPixmap apply(const QPixmap &src, int group, int state) const;

    QPixmap apply(const QPixmap &src, int effect, float value, const QColor &rgb, bool trans) const;
    QPixmap apply(const QPixmap &src, int effect, float value, const QColor &rgb, const QColor &rgb2, bool trans) const;

    QImage doublePixels(const QImage &src) const;

    static void toGray(QImage &image, float value);

    static void colorize(QImage &image, const QColor &col, float value);

    static void toMonochrome(QImage &image, const QColor &black, const QColor &white, float value);

    static void deSaturate(QImage &image, float value);

    static void toGamma(QImage &image, float value);

    static void semiTransparent(QImage &image);

    static void semiTransparent(QPixmap &pixmap);

    static void overlay(QImage &src, QImage &overlay);

private:
    KIconEffectPrivate* const d;
};

#endif