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