]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/joyevent.tex
added format parameter to File/DirName()
[wxWidgets.git] / docs / latex / wx / joyevent.tex
index f8da76cf651390eff0007d3b49561a6e71914858..fc67dd7de0bfd33d902114a2501f94c015f4b835 100644 (file)
@@ -7,6 +7,10 @@ events received by windows.
 
 \helpref{wxEvent}{wxevent}
 
+\wxheading{Include files}
+
+<wx/event.h>
+
 \wxheading{Event table macros}
 
 To process a mouse event, use these event handler macros to direct input to member
@@ -37,7 +41,7 @@ Constructor.
 
 \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).
+Returns true if the event was a down event from the specified button (or any button).
 
 \wxheading{Parameters}
 
@@ -48,7 +52,7 @@ indicate any button down event.}
 
 \constfunc{bool}{ButtonIsDown}{\param{int}{ button = wxJOY\_BUTTON\_ANY}}
 
-Returns TRUE if the specified button (or any button) was in a down state.
+Returns true if the specified button (or any button) was in a down state.
 
 \wxheading{Parameters}
 
@@ -59,7 +63,7 @@ indicate any button down event.}
 
 \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).
+Returns true if the event was an up event from the specified button (or any button).
 
 \wxheading{Parameters}
 
@@ -102,17 +106,17 @@ Returns the z position of the joystick event.
 
 \constfunc{bool}{IsButton}{\void}
 
-Returns TRUE if this was a button up or down event ({\it not} 'is any button down?').
+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.
+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.
+Returns true if this was a z move event.