documented UngetWriteBuf overload

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

diff --git a/docs/latex/wx/joystick.tex b/docs/latex/wx/joystick.tex
index 118a233360e18015b3db468666b3295d2db68d4b..7520b28603e8eaf9a03ba0fc10f64ac7b8495cb0 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}
 
+\wxheading{Include files}
+
+<wx/joystick.h>
+
 \wxheading{See also}
 
 \helpref{wxJoystickEvent}{wxjoystickevent}
@@ -29,8 +33,11 @@ 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.
 
 \membersection{wxJoystick::GetManufacturerId}\label{wxjoystickgetmanufacturerid}
 
@@ -97,13 +104,16 @@ Returns the x, y position of the joystick.
 
 \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 +157,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}