Fixed compile errors, warnings and other DSMs, and improved comments.

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

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index 05ea9878c8c8c6443b966e0a2e66ebd1344e88f5..a29e7d55e145586e767e3a3093691c34da07516a 100644 (file)
--- a/docs/latex/wx/mouseevt.tex
+++ b/docs/latex/wx/mouseevt.tex
@@ -3,6 +3,26 @@
 This event class contains information about mouse events.
 See \helpref{wxWindow::OnMouseEvent}{wxwindowonmouseevent}.
 
 This event class contains information about mouse events.
 See \helpref{wxWindow::OnMouseEvent}{wxwindowonmouseevent}.
 

+{\bf NB: } Note that under Windows mouse enter and leave events are not natively supported
+by the system but are generated by wxWindows 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
+time.
+
+{\bf NB: } Note the difference between methods like
+\helpref{LeftDown}{wxmouseeventleftdown} and
+\helpref{LeftIsDown}{wxmouseeventleftisdown}: the formet returns {\tt TRUE}
+when the event corresponds to the left mouse button click while the latter
+returns {\tt TRUE} if the left mouse button is currently being pressed. For
+example, when the user is dragging the mouse you can use
+\helpref{LeftIsDown}{wxmouseeventleftisdown} to test
+whether the left mouse button is (still) depressed. Also, by convention, if
+\helpref{LeftDown}{wxmouseeventleftdown} returns {\tt TRUE},
+\helpref{LeftIsDown}{wxmouseeventleftisdown} will also return {\tt TRUE} in
+wxWindows whatever the underlying GUI behaviour is (which is
+platform-dependent). The same applies, of course, to other mouse buttons as
+well.
+

 \wxheading{Derived from}
 
 \helpref{wxEvent}{wxevent}
 \wxheading{Derived from}
 
 \helpref{wxEvent}{wxevent}


@@ -30,6 +50,7 @@ functions that take a wxMouseEvent argument.
 \twocolitem{{\bf EVT\_MOTION(func)}}{Process a wxEVT\_MOTION event.}
 \twocolitem{{\bf EVT\_ENTER\_WINDOW(func)}}{Process a wxEVT\_ENTER\_WINDOW event.}
 \twocolitem{{\bf EVT\_LEAVE\_WINDOW(func)}}{Process a wxEVT\_LEAVE\_WINDOW event.}
 \twocolitem{{\bf EVT\_MOTION(func)}}{Process a wxEVT\_MOTION event.}
 \twocolitem{{\bf EVT\_ENTER\_WINDOW(func)}}{Process a wxEVT\_ENTER\_WINDOW event.}
 \twocolitem{{\bf EVT\_LEAVE\_WINDOW(func)}}{Process a wxEVT\_LEAVE\_WINDOW event.}

+\twocolitem{{\bf EVT\_MOUSEWHEEL(func)}}{Process a wxEVT\_MOUSEWHEEL event.}

 \twocolitem{{\bf EVT\_MOUSE\_EVENTS(func)}}{Process all mouse events.}
 \end{twocollist}%
 
 \twocolitem{{\bf EVT\_MOUSE\_EVENTS(func)}}{Process all mouse events.}
 \end{twocollist}%
 


@@ -65,12 +86,6 @@ TRUE if the middle mouse button is currently pressed down.
 
 TRUE if the right mouse button is currently pressed down.
 
 
 TRUE if the right mouse button is currently pressed down.
 

-\membersection{wxMouseEvent::m\_leftDown}
-
-\member{bool}{m\_leftDown}
-
-TRUE if the left mouse button is currently pressed down.
-

 \membersection{wxMouseEvent::m\_metaDown}
 
 \member{bool}{m\_metaDown}
 \membersection{wxMouseEvent::m\_metaDown}
 
 \member{bool}{m\_metaDown}


@@ -85,16 +100,36 @@ TRUE if shift is pressed down.
 
 \membersection{wxMouseEvent::m\_x}
 
 
 \membersection{wxMouseEvent::m\_x}
 

-\member{float}{m\_x}
+\member{long}{m\_x}

 
 X-coordinate of the event.
 
 \membersection{wxMouseEvent::m\_y}
 
 
 X-coordinate of the event.
 
 \membersection{wxMouseEvent::m\_y}
 

