don't call wxYield() from EnsureVisible(), this is too dangerous - and unnecessary...

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

diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex
index 53a2d5b7dba346f3149565f536c6e27006eb5f8e..34dfc6afd3e0b69e6dcc4bd0d305760c67d159ab 100644 (file)
--- a/docs/latex/wx/keyevent.tex
+++ b/docs/latex/wx/keyevent.tex
@@ -1,11 +1,15 @@
 \section{\class{wxKeyEvent}}\label{wxkeyevent}
 
 \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{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
 \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
 
 \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}%
 
 \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}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxKeyEvent::m\_altDown}


@@ -69,51 +83,61 @@ Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CH
 
 \membersection{wxKeyEvent::AltDown}
 
 
 \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}
 
 
 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.
 
 
 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}
 
 \membersection{wxKeyEvent::GetX}
 

-\func{float}{GetX}{\void}
+\constfunc{long}{GetX}{\void}

 
 Returns the X position of the event.
 
 \membersection{wxKeyEvent::GetY}
 
 
 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.
 
 
 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}
 
 \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.
 
 
 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.
 
 
 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}
 
 \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.
 
 
 Returns TRUE if the shift key was down at the time of the key event.