X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..2e9f62dafb75dc5baa3800af456d1b0248d85357:/docs/latex/wx/keyevent.tex diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex index 1248ec89cf..34dfc6afd3 100644 --- a/docs/latex/wx/keyevent.tex +++ b/docs/latex/wx/keyevent.tex @@ -83,51 +83,61 @@ 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::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} -\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} - -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::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} -\func{void}{Position}{\param{float *}{x}, \param{float *}{y}} +\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} -\func{bool}{ShiftDown}{\void} +\constfunc{bool}{ShiftDown}{\void} Returns TRUE if the shift key was down at the time of the key event.