Extended wxTextAttr and added wxTextCtrl::GetStyle stub

[wxWidgets.git] / docs / latex / wx / keyevent.tex

diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex
index 2cb649360f5e47d3d10afb48a243f981361d0c53..e2b47c7fb8017efa47bdc069c01afa82b84fe168 100644 (file)
--- a/docs/latex/wx/keyevent.tex
+++ b/docs/latex/wx/keyevent.tex
@@ -49,7 +49,7 @@ simpler.
 {\bf Note for Windows programmers:} The key and char events in wxWindows 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
 {\bf Note for Windows programmers:} The key and char events in wxWindows 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 acclerator).
+event in wxWindows (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.
 
 {\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}
 
 
 \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}
 
 
 \membersection{wxKeyEvent::m\_controlDown}
 
 \member{bool}{m\_controlDown}
 

-TRUE if control is pressed down.
+true if control is pressed down.

 
 \membersection{wxKeyEvent::m\_keyCode}
 
 
 \membersection{wxKeyEvent::m\_keyCode}
 


@@ -100,13 +100,13 @@ Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers.
 
 \member{bool}{m\_metaDown}
 
 
 \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}
 
 
 \membersection{wxKeyEvent::m\_shiftDown}
 
 \member{bool}{m\_shiftDown}
 

-TRUE if shift is pressed down.
+true if shift is pressed down.

 
 \membersection{wxKeyEvent::m\_x}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \membersection{wxKeyEvent::GetKeyCode}
 


@@ -170,19 +170,19 @@ platform-dependent and should only be used in advanced applications.
 
 \constfunc{long}{GetX}{\void}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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}}
 
 
 \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}
 
 
 \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
 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}
 
 
 \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.