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

\section{\class{wxJoystickEvent}}\label{wxjoystickevent}

This event class contains information about mouse events, particularly
events received by windows.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/event.h>

\wxheading{Library}

\helpref{wxCore}{librarieslist}

\wxheading{Event table macros}

To process a mouse event, use these event handler macros to direct input to member
functions that take a wxJoystickEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_JOY\_BUTTON\_DOWN(func)}}{Process a wxEVT\_JOY\_BUTTON\_DOWN event.}
\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}

\helpref{wxJoystick}{wxjoystick}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxJoystickEvent::wxJoystickEvent}\label{wxjoystickeventctor}

\func{}{wxJoystickEvent}{\param{WXTYPE}{ eventType = 0}, \param{int}{ state = 0},
 \param{int}{ joystick = wxJOYSTICK1}, \param{int }{change = 0}}

Constructor.

\membersection{wxJoystickEvent::ButtonDown}\label{wxjoystickeventbuttondown}

\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).

\wxheading{Parameters}

\docparam{button}{Can be wxJOY\_BUTTONn where n is 1, 2, 3 or 4; or wxJOY\_BUTTON\_ANY to
indicate any button down event.}

\membersection{wxJoystickEvent::ButtonIsDown}\label{wxjoystickeventbuttonisdown}

\constfunc{bool}{ButtonIsDown}{\param{int}{ button = wxJOY\_BUTTON\_ANY}}

Returns true if the specified button (or any button) was in a down state.

\wxheading{Parameters}

\docparam{button}{Can be wxJOY\_BUTTONn where n is 1, 2, 3 or 4; or wxJOY\_BUTTON\_ANY to
indicate any button down event.}

\membersection{wxJoystickEvent::ButtonUp}\label{wxjoystickeventbuttonup}

\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).

\wxheading{Parameters}

\docparam{button}{Can be wxJOY\_BUTTONn where n is 1, 2, 3 or 4; or wxJOY\_BUTTON\_ANY to
indicate any button down event.}

\membersection{wxJoystickEvent::GetButtonChange}\label{wxjoystickeventgetbuttonchange}

\constfunc{int}{GetButtonChange}{\void}

Returns the identifier of the button changing state. This is a wxJOY\_BUTTONn identifier, where
n is one of 1, 2, 3, 4.

\membersection{wxJoystickEvent::GetButtonState}\label{wxjoystickeventgetbuttonstate}

\constfunc{int}{GetButtonState}{\void}

Returns the down state of the buttons. This is a bitlist of wxJOY\_BUTTONn identifiers, where
n is one of 1, 2, 3, 4.

\membersection{wxJoystickEvent::GetJoystick}\label{wxjoystickeventgetjoystick}

\constfunc{int}{GetJoystick}{\void}

Returns the identifier of the joystick generating the event - one of wxJOYSTICK1 and wxJOYSTICK2.

\membersection{wxJoystickEvent::GetPosition}\label{wxjoystickeventgetposition}

\constfunc{wxPoint}{GetPosition}{\void}

Returns the x, y position of the joystick event.

\membersection{wxJoystickEvent::GetZPosition}\label{wxjoystickeventgetzposition}

\constfunc{int}{GetZPosition}{\void}

Returns the z position of the joystick event.

\membersection{wxJoystickEvent::IsButton}\label{wxjoystickeventisbutton}

\constfunc{bool}{IsButton}{\void}

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.

\membersection{wxJoystickEvent::IsZMove}\label{wxjoystickeventiszmove}

\constfunc{bool}{IsZMove}{\void}

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