docs/latex/wx/joyevent.tex

   1 \section{\class{wxJoystickEvent}}\label{wxjoystickevent}
   2
   3 This event class contains information about mouse events, particularly
   4 events received by windows.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxEvent}{wxevent}
   9
  10 \wxheading{Include files}
  11
  12 <wx/event.h>
  13
  14 \wxheading{Library}
  15
  16 \helpref{wxCore}{librarieslist}
  17
  18 \wxheading{Event table macros}
  19
  20 To process a mouse event, use these event handler macros to direct input to member
  21 functions that take a wxJoystickEvent argument.
  22
  23 \twocolwidtha{7cm}
  24 \begin{twocollist}\itemsep=0pt
  25 \twocolitem{{\bf EVT\_JOY\_BUTTON\_DOWN(func)}}{Process a wxEVT\_JOY\_BUTTON\_DOWN event.}
  26 \twocolitem{{\bf EVT\_JOY\_BUTTON\_UP(func)}}{Process a wxEVT\_JOY\_BUTTON\_UP event.}
  27 \twocolitem{{\bf EVT\_JOY\_MOVE(func)}}{Process a wxEVT\_JOY\_MOVE event.}
  28 \twocolitem{{\bf EVT\_JOY\_ZMOVE(func)}}{Process a wxEVT\_JOY\_ZMOVE event.}
  29 \twocolitem{{\bf EVT\_JOYSTICK\_EVENTS(func)}}{Processes all joystick events.}
  30 \end{twocollist}%
  31
  32 \wxheading{See also}
  33
  34 \helpref{wxJoystick}{wxjoystick}
  35
  36 \latexignore{\rtfignore{\wxheading{Members}}}
  37
  38 \membersection{wxJoystickEvent::wxJoystickEvent}\label{wxjoystickeventctor}
  39
  40 \func{}{wxJoystickEvent}{\param{WXTYPE}{ eventType = 0}, \param{int}{ state = 0},
  41  \param{int}{ joystick = wxJOYSTICK1}, \param{int }{change = 0}}
  42
  43 Constructor.
  44
  45 \membersection{wxJoystickEvent::ButtonDown}\label{wxjoystickeventbuttondown}
  46
  47 \constfunc{bool}{ButtonDown}{\param{int}{ button = wxJOY\_BUTTON\_ANY}}
  48
  49 Returns true if the event was a down event from the specified button (or any button).
  50
  51 \wxheading{Parameters}
  52
  53 \docparam{button}{Can be wxJOY\_BUTTONn where n is 1, 2, 3 or 4; or wxJOY\_BUTTON\_ANY to
  54 indicate any button down event.}
  55
  56 \membersection{wxJoystickEvent::ButtonIsDown}\label{wxjoystickeventbuttonisdown}
  57
  58 \constfunc{bool}{ButtonIsDown}{\param{int}{ button = wxJOY\_BUTTON\_ANY}}
  59
  60 Returns true if the specified button (or any button) was in a down state.
  61
  62 \wxheading{Parameters}
  63
  64 \docparam{button}{Can be wxJOY\_BUTTONn where n is 1, 2, 3 or 4; or wxJOY\_BUTTON\_ANY to
  65 indicate any button down event.}
  66
  67 \membersection{wxJoystickEvent::ButtonUp}\label{wxjoystickeventbuttonup}
  68
  69 \constfunc{bool}{ButtonUp}{\param{int}{ button = wxJOY\_BUTTON\_ANY}}
  70
  71 Returns true if the event was an up event from the specified button (or any button).
  72
  73 \wxheading{Parameters}
  74
  75 \docparam{button}{Can be wxJOY\_BUTTONn where n is 1, 2, 3 or 4; or wxJOY\_BUTTON\_ANY to
  76 indicate any button down event.}
  77
  78 \membersection{wxJoystickEvent::GetButtonChange}\label{wxjoystickeventgetbuttonchange}
  79
  80 \constfunc{int}{GetButtonChange}{\void}
  81
  82 Returns the identifier of the button changing state. This is a wxJOY\_BUTTONn identifier, where
  83 n is one of 1, 2, 3, 4.
  84
  85 \membersection{wxJoystickEvent::GetButtonState}\label{wxjoystickeventgetbuttonstate}
  86
  87 \constfunc{int}{GetButtonState}{\void}
  88
  89 Returns the down state of the buttons. This is a bitlist of wxJOY\_BUTTONn identifiers, where
  90 n is one of 1, 2, 3, 4.
  91
  92 \membersection{wxJoystickEvent::GetJoystick}\label{wxjoystickeventgetjoystick}
  93
  94 \constfunc{int}{GetJoystick}{\void}
  95
  96 Returns the identifier of the joystick generating the event - one of wxJOYSTICK1 and wxJOYSTICK2.
  97
  98 \membersection{wxJoystickEvent::GetPosition}\label{wxjoystickeventgetposition}
  99
 100 \constfunc{wxPoint}{GetPosition}{\void}
 101
 102 Returns the x, y position of the joystick event.
 103
 104 \membersection{wxJoystickEvent::GetZPosition}\label{wxjoystickeventgetzposition}
 105
 106 \constfunc{int}{GetZPosition}{\void}
 107
 108 Returns the z position of the joystick event.
 109
 110 \membersection{wxJoystickEvent::IsButton}\label{wxjoystickeventisbutton}
 111
 112 \constfunc{bool}{IsButton}{\void}
 113
 114 Returns true if this was a button up or down event ({\it not} 'is any button down?').
 115
 116 \membersection{wxJoystickEvent::IsMove}\label{wxjoystickeventismove}
 117
 118 \constfunc{bool}{IsMove}{\void}
 119
 120 Returns true if this was an x, y move event.
 121
 122 \membersection{wxJoystickEvent::IsZMove}\label{wxjoystickeventiszmove}
 123
 124 \constfunc{bool}{IsZMove}{\void}
 125
 126 Returns true if this was a z move event.
 127