StelGuiItems.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 _STELGUIITEMS_HPP_
#define _STELGUIITEMS_HPP_

#include <QGraphicsPixmapItem>
#include <QGraphicsWidget>
#include <QDebug>
#include <QMap>

class QGraphicsSceneMouseEvent;
class QTimeLine;
class QGraphicsTextItem;
class QTimer;
class StelProgressController;
class QProgressBar;

// Progess bars in the lower right corner
class StelProgressBarMgr : public QGraphicsWidget
{
    Q_OBJECT
public:
    StelProgressBarMgr(QGraphicsItem* parent);
    
public slots:
    void addProgressBar(const StelProgressController *p);
    void removeProgressBar(const StelProgressController *p);
    void oneBarChanged();
private:
    QMap<const StelProgressController*, QProgressBar*> allBars;
};

// Buttons in the bottom left corner
class CornerButtons : public QObject, public QGraphicsItem
{
    Q_OBJECT
    Q_INTERFACES(QGraphicsItem)
public:
    CornerButtons(QGraphicsItem* parent=NULL);
    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
    virtual QRectF boundingRect() const;
    void setOpacity(double opacity);
private:
    mutable double lastOpacity;
};

class StelButton : public QObject, public QGraphicsPixmapItem
{
    friend class BottomStelBar;
    friend class LeftStelBar;
    Q_OBJECT
public:
    StelButton(QGraphicsItem* parent, const QPixmap& pixOn, const QPixmap& pixOff,
           const QPixmap& pixHover=QPixmap(),
           class StelAction* action=NULL, bool noBackground=false);
    
    StelButton(QGraphicsItem* parent, const QPixmap& pixOn, const QPixmap& pixOff,
           const QPixmap& pixHover,
           const QString& actionId, bool noBackground=false);
    StelButton(QGraphicsItem* parent, const QPixmap& pixOn, const QPixmap& pixOff, const QPixmap& pixNoChange,
           const QPixmap& pixHover,
           const QString& actionId=QString(), bool noBackground=false, bool isTristate=true);
    
    enum {ButtonStateOff = 0, ButtonStateOn = 1, ButtonStateNoChange = 2};

    int isChecked() const {return checked;}

    int getButtonPixmapWidth() const {return pixOn.width();}

    void setOpacity(double v) {opacity=v; updateIcon();}

    void setBackgroundPixmap(const QPixmap& newBackground);

    void setFocusOnSky(bool b) { flagChangeFocus=b; }

signals:
    void toggled(bool);
    void triggered();
    void hoverChanged(bool b);

public slots:
    void setChecked(int b);
    void setChecked(bool b) { setChecked((int)b); }

protected:
    virtual void mousePressEvent(QGraphicsSceneMouseEvent* event);
    virtual void hoverEnterEvent(QGraphicsSceneHoverEvent* event);
    virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent* event);
    virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
private slots:
    void animValueChanged(qreal value);
private:
    void initCtor(const QPixmap& apixOn,
                  const QPixmap& apixOff,
                  const QPixmap& apixNoChange,
                  const QPixmap& apixHover,
                  StelAction* aaction,
                  bool noBackground,
                  bool isTristate);
    void updateIcon();
    int toggleChecked(int);

    QPixmap pixOn;
    QPixmap pixOff;
    QPixmap pixNoChange;
    QPixmap pixHover;
    QPixmap pixBackground;

    int checked;
    bool flagChangeFocus;

    QTimeLine* timeLine;
    class StelAction* action;
    bool noBckground;
    bool isTristate_;
    double opacity;
    double hoverOpacity;
};

// The button bar on the left containing windows toggle buttons
class LeftStelBar : public QObject, public QGraphicsItem
{
    Q_OBJECT
    Q_INTERFACES(QGraphicsItem)
public:
    LeftStelBar(QGraphicsItem* parent);
    ~LeftStelBar();
    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
    virtual QRectF boundingRect() const;
    void addButton(StelButton* button);
    QRectF boundingRectNoHelpLabel() const;
    void setColor(const QColor& c);
private slots:
    void buttonHoverChanged(bool b);
private:
    QTimeLine* hideTimeLine;
    QGraphicsSimpleTextItem* helpLabel;
    QGraphicsPixmapItem* helpLabelPixmap; // bad-graphics replacement.
};

