define NO_GCC_PRAGMA in wx-config output on Darwin

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

diff --git a/docs/latex/wx/wave.tex b/docs/latex/wx/wave.tex
index 2cc66087a834c81c232353973f4d6602c7caa6dc..208ebcf7c8405c0ecef06198e86309ad7faf2ec0 100644 (file)
--- a/docs/latex/wx/wave.tex
+++ b/docs/latex/wx/wave.tex
@@ -1,13 +1,17 @@
 \section{\class{wxWave}}\label{wxwave}
 
 This class represents a short wave file, in Windows WAV format, that
 \section{\class{wxWave}}\label{wxwave}
 
 This class represents a short wave file, in Windows WAV format, that

-can be stored in memory and played. Currently this class is for Windows
-only.
+can be stored in memory and played. Currently this class is implemented
+on Windows and Linux only.

 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 

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

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxWave::wxWave}\label{wxwaveconstr}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxWave::wxWave}\label{wxwaveconstr}


@@ -16,7 +20,7 @@ only.
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
+\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}}

 
 Constructs a wave object from a file or resource. Call \helpref{wxWave::IsOk}{wxwaveisok} to
 determine whether this succeeded.
 
 Constructs a wave object from a file or resource. Call \helpref{wxWave::IsOk}{wxwaveisok} to
 determine whether this succeeded.


@@ -25,7 +29,7 @@ determine whether this succeeded.
 
 \docparam{fileName}{The filename or Windows resource.}
 
 
 \docparam{fileName}{The filename or Windows resource.}
 

-\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
+\docparam{isResource}{true if {\it fileName} is a resource, false if it is a filename.}

 
 \membersection{wxWave::\destruct{wxWave}}
 
 
 \membersection{wxWave::\destruct{wxWave}}
 


@@ -35,7 +39,7 @@ Destroys the wxWave object.
 
 \membersection{wxWave::Create}\label{wxwavecreate}
 
 
 \membersection{wxWave::Create}\label{wxwavecreate}
 

-\func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
+\func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}}

 
 Constructs a wave object from a file or resource.
 
 
 Constructs a wave object from a file or resource.
 


@@ -43,21 +47,21 @@ Constructs a wave object from a file or resource.
 
 \docparam{fileName}{The filename or Windows resource.}
 
 
 \docparam{fileName}{The filename or Windows resource.}
 

-\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
+\docparam{isResource}{true if {\it fileName} is a resource, false if it is a filename.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the call was successful, FALSE otherwise.
+true if the call was successful, false otherwise.

 
 \membersection{wxWave::IsOk}\label{wxwaveisok}
 
 \constfunc{bool}{IsOk}{\void}
 
 
 \membersection{wxWave::IsOk}\label{wxwaveisok}
 
 \constfunc{bool}{IsOk}{\void}
 

-Returns TRUE if the object contains a successfully loaded file or resource, FALSE otherwise.
+Returns true if the object contains a successfully loaded file or resource, false otherwise.

 
 \membersection{wxWave::Play}\label{wxwaveplay}
 
 
 \membersection{wxWave::Play}\label{wxwaveplay}
 

-\constfunc{bool}{Play}{\param{bool}{ async = TRUE}, \param{bool}{ looped = FALSE}}
+\constfunc{bool}{Play}{\param{bool}{ async = true}, \param{bool}{ looped = false}}

 
 Plays the wave file synchronously or asynchronously, looped or single-shot.
 
 
 Plays the wave file synchronously or asynchronously, looped or single-shot.