actionset.h

Go to the documentation of this file.

/* -*- myth -*- */
#ifndef ACTIONSET_H
#define ACTIONSET_H

// Qt headers
#include <QStringList>
#include <QHash>
#include <QMap>

class ActionSet
{
  public:
    ActionSet() {}
    ~ActionSet();

    // Commands
    bool AddAction(const ActionID &id,
                   const QString  &description,
                   const QString  &keys);
    bool Add(const ActionID &id, const QString &key);
    bool Remove(const ActionID &id, const QString &key);
    bool Replace(const ActionID &id,
                 const QString  &newkey,
                 const QString  &oldkey);

    // Sets
    bool        SetModifiedFlag(const ActionID &id, bool modified);

    // Gets
    QStringList GetContextStrings(void) const;
    QStringList GetActionStrings(const QString &context_name) const;
    QString     GetKeyString(const ActionID &id) const;
    QStringList GetKeys(const ActionID &id) const;
    QStringList GetContextKeys(const QString &context_name) const;
    QStringList GetAllKeys(void) const;
    QString     GetDescription(const ActionID &id) const;
    ActionList  GetActions(const QString &key) const;
    ActionList  GetModified(void) const;
    bool HasModified(void) const { return !m_modified.isEmpty(); }
    bool IsModified(const ActionID &id) const
        { return m_modified.contains(id); }

  protected:
    Action *GetAction(const ActionID &id);

  public:
    static const QString kJumpContext;
    static const QString kGlobalContext;

  private:
    QMap<QString, ActionList> m_keyToActionMap;
    typedef QHash<QString, Context> ContextMap;
    ContextMap                m_contexts;
    ActionList                m_modified;
};

#endif /* ACTIONSET_H */