KAlarmIface Class Reference

#include <kalarmiface.h>

Inheritance diagram for KAlarmIface:

Public Types
enum	AlarmType { DISPLAY = 1, COMMAND = 2, EMAIL = 3, AUDIO = 4 }
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, DISPLAY_COMMAND = 0x800,   EXCL_HOLIDAYS = 0x1000, WORK_TIME_ONLY = 0x2000 }
enum	RecurType {   MINUTELY = 1, DAILY = 2, WEEKLY = 3, MONTHLY = 4,   YEARLY = 5 }

Detailed Description

KAlarmIface provides a D-Bus interface for other applications to request KAlarm actions.

Definition at line 30 of file kalarmiface.h.

Member Enumeration Documentation

enum KAlarmIface::AlarmType

Values for the type parameter of "editNew()" D-Bus call.

• DISPLAY - create a display alarm.
• COMMAND - create a command alarm.
• EMAIL - create an email alarm.

Enumerator
DISPLAY
COMMAND
EMAIL
AUDIO

Definition at line 87 of file kalarmiface.h.

enum KAlarmIface::Flags

Bit values for the flags parameter of "scheduleXxxx()" D-Bus 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.
• DISPLAY_COMMAND - display command output in the alarm window.
• 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
• EXCL_HOLIDAYS - do not trigger the alarm on holidays
• WORK_TIME_ONLY - do not trigger the alarm outside working hours (or on holidays)
• DISABLED - set the alarm status to disabled.

Enumerator
REPEAT_AT_LOGIN
BEEP
REPEAT_SOUND
CONFIRM_ACK
AUTO_CLOSE
EMAIL_BCC
DISABLED
SCRIPT
EXEC_IN_XTERM
SPEAK
SHOW_IN_KORG
DISPLAY_COMMAND
EXCL_HOLIDAYS
WORK_TIME_ONLY

Definition at line 50 of file kalarmiface.h.

enum KAlarmIface::RecurType

Values for the repeatType parameter of "scheduleXxxx()" D-Bus 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.

Enumerator
MINUTELY
DAILY
WEEKLY
MONTHLY
YEARLY

Definition at line 74 of file kalarmiface.h.

---

The documentation for this class was generated from the following file:

• kalarmiface.h