theme.h

Go to the documentation of this file.

/*
 *   Copyright 2006-2007 Aaron Seigo <aseigo@kde.org>
 *
 *   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 <QtCore/QObject>
#include <QtGui/QFont>
#include <QtGui/QFontMetrics>

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

#include <plasma/plasma_export.h>
#include <plasma/packagestructure.h>

namespace Plasma
{

class ThemePrivate;

class PLASMA_EXPORT Theme : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString themeName READ themeName)

    public:
        enum ColorRole {
            TextColor = 0, 
            HighlightColor = 1, 
            BackgroundColor = 2, 
            ButtonTextColor = 4, 
            ButtonBackgroundColor = 8, 
            LinkColor = 16, 
            VisitedLinkColor = 32, 
            ButtonHoverColor = 64, 
            ButtonFocusColor = 128, 
            ViewTextColor = 256, 
            ViewBackgroundColor = 512, 
            ViewHoverColor = 1024, 
            ViewFocusColor = 2048 
        };

        enum FontRole {
            DefaultFont = 0, 
            DesktopFont, 
            SmallestFont 
        };

        static Theme *defaultTheme();

        explicit Theme(QObject *parent = 0);

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

        ~Theme();

        static PackageStructure::Ptr packageStructure();

        static KPluginInfo::List listThemeInfo();

        void setThemeName(const QString &themeName);

        QString themeName() const;

        Q_INVOKABLE QString imagePath(const QString &name) const;

        Q_INVOKABLE QString animationPath(const QString &name) const;

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

        Q_INVOKABLE bool currentThemeHasImage(const QString &name) const;

        Q_INVOKABLE KSharedConfigPtr colorScheme() const;

        Q_INVOKABLE QColor color(ColorRole role) const;

        Q_INVOKABLE void setFont(const QFont &font, FontRole role = DefaultFont);

        Q_INVOKABLE QFont font(FontRole role) const;

        Q_INVOKABLE QFontMetrics fontMetrics() const;

        Q_INVOKABLE bool windowTranslucencyEnabled() const;

        void setUseGlobalSettings(bool useGlobal);

        bool useGlobalSettings() const;

        bool useNativeWidgetStyle() const;

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


        bool findInCache(const QString &key, QPixmap &pix);

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

        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);

        KUrl homepage() const;

        int toolTipDelay() const;

    Q_SIGNALS:
        void themeChanged();

    public Q_SLOTS:
        void settingsChanged();

    private:
        friend class ThemeSingleton;
        friend class ThemePrivate;
        ThemePrivate *const d;

        Q_PRIVATE_SLOT(d, void compositingChanged(bool))
        Q_PRIVATE_SLOT(d, void colorsChanged())
        Q_PRIVATE_SLOT(d, void blurBehindChanged(bool blur))
        Q_PRIVATE_SLOT(d, void settingsFileChanged(const QString &))
        Q_PRIVATE_SLOT(d, void scheduledCacheUpdate())
        Q_PRIVATE_SLOT(d, void onAppExitCleanup())
        Q_PRIVATE_SLOT(d, void notifyOfChanged())
};

} // Plasma namespace

#endif // multiple inclusion guard