wxWidgets/docs/latex/wx/keyevent.tex
Bryan Petty f6bcfd974e merged 2.2 branch
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@7748 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2000-07-15 19:51:35 +00:00

145 lines
3.5 KiB
TeX

\section{\class{wxKeyEvent}}\label{wxkeyevent}
This event class contains information about keypress (character) events.
\wxheading{Derived from}
\helpref{wxEvent}{wxevent}
\wxheading{Include files}
<wx/event.h>
\wxheading{Event table macros}
To process a key event, use these event handler macros to direct input to member
functions that take a wxKeyEvent argument.
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_CHAR(func)}}{Process a wxEVT\_CHAR event (a non-modifier key has been pressed).}
\twocolitem{{\bf EVT\_KEY\_DOWN(func)}}{Process a wxEVT\_KEY\_DOWN event (any key has been pressed).}
\twocolitem{{\bf EVT\_KEY\_UP(func)}}{Process a wxEVT\_KEY\_UP event (any key has been released).}
\twocolitem{{\bf EVT\_CHAR(func)}}{Process a wxEVT\_CHAR event.}
\twocolitem{{\bf EVT\_CHAR\_HOOK(func)}}{Process a wxEVT\_CHAR\_HOOK event.}
\end{twocollist}%
\wxheading{See also}
\helpref{wxWindow::OnChar}{wxwindowonchar},
\helpref{wxWindow::OnCharHook}{wxwindowoncharhook},
\helpref{wxWindow::OnKeyDown}{wxwindowonkeydown},
\helpref{wxWindow::OnKeyUp}{wxwindowonkeyup}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxKeyEvent::m\_altDown}
\member{bool}{m\_altDown}
TRUE if the Alt key is pressed down.
\membersection{wxKeyEvent::m\_controlDown}
\member{bool}{m\_controlDown}
TRUE if control is pressed down.
\membersection{wxKeyEvent::m\_keyCode}
\member{long}{m\_keyCode}
Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers.
\membersection{wxKeyEvent::m\_metaDown}
\member{bool}{m\_metaDown}
TRUE if the Meta key is pressed down.
\membersection{wxKeyEvent::m\_shiftDown}
\member{bool}{m\_shiftDown}
TRUE if shift is pressed down.
\membersection{wxKeyEvent::m\_x}
\member{int}{m\_x}
X position of the event.
\membersection{wxKeyEvent::m\_y}
\member{int}{m\_y}
Y position of the event.
\membersection{wxKeyEvent::wxKeyEvent}
\func{}{wxKeyEvent}{\param{WXTYPE}{ keyEventType}}
Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CHAR\_HOOK.
\membersection{wxKeyEvent::AltDown}
\constfunc{bool}{AltDown}{\void}
Returns TRUE if the Alt key was down at the time of the key event.
\membersection{wxKeyEvent::ControlDown}
\constfunc{bool}{ControlDown}{\void}
Returns TRUE if the control key was down at the time of the key event.
\membersection{wxKeyEvent::GetKeyCode}
\constfunc{int}{GetKeyCode}{\void}
Returns the virtual key code. ASCII events return normal ASCII values,
while non-ASCII events return values such as {\bf WXK\_LEFT} for the
left cursor key. See \helpref{Keycodes}{keycodes} for a full list of the virtual key codes.
\membersection{wxKeyEvent::GetX}
\constfunc{long}{GetX}{\void}
Returns the X position of the event.
\membersection{wxKeyEvent::GetY}
\constfunc{long}{GetY}{\void}
Returns the Y position of the event.
\membersection{wxKeyEvent::MetaDown}
\constfunc{bool}{MetaDown}{\void}
Returns TRUE if the Meta key was down at the time of the key event.
\membersection{wxKeyEvent::GetPosition}
\constfunc{wxPoint}{GetPosition}{\void}
\constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}}
Obtains the position at which the key was pressed.
\membersection{wxKeyEvent::HasModifiers}
\constfunc{bool}{HasModifiers}{\void}
Returns TRUE if either of {\sc Ctrl}, {\sc Alt} or {\sc Meta} keys was down
at the time of the key event. Note that this function does not take into
account the {\sc Shift} key state.
\membersection{wxKeyEvent::ShiftDown}
\constfunc{bool}{ShiftDown}{\void}
Returns TRUE if the shift key was down at the time of the key event.