• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

kalarm

KAEvent Class Reference

#include <alarmevent.h>

Inheritance diagram for KAEvent:

Inheritance graph
[legend]

List of all members.

Detailed Description

KAEvent corresponds to a KCal::Event instance.

Definition at line 234 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, WORK_TIME_ONLY = 0x4000, DISPLAY_COMMAND = 0x8000, REMINDER = 0x10000,
  DEFERRAL = 0x20000, TIMED_FLAG = 0x40000, DATE_DEFERRAL = DEFERRAL, TIME_DEFERRAL = DEFERRAL | TIMED_FLAG,
  DISPLAYING_ = 0x80000, READ_ONLY_FLAGS = 0xF0000
}
enum  Action { MESSAGE = T_MESSAGE, FILE = T_FILE, COMMAND = T_COMMAND, EMAIL = T_EMAIL }
enum  DeferLimitType {
  LIMIT_NONE, LIMIT_MAIN, LIMIT_RECURRENCE, LIMIT_REPETITION,
  LIMIT_REMINDER
}
typedef QList< KAEvent * > List
enum  OccurOption { IGNORE_REPETITION, RETURN_REPETITION, ALLOW_FOR_REPETITION }
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  TriggerType {
  ALL_TRIGGER, MAIN_TRIGGER, WORK_TRIGGER, ALL_WORK_TRIGGER,
  DISPLAY_TRIGGER
}

Public Member Functions

Action action () const
KAAlarm alarm (KAAlarm::Type) const
int alarmCount () const
const QString & audioFile () const
void cancelCancelledDeferral ()
void cancelDefer ()
bool cancelOnPreActionError () const
KCalEvent::Status category () const
void clearResourceID ()
void clearUpdated () const
bool commandDisplay () const
bool commandXterm () const
KAAlarm convertDisplayingAlarm () const
bool copyToKOrganizer () const
bool defer (const DateTime &, bool reminder, bool adjustRecurrence=false)
DateTime deferDateTime () const
int deferDefaultMinutes () const
DateTime deferralLimit (DeferLimitType *=0) const
bool deferred () const
bool displayAction () const
void dumpDebug () const
bool enabled () const
void endChanges ()
bool expired () const
int fadeSeconds () const
float fadeVolume () const
KAAlarm firstAlarm () const
int flags () const
const QString & id () const
void incrementRevision ()
bool isTemplate () const
 KAEvent (const KAEvent &e)
 KAEvent (const KCal::Event *e)
 KAEvent (const KDateTime &dt, const QString &message, const QColor &bg, const QColor &fg, const QFont &f, Action action, int lateCancel, int flags, bool changesPending=false)
 KAEvent ()
