Warning, file /education/khangman/src/khangman.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

 /***************************************************************************
  *   Copyright 2001-2009 Anne-Marie Mahfouf <annma@kde.org>                *
  *   Copyright 2014 Rahul Chowdhury <rahul.chowdhury@kdemail.net>          *
  *                                                                         *
  *   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 _KHANGMAN_H_
 #define _KHANGMAN_H_
 
 #include <KSharedConfig>
 
 #include <QMainWindow>
 
 #include "khmthemefactory.h"
 
 class QQmlEngine;
 class QQuickWidget;
 class KHelpMenu;
 
 /**
  * @short KHangMan Main Window
  * @author Anne-Marie Mahfouf <annemarie.mahfouf@free.fr>
  * @version 3.0
  */
 class KHangMan : public QMainWindow
 {
     Q_OBJECT
 
     Q_PROPERTY( int resolveTime READ resolveTime WRITE setResolveTime NOTIFY resolveTimeChanged )
     Q_PROPERTY( bool soundEnabled READ soundEnabled WRITE setSoundEnabled NOTIFY soundEnabledChanged )
 
     Q_PROPERTY( int currentLanguage READ currentLanguage WRITE setCurrentLanguage NOTIFY currentLanguageChanged )
     Q_PROPERTY( QStringList languages READ languages NOTIFY languagesChanged)
 
     Q_PROPERTY( int currentCategory READ currentCategory WRITE setCurrentCategory NOTIFY currentCategoryChanged )
     Q_PROPERTY( QStringList categories READ categories NOTIFY categoriesChanged)
 
     Q_PROPERTY( int currentTheme READ currentTheme WRITE setCurrentTheme NOTIFY currentThemeChanged )
     Q_PROPERTY( QStringList themes READ themes NOTIFY themesChanged)
     Q_PROPERTY( QString backgroundUrl READ backgroundUrl NOTIFY currentThemeChanged)
     Q_PROPERTY( QColor letterColor READ currentThemeLetterColor NOTIFY currentThemeChanged)
 
     Q_PROPERTY( QStringList currentWord READ currentWord NOTIFY currentWordChanged)
     Q_PROPERTY( QString currentHint READ getCurrentHint NOTIFY currentHintChanged)
     Q_PROPERTY( QStringList alphabet READ alphabet NOTIFY currentLanguageChanged)
 
     Q_PROPERTY( int winCount READ winCount WRITE setWinCount NOTIFY winCountChanged )
     Q_PROPERTY( int lossCount READ lossCount WRITE setLossCount NOTIFY lossCountChanged )
 
     Q_PROPERTY( int scoreMultiplyingFactor READ scoreMultiplyingFactor WRITE setScoreMultiplyingFactor NOTIFY scoreMultiplyingFactorChanged )
 
     Q_PROPERTY( int netScore READ netScore NOTIFY netScoreChanged )
 
 public:
     /**
     * Default Constructor
     */
     KHangMan();
 
     /**
     * Default Destructor
     */
     ~KHangMan() override;
 
     // These accessor and mutator methods are not needed once the
     // kconfig_compiler can generate Q_INVOKABLE methods, slots or/and
     // properties
     int resolveTime();
     void setResolveTime(int resolveTime);
 
     /** Getter and Setter for soundEnabled property */
     bool soundEnabled();
     void setSoundEnabled(bool sound);
 
     int currentCategory();
     QStringList categories();
 
     int currentLanguage();
     QStringList languages();
 
     int winCount() const;
     int lossCount() const;
 
     int scoreMultiplyingFactor() const;
     int netScore() const;
 
     int currentTheme();
     QStringList themes();
     QString backgroundUrl();
     QColor currentThemeLetterColor();
 
     //Display the mainwindow only when kvtml files are present, else show an error message and quit.
     void show();
 
     // get m_view->engine()
     QQmlEngine* getEngine();
 
     /** Calculate the net score */
     void calculateNetScore();
 
     Q_INVOKABLE QStringList currentWord() const;
 
     /** Get the current hint */
     Q_INVOKABLE QString getCurrentHint() const;
 
     Q_INVOKABLE QStringList alphabet() const;
 
     /** Return true if the word contains the char in the QString */
     Q_INVOKABLE bool containsChar(const QString &original);
 
     /** Return true if the answer and the current word match */
     Q_INVOKABLE bool isResolved() const;
 
     /** Reveals the solution to the current puzzle */
     Q_INVOKABLE void revealCurrentWord();
 
 public Q_SLOTS:
     ///When the language is changed in the Language menu
     void setCurrentLanguage(int index);
 
     ///When the category is changed in the Category menu
     void  setCurrentCategory(int index);
 
     /** Set the current theme */
     void setCurrentTheme(int index);
 
     ///access the KNewStuff class to install new data
     void slotDownloadNewStuff();
 
     ///Load kvtml file and get a word and its tip in random
     void readFile();
 
     /** Generate a new word */
     void nextWord();
 
     /** Sets the count for number of words correctly guessed */
     void setWinCount(int count);
 
     /** Sets the count for number of words wrongly guessed */
     void setLossCount(int count);
 
     /** Sets the score multiplying factor */
     void setScoreMultiplyingFactor( int factor );
 
     /** Handle the guessed letter */
     void replaceLetters(const QString& charString);
 
     void showAboutKHangMan();
     void showAboutKDE();
     void showHandbook();
 
 Q_SIGNALS:
 
     void resolveTimeChanged();
     void soundEnabledChanged();
     void currentLanguageChanged();
     void currentCategoryChanged();
     void currentWordChanged();
     void currentHintChanged();
     void languagesChanged();
     void categoriesChanged();
     void themesChanged();
     void currentThemeChanged();
     void winCountChanged();
     void lossCountChanged();
     void scoreMultiplyingFactorChanged();
     void netScoreChanged();
 
 private:
     KConfigGroup config(const QString &group);
 
     /** Strip the accents off given string
      * @params original string to strip accents off of
      * @returns string without accents
      */
     QString stripAccents(const QString & original);
 
     ///Scan the files in the selected language dir to set the levels
     void loadLevels();
     // Populate m_specialCharacters if the
     // current language has special characters.
     void loadLanguageSpecialCharacters();
 
     /** Scan the languages found on disk and load the current
      * language from settings with en as default.
      */
     void scanLanguages();
 
     //shuffle words+hints
     void slotSetWordsSequence();
 
     ///the different data titles and files in the current language dir
     QMap<QString, QString> m_titleLevels;
 
     int m_currentCategory;
     int m_currentLanguage;
 
     // language information
     QStringList m_languages;
     QStringList m_languageNames;
 
     // Some important members: the view and newStuff.
     QQuickWidget   *m_view;
 
     // Contains all the words that are read from the data file.
     QStringList m_specialCharacters;
 
     //Theme manager
     KHMThemeFactory m_themeFactory;
 
     //Config group
     KSharedConfig::Ptr m_config;
 
     int m_winCount;
     int m_lossCount;
 
     //The index to the random sequence
     int m_randomInt;
 
     // Multiplying factor for scores
     int m_scoreMultiplyingFactor;
 
     int m_netScore;
 
     //The random sequence of words of the current level file
     QList<QPair<QString, QString> > m_randomList;
 
     /** The word to be guessed */
     QString m_originalWord;
 
     /** The hidden word that is filled in during the game. */
     QString m_currentWord;
 
     //Current hint
     QString m_hint;
 
     /** help menu for displaying about box */
     KHelpMenu *m_helpMenu;
 };
 
 #endif // _KHANGMAN_H_
 
 // kate: space-indent on; tab-width 4; indent-width 4; mixed-indent off; replace-tabs on;
 // vim: set et sw=4 ts=4 cino=l1,cs,U1: