triggerEvent
Prev
Next

Name

triggerEvent — trigger an already scheduled alarm.

Synopsis

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

Parameters

calendarFile

Specifies the URL (not path) of the calendar file containing the event to be triggered.

eventID

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

Description

triggerEvent() is a DCOP call to trigger the immediate display or execution of the specified alarm (regardless of what time it is scheduled for). KAlarm retrieves the alarm from the calendar file and then displays or executes it.

If the alarm is already due, KAlarm then deletes all scheduled occurrences of the alarm up to the current time, and if no repetitions of the alarm still remain, the alarm is deleted from the calendar file. If the alarm is not due yet, its scheduled occurrences are left unchanged.

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.

Prev
Next
Home


Would you like to comment or contribute an update to this page?
Send feedback to the TDE Development Team