-rw-r--r-- | library/sound.cpp | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/library/sound.cpp b/library/sound.cpp index 1ff3b3f..c8704f9 100644 --- a/library/sound.cpp +++ b/library/sound.cpp | |||
@@ -146,4 +146,7 @@ private: | |||
146 | #endif | 146 | #endif |
147 | 147 | ||
148 | /*! Opens a wave sound file \a name for playing | ||
149 | * Resource is used for finding the file | ||
150 | **/ | ||
148 | Sound::Sound(const QString& name) | 151 | Sound::Sound(const QString& name) |
149 | { | 152 | { |
@@ -153,4 +156,5 @@ Sound::Sound(const QString& name) | |||
153 | } | 156 | } |
154 | 157 | ||
158 | /*! Destroys the sound */ | ||
155 | Sound::~Sound() | 159 | Sound::~Sound() |
156 | { | 160 | { |
@@ -160,4 +164,5 @@ Sound::~Sound() | |||
160 | } | 164 | } |
161 | 165 | ||
166 | /*! Play the sound once */ | ||
162 | void Sound::play() | 167 | void Sound::play() |
163 | { | 168 | { |
@@ -167,4 +172,5 @@ void Sound::play() | |||
167 | } | 172 | } |
168 | 173 | ||
174 | /*! Play the sound, repeatedly until stop() is called */ | ||
169 | void Sound::playLoop() | 175 | void Sound::playLoop() |
170 | { | 176 | { |
@@ -175,4 +181,5 @@ void Sound::playLoop() | |||
175 | } | 181 | } |
176 | 182 | ||
183 | /*! Do not repeat the sound after it finishes. This will end a playLoop() */ | ||
177 | void Sound::stop() | 184 | void Sound::stop() |
178 | { | 185 | { |
@@ -191,4 +198,7 @@ bool Sound::isFinished() const | |||
191 | } | 198 | } |
192 | 199 | ||
200 | /*! Sounds the audible system alarm. This is used for applications such | ||
201 | as Calendar when it needs to alarm the user of an event. | ||
202 | */ | ||
193 | void Sound::soundAlarm() | 203 | void Sound::soundAlarm() |
194 | { | 204 | { |
@@ -197,2 +207,15 @@ void Sound::soundAlarm() | |||
197 | #endif | 207 | #endif |
198 | } | 208 | } |
209 | |||
210 | |||
211 | /*! \class Sound | ||
212 | \brief The Sound class plays WAVE sound files and can invoke the audible alarm. | ||
213 | |||
214 | The Sound class is constructed with the .wav music file name. The Sound | ||
215 | class retrieves the sound file from the shared Resource class. This class | ||
216 | ties together QSound and the available sound resources. | ||
217 | |||
218 | To sound an audible system alarm, call the static method soundAlarm() | ||
219 | |||
220 | \ingroup qtopiaemb | ||
221 | */ | ||