StelModule.hpp

/*
 * Stellarium
 * Copyright (C) 2006 Fabien Chereau
 *
 * 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, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELMODULE_HPP_
#define _STELMODULE_HPP_

#include <QString>
#include <QObject>

// Predeclaration
class StelCore;
class QSettings;

class StelModule : public QObject
{
    Q_OBJECT
    // Do not add Q_OBJECT here!!
    // This make this class compiled by the Qt moc compiler and for some unknown reasons makes it impossible to dynamically
    // load plugins on windows.
    Q_ENUMS(StelModuleSelectAction)
    Q_ENUMS(StelModuleActionName)
public:
    StelModule();

    virtual ~StelModule() {;}

    virtual void init() = 0;

    virtual void deinit() {;}

    virtual void draw(StelCore* core) {Q_UNUSED(core);}

    virtual void update(double deltaTime) = 0;

    virtual QString getModuleVersion() const;

    virtual QString getAuthorName() const {return "Stellarium's Team";}

    virtual QString getAuthorEmail() const {return "http://www.stellarium.org";}

    virtual void handleMouseClicks(class QMouseEvent*) {;}

    virtual void handleMouseWheel(class QWheelEvent*) {;}

    virtual bool handleMouseMoves(int x, int y, Qt::MouseButtons b) {Q_UNUSED(x); Q_UNUSED(y); Q_UNUSED(b); return false;}

    virtual void handleKeys(class QKeyEvent* e) {Q_UNUSED(e);}

    virtual bool handlePinch(qreal scale, bool started) {Q_UNUSED(scale); Q_UNUSED(started); return false;}

    enum StelModuleSelectAction
    {
        AddToSelection,     
        ReplaceSelection,   
        RemoveFromSelection 
    };
#if QT_VERSION >= 0x050500
    Q_ENUM(StelModuleSelectAction)
#endif
    enum StelModuleActionName
    {
        ActionDraw,              
        ActionUpdate,            
        ActionHandleMouseClicks, 
        ActionHandleMouseMoves,  
        ActionHandleKeys         
    };
#if QT_VERSION >= 0x050500
    Q_ENUM(StelModuleActionName)
#endif
    virtual double getCallOrder(StelModuleActionName actionName) const {Q_UNUSED(actionName); return 0;}

    virtual bool configureGui(bool show=true) {Q_UNUSED(show); return false;}

protected:

    class StelAction* addAction(const QString& id, const QString& groupId, const QString& text,
                                QObject* target, const char* slot,
                                const QString& shortcut="", const QString& altShortcut="");

    class StelAction* addAction(const QString& id, const QString& groupId, const QString& text,
                                const char* slot,
                                const QString& shortcut="", const QString& altShortcut="") {
        return addAction(id, groupId, text, this, slot, shortcut, altShortcut);
    }
};

Q_DECLARE_METATYPE(StelModule::StelModuleSelectAction)

#endif // _STELMODULE_HPP_