kgreditor.h

Go to the documentation of this file.

/****************************************************************************
 *    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 KGREDITOR_H
#define KGREDITOR_H

#include "kgrglobals.h"

#include <QObject>

class KGrView;
class KGrScene;
class KGrGameIO;
class QTimer;

class KGrEditor : public QObject
{
    Q_OBJECT
public:
    KGrEditor (KGrView * theView, const QString &theSystemDir,
                                  const QString &theUserDir,
                                  QList<KGrGameData *> & pGameList);
    ~KGrEditor();

    bool saveOK();

    bool createLevel (int pGameIndex);

    bool updateLevel (int pGameIndex, int pLevel);

    bool saveLevelFile();   // Save the edited level in a text file (.grl).

    bool moveLevelFile (int pGameIndex, int pLevel);

    bool deleteLevelFile (int pGameIndex, int pLevel);

    bool editGame (int pGameIndex);

public slots:
    void editNameAndHint();

public:
    void setEditObj (char newEditObj);

    inline void getGameAndLevel (int & game, int & lev) {
                                 game = gameIndex; lev = editLevel; }

signals:
    void getMousePos    (int & i, int & j);

private:
    KGrView   * view;       // The canvas on which the editor paints.
    KGrScene  * scene;
    KGrGameIO * io;     // I/O object for reading level-data.
    QString     systemDataDir;
    QString     userDataDir;

    // Will REFERENCE the main list in KGrGame, allowing KGrEditor to add games.
    QList<KGrGameData *> & gameList;

    bool mouseMode;     // Flag to set up keyboard OR mouse control.
    bool editMode;      // Flag to change keyboard and mouse functions.
    char editObj;       // Type of object to be painted by the mouse.
    bool paintEditObj;      // Sets painting on/off (toggled by clicking).
    bool paintAltObj;       // Sets painting for the alternate object on/off
    int  oldI, oldJ;        // Last mouse position painted.
    int  editLevel;     // Level to be edited (= 0 for new level).
    int  heroCount;     // Can enter at most one hero.
    bool shouldSave;        // True if name or hint was edited.

    // The list-index of the game (collection of levels) being composed/edited.
    int  gameIndex;

    // The data, including the layout, for the level being composed or edited.
    KGrLevelData levelData;
    KGrLevelData savedLevelData;
    QString      levelName; // Level name during editing (optional).
    QString      levelHint; // Level hint during editing (optional).

    int  selectLevel (int action, int requestedLevel, int & requestedGame);

    void loadEditLevel (int);   // Load and display an existing level for edit.
    void initEdit();
    void insertEditObj (int, int, char object);
    char editableCell (int i, int j);
    void setEditableCell (int, int, char);
    void showEditLevel();
    bool reNumberLevels (int, int, int, int);
    bool ownerOK (Owner o);
    bool saveGameData (Owner o);

    QString getTitle();
    QString getLevelFilePath (KGrGameData * gameData, int lev);

    QTimer *     timer;     // The time-signal for the game-editor.

    bool mouseDisabled;

private slots:
    void doEdit  (int button);

    void tick    ();

    void endEdit (int button);
};

#endif // KGREDITOR_H