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