StelActionMgr.hpp

/*
 * Stellarium
 * Copyright (C) 2013 Guillaume 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 _STELACTIONMGR_HPP_
#define _STELACTIONMGR_HPP_

#include "StelPropertyMgr.hpp"
#include <QKeySequence>
#include <QList>

class StelAction : public QObject
{
    Q_OBJECT
public:
    Q_PROPERTY(bool checked READ isChecked WRITE setChecked NOTIFY toggled)
    Q_PROPERTY(bool checkable READ isCheckable)

    bool isCheckable() const {return boolProperty;}
    bool isChecked() const {return boolProperty ? boolProperty->getValue().toBool() : false; }
    bool isGlobal() const {return global;}
    void setShortcut(const QString& key);
    void setAltShortcut(const QString& key);
    QKeySequence::SequenceMatch matches(const QKeySequence& seq) const;

    QString getId() const {return objectName();}
    QString getGroup() const {return group;}
    const QKeySequence getShortcut() const {return keySequence;}
    const QKeySequence getAltShortcut() const {return altKeySequence;}
    QString getText() const;
    void setText(const QString& value) {text = value; emit changed();}
signals:
    void toggled(bool);
    void triggered();
    void changed();
public slots:
    void setChecked(bool);
    void trigger();
    void toggle();
private slots:
    void propertyChanged(bool);
private:
    friend class StelActionMgr;

    StelAction(const QString& actionId,
           const QString& groupId,
           const QString& text,
           const QString& primaryKey="",
           const QString& altKey="",
           bool global=false);
    void connectToObject(QObject* target, const char* slot);

    QString group;
    QString text;
    bool global;
    QKeySequence keySequence;
    QKeySequence altKeySequence;
    const QKeySequence defaultKeySequence;
    const QKeySequence defaultAltKeySequence;
    QObject* target;
    //If the StelAction is connected to a boolean property with a NOTIFY signal, a StelProperty is used for the connection
    StelProperty* boolProperty;
    QMetaMethod slot;

    // Currently, there is no proper way to handle shortcuts with non latin
    // keyboards layouts.  So for the moment, if we don't use QuickView, we
    // create a QAction added to the main view that will trigger the
    // StelAction when the shortcut is typed.
#ifndef USE_QUICKVIEW
private slots:
    void onChanged();
private:
    class QAction* qAction;
#endif
};

class StelActionMgr : public QObject
{
    Q_OBJECT
public:
    StelActionMgr();
    ~StelActionMgr();
    StelAction* addAction(const QString& id, const QString& groupId, const QString& text,
                          QObject* target, const char* slot,
                          const QString& shortcut="", const QString& altShortcut="",
                          bool global=false);
    StelAction* findAction(const QString& id);
    bool pushKey(int key, bool global=false);

    QStringList getGroupList() const;
    QList<StelAction*> getActionList(const QString& group) const;
    QList<StelAction*> getActionList() const;

    void saveShortcuts();
    void restoreDefaultShortcuts();

signals:
    void actionToggled(const QString& id, bool value);

    void shortcutsChanged();

public slots:
    void setAllActionsEnabled(bool value) {actionsEnabled = value;}

private slots:
    void onStelActionToggled(bool val);

private:
    bool actionsEnabled;
    QList<int> keySequence;
};

#endif // _STELACTIONMGR_HPP_