added wxListBox::HitTest() from Ryan (patch 1446207)

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

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index 03d2f74f6dc5550d80232629a295b7a5ed22d0ba..f9271e8a6d84951fed946b949ac34d1a23147fa1 100644 (file)
--- a/docs/latex/wx/mouseevt.tex
+++ b/docs/latex/wx/mouseevt.tex
@@ -9,7 +9,7 @@ left mouse button, {\tt wxMOUSE\_BTN\_MIDDLE} for the middle one and
 middle button so a portable application should avoid relying on the events from
 it.
 
-{\bf NB:} Note that under Windows mouse enter and leave events are not natively supported
+{\bf NB:} Note that under Windows CE mouse enter and leave events are not natively supported
 by the system but are generated by wxWidgets itself. This has several
 drawbacks: the LEAVE\_WINDOW event might be received some time after the mouse
 left the window and the state variables for it may have changed during this
@@ -44,7 +44,10 @@ functions that take a wxMouseEvent argument.
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_LEFT\_DOWN(func)}}{Process a wxEVT\_LEFT\_DOWN event.}
+\twocolitem{{\bf EVT\_LEFT\_DOWN(func)}}{Process a wxEVT\_LEFT\_DOWN event. The
+handler of this event should normally call \helpref{event.Skip()}{wxeventskip} to
+allow the default processing to take place as otherwise the window under mouse
+wouldn't get the focus.}
 \twocolitem{{\bf EVT\_LEFT\_UP(func)}}{Process a wxEVT\_LEFT\_UP event.}
 \twocolitem{{\bf EVT\_LEFT\_DCLICK(func)}}{Process a wxEVT\_LEFT\_DCLICK event.}
 \twocolitem{{\bf EVT\_MIDDLE\_DOWN(func)}}{Process a wxEVT\_MIDDLE\_DOWN event.}
@@ -151,7 +154,7 @@ action.
 
 \membersection{wxMouseEvent::wxMouseEvent}\label{wxmouseeventctor}
 
-\func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}, \param{int}{ id = 0}}
+\func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}}
 
 Constructor. Valid event types are:
 
@@ -189,8 +192,8 @@ values of {\it button} are:
 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\tt wxMOUSE\_BTN\_LEFT}}{check if left button was pressed}
-\twocolitem{{\tt wxMOUSE\_BTN\_MIDDLE}}{check if left button was pressed}
-\twocolitem{{\tt wxMOUSE\_BTN\_RIGHT}}{check if left button was pressed}
+\twocolitem{{\tt wxMOUSE\_BTN\_MIDDLE}}{check if middle button was pressed}
+\twocolitem{{\tt wxMOUSE\_BTN\_RIGHT}}{check if right button was pressed}
 \twocolitem{{\tt wxMOUSE\_BTN\_ANY}}{check if any button was pressed}
 \end{twocollist}
 
@@ -227,7 +230,7 @@ values).
 
 
 
-\membersection{wxKeyEvent::CmdDown}\label{wxmouseeventcmddown}
+\membersection{wxMouseEvent::CmdDown}\label{wxmouseeventcmddown}
 
 \constfunc{bool}{CmdDown}{\void}
 
@@ -289,6 +292,10 @@ Sets *x and *y to the position at which the event occurred.
 
 Returns the physical mouse position in pixels.
 
+Note that if the mouse event has been artificially generated from a special
+keyboard combination (e.g. under Windows when the ``menu'' key is pressed), the
+returned position is \texttt{wxDefaultPosition}.
+
 
 \membersection{wxMouseEvent::GetLogicalPosition}\label{wxmouseeventgetlogicalposition}