KAlarm Library
#include <kaevent.h>
Public Types | |
enum | Action { MESSAGE, FILE, COMMAND, EMAIL, AUDIO } |
enum | Type { INVALID_ALARM = 0, MAIN_ALARM = 1, REMINDER_ALARM = 0x02, DEFERRED_ALARM = 0x04, DEFERRED_REMINDER_ALARM = REMINDER_ALARM | DEFERRED_ALARM, AT_LOGIN_ALARM = 0x10, DISPLAYING_ALARM = 0x20 } |
Public Member Functions | |
KAAlarm () | |
KAAlarm (const KAAlarm &other) | |
~KAAlarm () | |
Action | action () const |
QDate | date () const |
DateTime | dateTime (bool withRepeats=false) const |
bool | deferred () const |
bool | isReminder () const |
bool | isValid () const |
KAAlarm & | operator= (const KAAlarm &other) |
bool | repeatAtLogin () const |
void | setTime (const DateTime &dt) |
void | setTime (const KDateTime &dt) |
QTime | time () const |
bool | timedDeferral () const |
Type | type () const |
Static Public Member Functions | |
static const char * | debugType (Type) |
Detailed Description
KAAlarm represents individual alarms within a KAEvent.
The KAAlarm class represents one of the main or subsidiary alarms in a KAEvent instance. It contains the alarm's type and trigger time.
Note that valid KAAlarm instances can only be created by the KAEvent class.
Member Enumeration Documentation
The basic KAAlarm action types.
- Enumerator:
Alarm types.
KAAlarm's of different types may be contained in a KAEvent, each KAAlarm defining a different component of the overall alarm.
- Enumerator:
Constructor & Destructor Documentation
Default constructor, which creates an invalid instance.
Definition at line 6066 of file kaevent.cpp.
KAlarmCal::KAAlarm::KAAlarm | ( | const KAAlarm & | other | ) |
Copy constructor.
Definition at line 6079 of file kaevent.cpp.
Destructor.
Definition at line 6084 of file kaevent.cpp.
Member Function Documentation
KAAlarm::Action KAlarmCal::KAAlarm::action | ( | ) | const |
Return the action type for the alarm.
Definition at line 6096 of file kaevent.cpp.
QDate KAlarmCal::KAAlarm::date | ( | ) | const |
Return the trigger date for the alarm.
Sub-repetitions are ignored: if a sub-repetition is due next, the last main recurrence will be returned instead.
Definition at line 6118 of file kaevent.cpp.
DateTime KAlarmCal::KAAlarm::dateTime | ( | bool | withRepeats = false | ) | const |
Return the trigger time for the alarm.
Sub-repetitions can optionally be ignored; in this case, if a sub-repetition is due next, the last main recurrence will be returned instead.
- Parameters:
-
withRepeats if true, returns the next sub-repetition time where appropriate; if false, ignores sub-repetitions.
Definition at line 6111 of file kaevent.cpp.
const char * KAlarmCal::KAAlarm::debugType | ( | Type | type | ) | [static] |
Return an alarm type as a string.
- Returns:
- alarm type string, or the empty string if debug output is disabled.
Definition at line 6161 of file kaevent.cpp.
bool KAlarmCal::KAAlarm::deferred | ( | ) | const |
Return whether this is a deferred alarm.
Definition at line 6138 of file kaevent.cpp.
bool KAlarmCal::KAAlarm::isReminder | ( | ) | const |
Return whether this is a reminder alarm.
Definition at line 6133 of file kaevent.cpp.
bool KAlarmCal::KAAlarm::isValid | ( | ) | const |
Return whether the alarm is valid, i.e.
whether it contains any alarm data.
Definition at line 6101 of file kaevent.cpp.
Assignment operator.
Definition at line 6089 of file kaevent.cpp.
bool KAlarmCal::KAAlarm::repeatAtLogin | ( | ) | const |
Return whether this is a repeat-at-login alarm.
Definition at line 6128 of file kaevent.cpp.
void KAlarmCal::KAAlarm::setTime | ( | const DateTime & | dt | ) |
Set the alarm's trigger time.
Definition at line 6148 of file kaevent.cpp.
void KAlarmCal::KAAlarm::setTime | ( | const KDateTime & | dt | ) |
Set the alarm's trigger time.
Definition at line 6153 of file kaevent.cpp.
QTime KAlarmCal::KAAlarm::time | ( | ) | const |
Return the trigger time-of-day for the alarm.
Sub-repetitions are ignored: if a sub-repetition is due next, the last main recurrence will be returned instead.
- Returns:
- trigger time-of-day. If the alarm is date-only, this will be the user-defined start-of-day time.
Definition at line 6123 of file kaevent.cpp.
bool KAlarmCal::KAAlarm::timedDeferral | ( | ) | const |
Return whether in the case of a deferred alarm, it is timed (as opposed to date-only).
- Returns:
true
if a timed deferral alarm,false
if date-only or not a deferred alarm.
Definition at line 6143 of file kaevent.cpp.
KAAlarm::Type KAlarmCal::KAAlarm::type | ( | ) | const |
Return the alarm's type (main, reminder, etc.).
Definition at line 6106 of file kaevent.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Apr 30 2012 21:50:08 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.