Added Word template for formatting wxWindows manual

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

\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 implemented
on Windows and GTK (Linux) only.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/wave.h>

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxWave::wxWave}\label{wxwaveconstr}

\func{}{wxWave}{\void}

Default constructor.

\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.

\wxheading{Parameters}

\docparam{fileName}{The filename or Windows resource.}

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

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

\func{}{\destruct{wxWave}}{\void}

Destroys the wxWave object.

\membersection{wxWave::Create}\label{wxwavecreate}

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

Constructs a wave object from a file or resource.

\wxheading{Parameters}

\docparam{fileName}{The filename or Windows resource.}

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

\wxheading{Return value}

TRUE if the call was successful, FALSE otherwise.

\membersection{wxWave::IsOk}\label{wxwaveisok}

\constfunc{bool}{IsOk}{\void}

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

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

\constfunc{bool}{Play}{\param{bool}{ async = TRUE}, \param{bool}{ looped = FALSE}}

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