Applied ref-couting patch.

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

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index 2b061529c5ccfc4a138fa5216e111f6b567233ae..f8ccc69ed63f036fb04dcae776f63db882f5636b 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.
 
 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
 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
 
 \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.}
 \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}
 
 
 \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:
 
 
 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}
 
 \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}
 
 \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}
 
 
 \constfunc{bool}{CmdDown}{\void}
 


@@ -393,10 +396,12 @@ Returns true if the left mouse button changed to down.
 Returns true if the left mouse button is currently down, independent
 of the current event type.
 
 Returns true if the left mouse button is currently down, independent
 of the current event type.
 

-Please notice that it is {\bf not} the same as
-\helpref{LeftDown}{wxmouseeventleftdown} which returns true if the left mouse
-button was just pressed. Rather, it describes the state of the mouse button
-before the event happened.
+Please notice that it is \emph{not} the same as 
+\helpref{LeftDown}{wxmouseeventleftdown} which returns \true if the event was
+generated by the left mouse button being pressed. Rather, it simply describes
+the state of the left mouse button at the time when the event was generated
+(so while it will be true for a left click event, it can also be true for
+a right click if it happened while the left mouse button was pressed).

 
 This event is usually used in the mouse event handlers which process "move
 mouse" messages to determine whether the user is (still) dragging the mouse.
 
 This event is usually used in the mouse event handlers which process "move
 mouse" messages to determine whether the user is (still) dragging the mouse.