ManagedKeyboardShortcut.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2014, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef MANAGED_KEYBOARD_SHORTCUT_H
#define MANAGED_KEYBOARD_SHORTCUT_H
 
#include "SoInteraction.h"
 
#include <ThirdPartyWarningsDisable.h>
#include <Inventor/events/SoKeyboardEvent.h>
 
#include <map>
#include <ThirdPartyWarningsRestore.h>
 
class SOMANAGEDINTERACTION_API ManagedKeyboardShortcut : public ManagedActionTrigger
{
public:
  ManagedKeyboardShortcut() : _modifiers(0), _key(SoKeyboardEvent::ANY) {}
 
  ManagedKeyboardShortcut(int modifiers, SoKeyboardEvent::Key key) : _modifiers(modifiers), _key(key) {}
 
  bool matches(int modifiers, SoKeyboardEvent::Key key) const;
 
  bool isValid() const;
 
  int getModifiers() const { return _modifiers; }
 
  SoKeyboardEvent::Key getKey() const { return _key; }
 
  std::string toString() const;
 
  static ManagedKeyboardShortcut fromString(const std::string& s);
 
 
private:
 
  int _modifiers;
  SoKeyboardEvent::Key _key;
 
  static void _populateKeyMap();
  static void _setKeyMapEntry(const char* cname, SoKeyboardEvent::Key key);
 
  static std::map<std::string, SoKeyboardEvent::Key> _keyCodeMap;
  static std::map<SoKeyboardEvent::Key, std::string> _keyNameMap;
 
  static SoKeyboardEvent::Key _getKeyCodeForName (const std::string& keyName);
  static std::string _getKeyNameForCode (SoKeyboardEvent::Key keyCode);
 
  static bool decodeKeyString (const std::string& keyCombo, int& modifiers, SoKeyboardEvent::Key& nKey);
};
 
#endif  // __ManagedKeyboardShortcut_H