kgdifficulty.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2007 Nicolas Roffet <nicolas-kde@roffet.com>                *
 *   Copyright 2007 Pino Toscano <toscano.pino@tiscali.it>                 *
 *   Copyright 2011-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 KGDIFFICULTY_H
#define KGDIFFICULTY_H

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

#include <libkdegames_export.h>

class KDEGAMES_EXPORT KgDifficultyLevel : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(KgDifficultyLevel)
    Q_PROPERTY(bool default READ isDefault)
    Q_PROPERTY(int hardness READ hardness)
    Q_PROPERTY(QByteArray key READ key)
    Q_PROPERTY(QString title READ title)
    Q_ENUMS(StandardLevel)
    Q_PROPERTY(StandardLevel standardLevel READ standardLevel)
    public:
        enum StandardLevel
        {
            Custom = -1, 
            RidiculouslyEasy = 10,
            VeryEasy = 20,
            Easy = 30,
            Medium = 40,
            Hard = 50,
            VeryHard = 60,
            ExtremelyHard = 70,
            Impossible = 80
        };

        KgDifficultyLevel(int hardness, const QByteArray& key, const QString& title, bool isDefault = false);
        explicit KgDifficultyLevel(StandardLevel level, bool isDefault = false);
        virtual ~KgDifficultyLevel();

        bool isDefault() const;
        int hardness() const;
        QByteArray key() const;
        QString title() const;
        StandardLevel standardLevel() const;
    private:
        class Private;
        Private* const d;
};

class KDEGAMES_EXPORT KgDifficulty : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY(KgDifficulty)
    //Use currentLevel in game logic and selectedLevel in level selection UI.
    Q_PROPERTY(const KgDifficultyLevel* currentLevel READ currentLevel WRITE select NOTIFY currentLevelChanged)
    Q_PROPERTY(const KgDifficultyLevel* selectedLevel READ currentLevel WRITE select NOTIFY selectedLevelChanged)
    Q_PROPERTY(bool editable READ isEditable WRITE setEditable NOTIFY editableChanged)
    Q_PROPERTY(bool gameRunning READ isGameRunning WRITE setGameRunning NOTIFY gameRunningChanged)
    public:
        explicit KgDifficulty(QObject* parent = 0);
        virtual ~KgDifficulty();

        void addLevel(KgDifficultyLevel* level);
        void addStandardLevel(KgDifficultyLevel::StandardLevel level, bool isDefault = false);
        void addStandardLevelRange(KgDifficultyLevel::StandardLevel from, KgDifficultyLevel::StandardLevel to);
        void addStandardLevelRange(KgDifficultyLevel::StandardLevel from, KgDifficultyLevel::StandardLevel to, KgDifficultyLevel::StandardLevel defaultLevel);

        QList<const KgDifficultyLevel*> levels() const;
        const KgDifficultyLevel* currentLevel() const;

        bool isEditable() const;
        bool isGameRunning() const;
        void setEditable(bool editable);
        void setGameRunning(bool running);
    Q_SIGNALS:
        void editableChanged(bool editable);
        void gameRunningChanged(bool gameRunning);
        void currentLevelChanged(const KgDifficultyLevel* level);
        void selectedLevelChanged(const KgDifficultyLevel* level);
    public Q_SLOTS:
        void select(const KgDifficultyLevel* level);
    private:
        class Private;
        Private* const d;
};

Q_DECLARE_METATYPE(const KgDifficultyLevel*)

//TODO: Where to put documentation for this namespace?
namespace Kg
{
    KDEGAMES_EXPORT KgDifficulty* difficulty();
    KDEGAMES_EXPORT KgDifficultyLevel::StandardLevel difficultyLevel();
}

class KXmlGuiWindow;

//TODO KDE5: move this into a separate QtWidgets support library
namespace KgDifficultyGUI
{
    KDEGAMES_EXPORT void init(KXmlGuiWindow* window, KgDifficulty* difficulty = 0);
}

#endif // KGDIFFICULTY_H