fix warning

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

diff --git a/docs/latex/wx/joystick.tex b/docs/latex/wx/joystick.tex
index 338f11668ffee528ad401282fb034985339a0d3f..72c473017fc42da95fb0dc86ee52c7b4c86f041e 100644 (file)
--- a/docs/latex/wx/joystick.tex
+++ b/docs/latex/wx/joystick.tex
@@ -6,6 +6,10 @@ wxJoystick allows an application to control one or more joysticks.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/joystick.h>
+

 \wxheading{See also}
 
 \helpref{wxJoystickEvent}{wxjoystickevent}
 \wxheading{See also}
 
 \helpref{wxJoystickEvent}{wxjoystickevent}


@@ -29,8 +33,11 @@ Destroys the wxJoystick object.
 
 \constfunc{int}{GetButtonState}{\void}
 
 
 \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.

 
 \membersection{wxJoystick::GetManufacturerId}\label{wxjoystickgetmanufacturerid}
 
 
 \membersection{wxJoystick::GetManufacturerId}\label{wxjoystickgetmanufacturerid}
 


@@ -97,13 +104,16 @@ Returns the x, y position of the joystick.
 
 \constfunc{int}{GetPOVPosition}{\void}
 
 
 \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.
 
 \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}
 
 
 \membersection{wxJoystick::GetRudderMax}\label{wxjoystickgetruddermax}
 


@@ -205,49 +215,49 @@ Returns the z position of the joystick.
 
 \constfunc{bool}{HasPOV}{\void}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \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}
 
 
 \membersection{wxJoystick::ReleaseCapture}\label{wxjoystickreleasecapture}
 


@@ -257,7 +267,7 @@ Releases the capture set by {\bf SetCapture}.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the capture release succeeded.
+true if the capture release succeeded.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -278,7 +288,7 @@ threshold. If greater than zero, events are received every {\it pollingFreq} mil
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the capture succeeded.
+true if the capture succeeded.

 
 \wxheading{See also}
 
 
 \wxheading{See also}