Added parent window parameter to wxHelpController constructor

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

diff --git a/docs/latex/wx/mouseevt.tex b/docs/latex/wx/mouseevt.tex
index e7078931bd9470ec4989560e3d7fa6d09c8e761a..f9271e8a6d84951fed946b949ac34d1a23147fa1 100644 (file)
--- a/docs/latex/wx/mouseevt.tex
+++ b/docs/latex/wx/mouseevt.tex
@@ -9,8 +9,8 @@ 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
-by the system but are generated by wxWindows itself. This has several
+{\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
 time.
@@ -25,7 +25,7 @@ example, when the user is dragging the mouse you can use
 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
+wxWidgets whatever the underlying GUI behaviour is (which is
 platform-dependent). The same applies, of course, to other mouse buttons as
 well.
 
@@ -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.}
@@ -63,84 +66,84 @@ functions that take a wxMouseEvent argument.
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
-\membersection{wxMouseEvent::m\_altDown}
+\membersection{wxMouseEvent::m\_altDown}\label{wxmouseeventmaltdown}
 
 \member{bool}{m\_altDown}
 
 true if the Alt key is pressed down.
 
 
-\membersection{wxMouseEvent::m\_controlDown}
+\membersection{wxMouseEvent::m\_controlDown}\label{wxmouseeventmcontroldown}
 
 \member{bool}{m\_controlDown}
 
 true if control key is pressed down.
 
 
-\membersection{wxMouseEvent::m\_leftDown}
+\membersection{wxMouseEvent::m\_leftDown}\label{wxmouseeventmleftdown}
 
 \member{bool}{m\_leftDown}
 
 true if the left mouse button is currently pressed down.
 
 
-\membersection{wxMouseEvent::m\_middleDown}
+\membersection{wxMouseEvent::m\_middleDown}\label{wxmouseeventmmiddledown}
 
 \member{bool}{m\_middleDown}
 
 true if the middle mouse button is currently pressed down.
 
 
-\membersection{wxMouseEvent::m\_rightDown}
+\membersection{wxMouseEvent::m\_rightDown}\label{wxmouseeventmrightdown}
 
 \member{bool}{m\_rightDown}
 
 true if the right mouse button is currently pressed down.
 
 
-\membersection{wxMouseEvent::m\_metaDown}
+\membersection{wxMouseEvent::m\_metaDown}\label{wxmouseeventmmetadown}
 
 \member{bool}{m\_metaDown}
 
 true if the Meta key is pressed down.
 
 
-\membersection{wxMouseEvent::m\_shiftDown}
+\membersection{wxMouseEvent::m\_shiftDown}\label{wxmouseeventmshiftdown}
 
 \member{bool}{m\_shiftDown}
 
 true if shift is pressed down.
 
 
-\membersection{wxMouseEvent::m\_x}
+\membersection{wxMouseEvent::m\_x}\label{wxmouseeventmx}
 
 \member{long}{m\_x}
 
 X-coordinate of the event.
 
 
-\membersection{wxMouseEvent::m\_y}
+\membersection{wxMouseEvent::m\_y}\label{wxmouseeventmy}
 
 \member{long}{m\_y}
 
 Y-coordinate of the event.
 
 
-\membersection{wxMouseEvent::m\_wheelRotation}
+\membersection{wxMouseEvent::m\_wheelRotation}\label{wxmouseeventmwheelrotation}
 
 \member{int}{m\_wheelRotation}
 
 The distance the mouse wheel is rotated.
 
 
-\membersection{wxMouseEvent::m\_wheelDelta}
+\membersection{wxMouseEvent::m\_wheelDelta}\label{wxmouseeventmwheeldelta}
 
 \member{int}{m\_wheelDelta}
 
 The wheel delta, normally $120$.
 
 
-\membersection{wxMouseEvent::m\_linesPerAction}
+\membersection{wxMouseEvent::m\_linesPerAction}\label{wxmouseeventmlinesperaction}
 
 \member{int}{m\_linesPerAction}
 
@@ -149,9 +152,9 @@ action.
 
 
 
-\membersection{wxMouseEvent::wxMouseEvent}
+\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:
 
@@ -173,7 +176,7 @@ Constructor. Valid event types are:
 \end{itemize}
 
 
-\membersection{wxMouseEvent::AltDown}
+\membersection{wxMouseEvent::AltDown}\label{wxmouseeventaltdown}
 
 \func{bool}{AltDown}{\void}
 
@@ -189,13 +192,13 @@ 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}
 
 
-\membersection{wxMouseEvent::ButtonDClick}
+\membersection{wxMouseEvent::ButtonDClick}\label{wxmouseeventbuttondclick}
 
 \func{bool}{ButtonDClick}{\param{int}{ but = wxMOUSE\_BTN\_ANY}}
 
@@ -205,7 +208,7 @@ was generated (see \helpref{Button}{wxmouseeventbutton} for the possible
 values).
 
 