unsigned long kmailSerialNumber () const
QString logFile () const
KCal::Duration longestRecurrenceInterval () const
QDate mainDate () const
DateTime mainDateTime (bool withRepeats=false) const
DateTime mainEndRepeatTime () const
bool mainExpired () const
QTime mainTime () const
const QString & messageFileOrCommand () const
KAAlarm nextAlarm (KAAlarm::Type) const
KAAlarm nextAlarm (const KAAlarm &al) const
OccurType nextOccurrence (const KDateTime &preDateTime, DateTime &result, OccurOption=IGNORE_REPETITION) const
DateTime nextTrigger (TriggerType) const
bool occursAfter (const KDateTime &preDateTime, bool includeRepetitions) const
KAEvent & operator= (const KAEvent &e)
const QString & postAction () const
const QString & preAction () const
OccurType previousOccurrence (const KDateTime &afterDateTime, DateTime &result, bool includeRepetitions=false) const
int recurInterval () const
KARecurrence * recurrence () const
QString recurrenceText (bool brief=false) const
bool recurs () const
KARecurrence::Type recurType () const
void reinstateFromDisplaying (const KCal::Event *, QString &resourceID, bool &showEdit, bool &showDefer)
int reminder () const
int reminderArchived () const
bool reminderDeferral () const
bool reminderOnceOnly () const
void removeExpiredAlarm (KAAlarm::Type)
bool repeatSound () const
QString repetitionText (bool brief=false) const
AlarmResource * resource () const
QString resourceID () const
void set (const KDateTime &, const QString &message, const QColor &bg, const QColor &fg, const QFont &, Action, int lateCancel, int flags, bool changesPending=false)
void set (const KCal::Event *)
void setActions (const QString &pre, const QString &post, bool cancelOnError)
void setArchive ()
void setAudioFile (const QString &filename, float volume, float fadeVolume, int fadeSeconds)
void setAutoClose (bool ac)
void setCategory (KCalEvent::Status)
void setDeferDefaultMinutes (int minutes)
bool setDisplaying (const KAEvent &, KAAlarm::Type, const QString &resourceID, const KDateTime &, bool showEdit, bool showDefer)
void setEmail (uint from, const EmailAddressList &, const QString &subject, const QStringList &attachments)
void setEnabled (bool enable)
void setEventID (const QString &id)
void setFirstRecurrence ()
void setKMailSerialNumber (unsigned long n)
void setLateCancel (int lc)
void setLogFile (const QString &logfile)
OccurType setNextOccurrence (const KDateTime &preDateTime)
void setNoRecur ()
bool setRecurAnnualByDate (int freq, const QList< int > &months, int day, Preferences::Feb29Type, int count, const QDate &end)
bool setRecurAnnualByPos (int freq, const QList< MonthPos > &pos, const QList< int > &months, int count, const QDate &end)
bool setRecurDaily (int freq, const QBitArray &days, int count, const QDate &end)
bool setRecurMinutely (int freq, int count, const KDateTime &end)
bool setRecurMonthlyByDate (int freq, const QList< int > &days, int count, const QDate &end)
bool setRecurMonthlyByPos (int freq, const QList< MonthPos > &pos, int count, const QDate &end)
void setRecurrence (const KARecurrence &)
bool setRecurWeekly (int freq, const QBitArray &days, int count, const QDate &end)
void setReminder (int minutes, bool onceOnly)
void setRepeatAtLogin (bool rl)
bool setRepetition (const KCal::Duration &, int count)
void setResource (AlarmResource *r)
void setSaveDateTime (const KDateTime &dt)
void setTemplate (const QString &name, int afterTime=-1)
void setTime (const KDateTime &dt)
void setUid (KCalEvent::Status s)
void setUpdated ()
void setWorkTimeOnly (bool wto)
float soundVolume () const
bool speak () const
void startChanges ()
const DateTime & startDateTime () const
int templateAfterTime () const
const QString & templateName () const
bool toBeArchived () const
bool updated () const
bool updateKCalEvent (KCal::Event *, bool checkUid=true, bool original=false, bool cancelCancelledDefer=false) const
void updateWorkHours () const
bool usingDefaultTime () const
bool valid () const
bool workTimeOnly () const
 ~KAEvent ()

Static Public Member Functions

static bool adjustStartOfDay (const KCal::Event::List &)
static int calVersion ()
static QString calVersionString ()
static bool convertKCalEvents (KCal::CalendarLocal &, int version, bool adjustSummerTime)

Classes

struct  MonthPos

Member Typedef Documentation

typedef QList<KAEvent*> KAEvent::List

Definition at line 237 of file alarmevent.h.

Member Enumeration Documentation

anonymous enum

Enumerator:
BEEP 
REPEAT_AT_LOGIN 
ANY_TIME 
CONFIRM_ACK 
EMAIL_BCC 
DEFAULT_FONT 
REPEAT_SOUND 
DISABLED 
AUTO_CLOSE 
SCRIPT 
EXEC_IN_XTERM 
SPEAK 
COPY_KORGANIZER 
WORK_TIME_ONLY 
DISPLAY_COMMAND 
REMINDER 
DEFERRAL 
TIMED_FLAG 
DATE_DEFERRAL 
TIME_DEFERRAL 
DISPLAYING_ 
READ_ONLY_FLAGS 

Definition at line 238 of file alarmevent.h.

enum KAEvent::Action

Enumerator:
MESSAGE 
FILE 
COMMAND 
EMAIL 

Definition at line 264 of file alarmevent.h.

enum KAEvent::DeferLimitType

Enumerator:
LIMIT_NONE 
LIMIT_MAIN 
LIMIT_RECURRENCE 
LIMIT_REPETITION 
LIMIT_REMINDER 

Definition at line 290 of file alarmevent.h.

enum KAEvent::OccurOption

Enumerator:
IGNORE_REPETITION 
RETURN_REPETITION 
ALLOW_FOR_REPETITION 

Definition at line 284 of file alarmevent.h.

enum KAEvent::OccurType

Enumerator:
NO_OCCURRENCE 
FIRST_OR_ONLY_OCCURRENCE 
RECURRENCE_DATE 
RECURRENCE_DATE_TIME 
LAST_RECURRENCE 
OCCURRENCE_REPEAT 
FIRST_OR_ONLY_OCCURRENCE_REPEAT 
RECURRENCE_DATE_REPEAT 
RECURRENCE_DATE_TIME_REPEAT 
LAST_RECURRENCE_REPEAT 

