X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3972fb4919148d1ed67f897ea5beb67eedd662f6..281b0186b81a35b3eff658635b083b04a3cfa23c:/docs/latex/wx/keyevent.tex diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex index 53a2d5b7db..95552f4206 100644 --- a/docs/latex/wx/keyevent.tex +++ b/docs/latex/wx/keyevent.tex @@ -1,11 +1,15 @@ \section{\class{wxKeyEvent}}\label{wxkeyevent} -This event class contains information about keypress (character) events. See \helpref{wxWindow::OnChar}{wxwindowonchar}. +This event class contains information about keypress (character) events. \wxheading{Derived from} \helpref{wxEvent}{wxevent} +\wxheading{Include files} + + + \wxheading{Event table macros} To process a key event, use these event handler macros to direct input to member @@ -13,10 +17,20 @@ 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} @@ -69,31 +83,31 @@ Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CH \membersection{wxKeyEvent::AltDown} -\func{bool}{AltDown}{\void} +\constfunc{bool}{AltDown}{\void} Returns TRUE if the Alt key was down at the time of the key event. \membersection{wxKeyEvent::ControlDown} -\func{bool}{ControlDown}{\void} +\constfunc{bool}{ControlDown}{\void} Returns TRUE if the control key was down at the time of the key event. \membersection{wxKeyEvent::GetX} -\func{float}{GetX}{\void} +\constfunc{long}{GetX}{\void} Returns the X position of the event. \membersection{wxKeyEvent::GetY} -\func{float}{GetY}{\void} +\constfunc{long}{GetY}{\void} Returns the Y position of the event. \membersection{wxKeyEvent::KeyCode} -\func{long}{KeyCode}{\void} +\constfunc{long}{KeyCode}{\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 @@ -101,19 +115,21 @@ left cursor key. See \helpref{Keycodes}{keycodes} for a full list of the virtual \membersection{wxKeyEvent::MetaDown} -\func{bool}{MetaDown}{\void} +\constfunc{bool}{MetaDown}{\void} Returns TRUE if the Meta key was down at the time of the key event. -\membersection{wxKeyEvent::Position} +\membersection{wxKeyEvent::GetPosition} + +\constfunc{wxPoint}{GetPosition}{\void} -\func{void}{Position}{\param{float *}{x}, \param{float *}{y}} +\constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}} Obtains the position at which the key was pressed. \membersection{wxKeyEvent::ShiftDown} -\func{bool}{ShiftDown}{\void} +\constfunc{bool}{ShiftDown}{\void} Returns TRUE if the shift key was down at the time of the key event.