kgoldrunner.h

Go to the documentation of this file.

/****************************************************************************
 *    Copyright 2002  Marco Krüger <grisuji@gmx.de>                         *
 *    Copyright 2002  Ian Wadham <iandw.au@gmail.com>                       *
 *    Copyright 2009  Ian Wadham <iandw.au@gmail.com>                       *
 *                                                                          *
 *    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, see <http://www.gnu.org/licenses/>. *
 ****************************************************************************/

#ifndef KGOLDRUNNER_H
#define KGOLDRUNNER_H

#include "kgrglobals.h"

#include <KXmlGuiWindow>

class QSignalMapper;
class KAction;
class KToggleAction;

class KGrGame;
class KGrView;
class KGrScene;
class KGrRenderer;

class KGoldrunner : public KXmlGuiWindow
{
    Q_OBJECT
public:
    KGoldrunner();

    virtual ~KGoldrunner();

    bool startedOK() {return (startupOK);}

public slots:
    void setToggle      (const char * actionName, const bool onOff);
    void setAvail       (const char * actionName, const bool onOff);
    void redrawEditToolbar();

protected:
    void keyPressEvent (QKeyEvent * event);
    void keyReleaseEvent (QKeyEvent * event);

private:
    bool identifyMoveAction (QKeyEvent * event, bool pressed);

protected:
    void saveProperties (KConfigGroup &);

    void readProperties (const KConfigGroup &);

    bool queryClose();

private slots:
    // An extension of the constructor.  Gives us two scans of the event queue.
    void KGoldrunner_2();

    // Slot to change the graphics theme.
    void changeTheme ();

    void optionsConfigureKeys();

    void gameFreeze (bool);     // Status feedback on Pause state.

    void adjustHintAction (bool);   // Enable/disable "Hint" action.
    void setEditMenu (bool on_off); // Enable/disable "Save Edits" action.
    void setEditIcon (const QString & actionName, const char iconType);
    void viewFullScreen (bool activation);

    QSize sizeHint() const;

private:
    void setupActions();
    void setupEditToolbarActions();

    QSignalMapper * tempMapper;     // Temporary pointer.

    KAction * gameAction (const QString & name, const int code,
                          const QString & text, const QString & toolTip,
                          const QString & whatsThis, const QKeySequence & key);

    KAction * editAction (const QString & name, const int code,
                          const QString & text, const QString & toolTip,
                          const QString & whatsThis);

    KToggleAction * settingAction (const QString & name,
                                   const int       code,
                                   const QString & text,
                                   const QString & toolTip,
                                   const QString & whatsThis);

    KToggleAction * editToolbarAction
                         (const QString & name, const char code,
                          const QString & shortText, const QString & text,
                          const QString & toolTip, const QString & whatsThis);

    void keyControl      (const QString & name, const QString & text,
                          const QKeySequence & shortcut, const int code,
                          const bool mover = false);

    bool startupOK;

    KGrGame     *   game;       // Overall control of the gameplay.

    KGrView     *   view;       // Central widget.
    KGrScene    *   scene;      // Sets text for game-status messages.
    KGrRenderer *   renderer;       // Changes themes and gets icon pixmaps.

    bool frozen;
    bool getDirectories();      // Get directory paths, as below.

    QString systemHTMLDir;      // Where the manual is stored.
    QString systemDataDir;      // Where the system levels are stored.
    QString userDataDir;        // Where the user levels are stored.

    KAction *       saveGame;   // Save game, level, lives and score.

    // A KAction is needed here, to get access to KShortcut::setAlternate().
    KAction *       myPause;    // Pause or resume the game.

    KAction *       hintAction; // Display a hint, if available.
    KAction *       killHero;   // Kill hero (disabled during edits).
    KAction *       highScore;  // High scores (disabled during edits).

    KAction *       saveEdits;  // Save a level that has been edited.

    KToolBar *      editToolbar;    // Toolbar for creating/editing levels.
};

#endif // KGOLDRUNNER_H