Missed labels to replace number of 'topicNNN' in anchors. Consistent use of -dtor...

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

diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex
index 5a54a47e6551012cd66e0030d627aeb64200e3ed..a76d181b19d64670a4e331ae3bd1449088d28b24 100644 (file)
--- a/docs/latex/wx/keyevent.tex
+++ b/docs/latex/wx/keyevent.tex
@@ -78,66 +78,90 @@ functions that take a wxKeyEvent argument.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxKeyEvent::m\_altDown}
 
 \member{bool}{m\_altDown}
 
 true if the Alt key is pressed down.
 
+
 \membersection{wxKeyEvent::m\_controlDown}
 
 \member{bool}{m\_controlDown}
 
 true if control is pressed down.
 
+
 \membersection{wxKeyEvent::m\_keyCode}
 
 \member{long}{m\_keyCode}
 
 Virtual keycode. See \helpref{Keycodes}{keycodes} for a list of identifiers.
 
+
 \membersection{wxKeyEvent::m\_metaDown}
 
 \member{bool}{m\_metaDown}
 
 true if the Meta key is pressed down.
 
+
 \membersection{wxKeyEvent::m\_shiftDown}
 
 \member{bool}{m\_shiftDown}
 
 true if shift is pressed down.
 
+
 \membersection{wxKeyEvent::m\_x}
 
 \member{int}{m\_x}
 
 X position of the event.
 
+
 \membersection{wxKeyEvent::m\_y}
 
 \member{int}{m\_y}
 
 Y position of the event.
 
+
 \membersection{wxKeyEvent::wxKeyEvent}
 
 \func{}{wxKeyEvent}{\param{WXTYPE}{ keyEventType}}
 
 Constructor. Currently, the only valid event types are wxEVT\_CHAR and wxEVT\_CHAR\_HOOK.
 
+
 \membersection{wxKeyEvent::AltDown}
 
 \constfunc{bool}{AltDown}{\void}
 
 Returns true if the Alt key was down at the time of the key event.
 
-\membersection{wxKeyEvent::ControlDown}
+
+\membersection{wxKeyEvent::CmdDown}\label{wxkeyeventcmddown}
+
+\constfunc{bool}{CmdDown}{\void}
+
+"Cmd" is a pseudo key which is the same as Control for PC and Unix platforms
+but the special "Apple" (a.k.a as "Command") key under Macs: it makes often
+sense to use it instead of, say, ControlDown() because Cmd key is used for the
+same thing under Mac as Ctrl elsewhere (but Ctrl still exists, just not used
+for this purpose under Mac). So for non-Mac platforms this is the same as 
+\helpref{ControlDown()}{wxkeyeventcontroldown} and under Mac this is the same
+as \helpref{MetaDown()}{wxkeyeventmetadown}.
+
+
+\membersection{wxKeyEvent::ControlDown}\label{wxkeyeventcontroldown}
 
 \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}
@@ -146,6 +170,16 @@ 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::GetPosition}
+
+\constfunc{wxPoint}{GetPosition}{\void}
+
+\constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}}
+
+Obtains the position (in client coordinates) at which the key was pressed.
+
+
 \membersection{wxKeyEvent::GetRawKeyCode}
 
 \constfunc{wxUint32}{GetRawKeyCode}{\void}
@@ -156,6 +190,7 @@ which should only be used in advanced applications.
 {\bf NB:} Currently the raw key codes are not supported by all ports, use
 {\tt\#ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.
 
+
 \membersection{wxKeyEvent::GetRawKeyFlags}
 
 \constfunc{wxUint32}{GetRawKeyFlags}{\void}
@@ -166,31 +201,30 @@ platform-dependent and should only be used in advanced applications.
 {\bf NB:} Currently the raw key flags are not supported by all ports, use
 {\tt \#ifdef wxHAS\_RAW\_KEY\_CODES} to determine if this feature is available.
 
-\membersection{wxKeyEvent::GetX}
 
-\constfunc{long}{GetX}{\void}
+\membersection{wxKeyEvent::GetUnicodeKey}
 
-Returns the X position (in client coordinates) of the event.
+\constfunc{wxChar}{GetUnicodeKey}{\void}
 
-\membersection{wxKeyEvent::GetY}
+Returns the Unicode character corresponding to this key event.
 
-\constfunc{long}{GetY}{\void}
+This function is only available in Unicode build, i.e. when
+\texttt{wxUSE\_UNICODE} is $1$.
 
-Returns the Y (in client coordinates) position of the event.
 
-\membersection{wxKeyEvent::MetaDown}
+\membersection{wxKeyEvent::GetX}
 
-\constfunc{bool}{MetaDown}{\void}
+\constfunc{long}{GetX}{\void}
 
-Returns true if the Meta key was down at the time of the key event.
+Returns the X position (in client coordinates) of the event.
 
-\membersection{wxKeyEvent::GetPosition}
 
-\constfunc{wxPoint}{GetPosition}{\void}
+\membersection{wxKeyEvent::GetY}
 
-\constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}}
+\constfunc{long}{GetY}{\void}
+
+Returns the Y (in client coordinates) position of the event.
 
-Obtains the position (in client coordinates) at which the key was pressed.
 
 \membersection{wxKeyEvent::HasModifiers}
 
@@ -203,6 +237,14 @@ the latter is that it is common for {\sc NumLock} key to be configured as
 {\sc Meta} under X but the key presses even while {\sc NumLock} is on should
 be still processed normally).
 
+
+\membersection{wxKeyEvent::MetaDown}\label{wxkeyeventmetadown}
+
+\constfunc{bool}{MetaDown}{\void}
+
+Returns true if the Meta key was down at the time of the key event.
+
+
 \membersection{wxKeyEvent::ShiftDown}\label{wxkeyeventshiftdown}
 
 \constfunc{bool}{ShiftDown}{\void}