kalarm
KAEvent Class Reference
#include <alarmevent.h>
Inheritance diagram for KAEvent:

Detailed Description
KAEvent corresponds to a KCal::Event instance.Definition at line 231 of file alarmevent.h.
Public Types | |
enum | { BEEP = 0x02, REPEAT_AT_LOGIN = 0x04, ANY_TIME = 0x08, CONFIRM_ACK = 0x10, EMAIL_BCC = 0x20, DEFAULT_FONT = 0x40, REPEAT_SOUND = 0x80, DISABLED = 0x100, AUTO_CLOSE = 0x200, SCRIPT = 0x400, EXEC_IN_XTERM = 0x800, SPEAK = 0x1000, COPY_KORGANIZER = 0x2000, REMINDER = 0x10000, DEFERRAL = 0x20000, TIMED_FLAG = 0x40000, DATE_DEFERRAL = DEFERRAL, TIME_DEFERRAL = DEFERRAL | TIMED_FLAG, DISPLAYING_ = 0x80000, READ_ONLY_FLAGS = 0xF0000 } |
enum | Status { ACTIVE, EXPIRED, DISPLAYING, TEMPLATE, KORGANIZER } |
enum | Action { MESSAGE = T_MESSAGE, FILE = T_FILE, COMMAND = T_COMMAND, EMAIL = T_EMAIL } |
enum | OccurType { NO_OCCURRENCE = 0, FIRST_OR_ONLY_OCCURRENCE = 0x01, RECURRENCE_DATE = 0x02, RECURRENCE_DATE_TIME = 0x03, LAST_RECURRENCE = 0x04, OCCURRENCE_REPEAT = 0x10, FIRST_OR_ONLY_OCCURRENCE_REPEAT = OCCURRENCE_REPEAT | FIRST_OR_ONLY_OCCURRENCE, RECURRENCE_DATE_REPEAT = OCCURRENCE_REPEAT | RECURRENCE_DATE, RECURRENCE_DATE_TIME_REPEAT = OCCURRENCE_REPEAT | RECURRENCE_DATE_TIME, LAST_RECURRENCE_REPEAT = OCCURRENCE_REPEAT | LAST_RECURRENCE } |
enum | OccurOption { IGNORE_REPETITION, RETURN_REPETITION, ALLOW_FOR_REPETITION } |
enum | DeferLimitType { LIMIT_NONE, LIMIT_MAIN, LIMIT_RECURRENCE, LIMIT_REPETITION, LIMIT_REMINDER } |
Public Member Functions | |
KAEvent () | |
KAEvent (const QDateTime &dt, const QString &message, const QColor &bg, const QColor &fg, const QFont &f, Action action, int lateCancel, int flags) | |
KAEvent (const KCal::Event &e) | |
KAEvent (const KAEvent &e) | |
~KAEvent () | |
KAEvent & | operator= (const KAEvent &e) |
void | set (const KCal::Event &) |
void | set (const QDate &d, const QString &message, const QColor &bg, const QColor &fg, const QFont &f, Action action, int lateCancel, int flags) |
void | set (const QDateTime &, const QString &message, const QColor &bg, const QColor &fg, const QFont &, Action, int lateCancel, int flags) |
void | setMessage (const QDate &d, const QString &message, const QColor &bg, const QColor &fg, const QFont &f, int lateCancel, int flags) |
void | setMessage (const QDateTime &dt, const QString &message, const QColor &bg, const QColor &fg, const QFont &f, int lateCancel, int flags) |
void | setFileName (const QDate &d, const QString &filename, const QColor &bg, const QColor &fg, const QFont &f, int lateCancel, int flags) |
void | setFileName (const QDateTime &dt, const QString &filename, const QColor &bg, const QColor &fg, const QFont &f, int lateCancel, int flags) |
void | setCommand (const QDate &, const QString &command, int lateCancel, int flags, const QString &logfile=QString::null) |
void | setCommand (const QDateTime &, const QString &command, int lateCancel, int flags, const QString &logfile=QString::null) |
void | setEmail (const QDate &, const QString &from, const EmailAddressList &, const QString &subject, const QString &message, const QStringList &attachments, int lateCancel, int flags) |
void | setEmail (const QDateTime &, const QString &from, const EmailAddressList &, const QString &subject, const QString &message, const QStringList &attachments, int lateCancel, int flags) |
void | setEmail (const QString &from, const EmailAddressList &, const QString &subject, const QStringList &attachments) |
void | setAudioFile (const QString &filename, float volume, float fadeVolume, int fadeSeconds) |
void | setTemplate (const QString &name, int afterTime=-1) |
void | setActions (const QString &pre, const QString &post) |
OccurType | setNextOccurrence (const QDateTime &preDateTime) |
void | setFirstRecurrence () |
void | setEventID (const QString &id) |
void | adjustStartDate (const QDate &) |
void | setDate (const QDate &d) |
void | setTime (const QDateTime &dt) |
void | setSaveDateTime (const QDateTime &dt) |
void | setLateCancel (int lc) |
void | setAutoClose (bool ac) |
void | setRepeatAtLogin (bool rl) |
void | set (int flags) |
void | setUid (Status s) |
void | setKMailSerialNumber (unsigned long n) |
void | setLogFile (const QString &logfile) |
void | setReminder (int minutes, bool onceOnly) |
bool | defer (const DateTime &, bool reminder, bool adjustRecurrence=false) |
void | cancelDefer () |
void | cancelCancelledDeferral () |
void | setDeferDefaultMinutes (int minutes) |
bool | setDisplaying (const KAEvent &, KAAlarm::Type, const QDateTime &) |
void | reinstateFromDisplaying (const KAEvent &dispEvent) |
void | setArchive () |
void | setEnabled (bool enable) |
void | setUpdated () |
void | clearUpdated () const |
void | removeExpiredAlarm (KAAlarm::Type) |
void | incrementRevision () |
KCal::Event * | event () const |
bool | isTemplate () const |
const QString & | templateName () const |
bool | usingDefaultTime () const |
int | templateAfterTime () const |
KAAlarm | alarm (KAAlarm::Type) const |
KAAlarm | firstAlarm () const |
KAAlarm | nextAlarm (const KAAlarm &al) const |
KAAlarm | nextAlarm (KAAlarm::Type) const |
KAAlarm | convertDisplayingAlarm () const |
bool | updateKCalEvent (KCal::Event &, bool checkUid=true, bool original=false, bool cancelCancelledDefer=false) const |
Action | action () const |
bool | displayAction () const |
const QString & | id () const |
bool | valid () const |
int | alarmCount () const |
const DateTime & | startDateTime () const |
DateTime | mainDateTime (bool withRepeats=false) const |
QDate | mainDate () const |
QTime | mainTime () const |
DateTime | mainEndRepeatTime () const |
int | reminder () const |
bool | reminderOnceOnly () const |
bool | reminderDeferral () const |
int | reminderArchived () const |
DateTime | deferDateTime () const |
DateTime | deferralLimit (DeferLimitType *=0) const |
int | deferDefaultMinutes () const |
DateTime | nextDateTime (bool includeReminders=true) const |
const QString & | messageFileOrCommand () const |
QString | logFile () const |
bool | commandXterm () const |
unsigned long | kmailSerialNumber () const |
bool | copyToKOrganizer () const |
const QString & | audioFile () const |
float | soundVolume () const |
float | fadeVolume () const |
int | fadeSeconds () const |
bool | repeatSound () const |
const QString & | preAction () const |
const QString & | postAction () const |
bool | recurs () const |
KARecurrence::Type | recurType () const |
KARecurrence * | recurrence () const |
int | recurInterval () const |
int | longestRecurrenceInterval () const |
QString | recurrenceText (bool brief=false) const |
QString | repetitionText (bool brief=false) const |
int | remainingRecurrences () const |
bool | occursAfter (const QDateTime &preDateTime, bool includeRepetitions) const |
OccurType | nextOccurrence (const QDateTime &preDateTime, DateTime &result, OccurOption=IGNORE_REPETITION) const |
OccurType | previousOccurrence (const QDateTime &afterDateTime, DateTime &result, bool includeRepetitions=false) const |
int | flags () const |
bool | deferred () const |
bool | toBeArchived () const |
bool | enabled () const |
bool | updated () const |
bool | mainExpired () const |
bool | expired () const |
Status | uidStatus () const |
bool | setRepetition (int interval, int count) |
void | setNoRecur () |
void | setRecurrence (const KARecurrence &) |
bool | setRecurMinutely (int freq, int count, const QDateTime &end) |
bool | setRecurDaily (int freq, const QBitArray &days, int count, const QDate &end) |
bool | setRecurWeekly (int freq, const QBitArray &days, int count, const QDate &end) |
bool | setRecurMonthlyByDate (int freq, const QValueList< int > &days, int count, const QDate &end) |
bool | setRecurMonthlyByPos (int freq, const QValueList< MonthPos > &pos, int count, const QDate &end) |
bool | setRecurAnnualByDate (int freq, const QValueList< int > &months, int day, KARecurrence::Feb29Type, int count, const QDate &end) |
bool | setRecurAnnualByPos (int freq, const QValueList< MonthPos > &pos, const QValueList< int > &months, int count, const QDate &end) |
void | dumpDebug () const |
Static Public Member Functions | |
static Status | uidStatus (const QString &uid) |
static QString | uid (const QString &id, Status) |
static KAEvent | findTemplateName (AlarmCalendar &, const QString &name) |
static int | calVersion () |
static QString | calVersionString () |
static bool | adjustStartOfDay (const KCal::Event::List &) |
static void | convertKCalEvents (KCal::Calendar &, int version, bool adjustSummerTime) |
Classes | |
struct | MonthPos |
Member Enumeration Documentation
anonymous enum |
- Enumerator:
Definition at line 234 of file alarmevent.h.
enum KAEvent::Status |
The category of an event, indicated by the middle part of its UID.
Definition at line 269 of file alarmevent.h.
enum KAEvent::Action |
enum KAEvent::OccurType |
- Enumerator:
Definition at line 284 of file alarmevent.h.
enum KAEvent::OccurOption |
Definition at line 297 of file alarmevent.h.
Definition at line 303 of file alarmevent.h.
The documentation for this class was generated from the following files: