kalarm
DcopHandler Class ReferenceInheritance diagram for DcopHandler:
List of all members.
Detailed Description
Definition at line 31 of file dcophandler.h.
|
Public Member Functions |
| DcopHandler () |
virtual bool | cancelEvent (const QString &url, const QString &eventId) |
virtual bool | triggerEvent (const QString &url, const QString &eventId) |
virtual bool | scheduleMessage (const QString &message, const QString &startDateTime, int lateCancel, unsigned flags, const QString &bgColor, const QString &fgColor, const QString &font, const KURL &audioFile, int reminderMins, const QString &recurrence, int subRepeatInterval, int subRepeatCount) |
virtual bool | scheduleMessage (const QString &message, const QString &startDateTime, int lateCancel, unsigned flags, const QString &bgColor, const QString &fgColor, const QString &font, const KURL &audioFile, int reminderMins, int recurType, int recurInterval, int recurCount) |
virtual bool | scheduleMessage (const QString &message, const QString &startDateTime, int lateCancel, unsigned flags, const QString &bgColor, const QString &fgColor, const QString &font, const KURL &audioFile, int reminderMins, int recurType, int recurInterval, const QString &endDateTime) |
virtual bool | scheduleFile (const KURL &file, const QString &startDateTime, int lateCancel, unsigned flags, const QString &bgColor, const KURL &audioFile, int reminderMins, const QString &recurrence, int subRepeatInterval, int subRepeatCount) |
virtual bool | scheduleFile (const KURL &file, const QString &startDateTime, int lateCancel, unsigned flags, const QString &bgColor, const KURL &audioFile, int reminderMins, int recurType, int recurInterval, int recurCount) |
virtual bool | scheduleFile (const KURL &file, const QString &startDateTime, int lateCancel, unsigned flags, const QString &bgColor, const KURL &audioFile, int reminderMins, int recurType, int recurInterval, const QString &endDateTime) |
virtual bool | scheduleCommand (const QString &commandLine, const QString &startDateTime, int lateCancel, unsigned flags, const QString &recurrence, int subRepeatInterval, int subRepeatCount) |
virtual bool | scheduleCommand (const QString &commandLine, const QString &startDateTime, int lateCancel, unsigned flags, int recurType, int recurInterval, int recurCount) |
virtual bool | scheduleCommand (const QString &commandLine, const QString &startDateTime, int lateCancel, unsigned flags, int recurType, int recurInterval, const QString &endDateTime) |
virtual bool | scheduleEmail (const QString &fromID, const QString &addresses, const QString &subject, const QString &message, const QString &attachments, const QString &startDateTime, int lateCancel, unsigned flags, const QString &recurrence, int recurInterval, int recurCount) |
virtual bool | scheduleEmail (const QString &fromID, const QString &addresses, const QString &subject, const QString &message, const QString &attachments, const QString &startDateTime, int lateCancel, unsigned flags, int recurType, int recurInterval, int recurCount) |
virtual bool | scheduleEmail (const QString &fromID, const QString &addresses, const QString &subject, const QString &message, const QString &attachments, const QString &startDateTime, int lateCancel, unsigned flags, int recurType, int recurInterval, const QString &endDateTime) |
virtual bool | edit (const QString &eventID) |
virtual bool | editNew (const QString &templateName) |
Member Function Documentation
bool DcopHandler::cancelEvent |
( |
const QString & |
url, |
|
|
const QString & |
eventId |
|
) |
[virtual] |
|
|
Cancel (delete) an already scheduled alarm.
- Parameters:
-
| url | - The URL (not path) of the calendar file containing the event to be cancelled. Used only for integrity checking: the call will fail if it is not KAlarm's current calendar file. |
| eventId | - The unique ID of the event to be cancelled, as stored in the calendar file url . |
Implements KAlarmIface.
Definition at line 55 of file dcophandler.cpp. |
bool DcopHandler::edit |
( |
const QString & |
eventID |
) |
[virtual] |
|
|
Open the alarm edit dialog to edit an existing alarm.
- Parameters:
-
| eventId | The unique ID of the event to be edited, or QString::null to create a new alarm. |
- Returns:
- false if the alarm could not be found or is read-only, true otherwise.
Implements KAlarmIface.
Definition at line 197 of file dcophandler.cpp. |
bool DcopHandler::editNew |
( |
const QString & |
templateName |
) |
[virtual] |
|
|
Open the alarm edit dialog to edit a new alarm.
- Parameters:
-
| templateName | Name of the alarm template to base the new alarm on, or QString::null if none. If a template is specified but cannot be found, the alarm edit dialog is still opened but is (obviously) not preset with the template. |
- Returns:
- false if an alarm template was specified but could not be found, true otherwise.
Implements KAlarmIface.
Definition at line 202 of file dcophandler.cpp. |
bool DcopHandler::scheduleCommand |
( |
const QString & |
commandLine, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
int |
recurType, |
|
|
int |
recurInterval, |
|
|
const QString & |
endDateTime |
|
) |
[virtual] |
|
|
Schedule a command execution alarm.
- Parameters:
-
| commandLine | The command line or command script to execute. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| repeatType | The time units to use for recurrence. The actual recurrence interval is equal to repeatType multiplied by repeatInterval . The value of repeatType must a value defined in the RecurType enum. |
| repeatInterval | Recurrence interval in units defined by repeatType , or 0 for no recurrence. |
| endDateTime | Date/time after which the recurrence will end. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 154 of file dcophandler.cpp. |
bool DcopHandler::scheduleCommand |
( |
const QString & |
commandLine, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
int |
recurType, |
|
|
int |
recurInterval, |
|
|
int |
recurCount |
|
) |
[virtual] |
|
|
Schedule a command execution alarm.
- Parameters:
-
| commandLine | The command line or command script to execute. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| repeatType | The time units to use for recurrence. The actual recurrence interval is equal to repeatType multiplied by repeatInterval . The value of repeatType must a value defined in the RecurType enum. |
| repeatInterval | Recurrence interval in units defined by repeatType , or 0 for no recurrence. |
| repeatCount | Recurrence count (after the first occurrence), or 0 for no recurrence. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 142 of file dcophandler.cpp. |
bool DcopHandler::scheduleCommand |
( |
const QString & |
commandLine, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
recurrence, |
|
|
int |
subRepeatInterval, |
|
|
int |
subRepeatCount |
|
) |
[virtual] |
|
|
Schedule a command execution alarm.
- Parameters:
-
| commandLine | The command line or command script to execute. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| recurrence | Recurrence specification using iCalendar syntax (defined in RFC2445). |
| repeatInterval | Simple repetition repeat interval in minutes, or 0 for no sub-repetition. |
| repeatCount | Simple repetition repeat count (after the first occurrence), or 0 for no sub-repetition. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 132 of file dcophandler.cpp. |
bool DcopHandler::scheduleEmail |
( |
const QString & |
fromID, |
|
|
const QString & |
addresses, |
|
|
const QString & |
subject, |
|
|
const QString & |
message, |
|
|
const QString & |
attachments, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
int |
recurType, |
|
|
int |
recurInterval, |
|
|
const QString & |
endDateTime |
|
) |
[virtual] |
|
|
Schedule an email alarm.
- Parameters:
-
| fromID | The KMail identity to use as the sender of the email, or QString::null to use KAlarm's default sender ID. |
| addresses | Comma-separated list of addresses to send the email to. |
| subject | Subject line of the email. |
| message | Email message's body text. |
| attachments | Comma- or semicolon-separated list of paths or URLs of files to send as attachments to the email. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in the Flags enum. |
| repeatType | The time units to use for recurrence. The actual recurrence interval is equal to repeatType multiplied by repeatInterval . The value of repeatType must a value defined in the RecurType enum. |
| repeatInterval | Recurrence interval in units defined by repeatType , or 0 for no recurrence. |
| endDateTime | Date/time after which the recurrence will end. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 186 of file dcophandler.cpp. |
bool DcopHandler::scheduleEmail |
( |
const QString & |
fromID, |
|
|
const QString & |
addresses, |
|
|
const QString & |
subject, |
|
|
const QString & |
message, |
|
|
const QString & |
attachments, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
int |
recurType, |
|
|
int |
recurInterval, |
|
|
int |
recurCount |
|
) |
[virtual] |
|
|
Schedule an email alarm.
- Parameters:
-
| fromID | The KMail identity to use as the sender of the email, or QString::null to use KAlarm's default sender ID. |
| addresses | Comma-separated list of addresses to send the email to. |
| subject | Subject line of the email. |
| message | Email message's body text. |
| attachments | Comma- or semicolon-separated list of paths or URLs of files to send as attachments to the email. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in the Flags enum. |
| repeatType | The time units to use for recurrence. The actual recurrence interval is equal to repeatType multiplied by repeatInterval . The value of repeatType must a value defined in the RecurType enum. |
| repeatInterval | Recurrence interval in units defined by repeatType , or 0 for no recurrence. |
| repeatCount | Recurrence count (after the first occurrence), or 0 for no recurrence. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 175 of file dcophandler.cpp. |
bool DcopHandler::scheduleEmail |
( |
const QString & |
fromID, |
|
|
const QString & |
addresses, |
|
|
const QString & |
subject, |
|
|
const QString & |
message, |
|
|
const QString & |
attachments, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
recurrence, |
|
|
int |
recurInterval, |
|
|
int |
recurCount |
|
) |
[virtual] |
|
|
Schedule an email alarm.
- Parameters:
-
| fromID | The KMail identity to use as the sender of the email, or QString::null to use KAlarm's default sender ID. |
| addresses | Comma-separated list of addresses to send the email to. |
| subject | Subject line of the email. |
| message | Email message's body text. |
| attachments | Comma- or semicolon-separated list of paths or URLs of files to send as attachments to the email. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| recurrence | Recurrence specification using iCalendar syntax (defined in RFC2445). |
| repeatInterval | Simple repetition repeat interval in minutes, or 0 for no sub-repetition. |
| repeatCount | Simple repetition repeat count (after the first occurrence), or 0 for no sub-repetition. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 164 of file dcophandler.cpp. |
bool DcopHandler::scheduleFile |
( |
const KURL & |
file, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
int |
recurType, |
|
|
int |
recurInterval, |
|
|
const QString & |
endDateTime |
|
) |
[virtual] |
|
|
Schedule a file display alarm.
- Parameters:
-
| file | The text or image file to display. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| bgColor | The background colour for the alarm message window, or QString::null for the current default background colour. The string may be in any of the formats accepted by QColor::QColor(const QString&). |
| audioFile | The audio file to play when the alarm is displayed, or QString::null for none. |
| reminderMins | The number of minutes in advance of the main alarm and its recurrences to display a reminder alarm, or 0 for no reminder. |
| repeatType | The time units to use for recurrence. The actual recurrence interval is equal to repeatType multiplied by repeatInterval . The value of repeatType must a value defined in the RecurType enum. |
| repeatInterval | Recurrence interval in units defined by repeatType , or 0 for no recurrence. |
| endDateTime | Date/time after which the recurrence will end. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 122 of file dcophandler.cpp. |
bool DcopHandler::scheduleFile |
( |
const KURL & |
file, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
int |
recurType, |
|
|
int |
recurInterval, |
|
|
int |
recurCount |
|
) |
[virtual] |
|
|
Schedule a file display alarm.
- Parameters:
-
| file | The text or image file to display. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| bgColor | The background colour for the alarm message window, or QString::null for the current default background colour. The string may be in any of the formats accepted by QColor::QColor(const QString&). |
| audioFile | The audio file to play when the alarm is displayed, or QString::null for none. |
| reminderMins | The number of minutes in advance of the main alarm and its recurrences to display a reminder alarm, or 0 for no reminder. |
| repeatType | The time units to use for recurrence. The actual recurrence interval is equal to repeatType multiplied by repeatInterval . The value of repeatType must a value defined in the RecurType enum. |
| repeatInterval | Recurrence interval in units defined by repeatType , or 0 for no recurrence. |
| repeatCount | Recurrence count (after the first occurrence), or 0 for no recurrence. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 112 of file dcophandler.cpp. |
bool DcopHandler::scheduleFile |
( |
const KURL & |
file, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
const QString & |
recurrence, |
|
|
int |
subRepeatInterval, |
|
|
int |
subRepeatCount |
|
) |
[virtual] |
|
|
Schedule a file display alarm.
- Parameters:
-
| file | The text or image file to display. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| bgColor | The background colour for the alarm message window, or QString::null for the current default background colour. The string may be in any of the formats accepted by QColor::QColor(const QString&). |
| audioFile | The audio file to play when the alarm is displayed, or QString::null for none. |
| reminderMins | The number of minutes in advance of the main alarm and its recurrences to display a reminder alarm, or 0 for no reminder. |
| recurrence | Recurrence specification using iCalendar syntax (defined in RFC2445). |
| repeatInterval | Simple repetition repeat interval in minutes, or 0 for no sub-repetition. |
| repeatCount | Simple repetition repeat count (after the first occurrence), or 0 for no sub-repetition. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 101 of file dcophandler.cpp. |
bool DcopHandler::scheduleMessage |
( |
const QString & |
message, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const QString & |
fgColor, |
|
|
const QString & |
font, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
int |
recurType, |
|
|
int |
recurInterval, |
|
|
const QString & |
endDateTime |
|
) |
[virtual] |
|
|
Schedule a message display alarm.
- Parameters:
-
| message | The text of the message to display. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| bgColor | The background colour for the alarm message window, or QString::null for the current default background colour. The string may be in any of the formats accepted by QColor::QColor(const QString&). |
| fgColor | The foreground colour for the alarm message, or QString::null for the current default foreground colour. The format of the string is the same as for bgColor . |
| font | The font for the alarm message, or QString::null for the default message font current at the time the message is displayed. The string should be in format returned by QFont::toString(). |
| audioFile | The audio file to play when the alarm is displayed, or QString::null for none. |
| reminderMins | The number of minutes in advance of the main alarm and its recurrences to display a reminder alarm, or 0 for no reminder. |
| repeatType | The time units to use for recurrence. The actual recurrence interval is equal to repeatType multiplied by repeatInterval . The value of repeatType must a value defined in the RecurType enum. |
| repeatInterval | Recurrence interval in units defined by repeatType , or 0 for no recurrence. |
| endDateTime | Date/time after which the recurrence will end. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 89 of file dcophandler.cpp. |
bool DcopHandler::scheduleMessage |
( |
const QString & |
message, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const QString & |
fgColor, |
|
|
const QString & |
font, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
int |
recurType, |
|
|
int |
recurInterval, |
|
|
int |
recurCount |
|
) |
[virtual] |
|
|
Schedule a message display alarm.
- Parameters:
-
| message | The text of the message to display. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| bgColor | The background colour for the alarm message window, or QString::null for the current default background colour. The string may be in any of the formats accepted by QColor::QColor(const QString&). |
| fgColor | The foreground colour for the alarm message, or QString::null for the current default foreground colour. The format of the string is the same as for bgColor . |
| font | The font for the alarm message, or QString::null for the default message font current at the time the message is displayed. The string should be in format returned by QFont::toString(). |
| audioFile | The audio file to play when the alarm is displayed, or QString::null for none. |
| reminderMins | The number of minutes in advance of the main alarm and its recurrences to display a reminder alarm, or 0 for no reminder. |
| repeatType | The time units to use for recurrence. The actual recurrence interval is equal to repeatType multiplied by repeatInterval . The value of repeatType must a value defined in the RecurType enum. |
| repeatInterval | Recurrence interval in units defined by repeatType , or 0 for no recurrence. |
| repeatCount | Recurrence count (after the first occurrence), or 0 for no recurrence. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 77 of file dcophandler.cpp. |
bool DcopHandler::scheduleMessage |
( |
const QString & |
message, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const QString & |
fgColor, |
|
|
const QString & |
font, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
const QString & |
recurrence, |
|
|
int |
subRepeatInterval, |
|
|
int |
subRepeatCount |
|
) |
[virtual] |
|
|
Schedule a message display alarm.
- Parameters:
-
| message | The text of the message to display. |
| startDateTime | Start date/time, in the format YYYY-MM-DD[THH:MM[:SS]] or [T]HH:MM[:SS] |
| lateCancel | Late-cancellation period in minutes, or 0 for no cancellation. |
| flags | OR of flag bits defined in Flags enum. |
| bgColor | The background colour for the alarm message window, or QString::null for the current default background colour. The string may be in any of the formats accepted by QColor::QColor(const QString&). |
| fgColor | The foreground colour for the alarm message, or QString::null for the current default foreground colour. The format of the string is the same as for bgColor . |
| font | The font for the alarm message, or QString::null for the default message font current at the time the message is displayed. The string should be in format returned by QFont::toString(). |
| audioFile | The audio file to play when the alarm is displayed, or QString::null for none. |
| reminderMins | The number of minutes in advance of the main alarm and its recurrences to display a reminder alarm, or 0 for no reminder. |
| recurrence | Recurrence specification using iCalendar syntax (defined in RFC2445). |
| repeatInterval | Simple repetition repeat interval in minutes, or 0 for no sub-repetition. |
| repeatCount | Simple repetition repeat count (after the first occurrence), or 0 for no sub-repetition. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
Implements KAlarmIface.
Definition at line 65 of file dcophandler.cpp. |
bool DcopHandler::triggerEvent |
( |
const QString & |
url, |
|
|
const QString & |
eventId |
|
) |
[virtual] |
|
|
Trigger the immediate display or execution of an alarm, regardless of what time it is scheduled for.
- Parameters:
-
| url | - The URL (not path) of the calendar file containing the event to be triggered. Used only for integrity checking: the call will fail if it is not KAlarm's current calendar file. |
| eventId | - The unique ID of the event to be triggered, as stored in the calendar file url . |
Implements KAlarmIface.
Definition at line 60 of file dcophandler.cpp. |
The documentation for this class was generated from the following files:
|