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