X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3d902bdfa8fa9fe970de3456c31eb0d0b48edb7c..25c4a27cb334abfd64cc4d41e8db8584c40f1d12:/docs/doxygen/const_keymod.h

diff --git a/docs/doxygen/const_keymod.h b/docs/doxygen/const_keymod.h
new file mode 100644
index 0000000000..a2c7d854d1
--- /dev/null
+++ b/docs/doxygen/const_keymod.h
@@ -0,0 +1,42 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        keymod.h
+// Purpose:     key modifiers
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+
+/*!
+
+@page keymodifiers Key Modifiers
+ 
+ Include file: @verbatim #include <wx/defs.h> @endverbatim
+ 
+ The following key modifier constants are defined:
+ 
+ @verbatim
+     enum wxKeyModifier
+     {
+         wxMOD_NONE      = 0x0000,
+         wxMOD_ALT       = 0x0001,
+         wxMOD_CONTROL   = 0x0002,
+         wxMOD_ALTGR     = wxMOD_ALT | wxMOD_CONTROL,
+         wxMOD_SHIFT     = 0x0004,
+         wxMOD_META      = 0x0008,
+     #if defined(__WXMAC__) || defined(__WXCOCOA__)
+         wxMOD_CMD       = wxMOD_META,
+     #else
+         wxMOD_CMD       = wxMOD_CONTROL,
+     #endif
+         wxMOD_ALL       = 0xffff
+     };
+ @endverbatim
+ 
+ Notice that @c wxMOD\_CMD should be used instead of @c wxMOD_CONTROL 
+ in portable code to account for the fact that although 
+ @c Control modifier exists under Mac OS, it is not used for the same
+ purpose as under Windows or Unix there while the special Mac-specific 
+ @c Command modifier is used in exactly the same way.
+
+*/