KeyEvent.hpp

Go to the documentation of this file.

#ifndef __blip_KeyEvent_hpp
#define __blip_KeyEvent_hpp

#include <blip/Blip.hpp>
#include <blip/InputEvent.hpp>

#include <commonc++/Flags.h++>

namespace blip {

class InputQueue;

class KeyEvent : public InputEvent
{
  friend class InputEventQueue;

  public:

  enum Action { Action_Unknown = -1, Action_KeyDown = 0, Action_KeyUp,
                Action_Multiple };

  // TODO: function Keys F1 to F12, numpad, etc.

  enum KeyCode { K_Unknown = 0, K_SoftLeft, K_SoftRight, K_Home, K_Back,
                 K_Call, K_EndCall, K_0, K_1, K_2, K_3, K_4, K_5, K_6, K_7,
                 K_8, K_9, K_Star, K_Pound, K_DPadUp, K_DPadDown, K_DPadLeft,
                 K_DPadRight, K_DPad_Center, K_VolumeUp, K_VolumeDown,
                 K_Power, K_Camera, K_Clear, K_A, K_B, K_C, K_D, K_E, K_F,
                 K_G, K_H, K_I, K_J, K_K, K_L, K_M, K_N, K_O, K_P, K_Q, K_R,
                 K_S, K_T, K_U, K_V, K_W, K_X, K_Y, K_Z, K_Comma, K_Period,
                 K_AltLeft, K_AltRight, K_ShiftLeft, K_ShiftRight, K_Tab,
                 K_Space, K_Sym, K_Explorer, K_Envelope, K_Enter, K_Delete,
                 K_Grave, K_Minus, K_Equals, K_LeftBracket, K_RightBracket,
                 K_Backslash, K_Semicolon, K_Apostrophe, K_Slash, K_At, K_Num,
                 K_HeadsetHook, K_Focus, K_Plus, K_Menu, K_Notification,
                 K_Search, K_MediaPlayPause, K_MediaStop, K_MediaNext,
                 K_MediaPrevious, K_MediaRewind, K_MediaFastForward, K_Mute,
                 K_PageUp, K_PageDown, K_PictSymbols, K_SwitchCharset,
                 K_ButtonA, K_ButtonB, K_ButtonC, K_ButtonX, K_ButtonY,
                 K_ButtonZ, K_ButtonL1, K_ButtonR1, K_Button_L2, K_ButtonR2,
                 K_ButtonThumbLeft, K_ButtonThumbRight, K_ButtonStart,
                 K_ButtonSelect, K_ButtonMode, K_Escape, K_ForwardDelete,
                 K_ControlLeft, K_ControlRight, K_CapsLock, K_ScrollLock,
                 K_MetaLeft, K_MetaRight, K_Function, K_SysRq, K_Break,
                 K_MoveHome, K_MoveEnd, K_Insert, K_Forward, K_MediaPlay,
                 K_MediaPause, K_MediaClose, K_MediaEject, K_MediaRecord,
                 K_F1, K_F2, K_F3, K_F4, K_F5, K_F6, K_F7, K_F8, K_F9, K_F10,
                 K_F11, K_F12, K_NumLock, K_NumPad_0, K_NumPad_1, K_NumPad_2,
                 K_NumPad_3, K_NumPad_4, K_NumPad_5, K_NumPad_6, K_NumPad_7,
                 K_NumPad_8, K_NumPad_9, K_NumPad_Divide, K_NumPad_Multiply,
                 K_NumPad_Subtract, K_NumPad_Add, K_NumPad_Dot, K_NumPad_Comma,
                 K_NumPad_Enter, K_NumPad_Equals, K_NumPad_LeftParen,
                 K_NumPad_RightParen, K_VolumeMute, K_Info, K_ChannelUp,
                 K_ChannelDown, K_ZoomIn, K_ZoomOut, K_TV, K_Window,
                 K_Guide, K_DVR, K_Bookmark, K_Captions, K_Settings,
                 K_TVPower, K_TVInput, K_STBPower, K_STBInput, K_AVRPower,
                 K_AVRInput, K_ProgRed, K_ProgGreen, K_ProgYellow, K_ProgBlue,
                 K_AppSwitch, K_Button1, K_Button2, K_Button3, K_Button4,
                 K_Button5, K_Button6, K_Button7, K_Button8, K_Button9,
                 K_Button10, K_Button11, K_Button12, K_Button13, K_Button14,
                 K_Button15, K_Button16, K_LanguageSwitch, K_MannerMode,
                 K_3DMode, K_Contacts, K_Calendar, K_Music, K_Calculator,
                 K_ZenkakuHankaku, K_Eisu, K_Muhenkan, K_Henkan,
                 K_KatakanaHiragana, K_Yen, K_Ro, K_Kana, K_Assist,
                 K_BrightnessDown, K_BrightnessUp, K_MediaAudioTrack };

  virtual ~KeyEvent();

  Action getAction() const;

  const ccxx::Flags<int32_t> getFlags() const;

  KeyCode getKeyCode() const;

  char getCharacter() const;

  int32_t getScanCode() const;

  int32_t getMetaState() const;

  int getRepeatCount() const;

  time_ms_t getDownTime() const;

  virtual time_ms_t getEventTime() const;

  bool isMetaKeyPressed() const;

  bool isAltPressed() const;

  bool isLeftAltPressed() const;

  bool isRightAltPressed() const;

  bool isCapsLockPressed() const;

  bool isControlPressed() const;

  bool isLeftControlPressed() const;

  bool isRightControlPressed() const;

  bool isFunctionPressed() const;

  bool isNumLockPressed() const;

  bool isScrollLockPressed() const;

  bool isShiftPressed() const;

  bool isLeftShiftPressed() const;

  bool isRightShiftPressed() const;

  bool isSymPressed() const;

  static const uint32_t ALT_MASK;

  static const uint32_t ALT_LEFT_MASK;

  static const uint32_t ALT_RIGHT_MASK;

  static const uint32_t ALT_ANY_MASK;

  static const uint32_t CAPS_LOCK_MASK;

  static const uint32_t CTRL_MASK;

  static const uint32_t CTRL_LEFT_MASK;

  static const uint32_t CTRL_RIGHT_MASK;

  static const uint32_t CTRL_ANY_MASK;

  static const uint32_t FUNCTION_MASK;

  static const uint32_t META_MASK;

  static const uint32_t META_LEFT_MASK;

  static const uint32_t META_RIGHT_MASK;

  static const uint32_t META_ANY_MASK;

  static const uint32_t NUM_LOCK_MASK;

  static const uint32_t SCROLL_LOCK_MASK;

  static const uint32_t SHIFT_MASK;

  static const uint32_t SHIFT_LEFT_MASK;

  static const uint32_t SHIFT_RIGHT_MASK;

  static const uint32_t SHIFT_ANY_MASK;

  static const uint32_t SYM_MASK;

  protected:

  KeyEvent(AInputEvent* event);
  private:

  CCXX_COPY_DECLS(KeyEvent);
};

} // namespace blip

#endif // __blip_KeyEvent_hpp