mention Watcom makefile for wxBase

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

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index eff02f8b6d0907b66b62f0ffe0ae6abc2f8acf9c..49553b95021d7c808df74d7cffbec5daefd91acf 100644 (file)
--- a/docs/latex/wx/mouseevt.tex
+++ b/docs/latex/wx/mouseevt.tex
@@ -1,24 +1,29 @@
 \section{\class{wxMouseEvent}}\label{wxmouseevent}
 
 \section{\class{wxMouseEvent}}\label{wxmouseevent}
 

-This event class contains information about mouse events.
-See \helpref{wxWindow::OnMouseEvent}{wxwindowonmouseevent}.
+This event class contains information about the events generated by the mouse:
+they include mouse buttons press and release events and mouse move events.

 
 

-{\bf NB: } Note that under Windows mouse enter and leave events are not natively supported
+All mouse events involving the buttons use $1$ for the left mouse button, $2$
+for the middle one and $3$ for the right one. Note that not all mice have
+a 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

 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.
 
 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
+{\bf NB:} Note the difference between methods like

 \helpref{LeftDown}{wxmouseeventleftdown} and
 \helpref{LeftDown}{wxmouseeventleftdown} and

-\helpref{LeftIsDown}{wxmouseeventleftisdown}: the formet returns {\tt TRUE}
+\helpref{LeftIsDown}{wxmouseeventleftisdown}: the former returns {\tt true}

 when the event corresponds to the left mouse button click while the latter
 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
+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
 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
+\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.
 wxWindows whatever the underlying GUI behaviour is (which is
 platform-dependent). The same applies, of course, to other mouse buttons as
 well.


@@ -60,43 +65,43 @@ functions that take a wxMouseEvent argument.
 
 \member{bool}{m\_altDown}
 
 
 \member{bool}{m\_altDown}
 

-TRUE if the Alt key is pressed down.
+true if the Alt key is pressed down.

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

-TRUE if control key is pressed down.
+true if control key is pressed down.

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

-TRUE if the left mouse button is currently pressed down.
+true if the left mouse button is currently pressed down.

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

-TRUE if the middle mouse button is currently pressed down.
+true if the middle mouse button is currently pressed down.

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

-TRUE if the right mouse button is currently pressed down.
+true if the right mouse button is currently pressed down.

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

-TRUE if the Meta key is pressed down.
+true if the Meta key is pressed down.

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

-TRUE if shift is pressed down.
+true if shift is pressed down.

 
 \membersection{wxMouseEvent::m\_x}
 
 
 \membersection{wxMouseEvent::m\_x}
 


@@ -157,24 +162,21 @@ Constructor. Valid event types are:
 
 \func{bool}{AltDown}{\void}
 
 
 \func{bool}{AltDown}{\void}
 

-Returns TRUE if the Alt key was down at the time of the event.
+Returns true if the Alt key was down at the time of the event.

 
 \membersection{wxMouseEvent::Button}
 
 \func{bool}{Button}{\param{int}{ button}}
 
 
 \membersection{wxMouseEvent::Button}
 
 \func{bool}{Button}{\param{int}{ button}}
 

-Returns TRUE if the identified mouse button is changing state. Valid
+Returns true if the identified mouse button is changing state. Valid

 values of {\it button} are 1, 2 or 3 for left, middle and right
 buttons respectively.
 
 values of {\it button} are 1, 2 or 3 for left, middle and right
 buttons respectively.
 

-Not all mice have middle buttons so a portable application should avoid
-this one.
-

 \membersection{wxMouseEvent::ButtonDClick}\label{buttondclick}
 
 \func{bool}{ButtonDClick}{\param{int}{ but = -1}}
 
 \membersection{wxMouseEvent::ButtonDClick}\label{buttondclick}
 
 \func{bool}{ButtonDClick}{\param{int}{ but = -1}}
 

-If the argument is omitted, this returns TRUE if the event was a mouse
+If the argument is omitted, this returns true if the event was a mouse

 double click event. Otherwise the argument specifies which double click event
 was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 double click event. Otherwise the argument specifies which double click event
 was generated (1, 2 or 3 for left, middle and right buttons respectively).
 


