kcolorutils.h

Go to the documentation of this file.

/* This file is part of the KDE project
 * Copyright (C) 2007 Matthew Woehlke <mw_triad@users.sourceforge.net>
 * Copyright (C) 2007 Thomas Zander <zander@kde.org>
 * Copyright (C) 2007 Zack Rusin <zack@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 as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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 KCOLORUTILS_H
#define KCOLORUTILS_H

#include <kdeui_export.h>
#include <QtGui/QPainter>

class QColor;

namespace KColorUtils {
    KDEUI_EXPORT qreal luma(const QColor&);

    KDEUI_EXPORT qreal contrastRatio(const QColor&, const QColor&);

    KDEUI_EXPORT QColor lighten(const QColor&, qreal amount = 0.5, qreal chromaInverseGain = 1.0);

    KDEUI_EXPORT QColor darken(const QColor&, qreal amount = 0.5, qreal chromaGain = 1.0);

    KDEUI_EXPORT QColor shade(const QColor&, qreal lumaAmount, qreal chromaAmount = 0.0);

    KDEUI_EXPORT QColor tint(const QColor &base, const QColor &color, qreal amount = 0.3);

    KDEUI_EXPORT QColor mix(const QColor &c1, const QColor &c2,
                            qreal bias = 0.5);

    KDEUI_EXPORT QColor overlayColors(const QColor &base, const QColor &paint,
                                      QPainter::CompositionMode comp = QPainter::CompositionMode_SourceOver);

}

#endif // KCOLORUTILS_H
// kate: space-indent on; indent-width 4; replace-tabs on; auto-insert-doxygen on;