Name

handleEvent — trigger or cancel an already scheduled alarm.

Synopsis

void handleEvent(const QString& calendarFile, const QString& eventID)

Parameters

calendarFile

Specifies the URL of the calendar file containing the event to be displayed/executed or canceled.

eventID

Specifies the unique ID of the event to be displayed/executed or canceled, as stored in calendarFile.

Description

handleEvent() is a DCOP call to display/execute or cancel the specified alarm. KAlarm retrieves the alarm from the calendar file and then determines what action to take depending on when the alarm is due.

  • If the alarm is not yet due, nothing happens.

  • If the alarm is due, it acts as follows. If the late-cancel flag is set and the alarm is late, i.e. the scheduled trigger time was longer than one minute ago, KAlarm does not display or execute the alarm; otherwise, KAlarm displays or executes the alarm. If no repetitions of the alarm are still scheduled, KAlarm then deletes the alarm from the calendar file.

Note

The calendarFile parameter is only used for integrity checking: if the URL does not specify KAlarm's current default calendar file, the request will be ignored.