kgtheme.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2012 Stefan Majewsky <majewsky@gmx.net>                     *
 *                                                                         *
 *   This program 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 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 Library 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 KGTHEME_H
#define KGTHEME_H

//The complete API needs to be there when compiling libkdegames.
#ifdef MAKE_KDEGAMES_LIB
#define KGTHEME_PROVIDE_COMPATIBILITY_API
#endif //MAKE_KDEGAMES_LIB

#include <QtCore/QMetaType>
#include <QtCore/QObject>
#include <QtGui/QPixmap>

#include <libkdegames_export.h>

class KDEGAMES_EXPORT KgTheme : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QByteArray identifier READ identifier NOTIFY readOnlyProperty)
    //it is not intended to allow these properties to change after the initial
    //setup (note how KgThemeProvider returns only const KgTheme*), hence
    //a dummy NOTIFY signal is enough
    Q_PROPERTY(QString name READ name WRITE setName NOTIFY readOnlyProperty)
    Q_PROPERTY(QString description READ description WRITE setDescription NOTIFY readOnlyProperty)
    Q_PROPERTY(QString author READ author WRITE setAuthor NOTIFY readOnlyProperty)
    Q_PROPERTY(QString authorEmail READ authorEmail WRITE setAuthorEmail NOTIFY readOnlyProperty)
    Q_PROPERTY(QString graphicsPath READ graphicsPath WRITE setGraphicsPath NOTIFY readOnlyProperty)
    Q_PROPERTY(QString previewPath READ previewPath WRITE setPreviewPath NOTIFY readOnlyProperty)
    Q_DISABLE_COPY(KgTheme)
    public:
        explicit KgTheme(const QByteArray& identifier, QObject* parent = 0);
        virtual ~KgTheme();

        virtual bool readFromDesktopFile(const QString& path);

#ifdef KGTHEME_PROVIDE_COMPATIBILITY_API
        static void addConfigGroupName(const QString& name);
#endif

        QByteArray identifier() const;

        QString name() const;
        void setName(const QString& name);
        QString description() const;
        void setDescription(const QString& description);
        QString author() const;
        void setAuthor(const QString& author);
        QString authorEmail() const;
        void setAuthorEmail(const QString& authorEmail);

        QString graphicsPath() const;
        void setGraphicsPath(const QString& path);
        QString previewPath() const;
        void setPreviewPath(const QString& path);

        QMap<QString, QString> customData() const;
        QString customData(const QString& key, const QString& defaultValue = QString()) const;
        void setCustomData(const QMap<QString, QString>& customData);
    Q_SIGNALS:
        void readOnlyProperty();
    private:
        class Private;
        Private* const d;
};

Q_DECLARE_METATYPE(const KgTheme*)

#endif // KGTHEME_H