@@ -182,7 +184,7 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 \func{bool}{ButtonDown}{\param{int}{ but = -1}}
 
 
 \func{bool}{ButtonDown}{\param{int}{ but = -1}}
 

-If the argument is omitted, this returns TRUE if the event was a mouse
+If the argument is omitted, this returns true if the event was a mouse

 button down event. Otherwise the argument specifies which button-down event
 was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 button down event. Otherwise the argument specifies which button-down event
 was generated (1, 2 or 3 for left, middle and right buttons respectively).
 


@@ -190,7 +192,7 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 \func{bool}{ButtonUp}{\param{int}{ but = -1}}
 
 
 \func{bool}{ButtonUp}{\param{int}{ but = -1}}
 

-If the argument is omitted, this returns TRUE if the event was a mouse
+If the argument is omitted, this returns true if the event was a mouse

 button up event. Otherwise the argument specifies which button-up event
 was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 button up event. Otherwise the argument specifies which button-up event
 was generated (1, 2 or 3 for left, middle and right buttons respectively).
 


@@ -198,22 +200,31 @@ was generated (1, 2 or 3 for left, middle and right buttons respectively).
 
 \func{bool}{ControlDown}{\void}
 
 
 \func{bool}{ControlDown}{\void}
 

-Returns TRUE if the control key was down at the time of the event.
+Returns true if the control key was down at the time of the event.

 
 \membersection{wxMouseEvent::Dragging}
 
 \func{bool}{Dragging}{\void}
 
 
 \membersection{wxMouseEvent::Dragging}
 
 \func{bool}{Dragging}{\void}
 

-Returns TRUE if this was a dragging event (motion while a button is depressed).
+Returns true if this was a dragging event (motion while a button is depressed).

 
 \membersection{wxMouseEvent::Entering}\label{wxmouseevententering}
 
 \func{bool}{Entering}{\void}
 
 
 \membersection{wxMouseEvent::Entering}\label{wxmouseevententering}
 
 \func{bool}{Entering}{\void}
 

-Returns TRUE if the mouse was entering the window.
+Returns true if the mouse was entering the window.

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

+\membersection{wxMouseEvent::GetButton}\label{wxmouseeventgetbutton}
+
+\constfunc{int}{GetButton}{\void}
+
+Returns the mouse button which generated this event or $-1$ if no button is
+involved (for mouse move, enter or leave event, for example). The value $1$ is
+returned for the left button down, up and double click events, $2$ and $3$ for
+the same events for the middle and the right buttons respectively.
+

 \membersection{wxMouseEvent::GetPosition}\label{wxmouseeventgetposition}
 
 \constfunc{wxPoint}{GetPosition}{\void}
 \membersection{wxMouseEvent::GetPosition}\label{wxmouseeventgetposition}
 
 \constfunc{wxPoint}{GetPosition}{\void}


@@ -239,7 +250,7 @@ translation set for the DC, which usually indicates that the window has been scr
 \constfunc{int}{GetLinesPerAction}{\void}
 
 Returns the configured number of lines (or whatever) to be scrolled per
 \constfunc{int}{GetLinesPerAction}{\void}
 
 Returns the configured number of lines (or whatever) to be scrolled per

-wheel action.  Defaults to one.
+wheel action.  Defaults to three.

 
 \membersection{wxMouseEvent::GetWheelRotation}\label{wxmouseeventgetwheelrotation}
 
 
 \membersection{wxMouseEvent::GetWheelRotation}\label{wxmouseeventgetwheelrotation}
 


@@ -277,14 +288,21 @@ Returns Y coordinate of the physical mouse event position.
 
 \constfunc{bool}{IsButton}{\void}
 
 
 \constfunc{bool}{IsButton}{\void}
 

-Returns TRUE if the event was a mouse button event (not necessarily a button down event -
+Returns true if the event was a mouse button event (not necessarily a button down event -

 that may be tested using {\it ButtonDown}).
 
 that may be tested using {\it ButtonDown}).
 

+\membersection{wxMouseEvent::IsPageScroll}
+
+\constfunc{bool}{IsPageScroll}{\void}
+
+Returns true if the system has been setup to do page scrolling with
+the mouse wheel instead of line scrolling.
+

 \membersection{wxMouseEvent::Leaving}\label{wxmouseeventleaving}
 
 \constfunc{bool}{Leaving}{\void}
 
 \membersection{wxMouseEvent::Leaving}\label{wxmouseeventleaving}
 
 \constfunc{bool}{Leaving}{\void}
 

