git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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