gui/StelGui.hpp

/*
 * Stellarium
 * Copyright (C) 2008 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 _STELGUI_HPP_
#define _STELGUI_HPP_

#include "StelModule.hpp"
#include "StelObject.hpp"
#include "LocationDialog.hpp"
#include "ViewDialog.hpp"
#include "HelpDialog.hpp"
#include "DateTimeDialog.hpp"
#include "SearchDialog.hpp"
#include "ConfigurationDialog.hpp"
#ifdef ENABLE_SCRIPT_CONSOLE
#include "ScriptConsole.hpp"
#endif
#include "StelGuiBase.hpp"
#include "StelStyle.hpp"

#include <QGraphicsTextItem>

class QGraphicsSceneMouseEvent;
class QAction;
class QTimeLine;
class StelButton;
class BottomStelBar;
class InfoPanel;

class StelGui : public QObject, public StelGuiBase
{
    Q_OBJECT
public:
    friend class ViewDialog;
    
    StelGui();
    virtual ~StelGui();

    // Methods defined in the StelModule class
    virtual void init(QGraphicsWidget* topLevelGraphicsWidget, StelAppGraphicsWidget* stelAppGraphicsWidget);
    void update();

    StelStyle getStelStyle() const {return currentStelStyle;}
    
    // Methods specific to the StelGui class
    void loadStyle(const QString& fileName);
    
    class QProgressBar* addProgressBar();
    
    BottomStelBar* getButtonBar() const;
    
    class LeftStelBar* getWindowsButtonBar() const;

    class SkyGui* getSkyGui() const;
    
    bool getFlagShowFlipButtons() const;
    
    bool getFlagShowNebulaBackgroundButton() const;

    bool initComplete(void) const;

#ifdef ENABLE_SCRIPT_CONSOLE
    ScriptConsole* getScriptConsole() {return &scriptConsole;}
#endif

    virtual void forceRefreshGui();
    
    virtual void setVisible(bool b);

    virtual bool getVisible() const;

    virtual bool isCurrentlyUsed() const;
    
    virtual void setInfoTextFilters(const StelObject::InfoStringGroup& aflags);
    virtual const StelObject::InfoStringGroup& getInfoTextFilters() const;
    
    virtual QAction* addGuiActions(const QString& actionName,
                                   const QString& text,
                                   const QString& shortCut,
                                   const QString& helpGroup,
                                   bool checkable=true,
                                   bool autoRepeat=false);
    
public slots:
    void setFlagShowFlipButtons(bool b);
    
    void setFlagShowNebulaBackgroundButton(bool b);

    bool getAutoHideHorizontalButtonBar() const;
    void setAutoHideHorizontalButtonBar(bool b);
    
    bool getAutoHideVerticalButtonBar() const;
    void setAutoHideVerticalButtonBar(bool b);

    #ifndef DISABLE_SCRIPTING

    void setScriptKeys(bool b);
    void increaseScriptSpeed();
    void decreaseScriptSpeed();
    void setRealScriptSpeed();
    #endif

    void setGuiVisible(bool);

private slots:
    void reloadStyle();
    #ifndef DISABLE_SCRIPTING
    void scriptStarted();
    void scriptStopped();
    #endif

    void setStelStyle(const QString& section);
    void quit();
    void updateI18n();
    void artDisplayedUpdated(const bool displayed);
    void boundariesDisplayedUpdated(const bool displayed);
    void linesDisplayedUpdated(const bool displayed);
    void namesDisplayedUpdated(const bool displayed);
    void azimuthalGridDisplayedUpdated(const bool displayed);
    void equatorGridDisplayedUpdated(const bool displayed);
    void equatorJ2000GridDisplayedUpdated(const bool displayed);
    void galacticGridDisplayedUpdated(const bool displayed);
    void equatorLineDisplayedUpdated(const bool displayed);
    void eclipticLineDisplayedUpdated(const bool displayed);
    void meridianLineDisplayedUpdated(const bool displayed);
    void horizonLineDisplayedUpdated(const bool displayed);
    void galacticPlaneLineDisplayedUpdated(const bool displayed);
    void atmosphereDisplayedUpdated(const bool displayed);
    void cardinalsPointsDisplayedUpdated(const bool displayed);
    void fogDisplayedUpdated(const bool displayed);
    void landscapeDisplayedUpdated(const bool displayed);
    void copySelectedObjectInfo(void);

private:
    QGraphicsWidget* topLevelGraphicsWidget;
            
    class SkyGui* skyGui;
    
    StelButton* buttonTimeRewind;
    StelButton* buttonTimeRealTimeSpeed;
    StelButton* buttonTimeCurrent;
    StelButton* buttonTimeForward;
    
    StelButton* buttonGotoSelectedObject;
    
    LocationDialog locationDialog;
    HelpDialog helpDialog;
    DateTimeDialog dateTimeDialog;
    SearchDialog searchDialog;
    ViewDialog viewDialog;
    ConfigurationDialog* configurationDialog;
#ifdef ENABLE_SCRIPT_CONSOLE
    ScriptConsole scriptConsole;
#endif

    bool flagShowFlipButtons;
    StelButton* flipVert;
    StelButton* flipHoriz;
    
    bool flagShowNebulaBackgroundButton;
    StelButton* btShowNebulaeBackground;

    bool initDone;
    bool guiHidden;
    
    QSizeF savedProgressBarSize;

    // Currently used StelStyle
    StelStyle currentStelStyle;

    // This method is used by init() to initialize the ConstellationMgr instance.
    void initConstellationMgr();

    // This method is used by init() to initialize the GridLineMgr instance.
    void initGrindLineMgr();

    // This method is used by init() to initialize the LandscapeMgr instance.
    void initLandscapeMgr();
};

class StelStandardGuiPluginInterface : public QObject, public StelGuiPluginInterface
{
    Q_OBJECT
    Q_INTERFACES(StelGuiPluginInterface)
public:
    virtual class StelGuiBase* getStelGuiBase() const;
};

#endif // _STELGUI_HPP_