wxRichTextAttr does not exist anymore - document instead wxTextAttr

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

diff --git a/docs/latex/wx/joystick.tex b/docs/latex/wx/joystick.tex
index 118a233360e18015b3db468666b3295d2db68d4b..1b1ca2cb85c32c23a602dc22abfa1cf7dd59e188 100644 (file)
--- a/docs/latex/wx/joystick.tex
+++ b/docs/latex/wx/joystick.tex
@@ -6,20 +6,28 @@ wxJoystick allows an application to control one or more joysticks.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/joystick.h>
+
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxJoystickEvent}{wxjoystickevent}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxJoystick::wxJoystick}\label{wxjoystickconstr}
+\membersection{wxJoystick::wxJoystick}\label{wxjoystickctor}
 
 \func{}{wxJoystick}{\param{int}{ joystick = wxJOYSTICK1}}
 
 Constructor. {\it joystick} may be one of wxJOYSTICK1, wxJOYSTICK2, indicating the joystick
 controller of interest.
 
-\membersection{wxJoystick::\destruct{wxJoystick}}
+\membersection{wxJoystick::\destruct{wxJoystick}}\label{wxjoystickdtor}
 
 \func{}{\destruct{wxJoystick}}{\void}
 
@@ -29,8 +37,19 @@ Destroys the wxJoystick object.
 
 \constfunc{int}{GetButtonState}{\void}
 
-Returns the state of the joystick buttons. A bitlist of wxJOY\_BUTTONn identifiers,
-where n is 1, 2, 3 or 4.
+Returns the state of the joystick buttons. Every button is mapped to a single
+bit in the returned integer, with the first button being mapped to the least
+significant bit, and so on.
+A bitlist of wxJOY\_BUTTONn identifiers, where n is 1, 2, 3 or 4 
+is available for historical reasons.
+
+\constfunc{bool}{GetButtonState}{\param{unsigned}{ id}}
+
+Returns the state of the specified joystick button.
+
+\wxheading{Parameters}
+
+\docparam{id}{The button id to report, from 0 to \helpref{GetNumberButtons()}{wxjoystickgetnumberbuttons} - 1}
 
 \membersection{wxJoystick::GetManufacturerId}\label{wxjoystickgetmanufacturerid}
 
@@ -59,7 +78,7 @@ Returns the number of buttons for this joystick.
 
 \membersection{wxJoystick::GetNumberJoysticks}\label{wxjoystickgetnumberjoysticks}
 
-\constfunc{int}{GetNumberJoysticks}{\void}
+\func{static int}{GetNumberJoysticks}{\void}
 
 Returns the number of joysticks currently attached to the computer.
 
@@ -93,17 +112,28 @@ Returns the product name for the joystick.
 
 Returns the x, y position of the joystick.
 
+\constfunc{int}{GetPosition}{\param{unsigned}{ axis}}
+
+Returns the position of the specified joystick axis.
+
+\wxheading{Parameters}
+
+\docparam{axis}{The joystick axis to report, from 0 to \helpref{GetNumberAxes()}{wxjoystickgetnumberaxes} - 1.}
+
 \membersection{wxJoystick::GetPOVPosition}\label{wxjoystickgetpovposition}
 
 \constfunc{int}{GetPOVPosition}{\void}
 
-Returns the point-of-view position, expressed in discrete units.
+Returns the point-of-view position, expressed in continuous, one-hundredth of a degree units,
+but limited to return 0, 9000, 18000 or 27000.
+Returns -1 on error.
 
 \membersection{wxJoystick::GetPOVCTSPosition}\label{wxjoystickgetpovctsposition}
 
 \constfunc{int}{GetPOVCTSPosition}{\void}
 
 Returns the point-of-view position, expressed in continuous, one-hundredth of a degree units.
+Returns -1 on error.
 
 \membersection{wxJoystick::GetRudderMax}\label{wxjoystickgetruddermax}
 
@@ -147,11 +177,11 @@ Gets the position of the fifth axis of the joystick, if it exists.
 
 Returns the maximum V position.
 
-\membersection{wxJoystick::GetUMin}\label{wxjoystickgetumin}
+\membersection{wxJoystick::GetVMin}\label{wxjoystickgetvmin}
 
-\constfunc{int}{GetUMin}{\void}
+\constfunc{int}{GetVMin}{\void}
 
-Returns the minimum U position.
+Returns the minimum V position.
 
 \membersection{wxJoystick::GetVPosition}\label{wxjoystickgetvposition}
 
@@ -191,7 +221,7 @@ Returns the maximum z position.
 
 \membersection{wxJoystick::GetZMin}\label{wxjoystickgetzmin}
 
-\constfunc{int}{GetXMin}{\void}
+\constfunc{int}{GetZMin}{\void}
 
 Returns the minimum z position.
 
@@ -205,49 +235,49 @@ Returns the z position of the joystick.
 
 \constfunc{bool}{HasPOV}{\void}
 
-Returns TRUE if the joystick has a point of view control.
+Returns true if the joystick has a point of view control.
 
 \membersection{wxJoystick::HasPOV4Dir}\label{wxjoystickhaspovfdir}
 
 \constfunc{bool}{HasPOV4Dir}{\void}
 
-Returns TRUE if the joystick point-of-view supports discrete values (centered, forward, backward, left, and right).
+Returns true if the joystick point-of-view supports discrete values (centered, forward, backward, left, and right).
 
 \membersection{wxJoystick::HasPOVCTS}\label{wxjoystickhaspovcts}
 
 \constfunc{bool}{HasPOVCTS}{\void}
 
-Returns TRUE if the joystick point-of-view supports continuous degree bearings.
+Returns true if the joystick point-of-view supports continuous degree bearings.
 
 \membersection{wxJoystick::HasRudder}\label{wxjoystickhasrudder}
 
 \constfunc{bool}{HasRudder}{\void}
 
-Returns TRUE if there is a rudder attached to the computer.
+Returns true if there is a rudder attached to the computer.
 
 \membersection{wxJoystick::HasU}\label{wxjoystickhasu}
 
 \constfunc{bool}{HasU}{\void}
 
-Returns TRUE if the joystick has a U axis.
+Returns true if the joystick has a U axis.
 
 \membersection{wxJoystick::HasV}\label{wxjoystickhasv}
 
 \constfunc{bool}{HasV}{\void}
 
-Returns TRUE if the joystick has a V axis.
+Returns true if the joystick has a V axis.
 
 \membersection{wxJoystick::HasZ}\label{wxjoystickhasz}
 
 \constfunc{bool}{HasZ}{\void}
 
-Returns TRUE if the joystick has a Z axis.
+Returns true if the joystick has a Z axis.
 
 \membersection{wxJoystick::IsOk}\label{wxjoystickisok}
 
 \constfunc{bool}{IsOk}{\void}
 
-Returns TRUE if the joystick is functioning.
+Returns true if the joystick is functioning.
 
 \membersection{wxJoystick::ReleaseCapture}\label{wxjoystickreleasecapture}
 
@@ -257,7 +287,7 @@ Releases the capture set by {\bf SetCapture}.
 
 \wxheading{Return value}
 
-TRUE if the capture release succeeded.
+true if the capture release succeeded.
 
 \wxheading{See also}
 
@@ -278,7 +308,7 @@ threshold. If greater than zero, events are received every {\it pollingFreq} mil
 
 \wxheading{Return value}
 
-TRUE if the capture succeeded.
+true if the capture succeeded.
 
 \wxheading{See also}