kalarm
KAlarmIface Class Reference#include <kalarmiface.h>
List of all members.
Detailed Description
KAlarmIface provides a DCOP interface for other applications to request KAlarm actions.
Definition at line 36 of file kalarmiface.h.
|
Public Types |
enum | Flags {
REPEAT_AT_LOGIN = 0x01,
BEEP = 0x02,
REPEAT_SOUND = 0x08,
CONFIRM_ACK = 0x04,
AUTO_CLOSE = 0x10,
EMAIL_BCC = 0x20,
DISABLED = 0x40,
SCRIPT = 0x80,
EXEC_IN_XTERM = 0x100,
SPEAK = 0x200,
SHOW_IN_KORG = 0x400
} |
enum | RecurType {
MINUTELY = 1,
DAILY = 2,
WEEKLY = 3,
MONTHLY = 4,
YEARLY = 5
} |
DCOP Member Functions |
virtual bool | cancelEvent (const QString &url, const QString &eventId)=0 |
virtual bool | triggerEvent (const QString &url, const QString &eventId)=0 |
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 repeatInterval, int repeatCount)=0 |
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 repeatType, int repeatInterval, int repeatCount)=0 |
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 repeatType, int repeatInterval, const QString &endDateTime)=0 |
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 repeatInterval, int repeatCount)=0 |
virtual bool | scheduleFile (const KURL &file, const QString &startDateTime, int lateCancel, unsigned flags, const QString &bgColor, const KURL &audioFile, int reminderMins, int repeatType, int repeatInterval, int repeatCount)=0 |
virtual bool | scheduleFile (const KURL &file, const QString &startDateTime, int lateCancel, unsigned flags, const QString &bgColor, const KURL &audioFile, int reminderMins, int repeatType, int repeatInterval, const QString &endDateTime)=0 |
virtual bool | scheduleCommand (const QString &commandLine, const QString &startDateTime, int lateCancel, unsigned flags, const QString &recurrence, int repeatInterval, int repeatCount)=0 |
virtual bool | scheduleCommand (const QString &commandLine, const QString &startDateTime, int lateCancel, unsigned flags, int repeatType, int repeatInterval, int repeatCount)=0 |
virtual bool | scheduleCommand (const QString &commandLine, const QString &startDateTime, int lateCancel, unsigned flags, int repeatType, int repeatInterval, const QString &endDateTime)=0 |
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 repeatInterval, int repeatCount)=0 |
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 repeatType, int repeatInterval, int repeatCount)=0 |
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 repeatType, int repeatInterval, const QString &endDateTime)=0 |
Member Enumeration Documentation
|
Bit values for the flags parameter of "scheduleXxxx()" DCOP calls.
The bit values may be OR'ed together.
- REPEAT_AT_LOGIN - repeat the alarm at every login.
- BEEP - sound an audible beep when the alarm is displayed.
- SPEAK - speak the alarm message when it is displayed.
- REPEAT_SOUND - repeat the sound file while the alarm is displayed.
- CONFIRM_ACK - closing the alarm message window requires a confirmation prompt.
- AUTO_CLOSE - auto-close the alarm window after the late-cancel period.
- SCRIPT - the command to execute is a script, not a shell command line.
- EXEC_IN_XTERM - execute the command alarm in a terminal window.
- EMAIL_BCC - send a blind copy the email to the user.
- SHOW_IN_KORG - show the alarm as an event in KOrganizer
- DISABLED - set the alarm status to disabled.
Definition at line 54 of file kalarmiface.h. |
|
Values for the repeatType parameter of "scheduleXxxx()" DCOP calls.
- MINUTELY - the repeat interval is measured in minutes.
- DAILY - the repeat interval is measured in days.
- WEEKLY - the repeat interval is measured in weeks.
- MONTHLY - the repeat interval is measured in months.
- YEARLY - the repeat interval is measured in years.
Definition at line 75 of file kalarmiface.h. |
Member Function Documentation
virtual bool KAlarmIface::cancelEvent |
( |
const QString & |
url, |
|
|
const QString & |
eventId |
|
) |
[pure 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 . |
|
virtual bool KAlarmIface::scheduleCommand |
( |
const QString & |
commandLine, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
int |
repeatType, |
|
|
int |
repeatInterval, |
|
|
const QString & |
endDateTime |
|
) |
[pure 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.
|
virtual bool KAlarmIface::scheduleCommand |
( |
const QString & |
commandLine, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
int |
repeatType, |
|
|
int |
repeatInterval, |
|
|
int |
repeatCount |
|
) |
[pure 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.
|
virtual bool KAlarmIface::scheduleCommand |
( |
const QString & |
commandLine, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
recurrence, |
|
|
int |
repeatInterval, |
|
|
int |
repeatCount |
|
) |
[pure 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 simple repetition. |
| repeatCount | Simple repetition repeat count (after the first occurrence), or 0 for no simple repetition. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
|
virtual bool KAlarmIface::scheduleEmail |
( |
const QString & |
fromID, |
|
|
const QString & |
addresses, |
|
|
const QString & |
subject, |
|
|
const QString & |
message, |
|
|
const QString & |
attachments, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
int |
repeatType, |
|
|
int |
repeatInterval, |
|
|
const QString & |
endDateTime |
|
) |
[pure 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.
|
virtual bool KAlarmIface::scheduleEmail |
( |
const QString & |
fromID, |
|
|
const QString & |
addresses, |
|
|
const QString & |
subject, |
|
|
const QString & |
message, |
|
|
const QString & |
attachments, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
int |
repeatType, |
|
|
int |
repeatInterval, |
|
|
int |
repeatCount |
|
) |
[pure 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.
|
virtual bool KAlarmIface::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 |
repeatInterval, |
|
|
int |
repeatCount |
|
) |
[pure 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 simple repetition. |
| repeatCount | Simple repetition repeat count (after the first occurrence), or 0 for no simple repetition. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
|
virtual bool KAlarmIface::scheduleFile |
( |
const KURL & |
file, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
int |
repeatType, |
|
|
int |
repeatInterval, |
|
|
const QString & |
endDateTime |
|
) |
[pure 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.
|
virtual bool KAlarmIface::scheduleFile |
( |
const KURL & |
file, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
int |
repeatType, |
|
|
int |
repeatInterval, |
|
|
int |
repeatCount |
|
) |
[pure 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.
|
virtual bool KAlarmIface::scheduleFile |
( |
const KURL & |
file, |
|
|
const QString & |
startDateTime, |
|
|
int |
lateCancel, |
|
|
unsigned |
flags, |
|
|
const QString & |
bgColor, |
|
|
const KURL & |
audioFile, |
|
|
int |
reminderMins, |
|
|
const QString & |
recurrence, |
|
|
int |
repeatInterval, |
|
|
int |
repeatCount |
|
) |
[pure 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 simple repetition. |
| repeatCount | Simple repetition repeat count (after the first occurrence), or 0 for no simple repetition. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
|
virtual bool KAlarmIface::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 |
repeatType, |
|
|
int |
repeatInterval, |
|
|
const QString & |
endDateTime |
|
) |
[pure 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.
|
virtual bool KAlarmIface::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 |
repeatType, |
|
|
int |
repeatInterval, |
|
|
int |
repeatCount |
|
) |
[pure 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.
|
virtual bool KAlarmIface::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 |
repeatInterval, |
|
|
int |
repeatCount |
|
) |
[pure 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 simple repetition. |
| repeatCount | Simple repetition repeat count (after the first occurrence), or 0 for no simple repetition. |
- Returns:
- true if alarm was scheduled successfully, false if configuration errors were found.
|
virtual bool KAlarmIface::triggerEvent |
( |
const QString & |
url, |
|
|
const QString & |
eventId |
|
) |
[pure 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 . |
|
The documentation for this class was generated from the following file:
|