Keyboard.h

Go to the documentation of this file.

//Luke Lenhart, 2008
//See /docs/License.txt for details on how this code may be used.

#pragma once

#include "../base/Setup.h"

#ifdef MPMA_COMPILE_INPUT

#include "../base/Types.h"
#include "Unified.h"

#include <vector>

namespace INPUT
{
    namespace KEYBOARD
    {
        //normal typeables
        const uint8 A='A'; 
        const uint8 B='B'; 
        const uint8 C='C'; 
        const uint8 D='D'; 
        const uint8 E='E'; 
        const uint8 F='F'; 
        const uint8 G='G'; 
        const uint8 H='H'; 
        const uint8 I='I'; 
        const uint8 J='J'; 
        const uint8 K='K'; 
        const uint8 L='L'; 
        const uint8 M='M'; 
        const uint8 N='N'; 
        const uint8 O='O'; 
        const uint8 P='P'; 
        const uint8 Q='Q'; 
        const uint8 R='R'; 
        const uint8 S='S'; 
        const uint8 T='T'; 
        const uint8 U='U'; 
        const uint8 V='V'; 
        const uint8 W='W'; 
        const uint8 X='X'; 
        const uint8 Y='Y'; 
        const uint8 Z='Z'; 
        const uint8 NUM0='0'; 
        const uint8 NUM1='1'; 
        const uint8 NUM2='2'; 
        const uint8 NUM3='3'; 
        const uint8 NUM4='4'; 
        const uint8 NUM5='5'; 
        const uint8 NUM6='6'; 
        const uint8 NUM7='7'; 
        const uint8 NUM8='8'; 
        const uint8 NUM9='9'; 
        const uint8 SPACE=' '; 
        const uint8 TILDA='`'; 
        const uint8 LEFT_BRACKET='['; 
        const uint8 RIGHT_BRACKET=']'; 
        const uint8 QUOTE='\''; 
        const uint8 COMMA=','; 
        const uint8 PERIOD='.'; 
        const uint8 SLASH='/'; 
        const uint8 BACKSLASH='\\'; 
        const uint8 EQUALS='='; 
        const uint8 DASH='-'; 
        const uint8 COLON=';'; 

        //normal control keys
        const uint8 ENTER='\n'; 
        const uint8 TAB='\t'; 
        const uint8 BACKSPACE=130; 
        const uint8 ESCAPE=131; 
        const uint8 UP=140; 
        const uint8 DOWN=141; 
        const uint8 LEFT=142; 
        const uint8 RIGHT=143; 
        const uint8 INSERT=150; 
        const uint8 DELETE=151; 
        const uint8 HOME=152; 
        const uint8 END=153; 
        const uint8 PAGE_UP=154; 
        const uint8 PAGE_DOWN=155; 
        const uint8 F1=161; 
        const uint8 F2=162; 
        const uint8 F3=163; 
        const uint8 F4=164; 
        const uint8 F5=165; 
        const uint8 F6=166; 
        const uint8 F7=167; 
        const uint8 F8=168; 
        const uint8 F9=169; 
        const uint8 F10=170; 
        const uint8 F11=171; 
        const uint8 F12=172; 

        //numpad keys (not all keyboards have)
        const uint8 PAD0=200; 
        const uint8 PAD1=201; 
        const uint8 PAD2=202; 
        const uint8 PAD3=203; 
        const uint8 PAD4=204; 
        const uint8 PAD5=205; 
        const uint8 PAD6=206; 
        const uint8 PAD7=207; 
        const uint8 PAD8=208; 
        const uint8 PAD9=209; 
        const uint8 PAD_SLASH=210; 
        const uint8 PAD_STAR=211; 
        const uint8 PAD_MINUS=212; 
        const uint8 PAD_PLUS=213; 
        const uint8 PAD_DOT=214; 
        const uint8 PAD_ENTER=215; 

        //modifier keys
        const uint8 LEFT_SHIFT=230; 
        const uint8 RIGHT_SHIFT=231; 
        const uint8 LEFT_CONTROL=232; 
        const uint8 RIGHT_CONTROL=233; 
        const uint8 LEFT_ALT=234; 
        const uint8 RIGHT_ALT=235; 

        const std::string& GetFriendlyName(uint8 key);

        const std::string& GetPersistentIdentifier(uint8 key);

        uint8 FindKey(const std::string &persistentIdentifier);

        bool IsKeyDown(uint8 key);

        const std::vector<uint8>& GetCurrentlyPressedKeys();

        const std::vector<uint8>& GetNewlyPressedKeys();

        bool UpdateTypedText(std::string &textToEdit);

        void SetCaptureMode(bool captureTypedText, bool captureKeyState);

        bool IsCapturingText();

        bool IsCapturingState();
    }
}

#endif //#ifdef MPMA_COMPILE_INPUT