RGuiAction.h

Go to the documentation of this file.

#ifndef RGUIACTION_H
#define RGUIACTION_H

#include <QMap>
#include <QMetaType>
#include <QString>
#include <QStringList>
#include <QList>
#include <QAction>

#include "RTransactionListener.h"
#include "RFocusListener.h"
#include "RSelectionListener.h"

class QToolBar;

class RDocument;
class RDocumentInterface;

class RGuiAction:
    public QAction,
    public RFocusListener,
    public RTransactionListener,
    public RSelectionListener {

Q_OBJECT

public:
    typedef void (*FactoryFunction)();

public:
    RGuiAction(const QString& text, QObject* parent = 0);
    virtual ~RGuiAction();
    
    virtual void initTexts();

    static QString formatToolTip(const QString& text, const QString& shortcut);
    QString getToolTip(const QString& text, const QString& shortcut);

    void setDocumentInterface(RDocumentInterface* di);
    RDocumentInterface* getDocumentInterface();

    void setShortcut(const QKeySequence& shortcut);
    void setDefaultShortcut(const QKeySequence& shortcut);
    void setShortcuts(const QList<QKeySequence>& shortcuts);
    void setDefaultShortcuts(const QList<QKeySequence>& shortcuts);
    QList<QKeySequence> getDefaultShortcuts();
    void setShortcutText(const QString& text);
    QString getShortcutText();
    void setSortOrder(int sortOrder);
    int getSortOrder();

    void addToMenu(QMenu* menu);
    void addToToolBar(QToolBar* tb);
    void addToWidget(QWidget* w);

    virtual void setIcon(const QString& iconFile);

    void disableIcon();
    bool isIconDisabled();

    virtual void setToolTip(const QString& tip);

    virtual void setStatusTip(const QString& tip);

    virtual void setEnabled(bool on);
    
    virtual void setEnabledOverride(bool on, int override);
    
    virtual void setChecked(bool on);

    static void triggerGroupDefault(const QString& group);
    static void triggerGroupDefaults();

    virtual bool isChecked();
    
    void setRequiresDocument(bool on) {
        requiresDocument = on;
    }

    bool getRequiresDocument() {
        return requiresDocument;
    }

    void setRequiresSelection(bool on) {
        requiresSelection = on;
    }

    bool getRequiresSelection() {
        return requiresSelection;
    }

    void setRequiresUndoableTransaction(bool on) {
        requiresUndoableTransaction = on;
    }

    bool getRequiresUndoableTransaction() {
        return requiresUndoableTransaction;
    }

    void setRequiresRedoableTransaction(bool on) {
        requiresRedoableTransaction = on;
    }

    bool getRequiresRedoableTransaction() {
        return requiresRedoableTransaction;
    }

    void setOverride() {
        override = true;
    }

    bool isOverride() {
        return override;
    }

    void setNoState(bool checkable = false) {
        noState = true;
        setCheckable(checkable);
    }

    bool hasNoState() {
        return noState;
    }

    void setUniqueGroup(const QString& ug) {
        uniqueGroup = ug;
    }

    QString getUniqueGroup() {
        return uniqueGroup;
    }

    QString getMainCommand() {
        return mainCommand;
    }

    QStringList getCommands() {
        return commandList;
    }

    QStringList getDefaultCommands() {
        return defaultCommandList;
    }
    
    void setDefaultCommands(const QStringList& cmds);
    void setCommands(const QStringList& cmds);
    
    void setFactory(FactoryFunction f);
    
    void setScriptFile(const QString& sf, bool isSecondary = false);

    QString getScriptFile() {
        return scriptFile;
    }

    virtual void setGroup(const QString& title);
    QString getGroup();

    void setGroupDefault(bool on);
    bool isGroupDefault();

    static QList<RGuiAction*> getActions() {
        return actions;
    }

    static bool triggerByCommand(const QString& cmd);
    static RGuiAction* getByScriptFile(const QString& scriptFile);
    static bool triggerByScriptFile(const QString& scriptFile);
    
    static QStringList getAvailableCommands(bool primaryOnly=false);
    static QStringList getAvailableCommands(const QString& start, bool primaryOnly=false);

    static void clear();

    virtual void updateTransactionListener(const RDocument* document);
    virtual void updateSelectionListener(RDocumentInterface* documentInterface);
    virtual void updateFocus(RDocumentInterface* documentInterface);

    void addArgument(const QString& arg);
    QStringList getArguments();

public slots:
    bool slotTrigger(const QString& command = QString::null);

signals:
    void postTriggered();

protected:
    static QMap<QString, RGuiAction*> actionsByCommand;
    static QMap<QString, RGuiAction*> actionsByPrimaryCommand;
    static QMap<QString, RGuiAction*> actionsByScriptFile;
    static QMultiMap<QString, RGuiAction*> actionsByGroup;
    static QList<RGuiAction*> actions;

    FactoryFunction factory;
    QString scriptFile;
    QString mainCommand;
    QStringList commandList;
    QStringList defaultCommandList;
    QString group;
    bool groupDefault;
    
    bool requiresDocument;
    bool requiresSelection;
    bool requiresUndoableTransaction;
    bool requiresRedoableTransaction;
    bool override;
    bool noState;
    QString uniqueGroup;
    QStringList arguments;

    QList<QKeySequence> defaultShortcuts;
    QString shortcutText;
    QString toolTip;
    int sortOrder;
    bool iconDisabled;
    int enabledOverride;
    RDocumentInterface* documentInterface;
};

Q_DECLARE_METATYPE(RGuiAction*)
Q_DECLARE_METATYPE(QList<RGuiAction*>)

#endif