Definition at line 271 of file alarmevent.h.

enum KAEvent::TriggerType

Enumerator:
ALL_TRIGGER 
MAIN_TRIGGER 
WORK_TRIGGER 
ALL_WORK_TRIGGER 
DISPLAY_TRIGGER 

Definition at line 298 of file alarmevent.h.

Constructor & Destructor Documentation

KAEvent::KAEvent (  )  [inline]

Definition at line 307 of file alarmevent.h.

KAEvent::KAEvent ( const KDateTime &  dt,
const QString &  message,
const QColor &  bg,
const QColor &  fg,
const QFont &  f,
Action  action,
int  lateCancel,
int  flags,
bool  changesPending = false 
) [inline]

Definition at line 309 of file alarmevent.h.

KAEvent::KAEvent ( const KCal::Event *  e  )  [inline, explicit]

Definition at line 311 of file alarmevent.h.

KAEvent::KAEvent ( const KAEvent &  e  )  [inline]

Definition at line 312 of file alarmevent.h.

KAEvent::~KAEvent (  )  [inline]

Definition at line 313 of file alarmevent.h.

Member Function Documentation

Action KAEvent::action (  )  const [inline]

Definition at line 364 of file alarmevent.h.

static bool KAEvent::adjustStartOfDay ( const KCal::Event::List &   )  [static]

KAAlarm KAEvent::alarm ( KAAlarm::Type  type  )  const

Definition at line 2015 of file alarmevent.cpp.

int KAEvent::alarmCount (  )  const [inline]

Definition at line 368 of file alarmevent.h.

const QString& KAEvent::audioFile (  )  const [inline]

Definition at line 393 of file alarmevent.h.

int KAEvent::calVersion (  )  [static]

Definition at line 50 of file alarmevent.cpp.

QString KAEvent::calVersionString (  )  [static]

Definition at line 49 of file alarmevent.cpp.

void KAEvent::cancelCancelledDeferral (  ) 

Definition at line 2382 of file alarmevent.cpp.

void KAEvent::cancelDefer (  ) 

Definition at line 2359 of file alarmevent.cpp.

bool KAEvent::cancelOnPreActionError (  )  const [inline]

Definition at line 400 of file alarmevent.h.

KCalEvent::Status KAEvent::category (  )  const [inline]

Definition at line 418 of file alarmevent.h.

void KAEvent::clearResourceID (  )  [inline]

Definition at line 349 of file alarmevent.h.

void KAEvent::clearUpdated (  )  const [inline]

Definition at line 348 of file alarmevent.h.

bool KAEvent::commandDisplay (  )  const [inline]

Definition at line 388 of file alarmevent.h.

bool KAEvent::commandXterm (  )  const [inline]

Definition at line 387 of file alarmevent.h.

KAAlarm KAEvent::convertDisplayingAlarm (  )  const

Definition at line 2488 of file alarmevent.cpp.

bool KAEvent::convertKCalEvents ( KCal::CalendarLocal &  calendar,
int  version,
bool  adjustSummerTime 
) [static]

Definition at line 3389 of file alarmevent.cpp.

bool KAEvent::copyToKOrganizer (  )  const [inline]

Definition at line 390 of file alarmevent.h.

bool KAEvent::defer ( const DateTime &  dateTime,
bool  reminder,
bool  adjustRecurrence = false 
)

Definition at line 2231 of file alarmevent.cpp.

DateTime KAEvent::deferDateTime (  )  const [inline]

Definition at line 382 of file alarmevent.h.

int KAEvent::deferDefaultMinutes (  )  const [inline]

Definition at line 384 of file alarmevent.h.

DateTime KAEvent::deferralLimit ( KAEvent::DeferLimitType *  limitType = 0  )  const

Definition at line 2394 of file alarmevent.cpp.

bool KAEvent::deferred (  )  const [inline]

Definition at line 412 of file alarmevent.h.

bool KAEvent::displayAction (  )  const [inline]

Definition at line 365 of file alarmevent.h.

void KAEvent::dumpDebug (  )  const

Reimplemented from KAAlarmEventBase.

Definition at line 3985 of file alarmevent.cpp.

bool KAEvent::enabled (  )  const [inline]

Definition at line 414 of file alarmevent.h.

void KAEvent::endChanges (  ) 

Definition at line 1017 of file alarmevent.cpp.

bool KAEvent::expired (  )  const [inline]