-\member{float}{m\_y}
+\member{long}{m\_y}

 
 Y-coordinate of the event.
 
 
 Y-coordinate of the event.
 

+\membersection{wxMouseEvent::m\_wheelRotation}
+
+\member{int}{m\_wheelRotation}
+
+The distance the mouse wheel is rotated.
+
+\membersection{wxMouseEvent::m\_wheelDelta}
+
+\member{int}{m\_wheelDelta}
+
+The wheel delta, normally 120.
+
+\membersection{wxMouseEvent::m\_linesPerAction}
+
+\member{int}{m\_linesPerAction}
+
+The configured number of lines (or whatever) to be scrolled per wheel
+action.
+
+

 \membersection{wxMouseEvent::wxMouseEvent}
 
 \func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}, \param{int}{ id = 0}}
 \membersection{wxMouseEvent::wxMouseEvent}
 
 \func{}{wxMouseEvent}{\param{WXTYPE}{ mouseEventType = 0}, \param{int}{ id = 0}}


@@ -115,6 +150,7 @@ Constructor. Valid event types are:
 \item {\bf wxEVT\_RIGHT\_UP}
 \item {\bf wxEVT\_RIGHT\_DCLICK}
 \item {\bf wxEVT\_MOTION}
 \item {\bf wxEVT\_RIGHT\_UP}
 \item {\bf wxEVT\_RIGHT\_DCLICK}
 \item {\bf wxEVT\_MOTION}

+\item {\bf wxEVT\_MOUSEWHEEL}

 \end{itemize}
 
 \membersection{wxMouseEvent::AltDown}
 \end{itemize}
 
 \membersection{wxMouseEvent::AltDown}


@@ -174,158 +210,182 @@ Returns TRUE if this was a dragging event (motion while a button is depressed).
 
 \func{bool}{Entering}{\void}
 
 
 \func{bool}{Entering}{\void}
 

-Returns TRUE if the mouse was entering the window (MS Windows and Motif).
+Returns TRUE if the mouse was entering the window.

 
 See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.
 
 
 See also \helpref{wxMouseEvent::Leaving}{wxmouseeventleaving}.
 

+\membersection{wxMouseEvent::GetPosition}\label{wxmouseeventgetposition}
+
+\constfunc{wxPoint}{GetPosition}{\void}
+
+\constfunc{void}{GetPosition}{\param{wxCoord*}{ x}, \param{wxCoord*}{ y}}
+
+\constfunc{void}{GetPosition}{\param{long*}{ x}, \param{long*}{ y}}
+
+Sets *x and *y to the position at which the event occurred.
+
+Returns the physical mouse position in pixels.
+
+\membersection{wxMouseEvent::GetLogicalPosition}\label{wxmouseeventgetlogicalposition}
+
+\constfunc{wxPoint}{GetLogicalPosition}{\param{const wxDC\&}{ dc}}
+
+Returns the logical mouse position in pixels (i.e. translated according to the
+translation set for the DC, which usually indicates that the window has been scrolled).
+
+
+\membersection{wxMouseEvent::GetLinesPerAction}\label{wxmouseeventgetlinesperaction}
+
+\constfunc{int}{GetLinesPerAction}{\void}
+
+Returns the configured number of lines (or whatever) to be scrolled per
+wheel action.  Defaults to three.
+
+\membersection{wxMouseEvent::GetWheelRotation}\label{wxmouseeventgetwheelrotation}
+
+\constfunc{int}{GetWheelRotation}{\void}
+
+Get wheel rotation, positive or negative indicates direction of
+rotation.  Current devices all send an event when rotation is equal to
++/-WheelDelta, but this allows for finer resolution devices to be
+created in the future.  Because of this you shouldn't assume that one
+event is equal to 1 line or whatever, but you should be able to either
+do partial line scrolling or wait until +/-WheelDelta rotation values
+have been accumulated before scrolling.
+
+\membersection{wxMouseEvent::GetWheelDelta}\label{wxmouseeventgetwheeldelta}
+
+\constfunc{int}{GetWheelDelta}{\void}
+
+Get wheel delta, normally 120.  This is the threshold for action to be
+taken, and one such action (for example, scrolling one increment)
+should occur for each delta.
+

 \membersection{wxMouseEvent::GetX}\label{wxmouseeventgetx}
 
 \membersection{wxMouseEvent::GetX}\label{wxmouseeventgetx}
 

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

 
 

