public/fpdf_fwlevent.h

   1 // Copyright 2014 PDFium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
   6
   7 #ifndef PUBLIC_FPDF_FWLEVENT_H_
   8 #define PUBLIC_FPDF_FWLEVENT_H_
   9
  10 #include "fpdfview.h"
  11
  12 #ifdef __cplusplus
  13 extern "C" {
  14 #endif
  15
  16 typedef int FPDF_INT32;
  17 typedef unsigned int FPDF_UINT32;
  18 typedef float FPDF_FLOAT;
  19 // event type
  20 typedef enum {
  21   FWL_EVENTTYPE_Mouse = 0,
  22   FWL_EVENTTYPE_MouseWheel,
  23   FWL_EVENTTYPE_Key,
  24 } FWL_EVENTTYPE;
  25
  26 // key flag
  27 typedef enum {
  28   FWL_EVENTFLAG_ShiftKey = 1 << 0,
  29   FWL_EVENTFLAG_ControlKey = 1 << 1,
  30   FWL_EVENTFLAG_AltKey = 1 << 2,
  31   FWL_EVENTFLAG_MetaKey = 1 << 3,
  32   FWL_EVENTFLAG_KeyPad = 1 << 4,
  33   FWL_EVENTFLAG_AutoRepeat = 1 << 5,
  34   FWL_EVENTFLAG_LeftButtonDown = 1 << 6,
  35   FWL_EVENTFLAG_MiddleButtonDown = 1 << 7,
  36   FWL_EVENTFLAG_RightButtonDown = 1 << 8,
  37 } FWL_EVENTFLAG;
  38
  39 // Mouse message command
  40 typedef enum {
  41   FWL_EVENTMOUSECMD_LButtonDown = 1,
  42   FWL_EVENTMOUSECMD_LButtonUp,
  43   FWL_EVENTMOUSECMD_LButtonDblClk,
  44   FWL_EVENTMOUSECMD_RButtonDown,
  45   FWL_EVENTMOUSECMD_RButtonUp,
  46   FWL_EVENTMOUSECMD_RButtonDblClk,
  47   FWL_EVENTMOUSECMD_MButtonDown,
  48   FWL_EVENTMOUSECMD_MButtonUp,
  49   FWL_EVENTMOUSECMD_MButtonDblClk,
  50   FWL_EVENTMOUSECMD_MouseMove,
  51   FWL_EVENTMOUSECMD_MouseEnter,
  52   FWL_EVENTMOUSECMD_MouseHover,
  53   FWL_EVENTMOUSECMD_MouseLeave,
  54 } FWL_EVENT_MOUSECMD;
  55
  56 // mouse event
  57 struct FWL_EVENT_MOUSE {
  58   FPDF_UINT32 command;
  59   FPDF_DWORD flag;
  60   FPDF_FLOAT x;
  61   FPDF_FLOAT y;
  62 };
  63
  64 // mouse wheel
  65 struct FWL_EVENT_MOUSEWHEEL {
  66   FPDF_DWORD flag;
  67   FPDF_FLOAT x;
  68   FPDF_FLOAT y;
  69   FPDF_FLOAT deltaX;
  70   FPDF_FLOAT deltaY;
  71 };
  72
  73 // virtual keycode
  74 typedef enum {
  75   FWL_VKEY_Back = 0x08,
  76   FWL_VKEY_Tab = 0x09,
  77   FWL_VKEY_Clear = 0x0C,
  78   FWL_VKEY_Return = 0x0D,
  79   FWL_VKEY_Shift = 0x10,
  80   FWL_VKEY_Control = 0x11,
  81   FWL_VKEY_Menu = 0x12,
  82   FWL_VKEY_Pause = 0x13,
  83   FWL_VKEY_Capital = 0x14,
  84   FWL_VKEY_Kana = 0x15,
  85   FWL_VKEY_Hangul = 0x15,
  86   FWL_VKEY_Junja = 0x17,
  87   FWL_VKEY_Final = 0x18,
  88   FWL_VKEY_Hanja = 0x19,
  89   FWL_VKEY_Kanji = 0x19,
  90   FWL_VKEY_Escape = 0x1B,
  91   FWL_VKEY_Convert = 0x1C,
  92   FWL_VKEY_NonConvert = 0x1D,
  93   FWL_VKEY_Accept = 0x1E,
  94   FWL_VKEY_ModeChange = 0x1F,
  95   FWL_VKEY_Space = 0x20,
  96   FWL_VKEY_Prior = 0x21,
  97   FWL_VKEY_Next = 0x22,
  98   FWL_VKEY_End = 0x23,
  99   FWL_VKEY_Home = 0x24,
 100   FWL_VKEY_Left = 0x25,
 101   FWL_VKEY_Up = 0x26,
 102   FWL_VKEY_Right = 0x27,
 103   FWL_VKEY_Down = 0x28,
 104   FWL_VKEY_Select = 0x29,
 105   FWL_VKEY_Print = 0x2A,
 106   FWL_VKEY_Execute = 0x2B,
 107   FWL_VKEY_Snapshot = 0x2C,
 108   FWL_VKEY_Insert = 0x2D,
 109   FWL_VKEY_Delete = 0x2E,
 110   FWL_VKEY_Help = 0x2F,
 111   FWL_VKEY_0 = 0x30,
 112   FWL_VKEY_1 = 0x31,
 113   FWL_VKEY_2 = 0x32,
 114   FWL_VKEY_3 = 0x33,
 115   FWL_VKEY_4 = 0x34,
 116   FWL_VKEY_5 = 0x35,
 117   FWL_VKEY_6 = 0x36,
 118   FWL_VKEY_7 = 0x37,
 119   FWL_VKEY_8 = 0x38,
 120   FWL_VKEY_9 = 0x39,
 121   FWL_VKEY_A = 0x41,
 122   FWL_VKEY_B = 0x42,
 123   FWL_VKEY_C = 0x43,
 124   FWL_VKEY_D = 0x44,
 125   FWL_VKEY_E = 0x45,
 126   FWL_VKEY_F = 0x46,
 127   FWL_VKEY_G = 0x47,
 128   FWL_VKEY_H = 0x48,
 129   FWL_VKEY_I = 0x49,
 130   FWL_VKEY_J = 0x4A,
 131   FWL_VKEY_K = 0x4B,
 132   FWL_VKEY_L = 0x4C,
 133   FWL_VKEY_M = 0x4D,
 134   FWL_VKEY_N = 0x4E,
 135   FWL_VKEY_O = 0x4F,
 136   FWL_VKEY_P = 0x50,
 137   FWL_VKEY_Q = 0x51,
 138   FWL_VKEY_R = 0x52,
 139   FWL_VKEY_S = 0x53,
 140   FWL_VKEY_T = 0x54,
 141   FWL_VKEY_U = 0x55,
 142   FWL_VKEY_V = 0x56,
 143   FWL_VKEY_W = 0x57,
 144   FWL_VKEY_X = 0x58,
 145   FWL_VKEY_Y = 0x59,
 146   FWL_VKEY_Z = 0x5A,
 147   FWL_VKEY_LWin = 0x5B,
 148   FWL_VKEY_Command = 0x5B,
 149   FWL_VKEY_RWin = 0x5C,
 150   FWL_VKEY_Apps = 0x5D,
 151   FWL_VKEY_Sleep = 0x5F,
 152   FWL_VKEY_NumPad0 = 0x60,
 153   FWL_VKEY_NumPad1 = 0x61,
 154   FWL_VKEY_NumPad2 = 0x62,
 155   FWL_VKEY_NumPad3 = 0x63,
 156   FWL_VKEY_NumPad4 = 0x64,
 157   FWL_VKEY_NumPad5 = 0x65,
 158   FWL_VKEY_NumPad6 = 0x66,
 159   FWL_VKEY_NumPad7 = 0x67,
 160   FWL_VKEY_NumPad8 = 0x68,
 161   FWL_VKEY_NumPad9 = 0x69,
 162   FWL_VKEY_Multiply = 0x6A,
 163   FWL_VKEY_Add = 0x6B,
 164   FWL_VKEY_Separator = 0x6C,
 165   FWL_VKEY_Subtract = 0x6D,
 166   FWL_VKEY_Decimal = 0x6E,
 167   FWL_VKEY_Divide = 0x6F,
 168   FWL_VKEY_F1 = 0x70,
 169   FWL_VKEY_F2 = 0x71,
 170   FWL_VKEY_F3 = 0x72,
 171   FWL_VKEY_F4 = 0x73,
 172   FWL_VKEY_F5 = 0x74,
 173   FWL_VKEY_F6 = 0x75,
 174   FWL_VKEY_F7 = 0x76,
 175   FWL_VKEY_F8 = 0x77,
 176   FWL_VKEY_F9 = 0x78,
 177   FWL_VKEY_F10 = 0x79,
 178   FWL_VKEY_F11 = 0x7A,
 179   FWL_VKEY_F12 = 0x7B,
 180   FWL_VKEY_F13 = 0x7C,
 181   FWL_VKEY_F14 = 0x7D,
 182   FWL_VKEY_F15 = 0x7E,
 183   FWL_VKEY_F16 = 0x7F,
 184   FWL_VKEY_F17 = 0x80,
 185   FWL_VKEY_F18 = 0x81,
 186   FWL_VKEY_F19 = 0x82,
 187   FWL_VKEY_F20 = 0x83,
 188   FWL_VKEY_F21 = 0x84,
 189   FWL_VKEY_F22 = 0x85,
 190   FWL_VKEY_F23 = 0x86,
 191   FWL_VKEY_F24 = 0x87,
 192   FWL_VKEY_NunLock = 0x90,
 193   FWL_VKEY_Scroll = 0x91,
 194   FWL_VKEY_LShift = 0xA0,
 195   FWL_VKEY_RShift = 0xA1,
 196   FWL_VKEY_LControl = 0xA2,
 197   FWL_VKEY_RControl = 0xA3,
 198   FWL_VKEY_LMenu = 0xA4,
 199   FWL_VKEY_RMenu = 0xA5,
 200   FWL_VKEY_BROWSER_Back = 0xA6,
 201   FWL_VKEY_BROWSER_Forward = 0xA7,
 202   FWL_VKEY_BROWSER_Refresh = 0xA8,
 203   FWL_VKEY_BROWSER_Stop = 0xA9,
 204   FWL_VKEY_BROWSER_Search = 0xAA,
 205   FWL_VKEY_BROWSER_Favorites = 0xAB,
 206   FWL_VKEY_BROWSER_Home = 0xAC,
 207   FWL_VKEY_VOLUME_Mute = 0xAD,
 208   FWL_VKEY_VOLUME_Down = 0xAE,
 209   FWL_VKEY_VOLUME_Up = 0xAF,
 210   FWL_VKEY_MEDIA_NEXT_Track = 0xB0,
 211   FWL_VKEY_MEDIA_PREV_Track = 0xB1,
 212   FWL_VKEY_MEDIA_Stop = 0xB2,
 213   FWL_VKEY_MEDIA_PLAY_Pause = 0xB3,
 214   FWL_VKEY_MEDIA_LAUNCH_Mail = 0xB4,
 215   FWL_VKEY_MEDIA_LAUNCH_MEDIA_Select = 0xB5,
 216   FWL_VKEY_MEDIA_LAUNCH_APP1 = 0xB6,
 217   FWL_VKEY_MEDIA_LAUNCH_APP2 = 0xB7,
 218   FWL_VKEY_OEM_1 = 0xBA,
 219   FWL_VKEY_OEM_Plus = 0xBB,
 220   FWL_VKEY_OEM_Comma = 0xBC,
 221   FWL_VKEY_OEM_Minus = 0xBD,
 222   FWL_VKEY_OEM_Period = 0xBE,
 223   FWL_VKEY_OEM_2 = 0xBF,
 224   FWL_VKEY_OEM_3 = 0xC0,
 225   FWL_VKEY_OEM_4 = 0xDB,
 226   FWL_VKEY_OEM_5 = 0xDC,
 227   FWL_VKEY_OEM_6 = 0xDD,
 228   FWL_VKEY_OEM_7 = 0xDE,
 229   FWL_VKEY_OEM_8 = 0xDF,
 230   FWL_VKEY_OEM_102 = 0xE2,
 231   FWL_VKEY_ProcessKey = 0xE5,
 232   FWL_VKEY_Packet = 0xE7,
 233   FWL_VKEY_Attn = 0xF6,
 234   FWL_VKEY_Crsel = 0xF7,
 235   FWL_VKEY_Exsel = 0xF8,
 236   FWL_VKEY_Ereof = 0xF9,
 237   FWL_VKEY_Play = 0xFA,
 238   FWL_VKEY_Zoom = 0xFB,
 239   FWL_VKEY_NoName = 0xFC,
 240   FWL_VKEY_PA1 = 0xFD,
 241   FWL_VKEY_OEM_Clear = 0xFE,
 242   FWL_VKEY_Unknown = 0,
 243 } FWL_VKEYCODE;
 244
 245 // key event command
 246 typedef enum {
 247   FWL_EVENTKEYCMD_KeyDown = 1,
 248   FWL_EVENTKEYCMD_KeyUp,
 249   FWL_EVENTKEYCMD_Char,
 250 } FWL_EVENTKEYCMD;
 251
 252 // key event
 253 struct FWL_EVENT_KEY {
 254   FPDF_UINT32 command;
 255   FPDF_DWORD flag;
 256   union {
 257     // Virtual key code.
 258     FPDF_UINT32 vkcode;
 259     // Character code.
 260     FPDF_DWORD charcode;
 261   } code;
 262 };
 263
 264 // event type
 265 struct FWL_EVENT {
 266   // structure size.
 267   FPDF_UINT32 size;
 268   // FWL_EVENTTYPE.
 269   FPDF_UINT32 type;
 270   union {
 271     struct FWL_EVENT_MOUSE mouse;
 272     struct FWL_EVENT_MOUSEWHEEL wheel;
 273     struct FWL_EVENT_KEY key;
 274   } s;
 275 };
 276
 277 #ifdef __cplusplus
 278 }
 279 #endif
 280
 281 #endif  // PUBLIC_FPDF_FWLEVENT_H_