The K Desktop Environment

displayMessage

Name

displayMessage — display an already scheduled alarm message.

Synopsis

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

Parameters

calendarFile

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

eventID

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

Description

displayMessage() is a DCOP call to display the specified alarm message. KAlarm retrieves the alarm message from the calendar file and then displays it.

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.