explained (?) difference between LeftDown and LeftIsDown

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2712 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index ca61af25f75fbeaf94b874e6ef6a3063ee0422f9..0c112ef708e8ca0bebdcdc486b246558f1432c50 100644 (file)
--- a/docs/latex/wx/mouseevt.tex
+++ b/docs/latex/wx/mouseevt.tex
@@ -228,7 +228,7 @@ See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.
 
 Returns TRUE if the event was a left double click.
 
 
 Returns TRUE if the event was a left double click.
 

-\membersection{wxMouseEvent::LeftDown}
+\membersection{wxMouseEvent::LeftDown}\label{wxmouseeventleftdown}

 
 \constfunc{bool}{LeftDown}{\void}
 
 
 \constfunc{bool}{LeftDown}{\void}
 


@@ -241,6 +241,14 @@ 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.
+
+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.
+

 \membersection{wxMouseEvent::LeftUp}
 
 \constfunc{bool}{LeftUp}{\void}
 \membersection{wxMouseEvent::LeftUp}
 
 \constfunc{bool}{LeftUp}{\void}