-\membersection{wxMouseEvent::ButtonDown}
+\membersection{wxMouseEvent::ButtonDown}\label{wxmouseeventbuttondown}
 
 \func{bool}{ButtonDown}{\param{int}{ but = -1}}
 
@@ -216,7 +219,7 @@ values).
 
 
 
-\membersection{wxMouseEvent::ButtonUp}
+\membersection{wxMouseEvent::ButtonUp}\label{wxmouseeventbuttonup}
 
 \func{bool}{ButtonUp}{\param{int}{ but = -1}}
 
@@ -227,7 +230,19 @@ values).
 
 
 
-\membersection{wxMouseEvent::ControlDown}
+\membersection{wxMouseEvent::CmdDown}\label{wxmouseeventcmddown}
+
+\constfunc{bool}{CmdDown}{\void}
+
+Same as \helpref{MetaDown}{wxmouseeventmetadown} under Mac, same as 
+\helpref{ControlDown}{wxmouseeventcontroldown} elsewhere.
+
+\wxheading{See also}
+
+\helpref{wxKeyEvent::CmdDown}{wxkeyeventcmddown}
+
+
+\membersection{wxMouseEvent::ControlDown}\label{wxmouseeventcontroldown}
 
 \func{bool}{ControlDown}{\void}
 
@@ -277,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}
 
@@ -331,7 +350,7 @@ Returns X coordinate of the physical mouse event position.
 Returns Y coordinate of the physical mouse event position.
 
 
-\membersection{wxMouseEvent::IsButton}
+\membersection{wxMouseEvent::IsButton}\label{wxmouseeventisbutton}
 
 \constfunc{bool}{IsButton}{\void}
 
@@ -339,7 +358,7 @@ Returns true if the event was a mouse button event (not necessarily a button dow
 that may be tested using {\it ButtonDown}).
 
 
-\membersection{wxMouseEvent::IsPageScroll}
+\membersection{wxMouseEvent::IsPageScroll}\label{wxmouseeventispagescroll}
 
 \constfunc{bool}{IsPageScroll}{\void}
 
@@ -356,7 +375,7 @@ Returns true if the mouse was leaving the window.
 See also \helpref{wxMouseEvent::Entering}{wxmouseevententering}.
 
 
-\membersection{wxMouseEvent::LeftDClick}
+\membersection{wxMouseEvent::LeftDClick}\label{wxmouseeventleftdclick}
 
 \constfunc{bool}{LeftDClick}{\void}
 
@@ -386,28 +405,28 @@ 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}\label{wxmouseeventleftup}
 
 \constfunc{bool}{LeftUp}{\void}
 
 Returns true if the left mouse button changed to up.
 
 
-\membersection{wxMouseEvent::MetaDown}
+\membersection{wxMouseEvent::MetaDown}\label{wxmouseeventmetadown}
 
 \constfunc{bool}{MetaDown}{\void}
 
 Returns true if the Meta key was down at the time of the event.
 
 
-\membersection{wxMouseEvent::MiddleDClick}
+\membersection{wxMouseEvent::MiddleDClick}\label{wxmouseeventmiddledclick}
 
 \constfunc{bool}{MiddleDClick}{\void}
 
 Returns true if the event was a middle double click.
 
 
-\membersection{wxMouseEvent::MiddleDown}
+\membersection{wxMouseEvent::MiddleDown}\label{wxmouseeventmiddledown}
 
 \constfunc{bool}{MiddleDown}{\void}
 
@@ -422,7 +441,7 @@ Returns true if the middle mouse button is currently down, independent
 of the current event type.
 
 
-\membersection{wxMouseEvent::MiddleUp}
+\membersection{wxMouseEvent::MiddleUp}\label{wxmouseeventmiddleup}
 
 \constfunc{bool}{MiddleUp}{\void}
 
@@ -438,14 +457,14 @@ If any mouse button is held pressed, then this method returns \false and
 \helpref{Dragging}{wxmouseeventdragging} returns \true.
 
 
-\membersection{wxMouseEvent::RightDClick}
+\membersection{wxMouseEvent::RightDClick}\label{wxmouseeventrightdclick}
 
 \constfunc{bool}{RightDClick}{\void}
 
 Returns true if the event was a right double click.
 
 
-\membersection{wxMouseEvent::RightDown}
+\membersection{wxMouseEvent::RightDown}\label{wxmouseeventrightdown}
 
 \constfunc{bool}{RightDown}{\void}
 
@@ -460,14 +479,14 @@ Returns true if the right mouse button is currently down, independent
 of the current event type.
 
 
-\membersection{wxMouseEvent::RightUp}
+\membersection{wxMouseEvent::RightUp}\label{wxmouseeventrightup}
 
 \constfunc{bool}{RightUp}{\void}
 
 Returns true if the right mouse button changed to up.
 
 
-\membersection{wxMouseEvent::ShiftDown}
+\membersection{wxMouseEvent::ShiftDown}\label{wxmouseeventshiftdown}
 
 \constfunc{bool}{ShiftDown}{\void}