kalarm

#include <alarmevent.h>

Inherits KAAlarmEventBase.

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 (const TQDateTime &dt, const TQString &message, const TQColor &bg, const TQColor &fg, const TQFont &f, Action action, int lateCancel, int flags)
 KAEvent (const KCal::Event &e)
 KAEvent (const KAEvent &e)
KAEventoperator= (const KAEvent &e)
void set (const KCal::Event &)
void set (const TQDateTime &, const TQString &message, const TQColor &bg, const TQColor &fg, const TQFont &, Action, int lateCancel, int flags)
void setEmail (uint from, const EmailAddressList &, const TQString &subject, const TQStringList &attachments)
void setAudioFile (const TQString &filename, float volume, float fadeVolume, int fadeSeconds)
void setTemplate (const TQString &name, int afterTime=-1)
void setActions (const TQString &pre, const TQString &post)
OccurType setNextOccurrence (const TQDateTime &preDateTime)
void setFirstRecurrence ()
void setEventID (const TQString &id)
void setDate (const TQDate &d)
void setTime (const TQDateTime &dt)
void setSaveDateTime (const TQDateTime &dt)
void setLateCancel (int lc)
void setAutoClose (bool ac)
void setRepeatAtLogin (bool rl)
void setUid (Status s)
void setKMailSerialNumber (unsigned long n)
void setLogFile (const TQString &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 TQDateTime &)
void reinstateFromDisplaying (const KAEvent &dispEvent)
void setArchive ()
void setEnabled (bool enable)
void setUpdated ()
void clearUpdated () const
void removeExpiredAlarm (KAAlarm::Type)
void incrementRevision ()
KCal::Eventevent () const
bool isTemplate () const
const TQString & 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 TQString & id () const
bool valid () const
int alarmCount () const
const DateTime & startDateTime () const
DateTime mainDateTime (bool withRepeats=false) const
TQDate mainDate () const
TQTime 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 displayDateTime () const
const TQString & messageFileOrCommand () const
TQString logFile () const
bool commandXterm () const
unsigned long kmailSerialNumber () const
bool copyToKOrganizer () const
const TQString & audioFile () const
float soundVolume () const
float fadeVolume () const
int fadeSeconds () const
bool repeatSound () const
const TQString & preAction () const
const TQString & postAction () const
bool recurs () const
KARecurrence::Type recurType () const
KARecurrence * recurrence () const
int recurInterval () const
int longestRecurrenceInterval () const
TQString recurrenceText (bool brief=false) const
TQString repetitionText (bool brief=false) const
bool occursAfter (const TQDateTime &preDateTime, bool includeRepetitions) const
OccurType nextOccurrence (const TQDateTime &preDateTime, DateTime &result, OccurOption=IGNORE_REPETITION) const
OccurType previousOccurrence (const TQDateTime &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 TQDateTime &end)
bool setRecurDaily (int freq, const TQBitArray &days, int count, const TQDate &end)
bool setRecurWeekly (int freq, const TQBitArray &days, int count, const TQDate &end)
bool setRecurMonthlyByDate (int freq, const TQValueList< int > &days, int count, const TQDate &end)
bool setRecurMonthlyByPos (int freq, const TQValueList< MonthPos > &pos, int count, const TQDate &end)
bool setRecurAnnualByDate (int freq, const TQValueList< int > &months, int day, KARecurrence::Feb29Type, int count, const TQDate &end)
bool setRecurAnnualByPos (int freq, const TQValueList< MonthPos > &pos, const TQValueList< int > &months, int count, const TQDate &end)
void dumpDebug () const
- Public Member Functions inherited from KAAlarmEventBase
const TQString & cleanText () const
TQString message () const
TQString fileName () const
TQString command () const
uint emailFromId () const
const EmailAddressList & emailAddresses () const
TQString emailAddresses (const TQString &sep) const
const TQString & emailSubject () const
const TQStringList & emailAttachments () const
TQString emailAttachments (const TQString &sep) const
bool emailBcc () const
const TQColor & bgColour () const
const TQColor & fgColour () const
bool defaultFont () const
const TQFont & font () const
int lateCancel () const
bool autoClose () const
bool commandScript () const
bool confirmAck () const
bool repeatAtLogin () const
int repeatCount () const
int repeatInterval () const
bool displaying () const
bool beep () const
bool speak () const
int flags () const
void dumpDebug () const

Static Public Member Functions

static Status uidStatus (const TQString &uid)
static TQString uid (const TQString &id, Status)
static KAEvent findTemplateName (AlarmCalendar &, const TQString &name)
static int calVersion ()
static TQString calVersionString ()
static bool adjustStartOfDay (const KCal::Event::List &)
static void convertKCalEvents (KCal::Calendar &, int version, bool adjustSummerTime)
static void convertRepetitions (KCal::CalendarLocal &)

Additional Inherited Members

- Protected Types inherited from KAAlarmEventBase
enum  Type {
  T_MESSAGE, T_FILE, T_COMMAND, T_AUDIO,
  T_EMAIL
}
- Protected Member Functions inherited from KAAlarmEventBase
 KAAlarmEventBase (const KAAlarmEventBase &rhs)
KAAlarmEventBase & operator= (const KAAlarmEventBase &rhs)
void copy (const KAAlarmEventBase &)
void set (int flags)
- Protected Attributes inherited from KAAlarmEventBase
TQString mEventID
TQString mText
DateTime mNextMainDateTime
TQColor mBgColour
TQColor mFgColour
TQFont mFont
uint mEmailFromIdentity
EmailAddressList mEmailAddresses
TQString mEmailSubject
TQStringList mEmailAttachments
float mSoundVolume
float mFadeVolume
int mFadeSeconds
Type mActionType
int mRepeatCount
int mRepeatInterval
int mNextRepeat
int mLateCancel
bool mAutoClose
bool mCommandScript
bool mBeep
bool mSpeak
bool mRepeatSound
bool mRepeatAtLogin
bool mDisplaying
bool mEmailBcc
bool mConfirmAck
bool mDefaultFont

Detailed Description

KAEvent corresponds to a KCal::Event instance.

Definition at line 231 of file alarmevent.h.

Member Enumeration Documentation

The category of an event, indicated by the middle part of its UID.

Definition at line 269 of file alarmevent.h.


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