another patch bring the docs more up to date (patch 1717776)

[wxWidgets.git] / docs / latex / wx / keymod.tex

\section{Key Modifiers}\label{keymodifiers}

\wxheading{Include files}

<wx/defs.h>

The following key modifier constants are defined:

{\small
\begin{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
    };
\end{verbatim}
}

Notice that \texttt{wxMOD\_CMD} should be used instead of 
\texttt{wxMOD\_CONTROL} in portable code to account for the fact that although 
\textsc{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 
\textsc{Command} modifier is used in exactly the same way.