-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 | |||
@@ -136,63 +136,86 @@ public: | |||
136 | { | 136 | { |
137 | return ( loopsleft == 0 ); | 137 | return ( loopsleft == 0 ); |
138 | } | 138 | } |
139 | 139 | ||
140 | private: | 140 | private: |
141 | QString filename; | 141 | QString filename; |
142 | int loopsleft; | 142 | int loopsleft; |
143 | int ms; | 143 | int ms; |
144 | }; | 144 | }; |
145 | 145 | ||
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 | { |
150 | #ifndef QT_NO_SOUND | 153 | #ifndef QT_NO_SOUND |
151 | d = new SoundData(name); | 154 | d = new SoundData(name); |
152 | #endif | 155 | #endif |
153 | } | 156 | } |
154 | 157 | ||
158 | /*! Destroys the sound */ | ||
155 | Sound::~Sound() | 159 | Sound::~Sound() |
156 | { | 160 | { |
157 | #ifndef QT_NO_SOUND | 161 | #ifndef QT_NO_SOUND |
158 | delete d; | 162 | delete d; |
159 | #endif | 163 | #endif |
160 | } | 164 | } |
161 | 165 | ||
166 | /*! Play the sound once */ | ||
162 | void Sound::play() | 167 | void Sound::play() |
163 | { | 168 | { |
164 | #ifndef QT_NO_SOUND | 169 | #ifndef QT_NO_SOUND |
165 | d->playLoop(1); | 170 | d->playLoop(1); |
166 | #endif | 171 | #endif |
167 | } | 172 | } |
168 | 173 | ||
174 | /*! Play the sound, repeatedly until stop() is called */ | ||
169 | void Sound::playLoop() | 175 | void Sound::playLoop() |
170 | { | 176 | { |
171 | #ifndef QT_NO_SOUND | 177 | #ifndef QT_NO_SOUND |
172 | d->killTimers(); | 178 | d->killTimers(); |
173 | d->playLoop(); | 179 | d->playLoop(); |
174 | #endif | 180 | #endif |
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 | { |
179 | #ifndef QT_NO_SOUND | 186 | #ifndef QT_NO_SOUND |
180 | d->killTimers(); | 187 | d->killTimers(); |
181 | #endif | 188 | #endif |
182 | } | 189 | } |
183 | 190 | ||
184 | bool Sound::isFinished() const | 191 | bool Sound::isFinished() const |
185 | { | 192 | { |
186 | #ifndef QT_NO_SOUND | 193 | #ifndef QT_NO_SOUND |
187 | return d->isFinished(); | 194 | return d->isFinished(); |
188 | #else | 195 | #else |
189 | return true; | 196 | return true; |
190 | #endif | 197 | #endif |
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 | { |
195 | #ifndef QT_NO_COP | 205 | #ifndef QT_NO_COP |
196 | QCopEnvelope( "QPE/TaskBar", "soundAlarm()" ); | 206 | QCopEnvelope( "QPE/TaskBar", "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 | */ | ||