X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fe604ccddcf5696a751892ad70dbc822be239c95..10ff9c616e00e4074dfdc2ac9e354605cc129c22:/docs/latex/wx/joyevent.tex?ds=sidebyside diff --git a/docs/latex/wx/joyevent.tex b/docs/latex/wx/joyevent.tex index f8da76cf65..b45d47b63f 100644 --- a/docs/latex/wx/joyevent.tex +++ b/docs/latex/wx/joyevent.tex @@ -5,7 +5,16 @@ 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} @@ -18,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} @@ -26,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}} @@ -37,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} @@ -48,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} @@ -59,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} @@ -102,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.