-rw-r--r-- | library/alarmserver.cpp | 23 | ||||
-rw-r--r-- | library/global.cpp | 6 |
2 files changed, 17 insertions, 12 deletions
diff --git a/library/alarmserver.cpp b/library/alarmserver.cpp index 2ea4025..a75fc7e 100644 --- a/library/alarmserver.cpp +++ b/library/alarmserver.cpp | |||
@@ -304,18 +304,18 @@ void TimerReceiverObject::timerEvent( QTimerEvent * ) | |||
304 | /*! | 304 | /*! |
305 | \class AlarmServer alarmserver.h | 305 | \class AlarmServer alarmserver.h |
306 | \brief The AlarmServer class allows alarms to be scheduled and unscheduled. | 306 | \brief The AlarmServer class allows alarms to be scheduled and unscheduled. |
307 | 307 | ||
308 | Applications can schedule alarms with addAlarm() and can | 308 | Applications can schedule alarms with addAlarm() and can |
309 | unschedule alarms with deleteAlarm(). When the time for an alarm | 309 | unschedule alarms with deleteAlarm(). When the time for an alarm |
310 | to go off is reached the specified \link qcop.html QCop\endlink | 310 | to go off is reached the specified \link qcop.html QCop\endlink |
311 | message is sent on the specified channel (optionally with | 311 | message is sent on the specified channel (optionally with |
312 | additional data). | 312 | additional data). |
313 | 313 | ||
314 | Scheduling an alarm using this class is important (rather just using | 314 | Scheduling an alarm using this class is important (rather just using |
315 | a QTimer) since the machine may be asleep and needs to get woken up using | 315 | a QTimer) since the machine may be asleep and needs to get woken up using |
316 | the Linux kernel which implements this at the kernel level to minimize | 316 | the Linux kernel which implements this at the kernel level to minimize |
317 | battery usage while asleep. | 317 | battery usage while asleep. |
318 | 318 | ||
319 | \ingroup qtopiaemb | 319 | \ingroup qtopiaemb |
320 | \sa QCopEnvelope | 320 | \sa QCopEnvelope |
321 | */ | 321 | */ |
@@ -324,11 +324,11 @@ void TimerReceiverObject::timerEvent( QTimerEvent * ) | |||
324 | Schedules an alarm to go off at (or soon after) time \a when. When | 324 | Schedules an alarm to go off at (or soon after) time \a when. When |
325 | the alarm goes off, the \link qcop.html QCop\endlink \a message will | 325 | the alarm goes off, the \link qcop.html QCop\endlink \a message will |
326 | be sent to \a channel, with \a data as a parameter. | 326 | be sent to \a channel, with \a data as a parameter. |
327 | 327 | ||
328 | If this function is called with exactly the same data as a previous | 328 | If this function is called with exactly the same data as a previous |
329 | call the subsequent call is ignored, so there is only ever one alarm | 329 | call the subsequent call is ignored, so there is only ever one alarm |
330 | with a given set of parameters. | 330 | with a given set of parameters. |
331 | 331 | ||
332 | \sa deleteAlarm() | 332 | \sa deleteAlarm() |
333 | */ | 333 | */ |
334 | void AlarmServer::addAlarm ( QDateTime when, const QCString& channel, | 334 | void AlarmServer::addAlarm ( QDateTime when, const QCString& channel, |
@@ -381,15 +381,15 @@ void AlarmServer::addAlarm ( QDateTime when, const QCString& channel, | |||
381 | /*! | 381 | /*! |
382 | Deletes previously scheduled alarms which match \a when, \a channel, | 382 | Deletes previously scheduled alarms which match \a when, \a channel, |
383 | \a message, and \a data. | 383 | \a message, and \a data. |
384 | 384 | ||
385 | Passing null values for \a when, \a channel, or for the \link | 385 | Passing null values for \a when, \a channel, or for the \link |
386 | qcop.html QCop\endlink \a message, acts as a wildcard meaning "any". | 386 | qcop.html QCop\endlink \a message, acts as a wildcard meaning "any". |
387 | Similarly, passing -1 for \a data indicates "any". | 387 | Similarly, passing -1 for \a data indicates "any". |
388 | 388 | ||
389 | If there is no matching alarm, nothing happens. | 389 | If there is no matching alarm, nothing happens. |
390 | 390 | ||
391 | \sa addAlarm() | 391 | \sa addAlarm() |
392 | 392 | ||
393 | */ | 393 | */ |
394 | void AlarmServer::deleteAlarm (QDateTime when, const QCString& channel, const QCString& message, int data) | 394 | void AlarmServer::deleteAlarm (QDateTime when, const QCString& channel, const QCString& message, int data) |
395 | { | 395 | { |
@@ -434,7 +434,10 @@ void AlarmServer::deleteAlarm (QDateTime when, const QCString& channel, const QC | |||
434 | } | 434 | } |
435 | 435 | ||
436 | /*! | 436 | /*! |
437 | Writes the system clock to the hardware clock. | 437 | The implementation depends on the mode of AlarmServer. If the AlarmServer |
438 | uses atd the current system time will be written to the hardware clock. | ||
439 | If the AlarmServer relies on opie-alarm the time will be written once the | ||
440 | device gets suspended. opie-alarm is used by the Zaurus, iPAQs and SIMpad | ||
438 | */ | 441 | */ |
439 | void Global::writeHWClock() | 442 | void Global::writeHWClock() |
440 | { | 443 | { |
diff --git a/library/global.cpp b/library/global.cpp index 5c89430..90954fe 100644 --- a/library/global.cpp +++ b/library/global.cpp | |||
@@ -213,8 +213,10 @@ static QString dictDir() | |||
213 | 213 | ||
214 | \section1 Hardware | 214 | \section1 Hardware |
215 | 215 | ||
216 | The writeHWClock() function sets the hardware clock to the system | 216 | The implementation of the writeHWClock() function depends on the AlarmServer |
217 | clock's date and time. | 217 | implementation. If the AlarmServer is using atd the clock will be synced to |
218 | hardware. If opie-alarm is used the hardware clock will be synced before | ||
219 | suspending the device. opie-alarm is used by iPAQ and Zaurii implementation | ||
218 | 220 | ||
219 | \ingroup qtopiaemb | 221 | \ingroup qtopiaemb |
220 | */ | 222 | */ |