-Returns TRUE if the mouse was leaving the window.
+Returns true if the mouse was leaving the window.

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


@@ -292,23 +310,23 @@ See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.
 
 \constfunc{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}\label{wxmouseeventleftdown}
 
 \constfunc{bool}{LeftDown}{\void}
 
 
 \membersection{wxMouseEvent::LeftDown}\label{wxmouseeventleftdown}
 
 \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}\label{wxmouseeventleftisdown}
 
 \constfunc{bool}{LeftIsDown}{\void}
 
 
 \membersection{wxMouseEvent::LeftIsDown}\label{wxmouseeventleftisdown}
 
 \constfunc{bool}{LeftIsDown}{\void}
 

-Returns TRUE if the left mouse button is currently down, independent
+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
 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
+\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.
 
 button was just pressed. Rather, it describes the state of the mouse button
 before the event happened.
 


@@ -319,73 +337,73 @@ mouse" messages to determine whether the user is (still) dragging the mouse.
 
 \constfunc{bool}{LeftUp}{\void}
 
 
 \constfunc{bool}{LeftUp}{\void}
 

-Returns TRUE if the left mouse button changed to up.
+Returns true if the left mouse button changed to up.

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

-Returns TRUE if the Meta key was down at the time of the event.
+Returns true if the Meta key was down at the time of the event.

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

-Returns TRUE if the event was a middle double click.
+Returns true if the event was a middle double click.

 
 \membersection{wxMouseEvent::MiddleDown}
 
 \constfunc{bool}{MiddleDown}{\void}
 
 
 \membersection{wxMouseEvent::MiddleDown}
 
 \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}\label{wxmouseeventmiddleisdown}
 
 \constfunc{bool}{MiddleIsDown}{\void}
 
 
 \membersection{wxMouseEvent::MiddleIsDown}\label{wxmouseeventmiddleisdown}
 
 \constfunc{bool}{MiddleIsDown}{\void}
 

-Returns TRUE if the middle mouse button is currently down, independent
+Returns true if the middle mouse button is currently down, independent

 of the current event type.
 
 \membersection{wxMouseEvent::MiddleUp}
 
 \constfunc{bool}{MiddleUp}{\void}
 
 of the current event type.
 
 \membersection{wxMouseEvent::MiddleUp}
 
 \constfunc{bool}{MiddleUp}{\void}
 

-Returns TRUE if the middle mouse button changed to up.
+Returns true if the middle mouse button changed to up.

 
 \membersection{wxMouseEvent::Moving}
 
 \constfunc{bool}{Moving}{\void}
 
 
 \membersection{wxMouseEvent::Moving}
 
 \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::RightDClick}
 
 \constfunc{bool}{RightDClick}{\void}
 
 
 \membersection{wxMouseEvent::RightDClick}
 
 \constfunc{bool}{RightDClick}{\void}
 

-Returns TRUE if the event was a right double click.
+Returns true if the event was a right double click.

 
 \membersection{wxMouseEvent::RightDown}
 
 \constfunc{bool}{RightDown}{\void}
 
 
 \membersection{wxMouseEvent::RightDown}
 
 \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}\label{wxmouseeventrightisdown}
 
 \constfunc{bool}{RightIsDown}{\void}
 
 
 \membersection{wxMouseEvent::RightIsDown}\label{wxmouseeventrightisdown}
 
 \constfunc{bool}{RightIsDown}{\void}
 

-Returns TRUE if the right mouse button is currently down, independent
+Returns true if the right mouse button is currently down, independent

 of the current event type.
 
 \membersection{wxMouseEvent::RightUp}
 
 \constfunc{bool}{RightUp}{\void}
 
 of the current event type.
 
 \membersection{wxMouseEvent::RightUp}
 
 \constfunc{bool}{RightUp}{\void}
 

-Returns TRUE if the right mouse button changed to up.
+Returns true if the right mouse button changed to up.

 
 \membersection{wxMouseEvent::ShiftDown}
 
 \constfunc{bool}{ShiftDown}{\void}
 
 
 \membersection{wxMouseEvent::ShiftDown}
 
 \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.