include/wx/msw/private/keyboard.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/private/keyboard.h
   3 // Purpose:     Helper keyboard-related functions.
   4 // Author:      Vadim Zeitlin
   5 // Created:     2010-09-09
   6 // Copyright:   (c) 2010 Vadim Zeitlin <vadim@wxwidgets.org>
   7 // Licence:     wxWindows licence
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_MSW_PRIVATE_KEYBOARD_H_
  11 #define _WX_MSW_PRIVATE_KEYBOARD_H_
  12
  13 #include "wx/defs.h"
  14
  15 namespace wxMSWKeyboard
  16 {
  17
  18 // ----------------------------------------------------------------------------
  19 // Functions for translating between MSW virtual keys codes and wx key codes
  20 //
  21 // These functions are currently implemented in src/msw/window.cpp.
  22 // ----------------------------------------------------------------------------
  23
  24 // Translate MSW virtual key code to wx key code. lParam is used to distinguish
  25 // between numpad and extended version of the keys, extended is assumed by
  26 // default if lParam == 0.
  27 //
  28 // Returns WXK_NONE if translation couldn't be done at all (this happens e.g.
  29 // for dead keys and in this case uc will be WXK_NONE too) or if the key
  30 // corresponds to a non-Latin-1 character in which case uc is filled with its
  31 // Unicode value.
  32 WXDLLIMPEXP_CORE int VKToWX(WXWORD vk, WXLPARAM lParam = 0, wchar_t *uc = NULL);
  33
  34 // Translate wxKeyCode enum element (passed as int for compatibility reasons)
  35 // to MSW virtual key code. isExtended is set to true if the key corresponds to
  36 // a non-numpad version of a key that exists both on numpad and outside it.
  37 WXDLLIMPEXP_CORE WXWORD WXToVK(int id, bool *isExtended = NULL);
  38
  39 } // namespace wxMSWKeyboard
  40
  41 #endif // _WX_MSW_PRIVATE_KEYBOARD_H_