X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..2fa2b11bbffc8995892369cedb9b208ca9a54d5b:/docs/latex/wx/keyevent.tex diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex index d6dbea27fb..5a54a47e65 100644 --- a/docs/latex/wx/keyevent.tex +++ b/docs/latex/wx/keyevent.tex @@ -2,7 +2,7 @@ This event class contains information about keypress (character) events. -Notice that there are three different kinds of keyboard events in wxWindows: +Notice that there are three different kinds of keyboard events in wxWidgets: key down and up events and char events. The difference between the first two is clear - the first corresponds to a key press and the second to a key release - otherwise they are identical. Just note that if the key is @@ -37,7 +37,7 @@ same key code {\tt 'a'} as usual but the char event will have key code of $1$, the ASCII value of this key combination. You may discover how the other keys on your system behave interactively by -running the \helpref{text}{sampletext} wxWindows sample and pressing some keys +running the \helpref{text}{sampletext} wxWidgets sample and pressing some keys in any of the text controls shown in it. {\bf Note:} If a key down ({\tt EVT\_KEY\_DOWN}) event is caught and @@ -46,10 +46,10 @@ char event ({\tt EVT\_CHAR}) will not happen. This is by design and enables the programs that handle both types of events to be a bit simpler. -{\bf Note for Windows programmers:} The key and char events in wxWindows are +{\bf Note for Windows programmers:} The key and char events in wxWidgets are similar to but slightly different from Windows {\tt WM\_KEYDOWN} and {\tt WM\_CHAR} events. In particular, Alt-x combination will generate a char -event in wxWindows (unless it is used as an accelerator). +event in wxWidgets (unless it is used as an accelerator). {\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in key event function, otherwise menu shortcuts may cease to work under Windows. @@ -82,13 +82,13 @@ functions that take a wxKeyEvent argument. \member{bool}{m\_altDown} -TRUE if the Alt key is pressed down. +true if the Alt key is pressed down. \membersection{wxKeyEvent::m\_controlDown} \member{bool}{m\_controlDown} -TRUE if control is pressed down. +true if control is pressed down. \membersection{wxKeyEvent::m\_keyCode} @@ -100,13 +100,13 @@ Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers. \member{bool}{m\_metaDown} -TRUE if the Meta key is pressed down. +true if the Meta key is pressed down. \membersection{wxKeyEvent::m\_shiftDown} \member{bool}{m\_shiftDown} -TRUE if shift is pressed down. +true if shift is pressed down. \membersection{wxKeyEvent::m\_x} @@ -130,13 +130,13 @@ Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CH \constfunc{bool}{AltDown}{\void} -Returns TRUE if the Alt key was down at the time of the key event. +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. +Returns true if the control key was down at the time of the key event. \membersection{wxKeyEvent::GetKeyCode} @@ -170,19 +170,19 @@ platform-dependent and should only be used in advanced applications. \constfunc{long}{GetX}{\void} -Returns the X position of the event. +Returns the X position (in client coordinates) of the event. \membersection{wxKeyEvent::GetY} \constfunc{long}{GetY}{\void} -Returns the Y position of the event. +Returns the Y (in client coordinates) 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. +Returns true if the Meta key was down at the time of the key event. \membersection{wxKeyEvent::GetPosition} @@ -190,13 +190,13 @@ Returns TRUE if the Meta key was down at the time of the key event. \constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}} -Obtains the position at which the key was pressed. +Obtains the position (in client coordinates) at which the key was pressed. \membersection{wxKeyEvent::HasModifiers} \constfunc{bool}{HasModifiers}{\void} -Returns TRUE if either {\sc Ctrl} or {\sc Alt} keys was down +Returns true if either {\sc Ctrl} or {\sc Alt} keys was down at the time of the key event. Note that this function does not take into account neither {\sc Shift} nor {\sc Meta} key states (the reason for ignoring the latter is that it is common for {\sc NumLock} key to be configured as @@ -207,5 +207,5 @@ be still processed normally). \constfunc{bool}{ShiftDown}{\void} -Returns TRUE if the shift key was down at the time of the key event. +Returns true if the shift key was down at the time of the key event.