[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.
Commit	Line	Data
e7102772 VZ	1	\section{Key Modifiers}\label{keymodifiers}
	2
	3	\wxheading{Include files}
	4
	5	<wx/defs.h>
	6
	7	The following key modifier constants are defined:
	8
	9	{\small
	10	\begin{verbatim}
	11	enum wxKeyModifier
	12	{
	13	wxMOD_NONE = 0x0000,
	14	wxMOD_ALT = 0x0001,
	15	wxMOD_CONTROL = 0x0002,
	16	wxMOD_ALTGR = wxMOD_ALT \| wxMOD_CONTROL,
	17	wxMOD_SHIFT = 0x0004,
	18	wxMOD_META = 0x0008,
	19	#if defined(__WXMAC__) \|\| defined(__WXCOCOA__)
	20	wxMOD_CMD = wxMOD_META,
	21	#else
	22	wxMOD_CMD = wxMOD_CONTROL,
	23	#endif
	24	wxMOD_ALL = 0xffff
	25	};
	26	\end{verbatim}
	27	}
	28
	29	Notice that \texttt{wxMOD\_CMD} should be used instead of
	30	\texttt{wxMOD\_CONTROL} in portable code to account for the fact that although
	31	\textsc{Control} modifier exists under Mac OS, it is not used for the same
	32	purpose as under Windows or Unix there while the special Mac-specific
	33	\textsc{Command} modifier is used in exactly the same way.
	34