X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..2712e31795ee7ab4de62189b440d702f3f849c0d:/docs/latex/wx/joyevent.tex diff --git a/docs/latex/wx/joyevent.tex b/docs/latex/wx/joyevent.tex index 8f2e8b3ced..b45d47b63f 100644 --- a/docs/latex/wx/joyevent.tex +++ b/docs/latex/wx/joyevent.tex @@ -5,12 +5,17 @@ events received by windows. \wxheading{Derived from} -\helpref{wxEvent}{wxevent} +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Event table macros} To process a mouse event, use these event handler macros to direct input to member @@ -22,6 +27,7 @@ functions that take a wxJoystickEvent argument. \twocolitem{{\bf EVT\_JOY\_BUTTON\_UP(func)}}{Process a wxEVT\_JOY\_BUTTON\_UP event.} \twocolitem{{\bf EVT\_JOY\_MOVE(func)}}{Process a wxEVT\_JOY\_MOVE event.} \twocolitem{{\bf EVT\_JOY\_ZMOVE(func)}}{Process a wxEVT\_JOY\_ZMOVE event.} +\twocolitem{{\bf EVT\_JOYSTICK\_EVENTS(func)}}{Processes all joystick events.} \end{twocollist}% \wxheading{See also} @@ -30,7 +36,7 @@ functions that take a wxJoystickEvent argument. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxJoystickEvent::wxJoystickEvent} +\membersection{wxJoystickEvent::wxJoystickEvent}\label{wxjoystickeventctor} \func{}{wxJoystickEvent}{\param{WXTYPE}{ eventType = 0}, \param{int}{ state = 0}, \param{int}{ joystick = wxJOYSTICK1}, \param{int }{change = 0}} @@ -41,7 +47,7 @@ Constructor. \constfunc{bool}{ButtonDown}{\param{int}{ button = wxJOY\_BUTTON\_ANY}} -Returns TRUE if the event was a down event from the specified button (or any button). +Returns true if the event was a down event from the specified button (or any button). \wxheading{Parameters} @@ -52,7 +58,7 @@ indicate any button down event.} \constfunc{bool}{ButtonIsDown}{\param{int}{ button = wxJOY\_BUTTON\_ANY}} -Returns TRUE if the specified button (or any button) was in a down state. +Returns true if the specified button (or any button) was in a down state. \wxheading{Parameters} @@ -63,7 +69,7 @@ indicate any button down event.} \constfunc{bool}{ButtonUp}{\param{int}{ button = wxJOY\_BUTTON\_ANY}} -Returns TRUE if the event was an up event from the specified button (or any button). +Returns true if the event was an up event from the specified button (or any button). \wxheading{Parameters} @@ -106,17 +112,17 @@ Returns the z position of the joystick event. \constfunc{bool}{IsButton}{\void} -Returns TRUE if this was a button up or down event ({\it not} 'is any button down?'). +Returns true if this was a button up or down event ({\it not} 'is any button down?'). \membersection{wxJoystickEvent::IsMove}\label{wxjoystickeventismove} \constfunc{bool}{IsMove}{\void} -Returns TRUE if this was an x, y move event. +Returns true if this was an x, y move event. \membersection{wxJoystickEvent::IsZMove}\label{wxjoystickeventiszmove} \constfunc{bool}{IsZMove}{\void} -Returns TRUE if this was a z move event. +Returns true if this was a z move event.