#include <alarmevent.h>
Inherits KAAlarmEventBase.
|
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
} |
|
|
| 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) |
|
KAEvent & | operator= (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::Event * | event () 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 |
|
KAEvent corresponds to a KCal::Event instance.
Definition at line 231 of file alarmevent.h.
◆ anonymous enum
◆ Action
◆ DeferLimitType
enum KAEvent::DeferLimitType |
◆ OccurOption
enum KAEvent::OccurOption |
◆ OccurType
◆ Status
The category of an event, indicated by the middle part of its UID.
Definition at line 269 of file alarmevent.h.
◆ KAEvent() [1/4]
◆ KAEvent() [2/4]
KAEvent::KAEvent |
( |
const TQDateTime & |
dt, |
|
|
const TQString & |
message, |
|
|
const TQColor & |
bg, |
|
|
const TQColor & |
fg, |
|
|
const TQFont & |
f, |
|
|
Action |
action, |
|
|
int |
lateCancel, |
|
|
int |
flags |
|
) |
| |
|
inline |
◆ KAEvent() [3/4]
◆ KAEvent() [4/4]
KAEvent::KAEvent |
( |
const KAEvent & |
e | ) |
|
|
inline |
◆ ~KAEvent()
◆ action()
Action KAEvent::action |
( |
| ) |
const |
|
inline |
◆ adjustStartOfDay()
bool KAEvent::adjustStartOfDay |
( |
const KCal::Event::List & |
| ) |
|
|
static |
◆ alarm()
KAAlarm KAEvent::alarm |
( |
KAAlarm::Type |
type | ) |
const |
◆ alarmCount()
int KAEvent::alarmCount |
( |
| ) |
const |
|
inline |
◆ audioFile()
const TQString & KAEvent::audioFile |
( |
| ) |
const |
|
inline |
◆ calVersion()
int KAEvent::calVersion |
( |
| ) |
|
|
static |
◆ calVersionString()
TQString KAEvent::calVersionString |
( |
| ) |
|
|
static |
◆ cancelCancelledDeferral()
void KAEvent::cancelCancelledDeferral |
( |
| ) |
|
◆ cancelDefer()
void KAEvent::cancelDefer |
( |
| ) |
|
◆ clearUpdated()
void KAEvent::clearUpdated |
( |
| ) |
const |
|
inline |
◆ commandXterm()
bool KAEvent::commandXterm |
( |
| ) |
const |
|
inline |
◆ convertDisplayingAlarm()
KAAlarm KAEvent::convertDisplayingAlarm |
( |
| ) |
const |
◆ convertKCalEvents()
void KAEvent::convertKCalEvents |
( |
KCal::Calendar & |
calendar, |
|
|
int |
version, |
|
|
bool |
adjustSummerTime |
|
) |
| |
|
static |
◆ convertRepetitions()
◆ copyToKOrganizer()
bool KAEvent::copyToKOrganizer |
( |
| ) |
const |
|
inline |
◆ defer()
bool KAEvent::defer |
( |
const DateTime & |
dateTime, |
|
|
bool |
reminder, |
|
|
bool |
adjustRecurrence = false |
|
) |
| |
◆ deferDateTime()
DateTime KAEvent::deferDateTime |
( |
| ) |
const |
|
inline |
◆ deferDefaultMinutes()
int KAEvent::deferDefaultMinutes |
( |
| ) |
const |
|
inline |
◆ deferralLimit()
DateTime KAEvent::deferralLimit |
( |
KAEvent::DeferLimitType * |
limitType = 0 | ) |
const |
◆ deferred()
bool KAEvent::deferred |
( |
| ) |
const |
|
inline |
◆ displayAction()
bool KAEvent::displayAction |
( |
| ) |
const |
|
inline |
◆ displayDateTime()
DateTime KAEvent::displayDateTime |
( |
| ) |
const |
◆ dumpDebug()
void KAEvent::dumpDebug |
( |
| ) |
const |
◆ enabled()
bool KAEvent::enabled |
( |
| ) |
const |
|
inline |
◆ event()
Event * KAEvent::event |
( |
| ) |
const |
◆ expired()
bool KAEvent::expired |
( |
| ) |
const |
|
inline |
◆ fadeSeconds()
int KAEvent::fadeSeconds |
( |
| ) |
const |
|
inline |
◆ fadeVolume()
float KAEvent::fadeVolume |
( |
| ) |
const |
|
inline |
◆ findTemplateName()
◆ firstAlarm()
KAAlarm KAEvent::firstAlarm |
( |
| ) |
const |
◆ flags()
int KAEvent::flags |
( |
| ) |
const |
◆ id()
const TQString & KAEvent::id |
( |
| ) |
const |
|
inline |
◆ incrementRevision()
void KAEvent::incrementRevision |
( |
| ) |
|
|
inline |
◆ isTemplate()
bool KAEvent::isTemplate |
( |
| ) |
const |
|
inline |
◆ kmailSerialNumber()
unsigned long KAEvent::kmailSerialNumber |
( |
| ) |
const |
|
inline |
◆ logFile()
TQString KAEvent::logFile |
( |
| ) |
const |
|
inline |
◆ longestRecurrenceInterval()
int KAEvent::longestRecurrenceInterval |
( |
| ) |
const |
|
inline |
◆ mainDate()
TQDate KAEvent::mainDate |
( |
| ) |
const |
|
inline |
◆ mainDateTime()
DateTime KAEvent::mainDateTime |
( |
bool |
withRepeats = false | ) |
const |
|
inline |
◆ mainEndRepeatTime()
DateTime KAEvent::mainEndRepeatTime |
( |
| ) |
const |
|
inline |
◆ mainExpired()
bool KAEvent::mainExpired |
( |
| ) |
const |
|
inline |
◆ mainTime()
TQTime KAEvent::mainTime |
( |
| ) |
const |
|
inline |
◆ messageFileOrCommand()
const TQString & KAEvent::messageFileOrCommand |
( |
| ) |
const |
|
inline |
◆ nextAlarm() [1/2]
KAAlarm KAEvent::nextAlarm |
( |
const KAAlarm & |
al | ) |
const |
|
inline |
◆ nextAlarm() [2/2]
KAAlarm KAEvent::nextAlarm |
( |
KAAlarm::Type |
prevType | ) |
const |
◆ nextOccurrence()
KAEvent::OccurType KAEvent::nextOccurrence |
( |
const TQDateTime & |
preDateTime, |
|
|
DateTime & |
result, |
|
|
KAEvent::OccurOption |
includeRepetitions = IGNORE_REPETITION |
|
) |
| const |
◆ occursAfter()
bool KAEvent::occursAfter |
( |
const TQDateTime & |
preDateTime, |
|
|
bool |
includeRepetitions |
|
) |
| const |
◆ operator=()
◆ postAction()
const TQString & KAEvent::postAction |
( |
| ) |
const |
|
inline |
◆ preAction()
const TQString & KAEvent::preAction |
( |
| ) |
const |
|
inline |
◆ previousOccurrence()
KAEvent::OccurType KAEvent::previousOccurrence |
( |
const TQDateTime & |
afterDateTime, |
|
|
DateTime & |
result, |
|
|
bool |
includeRepetitions = false |
|
) |
| const |
◆ recurInterval()
int KAEvent::recurInterval |
( |
| ) |
const |
◆ recurrence()
KARecurrence * KAEvent::recurrence |
( |
| ) |
const |
|
inline |
◆ recurrenceText()
TQString KAEvent::recurrenceText |
( |
bool |
brief = false | ) |
const |
◆ recurs()
bool KAEvent::recurs |
( |
| ) |
const |
|
inline |
◆ recurType()
KARecurrence::Type KAEvent::recurType |
( |
| ) |
const |
|
inline |
◆ reinstateFromDisplaying()
void KAEvent::reinstateFromDisplaying |
( |
const KAEvent & |
dispEvent | ) |
|
◆ reminder()
int KAEvent::reminder |
( |
| ) |
const |
|
inline |
◆ reminderArchived()
int KAEvent::reminderArchived |
( |
| ) |
const |
|
inline |
◆ reminderDeferral()
bool KAEvent::reminderDeferral |
( |
| ) |
const |
|
inline |
◆ reminderOnceOnly()
bool KAEvent::reminderOnceOnly |
( |
| ) |
const |
|
inline |
◆ removeExpiredAlarm()
void KAEvent::removeExpiredAlarm |
( |
KAAlarm::Type |
type | ) |
|
◆ repeatSound()
bool KAEvent::repeatSound |
( |
| ) |
const |
|
inline |
◆ repetitionText()
TQString KAEvent::repetitionText |
( |
bool |
brief = false | ) |
const |
◆ set() [1/2]
◆ set() [2/2]
void KAEvent::set |
( |
const TQDateTime & |
dateTime, |
|
|
const TQString & |
message, |
|
|
const TQColor & |
bg, |
|
|
const TQColor & |
fg, |
|
|
const TQFont & |
font, |
|
|
Action |
action, |
|
|
int |
lateCancel, |
|
|
int |
flags |
|
) |
| |
◆ setActions()
void KAEvent::setActions |
( |
const TQString & |
pre, |
|
|
const TQString & |
post |
|
) |
| |
|
inline |
◆ setArchive()
void KAEvent::setArchive |
( |
| ) |
|
|
inline |
◆ setAudioFile()
void KAEvent::setAudioFile |
( |
const TQString & |
filename, |
|
|
float |
volume, |
|
|
float |
fadeVolume, |
|
|
int |
fadeSeconds |
|
) |
| |
◆ setAutoClose()
void KAEvent::setAutoClose |
( |
bool |
ac | ) |
|
|
inline |
◆ setDate()
void KAEvent::setDate |
( |
const TQDate & |
d | ) |
|
|
inline |
◆ setDeferDefaultMinutes()
void KAEvent::setDeferDefaultMinutes |
( |
int |
minutes | ) |
|
|
inline |
◆ setDisplaying()
bool KAEvent::setDisplaying |
( |
const KAEvent & |
event, |
|
|
KAAlarm::Type |
alarmType, |
|
|
const TQDateTime & |
repeatAtLoginTime |
|
) |
| |
◆ setEmail()
void KAEvent::setEmail |
( |
uint |
from, |
|
|
const EmailAddressList & |
addresses, |
|
|
const TQString & |
subject, |
|
|
const TQStringList & |
attachments |
|
) |
| |
◆ setEnabled()
void KAEvent::setEnabled |
( |
bool |
enable | ) |
|
|
inline |
◆ setEventID()
void KAEvent::setEventID |
( |
const TQString & |
id | ) |
|
|
inline |
◆ setFirstRecurrence()
void KAEvent::setFirstRecurrence |
( |
| ) |
|
◆ setKMailSerialNumber()
void KAEvent::setKMailSerialNumber |
( |
unsigned long |
n | ) |
|
|
inline |
◆ setLateCancel()
void KAEvent::setLateCancel |
( |
int |
lc | ) |
|
|
inline |
◆ setLogFile()
void KAEvent::setLogFile |
( |
const TQString & |
logfile | ) |
|
◆ setNextOccurrence()
KAEvent::OccurType KAEvent::setNextOccurrence |
( |
const TQDateTime & |
preDateTime | ) |
|
◆ setNoRecur()
void KAEvent::setNoRecur |
( |
| ) |
|
|
inline |
◆ setRecurAnnualByDate()
bool KAEvent::setRecurAnnualByDate |
( |
int |
freq, |
|
|
const TQValueList< int > & |
months, |
|
|
int |
day, |
|
|
KARecurrence::Feb29Type |
feb29, |
|
|
int |
count, |
|
|
const TQDate & |
end |
|
) |
| |
◆ setRecurAnnualByPos()
bool KAEvent::setRecurAnnualByPos |
( |
int |
freq, |
|
|
const TQValueList< MonthPos > & |
pos, |
|
|
const TQValueList< int > & |
months, |
|
|
int |
count, |
|
|
const TQDate & |
end |
|
) |
| |
◆ setRecurDaily()
bool KAEvent::setRecurDaily |
( |
int |
freq, |
|
|
const TQBitArray & |
days, |
|
|
int |
count, |
|
|
const TQDate & |
end |
|
) |
| |
◆ setRecurMinutely()
bool KAEvent::setRecurMinutely |
( |
int |
freq, |
|
|
int |
count, |
|
|
const TQDateTime & |
end |
|
) |
| |
◆ setRecurMonthlyByDate()
bool KAEvent::setRecurMonthlyByDate |
( |
int |
freq, |
|
|
const TQValueList< int > & |
days, |
|
|
int |
count, |
|
|
const TQDate & |
end |
|
) |
| |
◆ setRecurMonthlyByPos()
bool KAEvent::setRecurMonthlyByPos |
( |
int |
freq, |
|
|
const TQValueList< MonthPos > & |
pos, |
|
|
int |
count, |
|
|
const TQDate & |
end |
|
) |
| |
◆ setRecurrence()
void KAEvent::setRecurrence |
( |
const KARecurrence & |
recurrence | ) |
|
◆ setRecurWeekly()
bool KAEvent::setRecurWeekly |
( |
int |
freq, |
|
|
const TQBitArray & |
days, |
|
|
int |
count, |
|
|
const TQDate & |
end |
|
) |
| |
◆ setReminder()
void KAEvent::setReminder |
( |
int |
minutes, |
|
|
bool |
onceOnly |
|
) |
| |
◆ setRepeatAtLogin()
void KAEvent::setRepeatAtLogin |
( |
bool |
rl | ) |
|
|
inline |
◆ setRepetition()
bool KAEvent::setRepetition |
( |
int |
interval, |
|
|
int |
count |
|
) |
| |
◆ setSaveDateTime()
void KAEvent::setSaveDateTime |
( |
const TQDateTime & |
dt | ) |
|
|
inline |
◆ setTemplate()
void KAEvent::setTemplate |
( |
const TQString & |
name, |
|
|
int |
afterTime = -1 |
|
) |
| |
|
inline |
◆ setTime()
void KAEvent::setTime |
( |
const TQDateTime & |
dt | ) |
|
|
inline |
◆ setUid()
void KAEvent::setUid |
( |
Status |
s | ) |
|
|
inline |
◆ setUpdated()
void KAEvent::setUpdated |
( |
| ) |
|
|
inline |
◆ soundVolume()
float KAEvent::soundVolume |
( |
| ) |
const |
|
inline |
◆ startDateTime()
const DateTime & KAEvent::startDateTime |
( |
| ) |
const |
|
inline |
◆ templateAfterTime()
int KAEvent::templateAfterTime |
( |
| ) |
const |
|
inline |
◆ templateName()
const TQString & KAEvent::templateName |
( |
| ) |
const |
|
inline |
◆ toBeArchived()
bool KAEvent::toBeArchived |
( |
| ) |
const |
|
inline |
◆ uid()
TQString KAEvent::uid |
( |
const TQString & |
id, |
|
|
Status |
status |
|
) |
| |
|
static |
◆ uidStatus() [1/2]
Status KAEvent::uidStatus |
( |
| ) |
const |
|
inline |
◆ uidStatus() [2/2]
◆ updated()
bool KAEvent::updated |
( |
| ) |
const |
|
inline |
◆ updateKCalEvent()
bool KAEvent::updateKCalEvent |
( |
KCal::Event & |
ev, |
|
|
bool |
checkUid = true , |
|
|
bool |
original = false , |
|
|
bool |
cancelCancelledDefer = false |
|
) |
| const |
◆ usingDefaultTime()
bool KAEvent::usingDefaultTime |
( |
| ) |
const |
|
inline |
◆ valid()
bool KAEvent::valid |
( |
| ) |
const |
|
inline |
The documentation for this class was generated from the following files:
|