-Returns X coordinate of the mouse event position.
+Returns X coordinate of the physical mouse event position.

 
 \membersection{wxMouseEvent::GetY}\label{wxmouseeventgety}
 
 
 \membersection{wxMouseEvent::GetY}\label{wxmouseeventgety}
 

-\func{float}{GetY}{\void}
+\func{long}{GetY}{\void}

 
 

-Returns Y coordinate of the mouse event position.
+Returns Y coordinate of the physical mouse event position.

 
 \membersection{wxMouseEvent::IsButton}
 
 
 \membersection{wxMouseEvent::IsButton}
 

-\func{bool}{IsButton}{\void}
+\constfunc{bool}{IsButton}{\void}

 
 Returns TRUE if the event was a mouse button event (not necessarily a button down event -
 that may be tested using {\it ButtonDown}).
 
 \membersection{wxMouseEvent::Leaving}\label{wxmouseeventleaving}
 
 
 Returns TRUE if the event was a mouse button event (not necessarily a button down event -
 that may be tested using {\it ButtonDown}).
 
 \membersection{wxMouseEvent::Leaving}\label{wxmouseeventleaving}
 

-\func{bool}{Leaving}{\void}
+\constfunc{bool}{Leaving}{\void}

 
 

-Returns TRUE if the mouse was leaving the window (MS Windows and Motif).
+Returns TRUE if the mouse was leaving the window.

 
 See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.
 
 \membersection{wxMouseEvent::LeftDClick}
 
 
 See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.
 
 \membersection{wxMouseEvent::LeftDClick}
 

-\func{bool}{LeftDClick}{\void}
+\constfunc{bool}{LeftDClick}{\void}

 
 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}

 
 

-\func{bool}{LeftDown}{\void}
+\constfunc{bool}{LeftDown}{\void}

 
 Returns TRUE if the left mouse button changed to down.
 
 
 Returns TRUE if the left mouse button changed to down.
 

-\membersection{wxMouseEvent::LeftIsDown}
+\membersection{wxMouseEvent::LeftIsDown}\label{wxmouseeventleftisdown}

 
 

-\func{bool}{LeftIsDown}{\void}
+\constfunc{bool}{LeftIsDown}{\void}

 
 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}
 
 \membersection{wxMouseEvent::LeftUp}
 

-\func{bool}{LeftUp}{\void}
+\constfunc{bool}{LeftUp}{\void}

 
 Returns TRUE if the left mouse button changed to up.
 
 \membersection{wxMouseEvent::MetaDown}
 
 
 Returns TRUE if the left mouse button changed to up.
 
 \membersection{wxMouseEvent::MetaDown}
 

-\func{bool}{MetaDown}{\void}
+\constfunc{bool}{MetaDown}{\void}

 
 Returns TRUE if the Meta key was down at the time of the event.
 
 \membersection{wxMouseEvent::MiddleDClick}
 
 
 Returns TRUE if the Meta key was down at the time of the event.
 
 \membersection{wxMouseEvent::MiddleDClick}
 

-\func{bool}{MiddleDClick}{\void}
+\constfunc{bool}{MiddleDClick}{\void}

 
 Returns TRUE if the event was a middle double click.
 
 \membersection{wxMouseEvent::MiddleDown}
 
 
 Returns TRUE if the event was a middle double click.
 
 \membersection{wxMouseEvent::MiddleDown}
 

-\func{bool}{MiddleDown}{\void}
+\constfunc{bool}{MiddleDown}{\void}

 
 Returns TRUE if the middle mouse button changed to down.
 
 
 Returns TRUE if the middle mouse button changed to down.
 

-\membersection{wxMouseEvent::MiddleIsDown}
+\membersection{wxMouseEvent::MiddleIsDown}\label{wxmouseeventmiddleisdown}

 
 