Definition at line 417 of file alarmevent.h.

int KAEvent::fadeSeconds (  )  const [inline]

Definition at line 396 of file alarmevent.h.

float KAEvent::fadeVolume (  )  const [inline]

Definition at line 395 of file alarmevent.h.

KAAlarm KAEvent::firstAlarm (  )  const

Definition at line 2120 of file alarmevent.cpp.

int KAEvent::flags (  )  const

Reimplemented from KAAlarmEventBase.

Definition at line 1622 of file alarmevent.cpp.

const QString& KAEvent::id (  )  const [inline]

Definition at line 366 of file alarmevent.h.

void KAEvent::incrementRevision (  )  [inline]

Definition at line 352 of file alarmevent.h.

bool KAEvent::isTemplate (  )  const [inline]

Definition at line 354 of file alarmevent.h.

unsigned long KAEvent::kmailSerialNumber (  )  const [inline]

Definition at line 389 of file alarmevent.h.

QString KAEvent::logFile (  )  const [inline]

Definition at line 386 of file alarmevent.h.

KCal::Duration KAEvent::longestRecurrenceInterval (  )  const [inline]

Definition at line 405 of file alarmevent.h.

QDate KAEvent::mainDate (  )  const [inline]

Definition at line 373 of file alarmevent.h.

DateTime KAEvent::mainDateTime ( bool  withRepeats = false  )  const [inline]

Definition at line 370 of file alarmevent.h.

DateTime KAEvent::mainEndRepeatTime (  )  const [inline]

Definition at line 375 of file alarmevent.h.

bool KAEvent::mainExpired (  )  const [inline]

Definition at line 416 of file alarmevent.h.

QTime KAEvent::mainTime (  )  const [inline]

Definition at line 374 of file alarmevent.h.

const QString& KAEvent::messageFileOrCommand (  )  const [inline]

Definition at line 385 of file alarmevent.h.

KAAlarm KAEvent::nextAlarm ( KAAlarm::Type  prevType  )  const

Definition at line 2136 of file alarmevent.cpp.

KAAlarm KAEvent::nextAlarm ( const KAAlarm &  al  )  const [inline]

Definition at line 360 of file alarmevent.h.

KAEvent::OccurType KAEvent::nextOccurrence ( const KDateTime &  preDateTime,
DateTime &  result,
KAEvent::OccurOption  includeRepetitions = IGNORE_REPETITION 
) const

Definition at line 2574 of file alarmevent.cpp.

DateTime KAEvent::nextTrigger ( TriggerType  type  )  const

Definition at line 1000 of file alarmevent.cpp.

bool KAEvent::occursAfter ( const KDateTime &  preDateTime,
bool  includeRepetitions 
) const

Definition at line 2539 of file alarmevent.cpp.

KAEvent& KAEvent::operator= ( const KAEvent &  e  )  [inline]

Definition at line 314 of file alarmevent.h.

const QString& KAEvent::postAction (  )  const [inline]

Definition at line 399 of file alarmevent.h.

const QString& KAEvent::preAction (  )  const [inline]

Definition at line 398 of file alarmevent.h.

KAEvent::OccurType KAEvent::previousOccurrence ( const KDateTime &  afterDateTime,
DateTime &  result,
bool  includeRepetitions = false 
) const

Definition at line 2649 of file alarmevent.cpp.

int KAEvent::recurInterval (  )  const

Definition at line 3233 of file alarmevent.cpp.

KARecurrence* KAEvent::recurrence (  )  const [inline]

Definition at line 403 of file alarmevent.h.

QString KAEvent::recurrenceText ( bool  brief = false  )  const

Definition at line 2814 of file alarmevent.cpp.

bool KAEvent::recurs (  )  const [inline]

Definition at line 401 of file alarmevent.h.

KARecurrence::Type KAEvent::recurType (  )  const [inline]

Definition at line 402 of file alarmevent.h.

void KAEvent::reinstateFromDisplaying ( const KCal::Event *  ,
QString &  resourceID,
bool &  showEdit,
bool &  showDefer 
)

int KAEvent::reminder (  )  const [inline]

Definition at line 378 of file alarmevent.h.

int KAEvent::reminderArchived (  )  const [inline]

Definition at line 381 of file alarmevent.h.

bool KAEvent::reminderDeferral (  )  const [inline]

Definition at line 380 of file alarmevent.h.

bool KAEvent::reminderOnceOnly (  )  const [inline]

Definition at line 379 of file alarmevent.h.

void KAEvent::removeExpiredAlarm <