colorhelper.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2012 Martin Gräßlin <mgraesslin@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
#pragma once
 
#include <QColor>
#include <QObject>
 
class ColorHelper : public QObject
{
    Q_OBJECT
    Q_PROPERTY(qreal contrast READ contrast CONSTANT)
public:
    explicit ColorHelper(QObject *parent = nullptr);
    ~ColorHelper() override;
    enum ShadeRole {
        LightShade,
        MidlightShade,
        MidShade,
        DarkShade,
        ShadowShade
    };
    Q_ENUM(ShadeRole)
    enum BackgroundRole {
        NormalBackground = 0,
        AlternateBackground = 1,
        ActiveBackground = 2,
        LinkBackground = 3,
        VisitedBackground = 4,
        NegativeBackground = 5,
        NeutralBackground = 6,
        PositiveBackground = 7
    };
    Q_ENUM(BackgroundRole)
 
    
    enum ForegroundRole {
        NormalText = 0,
        InactiveText = 1,
        ActiveText = 2,
        LinkText = 3,
        VisitedText = 4,
        NegativeText = 5,
        NeutralText = 6,
        PositiveText = 7
    };
    Q_ENUM(ForegroundRole)
    Q_INVOKABLE QColor shade(const QColor &color, ShadeRole role);
    Q_INVOKABLE QColor shade(const QColor &color, ShadeRole role, qreal contrast);
    Q_INVOKABLE QColor multiplyAlpha(const QColor &color, qreal alpha);
    Q_INVOKABLE QColor background(bool active, BackgroundRole role = NormalBackground) const;
 
    Q_INVOKABLE QColor foreground(bool active, ForegroundRole role = NormalText) const;
 
    qreal contrast() const;
};