The K Desktop Environment

handleEvent

Name

handleEvent — display or cancel an already scheduled alarm message.

Synopsis

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

Parameters

calendarFile

Specifies the URL of the calendar file containing the event to be displayed or cancelled.

eventID

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

Description

handleEvent() is a DCOP call to display or cancel the specified alarm message. KAlarm retrieves the alarm message from the calendar file and then determines what action to take. If the late-cancel flag is set and the alarm is late, i.e. the scheduled time of display was more than a minute ago, KAlarm does not display the message; otherwise, KAlarm displays the alarm message. If no repetitions of the alarm are still scheduled, KAlarm then deletes the alarm message 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.