| -rw-r--r-- | library/sound.cpp | 31 |
1 files changed, 27 insertions, 4 deletions
diff --git a/library/sound.cpp b/library/sound.cpp index 1ff3b3f..c8704f9 100644 --- a/library/sound.cpp +++ b/library/sound.cpp @@ -107,5 +107,5 @@ public: filename ( Resource::findSound ( name )) { - loopsleft=0; + loopsleft=0; ms = WAVsoundDuration(filename); } @@ -129,8 +129,8 @@ public: return; } - } + } play(); } - + bool isFinished ( ) const { @@ -146,4 +146,7 @@ private: #endif +/*! Opens a wave sound file \a name for playing + * Resource is used for finding the file + **/ Sound::Sound(const QString& name) { @@ -153,4 +156,5 @@ Sound::Sound(const QString& name) } +/*! Destroys the sound */ Sound::~Sound() { @@ -160,4 +164,5 @@ Sound::~Sound() } +/*! Play the sound once */ void Sound::play() { @@ -167,4 +172,5 @@ void Sound::play() } +/*! Play the sound, repeatedly until stop() is called */ void Sound::playLoop() { @@ -175,4 +181,5 @@ void Sound::playLoop() } +/*! Do not repeat the sound after it finishes. This will end a playLoop() */ void Sound::stop() { @@ -191,8 +198,24 @@ bool Sound::isFinished() const } +/*! Sounds the audible system alarm. This is used for applications such + as Calendar when it needs to alarm the user of an event. +*/ void Sound::soundAlarm() { #ifndef QT_NO_COP QCopEnvelope( "QPE/TaskBar", "soundAlarm()" ); -#endif +#endif } + + +/*! \class Sound + \brief The Sound class plays WAVE sound files and can invoke the audible alarm. + + The Sound class is constructed with the .wav music file name. The Sound + class retrieves the sound file from the shared Resource class. This class + ties together QSound and the available sound resources. + + To sound an audible system alarm, call the static method soundAlarm() + + \ingroup qtopiaemb +*/ |