kanagramgame.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Joshua Keel <joshuakeel@gmail.com>              *
 *             (C) 2007 by Jeremy Whiting <jpwhiting@kde.org>              *
 *             (C) 2012 by Laszlo Papp <lpapp@kde.org>                     *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, 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 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 KANAGRAMGAME_H
#define KANAGRAMGAME_H

#include "kanagram_engine_export.h"

#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <QtCore/QHash>
#include <KDE/KUrl>

#include <krandomsequence.h>


class KEduVocDocument;

class KANAGRAM_ENGINE_EXPORT KanagramGame : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString dataLanguage READ dataLanguage WRITE setDataLanguage NOTIFY dataLanguageChanged)

    public:
        KanagramGame();

        ~KanagramGame();

        QString sanitizedDataLanguage() const;

        QString anagram() const;

        Q_INVOKABLE QString hint() const;

        QString word() const;

        KUrl picHint();

        KUrl audioFile();

        QString documentTitle() const;

        QString filename() const;

        Q_INVOKABLE QStringList vocabularyList() const;

        Q_INVOKABLE QStringList languageNames();

        Q_INVOKABLE QString dataLanguage() const;

        Q_INVOKABLE void setDataLanguage(const QString& dataLanguage);

        Q_INVOKABLE int dataLanguageSelectedIndex() const;

        Q_INVOKABLE int currentCategory() const;


    public Q_SLOTS:

        void useVocabulary(const QString &vocabularyname);

        void useVocabulary(int index);

        bool refreshVocabularyList();

        void loadDefaultVocabulary();

        void nextAnagram();

        void nextVocabulary();

        void previousVocabulary();

        void restoreWord();

        void setCurrentCategory(int index);

    Q_SIGNALS:

        void fileError(const QString &filename);

        void dataLanguageChanged();

    private:

        void createAnagram();

        bool checkFile();

        KRandomSequence m_random;

        QString m_anagram;

        QString m_hint;

        KUrl m_picHintUrl;

        KUrl m_audioUrl;

        QString m_originalWord;

        int m_index;

        bool m_uppercaseOnly;

        QStringList m_fileList;

        QStringList m_answeredWords;

        QString m_filename;

        KEduVocDocument* m_document;

        QHash<QString, QString> m_languageCodeNameHash;
};

#endif