theme.h

/*
 *   Copyright 2006-2007 Aaron Seigo <[email protected]>
 *   Copyright 2013 Marco Martin <[email protected]>
 *
 *   This program 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, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef PLASMA_THEME_H
#define PLASMA_THEME_H

#include <QGuiApplication>
#include <QFont>
#include <QObject>

#include <kplugininfo.h>
#include <ksharedconfig.h>

#include <plasma/plasma_export.h>

class KPluginMetaData;

namespace Plasma
{

class ThemePrivate;
class SvgPrivate;

class PLASMA_EXPORT Theme : public QObject
{
    Q_OBJECT

    Q_PROPERTY(QString themeName READ themeName NOTIFY themeChanged)
    Q_PROPERTY(bool useGlobalSettings READ useGlobalSettings NOTIFY themeChanged)
    Q_PROPERTY(QString wallpaperPath READ wallpaperPath NOTIFY themeChanged)

    //fonts
    Q_PROPERTY(QFont defaultFont READ defaultFont NOTIFY defaultFontChanged)
    Q_PROPERTY(QFont smallestFont READ smallestFont NOTIFY smallestFontChanged)

    // stylesheet
    Q_PROPERTY(QString styleSheet READ styleSheet NOTIFY themeChanged)

public:
    enum ColorRole {
        TextColor = 0, 
        BackgroundColor = 1, 
        HighlightColor = 2, 
        HoverColor = 3, 
        FocusColor = 4, 
        LinkColor = 5, 
        VisitedLinkColor = 6, 
        HighlightedTextColor = 7,
        PositiveTextColor = 8, 
        NeutralTextColor = 9, 
        NegativeTextColor = 10, 
        DisabledTextColor = 11 
    };

    enum ColorGroup {
        NormalColorGroup = 0,
        ButtonColorGroup = 1,
        ViewColorGroup = 2,
        ComplementaryColorGroup = 3
    };
    Q_ENUM(ColorGroup)

    
    explicit Theme(QObject *parent = nullptr);

    explicit Theme(const QString &themeName, QObject *parent = nullptr);

    ~Theme();

    void setThemeName(const QString &themeName);

    QString themeName() const;

    QString imagePath(const QString &name) const;

    QString wallpaperPath(const QSize &size = QSize()) const;

    Q_INVOKABLE QString wallpaperPathForSize(int width = -1, int height = -1) const;

    bool currentThemeHasImage(const QString &name) const;

    KSharedConfigPtr colorScheme() const;

    QColor color(ColorRole role, ColorGroup group = NormalColorGroup) const;

    void setUseGlobalSettings(bool useGlobal);

    bool useGlobalSettings() const;

    QString styleSheet(const QString &css = QString()) const;

    bool findInCache(const QString &key, QPixmap &pix, unsigned int lastModified = 0);

    void insertIntoCache(const QString &key, const QPixmap &pix);

    void insertIntoCache(const QString &key, const QPixmap &pix, const QString &id);

    void setCacheLimit(int kbytes);

    bool findInRectsCache(const QString &image, const QString &element, QRectF &rect) const;

    QStringList listCachedRectKeys(const QString &image) const;

    void insertIntoRectsCache(const QString &image, const QString &element, const QRectF &rect);

    void invalidateRectsCache(const QString &image);

    void releaseRectsCache(const QString &image);

#if PLASMA_ENABLE_DEPRECATED_SINCE(5, 67)

    PLASMA_DEPRECATED_VERSION(5, 67, "Use KPluginMetaData metadata()")
    KPluginInfo pluginInfo() const;
#endif

    KPluginMetaData metadata() const;

    QFont defaultFont() const;

    QFont smallestFont() const;

    bool backgroundContrastEnabled() const;

    qreal backgroundContrast() const;

    qreal backgroundIntensity() const;

    qreal backgroundSaturation() const;

    bool blurBehindEnabled() const;

    Q_INVOKABLE QSizeF mSize(const QFont &font = QGuiApplication::font()) const;

    QString backgroundPath(const QString &image) const;

Q_SIGNALS:
    void themeChanged();

    void defaultFontChanged();
    void smallestFontChanged();

private:
    friend class SvgPrivate;
    friend class FrameSvg;
    friend class FrameSvgPrivate;
    friend class ThemePrivate;
    ThemePrivate *d;
};

} // Plasma namespace

#endif // multiple inclusion guard