-\func{bool}{MiddleIsDown}{\void}
+\constfunc{bool}{MiddleIsDown}{\void}

 
 Returns TRUE if the middle mouse button is currently down, independent
 of the current event type.
 
 \membersection{wxMouseEvent::MiddleUp}
 
 
 Returns TRUE if the middle mouse button is currently down, independent
 of the current event type.
 
 \membersection{wxMouseEvent::MiddleUp}
 

-\func{bool}{MiddleUp}{\void}
+\constfunc{bool}{MiddleUp}{\void}

 
 Returns TRUE if the middle mouse button changed to up.
 
 \membersection{wxMouseEvent::Moving}
 
 
 Returns TRUE if the middle mouse button changed to up.
 
 \membersection{wxMouseEvent::Moving}
 

-\func{bool}{Moving}{\void}
+\constfunc{bool}{Moving}{\void}

 
 Returns TRUE if this was a motion event (no buttons depressed).
 
 
 Returns TRUE if this was a motion event (no buttons depressed).
 

-\membersection{wxMouseEvent::Position}
-
-\func{void}{Position}{\param{float *}{x}, \param{float *}{y}}
-
-Sets *x and *y to the position at which the event occurred. If the
-window is a window, the position is converted to logical units
-(according to the current mapping mode) with scrolling taken into
-account. To get back to device units (for example to calculate where on the
-screen to place a dialog box associated with a window mouse event), use
-\rtfsp{\bf wxDC::LogicalToDeviceX} and {\bf wxDC::LogicalToDeviceY}.
-
-For example, the following code calculates screen pixel coordinates
-from the frame position, window view start (assuming the window is the only
-subwindow on the frame and therefore at the top left of it), and the
-logical event position. A menu is popped up at the position where the
-mouse click occurred. (Note that the application should also check that
-the dialog box will be visible on the screen, since the click could have
-occurred near the screen edge!)
-
-\begin{verbatim}
-  float event_x, event_y;
-  event.Position(&event_x, &event_y);
-  frame->GetPosition(&x, &y);
-  window->ViewStart(&x1, &y1);
-  int mouse_x = (int)(window->GetDC()->LogicalToDeviceX(event_x + x - x1);
-  int mouse_y = (int)(window->GetDC()->LogicalToDeviceY(event_y + y - y1);
-
-  char *choice = wxGetSingleChoice("Menu", "Pick a node action",
-                                 no_choices, choices, frame, mouse_x, mouse_y);
-\end{verbatim}
-

 \membersection{wxMouseEvent::RightDClick}
 
 \membersection{wxMouseEvent::RightDClick}
 

-\func{bool}{RightDClick}{\void}
+\constfunc{bool}{RightDClick}{\void}

 
 Returns TRUE if the event was a right double click.
 
 \membersection{wxMouseEvent::RightDown}
 
 
 Returns TRUE if the event was a right double click.
 
 \membersection{wxMouseEvent::RightDown}
 

-\func{bool}{RightDown}{\void}
+\constfunc{bool}{RightDown}{\void}

 
 Returns TRUE if the right mouse button changed to down.
 
 
 Returns TRUE if the right mouse button changed to down.
 

-\membersection{wxMouseEvent::RightIsDown}
+\membersection{wxMouseEvent::RightIsDown}\label{wxmouseeventrightisdown}

 
 

-\func{bool}{RightIsDown}{\void}
+\constfunc{bool}{RightIsDown}{\void}

 
 Returns TRUE if the right mouse button is currently down, independent
 of the current event type.
 
 \membersection{wxMouseEvent::RightUp}
 
 
 Returns TRUE if the right mouse button is currently down, independent
 of the current event type.
 
 \membersection{wxMouseEvent::RightUp}
 

-\func{bool}{RightUp}{\void}
+\constfunc{bool}{RightUp}{\void}

 
 Returns TRUE if the right mouse button changed to up.
 
 \membersection{wxMouseEvent::ShiftDown}
 
 
 Returns TRUE if the right mouse button changed to up.
 
 \membersection{wxMouseEvent::ShiftDown}
 

-\func{bool}{ShiftDown}{\void}
+\constfunc{bool}{ShiftDown}{\void}

 
 Returns TRUE if the shift key was down at the time of the event.
 
 
 Returns TRUE if the shift key was down at the time of the event.