include/vrvCore/DtKeyState.h

Go to the documentation of this file.

/*********************************************************************
  ** Copyright (c) 2010 MAK Technologies, Inc.
  ** All rights reserved.
  *********************************************************************/
/*********************************************************************
  ** $RCSfile: DtKeyState.h,v $ $Revision: 1.7 $ $State: Exp $
  *********************************************************************/

#ifndef DtKeyState_H_
#define DtKeyState_H_


#include <vrvCore/vrvCore.h>

#include <string>

namespace makVrv
{
   class DT_DLL_VRVCORE DtKeyState
   {
   public:
      enum KeyType {
         KEY_BACKSPACE         = 0x08,
         KEY_TAB               = 0x09,
         KEY_CLEAR             = 0x0C,
         KEY_ENTER             = 0x0D,
         KEY_PAUSE             = 0x13,
         KEY_ESCAPE            = 0x1B,
         
         KEY_SPACE             = 0x20, 
         KEY_PAGE_UP           = 0x21, 
         KEY_PAGE_DOWN         = 0x22, 
         KEY_END               = 0x23,
         KEY_HOME              = 0x24,
         KEY_LEFT              = 0x25,   
         KEY_UP                = 0x26,  
         KEY_RIGHT             = 0x27,     
         KEY_DOWN              = 0x28,   
         KEY_PRINT_SCREEN      = 0x2C,
         KEY_INSERT            = 0x2D,
         KEY_DELETE            = 0x2E,

         KEY_0                 = 0x30, 
         KEY_1                 = 0x31,
         KEY_2                 = 0x32,
         KEY_3                 = 0x33,
         KEY_4                 = 0x34,
         KEY_5                 = 0x35,
         KEY_6                 = 0x36,
         KEY_7                 = 0x37,
         KEY_8                 = 0x38,
         KEY_9                 = 0x39,
         KEY_A                 = 0x41, 
         KEY_B                 = 0x42,
         KEY_C                 = 0x43,
         KEY_D                 = 0x44,
         KEY_E                 = 0x45,
         KEY_F                 = 0x46,
         KEY_G                 = 0x47,
         KEY_H                 = 0x48,
         KEY_I                 = 0x49,
         KEY_J                 = 0x4A,
         KEY_K                 = 0x4B,
         KEY_L                 = 0x4C,
         KEY_M                 = 0x4D,
         KEY_N                 = 0x4E,
         KEY_O                 = 0x4F,
         KEY_P                 = 0x50,
         KEY_Q                 = 0x51,
         KEY_R                 = 0x52,
         KEY_S                 = 0x53,
         KEY_T                 = 0x54,
         KEY_U                 = 0x55,
         KEY_V                 = 0x56,
         KEY_W                 = 0x57,
         KEY_X                 = 0x58,
         KEY_Y                 = 0x59,
         KEY_Z                 = 0x5A,
          
         KEY_PAD_0             = 0x60,
         KEY_PAD_1             = 0x61,      
         KEY_PAD_2             = 0x62,     
         KEY_PAD_3             = 0x63,      
         KEY_PAD_4             = 0x64,      
         KEY_PAD_5             = 0x65,      
         KEY_PAD_6             = 0x66,      
         KEY_PAD_7             = 0x67,     
         KEY_PAD_8             = 0x68,     
         KEY_PAD_9             = 0x69,   
         KEY_PAD_ADD           = 0x6B,         
         KEY_PAD_SUBTRACT      = 0x6D,     
         KEY_PAD_MULTIPLY      = 0x6A,     
         KEY_PAD_DIVIDE        = 0x6F,    
         KEY_PAD_DECIMAL       = 0x6E, 
           
         KEY_F1                = 0x70,
         KEY_F2                = 0x71,
         KEY_F3                = 0x72,
         KEY_F4                = 0x73,
         KEY_F5                = 0x74,
         KEY_F6                = 0x75,
         KEY_F7                = 0x76,
         KEY_F8                = 0x77,
         KEY_F9                = 0x78,
         KEY_F10               = 0x79,
         KEY_F11               = 0x7A,
         KEY_F12               = 0x7B,  
                   
         KEY_LEFT_SHIFT        = 0xA0,
         KEY_RIGHT_SHIFT       = 0xA1,
         KEY_LEFT_CTRL         = 0xA2,
         KEY_RIGHT_CTRL        = 0xA3,
         KEY_LEFT_ALT          = 0xA4,
         KEY_RIGHT_ALT         = 0xA5,
         
         KEY_SEMICOLON         = 0xBA,
         KEY_EQUAL_SIGN        = 0xBB,
         KEY_COMMA             = 0xBC,
         KEY_MINUS_SIGN        = 0xBD,
         KEY_PERIOD            = 0xBE,
         KEY_SLASH             = 0xBF,
         
         KEY_GRAVE             = 0xC0, 
         
         KEY_LEFT_BRACKET      = 0xDB, 
         KEY_BACKSLASH         = 0xDC,
         KEY_RIGHT_BRACKET     = 0xDD,
         KEY_APOSTROPHE        = 0xDE,
         KEY_NO_KEY            = 0xFF
      };

      enum KeyModifier {
         NO_MODIFIER = 0x0, 
         ALT_MODIFIER = 0x1, 
         CTRL_MODIFIER = 0x2, 
         SHIFT_MODIFIER = 0x4
      };   
   public:
      static std::string keyTypeToString( KeyType key );
      
   public:
   
      DtKeyState();
      
      DtKeyState( KeyType key, KeyModifier modifiers );
   
      virtual ~DtKeyState();

      DtKeyState(const DtKeyState&);
   
      DtKeyState &operator=(const DtKeyState&);
 
      virtual KeyType keyType() const;
      
      virtual void setKeyType( KeyType keyType );
      
      virtual bool altDown() const;
      
      virtual void setAltDown( bool altDown );
    
      virtual bool ctrlDown() const;
      
      virtual void setCtrlDown( bool ctrlDown );
    
      virtual bool shiftDown() const;
      
      virtual void setShiftDown( bool shiftDown );
      
      virtual KeyModifier modifiers() const;
      
      virtual void setModifiers( KeyModifier modifiers );
      
   protected:
   
      KeyType myKeyType;
      KeyModifier myModifiers;

   };
} //end namespace

#endif