Added logic, API and docs for wxDataViewModel::HasDefaultCompare indicating a compare...

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

diff --git a/docs/latex/wx/sound.tex b/docs/latex/wx/sound.tex
index f67b1f450c30d80d42fa48243111da31045b8931..6f4e0ee2383340801976f7d4170b66177890c414 100644 (file)
--- a/docs/latex/wx/sound.tex
+++ b/docs/latex/wx/sound.tex
@@ -14,9 +14,14 @@ on Windows and Unix (and uses either
 
 <wx/sound.h>
 
 
 <wx/sound.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

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

-\membersection{wxSound::wxSound}\label{wxsoundconstr}
+
+\membersection{wxSound::wxSound}\label{wxsoundctor}

 
 \func{}{wxSound}{\void}
 
 
 \func{}{wxSound}{\void}
 


@@ -24,8 +29,9 @@ Default constructor.
 
 \func{}{wxSound}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}}
 
 
 \func{}{wxSound}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}}
 

-Constructs a wave object from a file or resource. Call \helpref{wxSound::IsOk}{wxsoundisok} to
-determine whether this succeeded.
+Constructs a wave object from a file or, under Windows, from a Windows
+resource. Call \helpref{wxSound::IsOk}{wxsoundisok} to determine whether this
+succeeded.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -33,12 +39,14 @@ determine whether this succeeded.
 
 \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{wxSound::\destruct{wxSound}}
+
+\membersection{wxSound::\destruct{wxSound}}\label{wxsounddtor}

 
 \func{}{\destruct{wxSound}}{\void}
 
 Destroys the wxSound object.
 
 
 \func{}{\destruct{wxSound}}{\void}
 
 Destroys the wxSound object.
 

+

 \membersection{wxSound::Create}\label{wxsoundcreate}
 
 \func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = \false}}
 \membersection{wxSound::Create}\label{wxsoundcreate}
 
 \func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = \false}}


@@ -55,18 +63,23 @@ Constructs a wave object from a file or resource.
 
 \true if the call was successful, \false otherwise.
 
 
 \true if the call was successful, \false otherwise.
 

+

 \membersection{wxSound::IsOk}\label{wxsoundisok}
 
 \constfunc{bool}{IsOk}{\void}
 
 Returns \true if the object contains a successfully loaded file or resource, \false otherwise.
 
 \membersection{wxSound::IsOk}\label{wxsoundisok}
 
 \constfunc{bool}{IsOk}{\void}
 
 Returns \true if the object contains a successfully loaded file or resource, \false otherwise.
 

+

 \membersection{wxSound::IsPlaying}\label{wxsoundisplaying}
 
 \constfunc{static bool}{IsPlaying}{\void}
 
 Returns \true if a sound is played at the moment.
 
 \membersection{wxSound::IsPlaying}\label{wxsoundisplaying}
 
 \constfunc{static bool}{IsPlaying}{\void}
 
 Returns \true if a sound is played at the moment.
 

+This method is currently not implemented under Windows.
+
+

 \membersection{wxSound::Play}\label{wxsoundplay}
 
 \constfunc{bool}{Play}{\param{unsigned }{ flags = wxSOUND\_ASYNC}}
 \membersection{wxSound::Play}\label{wxsoundplay}
 
 \constfunc{bool}{Play}{\param{unsigned }{ flags = wxSOUND\_ASYNC}}


@@ -74,7 +87,10 @@ Returns \true if a sound is played at the moment.
 \func{static bool}{Play}{\param{const wxString\& }{filename}, \param{unsigned}{ flags = wxSOUND\_ASYNC}}
 
 Plays the sound file. If another sound is playing, it will be interrupted.
 \func{static bool}{Play}{\param{const wxString\& }{filename}, \param{unsigned}{ flags = wxSOUND\_ASYNC}}
 
 Plays the sound file. If another sound is playing, it will be interrupted.

-Returns \true on success, \false otherwise.
+Returns \true on success, \false otherwise. Note that in general it is possible
+to delete the object which is being asynchronously played any time after
+calling this function and the sound would continue playing, however this
+currently doesn't work under Windows for sound objects loaded from memory data.

 
 The possible values for \arg{flags} are:
 
 
 The possible values for \arg{flags} are:
 


@@ -89,10 +105,12 @@ and loops until another sound is played,
 \end{twocollist}
 
 The static form is shorthand for this code:
 \end{twocollist}
 
 The static form is shorthand for this code:

+

 \begin{verbatim}
 wxSound(filename).Play(flags);
 \end{verbatim}
 
 \begin{verbatim}
 wxSound(filename).Play(flags);
 \end{verbatim}
 

+

 \membersection{wxSound::Stop}\label{wxsoundstop}
 
 \func{static void}{Stop}{\void}
 \membersection{wxSound::Stop}\label{wxsoundstop}
 
 \func{static void}{Stop}{\void}