// The button bar on the bottom containing actions toggle buttons
class BottomStelBar : public QObject, public QGraphicsItem
{
    Q_OBJECT
    Q_INTERFACES(QGraphicsItem)
public:
    BottomStelBar(QGraphicsItem* parent, const QPixmap& pixLeft=QPixmap(), const QPixmap& pixRight=QPixmap(), const QPixmap& pixMiddle=QPixmap(), const QPixmap& pixSingle=QPixmap());
    virtual ~BottomStelBar();
    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
    virtual QRectF boundingRect() const;
    QRectF boundingRectNoHelpLabel() const;

    void addButton(StelButton* button, const QString& groupName="defaultGroup", const QString& beforeActionName="");
    StelButton* hideButton(const QString& actionName);

    void setGroupMargin(const QString& groupName, int left, int right);

    void setGroupBackground(const QString& groupName, const QPixmap& pixLeft=QPixmap(),
                            const QPixmap& pixRight=QPixmap(), const QPixmap& pixMiddle=QPixmap(),
                            const QPixmap& pixSingle=QPixmap());

    void setColor(const QColor& c);

    void setFlagShowTime(bool b) {flagShowTime=b;}
    bool getFlagShowTime() { return flagShowTime; }
    void setFlagShowLocation(bool b) {flagShowLocation=b;}
    bool getFlagShowLocation() { return flagShowLocation; }
    void setFlagShowFps(bool b) {flagShowFps=b;}
    bool getFlagShowFps() { return flagShowFps; }
    void setFlagShowFov(bool b) {flagShowFov=b;}
    bool getFlagShowFov() { return flagShowFov; }
    void setFlagFovDms(bool b) {flagFovDms=b;}
    bool getFlagFovDms() { return flagFovDms; }
    void setFlagTimeJd(bool b) {flagTimeJd=b;}
    bool getFlagTimeJd() { return flagTimeJd; }

    void setFlagShowTz(bool b) { flagShowTZ=b; }
    bool getFlagShowTz() { return flagShowTZ; }

signals:
    void sizeChanged();

private slots:
    void buttonHoverChanged(bool b);

private:
    void updateText(bool forceUpdatePos=false);
    void updateButtonsGroups();
    QRectF getButtonsBoundingRect() const;
    // Elements which get displayed above the buttons:
    QGraphicsSimpleTextItem* location;
    QGraphicsSimpleTextItem* datetime;
    QGraphicsSimpleTextItem* fov;
    QGraphicsSimpleTextItem* fps;
    // For bad graphics, show these instead. We can use location etc for font info.
    // We use ad-hoc pixmaps instead if command-line arg. -t (--text-fix) is given.
    QGraphicsPixmapItem* locationPixmap;
    QGraphicsPixmapItem* datetimePixmap;
    QGraphicsPixmapItem* fovPixmap;
    QGraphicsPixmapItem* fpsPixmap;



    struct ButtonGroup
    {
        ButtonGroup() : leftMargin(0), rightMargin(0),
                        pixBackgroundLeft(NULL), pixBackgroundRight(NULL),
                        pixBackgroundMiddle(NULL), pixBackgroundSingle(NULL) {;}
        QList<StelButton*> elems;
        int leftMargin;
        int rightMargin;
        QPixmap* pixBackgroundLeft;
        QPixmap* pixBackgroundRight;
        QPixmap* pixBackgroundMiddle;
        QPixmap* pixBackgroundSingle;
    };

    QMap<QString, ButtonGroup> buttonGroups;
    QPixmap pixBackgroundLeft;
    QPixmap pixBackgroundRight;
    QPixmap pixBackgroundMiddle;
    QPixmap pixBackgroundSingle;

    bool flagShowTime;
    bool flagShowLocation;
    bool flagShowFps;
    bool flagShowFov;
    bool flagFovDms;
    bool flagTimeJd;
    bool flagShowTZ;

    QGraphicsSimpleTextItem* helpLabel;
    QGraphicsPixmapItem* helpLabelPixmap; // bad-graphics replacement.
};

// The path around the bottom left button bars
class StelBarsPath : public QGraphicsPathItem
{
    public:
        StelBarsPath(QGraphicsItem* parent);
        void updatePath(BottomStelBar* bot, LeftStelBar* lef);
        double getRoundSize() const {return roundSize;}
        void setBackgroundOpacity(double opacity);
    private:
        double roundSize;
};

#endif // _STELGUIITEMS_HPP_