keybindings.h

Go to the documentation of this file.

/* -*- myth -*- */
#ifndef KEYBINDINGS_H
#define KEYBINDINGS_H
 
// MythControls headers
#include "action.h"
#include "actionset.h"
 
class KeyBindings
{
  public:
    enum Filter : std::uint8_t
    {
        AllBindings,
        NoModifiers,
        JustModifiers
    };
 
    enum ConflictLevels : std::uint8_t { kKeyBindingWarning, kKeyBindingError, };
 
    explicit KeyBindings(QString hostname, Filter Filters = AllBindings);
 
    // Commands
    bool        AddActionKey(const QString &context_name,
                             const QString &action_name,
                             const QString &key);
    ActionID   *GetConflict(const QString &context_name,
                            const QString &key, int &level) const;
    void        ReplaceActionKey(const QString &context_name,
                                 const QString &action_name,
                                 const QString &newkey,
                                 const QString &oldkey);
    bool        RemoveActionKey(const QString &context_name,
                                const QString &action_name,
                                const QString &key);
    void        CommitChanges(void);
 
    // Gets
    QStringList GetKeys(void) const;
    QStringList GetContexts(void) const;
    QStringList GetActions(const QString &context) const;
    void        GetKeyActions(const QString &key, ActionList &list) const;
    QStringList GetActionKeys(const QString &context_name,
                              const QString &action_name) const;
    QStringList GetContextKeys(const QString &context) const;
    QStringList GetKeyContexts(const QString &key) const;
    QString     GetActionDescription(const QString &context_name,
                                     const QString &action_name) const;
    bool        HasMandatoryBindings(void) const;
    bool        HasChanges(void) const { return m_actionSet.HasModified(); }
 
  protected:
    void CommitJumppoint(const ActionID &id);
    void CommitAction(const ActionID &id);
 
    void LoadMandatoryBindings(void);
    void LoadContexts(void);
    void LoadJumppoints(void);
 
  private:
    QString     m_hostname;
    ActionList  m_mandatoryBindings;
    QStringList m_defaultKeys;
    ActionSet   m_actionSet;
    Filter      m_filter { AllBindings };
};
 
#endif /* KEYBINDINGS_H */