X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4514447c97214ef73b5a65eea5d4b96cbd8d3780..affbfa1f2992c3f9778547f1d73743aefcc270d4:/docs/doxygen/mainpages/const_keymod.h diff --git a/docs/doxygen/mainpages/const_keymod.h b/docs/doxygen/mainpages/const_keymod.h index 769b668d69..139849e977 100644 --- a/docs/doxygen/mainpages/const_keymod.h +++ b/docs/doxygen/mainpages/const_keymod.h @@ -7,36 +7,36 @@ ///////////////////////////////////////////////////////////////////////////// -/*! - - @page page_keymodifiers Key Modifiers - - @header{wx/defs.h} - - 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. +/** + +@page page_keymodifiers Key Modifiers + +@header{wx/defs.h} + +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. */