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_

#ifndef NO_GUI

#include "StelModule.hpp"
#include "StelObject.hpp"
#include "StelGuiBase.hpp"
#include "StelStyle.hpp"

#include <QGraphicsTextItem>

class QGraphicsSceneMouseEvent;
class QTimeLine;
class StelButton;
class BottomStelBar;
class InfoPanel;
class ConfigurationDialog;
class DateTimeDialog;
class HelpDialog;
class LocationDialog;
class SearchDialog;
class ViewDialog;
class ShortcutsDialog;
class AstroCalcDialog;
class BookmarksDialog;
#ifdef ENABLE_SCRIPT_CONSOLE
class ScriptConsole;
#endif

class StelGui : public QObject, public StelGuiBase
{
    Q_OBJECT
    Q_PROPERTY(bool visible READ getVisible WRITE setVisible NOTIFY visibleChanged)
    Q_PROPERTY(bool autoHideHorizontalButtonBar READ getAutoHideHorizontalButtonBar WRITE setAutoHideHorizontalButtonBar NOTIFY autoHideHorizontalButtonBarChanged)
    Q_PROPERTY(bool autoHideVerticalButtonBar READ getAutoHideVerticalButtonBar WRITE setAutoHideVerticalButtonBar NOTIFY autoHideVerticalButtonBarChanged)

public:
    friend class ViewDialog;
    
    StelGui();
    virtual ~StelGui();

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

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

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

    bool getFlagShowToastSurveyButton() const;

    bool getFlagShowBookmarksButton() const;

    bool getFlagShowICRSGridButton() const;

    bool getFlagShowGalacticGridButton() const;

    bool getFlagShowEclipticGridButton() const;

    bool getFlagShowConstellationBoundariesButton() 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 getAstroCalcVisible();

    virtual bool isCurrentlyUsed() const;
    
    virtual void setInfoTextFilters(const StelObject::InfoStringGroup& aflags);
    virtual const StelObject::InfoStringGroup& getInfoTextFilters() const;

public slots:
    void setFlagShowFlipButtons(bool b);
    
    void setFlagShowNebulaBackgroundButton(bool b);

    void setFlagShowToastSurveyButton(bool b);

    void setFlagShowBookmarksButton(bool b);

    void setFlagShowICRSGridButton(bool b);

    void setFlagShowGalacticGridButton(bool b);

    void setFlagShowEclipticGridButton(bool b);

    void setFlagShowConstellationBoundariesButton(bool b);

    void setFlagShowDecimalDegrees(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();
    void stopScript();
    void pauseScript();
    void resumeScript();
#endif

    void setGuiVisible(bool);   

signals:
    void visibleChanged(bool b);
    void autoHideHorizontalButtonBarChanged(bool b);
    void autoHideVerticalButtonBarChanged(bool b);

private slots:
    void reloadStyle();
#ifndef DISABLE_SCRIPTING
    void scriptStarted();
    void scriptStopped();
#endif
    void setStelStyle(const QString& section);
    void quit();    
    void updateI18n();
    void copySelectedObjectInfo(void);

private:
    StelAction* getAction(const QString& actionName);

    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;
    ShortcutsDialog* shortcutsDialog;
    ConfigurationDialog* configurationDialog;
#ifdef ENABLE_SCRIPT_CONSOLE
    ScriptConsole* scriptConsole;
#endif
    AstroCalcDialog* astroCalcDialog;
    BookmarksDialog* bookmarksDialog;

    bool flagShowFlipButtons;
    StelButton* flipVert;
    StelButton* flipHoriz;

    bool flagShowNebulaBackgroundButton;
    StelButton* btShowNebulaeBackground;

    bool flagShowToastSurveyButton;
    StelButton* btShowToastSurvey;

    bool flagShowBookmarksButton;
    StelButton* btShowBookmarks;

    bool flagShowICRSGridButton;
    StelButton* btShowICRSGrid;

    bool flagShowGalacticGridButton;
    StelButton* btShowGalacticGrid;

    bool flagShowEclipticGridButton;
    StelButton* btShowEclipticGrid;

    bool flagShowConstellationBoundariesButton;
    StelButton* btShowConstellationBoundaries;

    bool initDone;

    QSizeF savedProgressBarSize;

    // Currently used StelStyle
    StelStyle currentStelStyle;

#ifndef DISABLE_SCRIPTING
    // We use a QStringList to save the user-configured buttons while script is running, and restore them later.
    QStringList scriptSaveSpeedbuttons;
#endif
};

#else // NO_GUI

#include "StelGuiBase.hpp"
#include <QProgressBar>

class StelGui : public StelGuiBase
{
public:
    StelGui() {;}
    ~StelGui() {;}
    virtual void init(QGraphicsWidget* topLevelGraphicsWidget, class StelAppGraphicsWidget* stelAppGraphicsWidget) {;}
    virtual void updateI18n() {;}
    virtual void setStelStyle(const QString& section) {;}
    virtual void setInfoTextFilters(const StelObject::InfoStringGroup& aflags) {dummyInfoTextFilter=aflags;}
    virtual const StelObject::InfoStringGroup& getInfoTextFilters() const {return dummyInfoTextFilter;}
    virtual QProgressBar* addProgressBar() {return new QProgressBar;}
    virtual QAction* addGuiActions(const QString& actionName, const QString& text, const QString& shortCut, const QString& helpGroup, bool checkable=true, bool autoRepeat=false) {return Q_NULLPTR;}
    virtual void forceRefreshGui() {;}
    virtual void setVisible(bool b) {visible=b;}
    virtual bool getVisible() const {return visible;}
    virtual bool isCurrentlyUsed() const {return false;}
private:
    StelObject::InfoStringGroup dummyInfoTextFilter;
    bool visible;
};

#endif

#endif // _STELGUI_HPP_