• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KAlarm Library

  • kalarmcal
kaevent.h
1/*
2 * kaevent.h - represents calendar events
3 * This file is part of kalarmcal library, which provides access to KAlarm
4 * calendar data.
5 * Copyright © 2001-2013 by David Jarvie <djarvie@kde.org>
6 *
7 * This library is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Library General Public License as published
9 * by the Free Software Foundation; either version 2 of the License, or (at
10 * your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
15 * License for more details.
16 *
17 * You should have received a copy of the GNU Library General Public License
18 * along with this library; see the file COPYING.LIB. If not, write to the
19 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
20 * MA 02110-1301, USA.
21 */
22
23#ifndef KAEVENT_H
24#define KAEVENT_H
25
26#include "kalarmcal_export.h"
27
28#include "datetime.h"
29#include "karecurrence.h"
30#include "kacalendar.h"
31#include "repetition.h"
32
33#ifndef KALARMCAL_USE_KRESOURCES
34#include <akonadi/collection.h>
35#include <akonadi/item.h>
36#include <kcalcore/person.h>
37#include <kcalcore/calendar.h>
38#else
39#include <kcal/person.h>
40#endif
41
42#include <QtCore/QBitArray>
43#include <QColor>
44#include <QFont>
45#include <QtCore/QVector>
46#ifdef KALARMCAL_USE_KRESOURCES
47#include <QtCore/QList>
48#endif
49#include <QtCore/QSharedDataPointer>
50#include <QtCore/QMetaType>
51
52namespace KHolidays { class HolidayRegion; }
53#ifdef KALARMCAL_USE_KRESOURCES
54namespace KCal {
55 class CalendarLocal;
56 class Event;
57}
58class AlarmResource;
59#endif
60
61namespace KAlarmCal
62{
63
77class KALARMCAL_EXPORT KAAlarm
78{
79 public:
81 enum Action
82 {
83 MESSAGE,
84 FILE,
85 COMMAND,
86 EMAIL,
87 AUDIO
88 };
89
94 enum Type
95 {
96 INVALID_ALARM = 0,
97 MAIN_ALARM = 1,
98 REMINDER_ALARM = 0x02,
99 DEFERRED_ALARM = 0x04,
100 DEFERRED_REMINDER_ALARM = REMINDER_ALARM | DEFERRED_ALARM,
101 // The following values must be greater than the preceding ones, to
102 // ensure that in ordered processing they are processed afterwards.
103 AT_LOGIN_ALARM = 0x10,
104 DISPLAYING_ALARM = 0x20
105
106 // IMPORTANT: if any values are added to this list, ensure that the
107 // KAEventPrivate::AlarmType enum is adjusted similarly.
108 };
109
111 KAAlarm();
112
114 KAAlarm(const KAAlarm& other);
115
117 ~KAAlarm();
118
120 KAAlarm& operator=(const KAAlarm& other);
121
123 Action action() const;
124
126 bool isValid() const;
127
129 Type type() const;
130
137 DateTime dateTime(bool withRepeats = false) const;
138
143 QDate date() const;
144
151 QTime time() const;
152
154 void setTime(const DateTime& dt);
156 void setTime(const KDateTime& dt);
157
159 bool repeatAtLogin() const;
160
162 bool isReminder() const;
163
165 bool deferred() const;
166
171 bool timedDeferral() const;
172
176 static const char* debugType(Type);
177
178 private:
179 //@cond PRIVATE
180 class Private;
181 Private* const d;
182 //@endcond
183
184 friend class KAEvent;
185 friend class KAEventPrivate;
186};
187
188class KAEventPrivate;
189
210class KALARMCAL_EXPORT KAEvent
211{
212 public:
214 typedef QVector<KAEvent*> List;
215
217 enum Flag
218 {
219 BEEP = 0x02,
220 REPEAT_AT_LOGIN = 0x04,
221 ANY_TIME = 0x08,
222 CONFIRM_ACK = 0x10,
223 EMAIL_BCC = 0x20,
224 DEFAULT_FONT = 0x40,
225 REPEAT_SOUND = 0x80,
226 DISABLED = 0x100,
227 AUTO_CLOSE = 0x200,
228 SCRIPT = 0x400,
229 EXEC_IN_XTERM = 0x800,
230 SPEAK = 0x1000,
231 COPY_KORGANIZER = 0x2000,
232 EXCL_HOLIDAYS = 0x4000,
233 WORK_TIME_ONLY = 0x8000,
234 DISPLAY_COMMAND = 0x10000,
235 REMINDER_ONCE = 0x20000
236
237 // IMPORTANT: if any values are added to this list, ensure that the
238 // additional enum values in KAEventPrivate are also adjusted.
239 };
240 Q_DECLARE_FLAGS(Flags, Flag)
241
242
244 enum Actions
245 {
246 ACT_NONE = 0,
247 ACT_DISPLAY = 0x01,
248 ACT_COMMAND = 0x02,
249 ACT_EMAIL = 0x04,
250 ACT_AUDIO = 0x08,
251 ACT_DISPLAY_COMMAND = ACT_DISPLAY | ACT_COMMAND,
252 ACT_ALL = ACT_DISPLAY | ACT_COMMAND | ACT_EMAIL | ACT_AUDIO
253 };
254
256 enum SubAction
257 {
258 MESSAGE = KAAlarm::MESSAGE,
259 FILE = KAAlarm::FILE,
260 COMMAND = KAAlarm::COMMAND,
261 EMAIL = KAAlarm::EMAIL,
262 AUDIO = KAAlarm::AUDIO
263 };
264
266 enum OccurType
267 {
268 NO_OCCURRENCE = 0,
269 FIRST_OR_ONLY_OCCURRENCE = 0x01,
270 RECURRENCE_DATE = 0x02,
271 RECURRENCE_DATE_TIME = 0x03,
272 LAST_RECURRENCE = 0x04,
273 OCCURRENCE_REPEAT = 0x10,
274 FIRST_OR_ONLY_OCCURRENCE_REPEAT = OCCURRENCE_REPEAT | FIRST_OR_ONLY_OCCURRENCE,
275 RECURRENCE_DATE_REPEAT = OCCURRENCE_REPEAT | RECURRENCE_DATE,
276 RECURRENCE_DATE_TIME_REPEAT = OCCURRENCE_REPEAT | RECURRENCE_DATE_TIME,
277 LAST_RECURRENCE_REPEAT = OCCURRENCE_REPEAT | LAST_RECURRENCE
278 };
279
281 enum OccurOption
282 {
283 IGNORE_REPETITION,
284 RETURN_REPETITION,
285 ALLOW_FOR_REPETITION
286 };
287
289 enum DeferLimitType
290 {
291 LIMIT_NONE,
292 LIMIT_MAIN,
293 LIMIT_RECURRENCE,
294 LIMIT_REPETITION,
295 LIMIT_REMINDER
296 };
297
299 enum TriggerType
300 {
301 ALL_TRIGGER,
302 MAIN_TRIGGER,
303 WORK_TRIGGER,
304 ALL_WORK_TRIGGER,
305 DISPLAY_TRIGGER
306 };
307
309 enum CmdErrType
310 {
311 CMD_NO_ERROR = 0,
312 CMD_ERROR = 0x01,
313 CMD_ERROR_PRE = 0x02,
314 CMD_ERROR_POST = 0x04,
315 CMD_ERROR_PRE_POST = CMD_ERROR_PRE | CMD_ERROR_POST
316 };
317
321 enum ExtraActionOption
322 {
323 CancelOnPreActError = 0x01,
324 DontShowPreActError = 0x02,
325 ExecPreActOnDeferral = 0x04
326 };
327 Q_DECLARE_FLAGS(ExtraActionOptions, ExtraActionOption)
328
329
330 enum UidAction
331 {
332 UID_IGNORE,
333 UID_CHECK,
334 UID_SET
335 };
336
338 KAEvent();
339
358 KAEvent(const KDateTime&, const QString& text, const QColor& bg, const QColor& fg,
359 const QFont& f, SubAction, int lateCancel, Flags flags, bool changesPending = false);
360#ifndef KALARMCAL_USE_KRESOURCES
362 explicit KAEvent(const KCalCore::Event::Ptr&);
363
365 void set(const KCalCore::Event::Ptr&);
366#else
368 explicit KAEvent(const KCal::Event*);
369
371 void set(const KCal::Event*);
372#endif
373
374 KAEvent(const KAEvent& other);
375 ~KAEvent();
376
377 KAEvent& operator=(const KAEvent& other);
378
396 void set(const KDateTime& dt, const QString& text, const QColor& bg,
397 const QColor& fg, const QFont& font, SubAction action, int lateCancel,
398 Flags flags, bool changesPending = false);
399
400#ifndef KALARMCAL_USE_KRESOURCES
410 bool updateKCalEvent(const KCalCore::Event::Ptr& event, UidAction u, bool setCustomProperties = true) const;
411#else
416 bool updateKCalEvent(KCal::Event* event, UidAction u) const;
417#endif
418
420 bool isValid() const;
421
423 void setEnabled(bool enable);
425 bool enabled() const;
426
427#ifndef KALARMCAL_USE_KRESOURCES
429 void setReadOnly(bool ro);
431 bool isReadOnly() const;
432#endif
433
437 void setArchive();
439 bool toBeArchived() const;
440
442 bool mainExpired() const;
447 bool expired() const;
448
450 Flags flags() const;
451
453 void setCategory(CalEvent::Type type);
454
456 CalEvent::Type category() const;
457
461 void setEventId(const QString& id);
462
466 QString id() const;
467
469 void incrementRevision();
471 int revision() const;
472
473#ifndef KALARMCAL_USE_KRESOURCES
475 void setCollectionId(Akonadi::Collection::Id id);
483 void setCollectionId_const(Akonadi::Collection::Id id) const;
485 Akonadi::Collection::Id collectionId() const;
486
488 void setItemId(Akonadi::Item::Id id);
490 Akonadi::Item::Id itemId() const;
491
497 bool setItemPayload(Akonadi::Item&, const QStringList& collectionMimeTypes) const;
498
500 void setCompatibility(KACalendar::Compat c);
502 KACalendar::Compat compatibility() const;
503
505 QMap<QByteArray, QString> customProperties() const;
506#else
511 void setResource(AlarmResource* r);
512
516 AlarmResource* resource() const;
517#endif
518
525 SubAction actionSubType() const;
526
532 Actions actionTypes() const;
533
539 void setLateCancel(int minutes);
540
546 int lateCancel() const;
547
554 void setAutoClose(bool autoclose);
555
563 bool autoClose() const;
564
565 void setKMailSerialNumber(unsigned long n);
566 unsigned long kmailSerialNumber() const;
567
572 QString cleanText() const;
576 QString message() const;
579 QString displayMessage() const;
582 QString fileName() const;
583
585 QColor bgColour() const;
587 QColor fgColour() const;
588
590 static void setDefaultFont(const QFont& font);
593 bool useDefaultFont() const;
595 QFont font() const;
596
599 QString command() const;
601 bool commandScript() const;
603 bool commandXterm() const;
605 bool commandDisplay() const;
606#ifndef KALARMCAL_USE_KRESOURCES
608 void setCommandError(CmdErrType error) const;
609#else
613 void setCommandError(CmdErrType error, bool writeConfig = true) const;
617 void setCommandError(const QString& configString);
619 static QString commandErrorConfigGroup();
620#endif
622 CmdErrType commandError() const;
623
627 void setLogFile(const QString& logfile);
630 QString logFile() const;
631
633 bool confirmAck() const;
634
636 bool copyToKOrganizer() const;
637
639#ifndef KALARMCAL_USE_KRESOURCES
640 void setEmail(uint from, const KCalCore::Person::List&, const QString& subject,
641 const QStringList& attachments);
642#else
643 void setEmail(uint from, const QList<KCal::Person>&, const QString& subject,
644 const QStringList& attachments);
645#endif
646
650 QString emailMessage() const;
651
655 uint emailFromId() const;
656
658#ifndef KALARMCAL_USE_KRESOURCES
659 KCalCore::Person::List emailAddressees() const;
660#else
661 QList<KCal::Person> emailAddressees() const;
662#endif
663
665 QStringList emailAddresses() const;
666
670 QString emailAddresses(const QString& sep) const;
671
675#ifndef KALARMCAL_USE_KRESOURCES
676 static QString joinEmailAddresses(const KCalCore::Person::List& addresses, const QString& sep);
677#else
678 static QString joinEmailAddresses(const QList<KCal::Person>& addresses, const QString& sep);
679#endif
680
682 QStringList emailPureAddresses() const;
683
687 QString emailPureAddresses(const QString& sep) const;
688
690 QString emailSubject() const;
691
693 QStringList emailAttachments() const;
694
698 QString emailAttachments(const QString& sep) const;
699
701 bool emailBcc() const;
702
712 void setAudioFile(const QString& filename, float volume, float fadeVolume,
713 int fadeSeconds, int repeatPause = -1, bool allowEmptyFile = false);
714
718 QString audioFile() const;
719
724 float soundVolume() const;
725
730 float fadeVolume() const;
731
735 int fadeSeconds() const;
736
738 bool repeatSound() const;
739
743 int repeatSoundPause() const;
744
746 bool beep() const;
747
749 bool speak() const;
750
757 void setTemplate(const QString& name, int afterTime = -1);
758
762 bool isTemplate() const;
763
768 QString templateName() const;
769
774 bool usingDefaultTime() const;
775
783 int templateAfterTime() const;
784
792 void setActions(const QString& pre, const QString& post, ExtraActionOptions options);
793
802 void setActions(const QString& pre, const QString& post, bool cancelOnError, bool dontShowError);
803
805 QString preAction() const;
806
810 QString postAction() const;
811
816 ExtraActionOptions extraActionOptions() const;
817
822 bool cancelOnPreActionError() const;
823
829 bool dontShowPreActionError() const;
830
838 void setReminder(int minutes, bool onceOnly);
839
845 void activateReminderAfter(const DateTime& mainAlarmTime);
846
853 int reminderMinutes() const;
858 bool reminderActive() const;
862 bool reminderOnceOnly() const;
864 bool reminderDeferral() const;
865
875 void defer(const DateTime& dt, bool reminder, bool adjustRecurrence = false);
876
880 void cancelDefer();
886 void setDeferDefaultMinutes(int minutes, bool dateOnly = false);
890 bool deferred() const;
895 DateTime deferDateTime() const;
896
902 DateTime deferralLimit(DeferLimitType* limitType = 0) const;
903
907 int deferDefaultMinutes() const;
909 bool deferDefaultDateOnly() const;
910
915 DateTime startDateTime() const;
920 void setTime(const KDateTime& dt);
925 DateTime mainDateTime(bool withRepeats = false) const;
926
929 QTime mainTime() const;
935 DateTime mainEndRepeatTime() const;
936
941 static void setStartOfDay(const QTime&);
942
948 static void adjustStartOfDay(const KAEvent::List& events);
949
954 DateTime nextTrigger(TriggerType type) const;
955
959 void setCreatedDateTime(const KDateTime& dt);
963 KDateTime createdDateTime() const;
964
970 void setRepeatAtLogin(bool repeat);
971
977 bool repeatAtLogin(bool includeArchived = false) const;
978
985 void setExcludeHolidays(bool exclude);
989 bool holidaysExcluded() const;
990
1001 static void setHolidays(const KHolidays::HolidayRegion& region);
1002
1008 void setWorkTimeOnly(bool wto);
1012 bool workTimeOnly() const;
1013
1016 bool isWorkingTime(const KDateTime& dt) const;
1017
1024 static void setWorkTime(const QBitArray& days, const QTime& start, const QTime& end);
1025
1029 void setNoRecur();
1030
1035 void setRecurrence(const KARecurrence& r);
1036
1045 bool setRecurMinutely(int freq, int count, const KDateTime& end);
1046
1056 bool setRecurDaily(int freq, const QBitArray& days, int count, const QDate& end);
1057
1067 bool setRecurWeekly(int freq, const QBitArray& days, int count, const QDate& end);
1068
1078 bool setRecurMonthlyByDate(int freq, const QVector<int>& days, int count, const QDate& end);
1079
1082 struct MonthPos
1083 {
1084 MonthPos() : days(7) {} //krazy:exclude=inline (need default constructor)
1085 int weeknum;
1086 QBitArray days;
1087 };
1088
1099 bool setRecurMonthlyByPos(int freq, const QVector<MonthPos>& pos, int count, const QDate& end);
1100
1114 bool setRecurAnnualByDate(int freq, const QVector<int>& months, int day, KARecurrence::Feb29Type, int count, const QDate& end);
1115
1127 bool setRecurAnnualByPos(int freq, const QVector<MonthPos>& pos, const QVector<int>& months, int count, const QDate& end);
1128
1132 bool recurs() const;
1137 KARecurrence::Type recurType() const;
1142 KARecurrence* recurrence() const;
1143
1148 int recurInterval() const;
1149
1153#ifndef KALARMCAL_USE_KRESOURCES
1154 KCalCore::Duration longestRecurrenceInterval() const;
1155#else
1156 KCal::Duration longestRecurrenceInterval() const;
1157#endif
1158
1163 void setFirstRecurrence();
1164
1166 QString recurrenceText(bool brief = false) const;
1167
1174 bool setRepetition(const Repetition& r);
1175
1179 Repetition repetition() const;
1180
1185 int nextRepetition() const;
1186
1188 QString repetitionText(bool brief = false) const;
1189
1196 bool occursAfter(const KDateTime& preDateTime, bool includeRepetitions) const;
1197
1206 OccurType setNextOccurrence(const KDateTime& preDateTime);
1207
1214 OccurType nextOccurrence(const KDateTime& preDateTime, DateTime& result, OccurOption option = IGNORE_REPETITION) const;
1215
1225 OccurType previousOccurrence(const KDateTime& afterDateTime, DateTime& result, bool includeRepetitions = false) const;
1226
1241#ifndef KALARMCAL_USE_KRESOURCES
1242 bool setDisplaying(const KAEvent& event, KAAlarm::Type type, Akonadi::Collection::Id colId, const KDateTime& repeatAtLoginTime, bool showEdit, bool showDefer);
1243#else
1244 bool setDisplaying(const KAEvent& event, KAAlarm::Type type, const QString& resourceID, const KDateTime& repeatAtLoginTime, bool showEdit, bool showDefer);
1245#endif
1246
1247#ifndef KALARMCAL_USE_KRESOURCES
1257 void reinstateFromDisplaying(const KCalCore::Event::Ptr& event, Akonadi::Collection::Id& colId, bool& showEdit, bool& showDefer);
1258#else
1259 void reinstateFromDisplaying(const KCal::Event* event, QString& resourceID, bool& showEdit, bool& showDefer);
1260#endif
1261
1268 KAAlarm convertDisplayingAlarm() const;
1269
1271 bool displaying() const;
1272
1277 KAAlarm alarm(KAAlarm::Type type) const;
1278
1286 KAAlarm firstAlarm() const;
1287
1291 KAAlarm nextAlarm(const KAAlarm& previousAlarm) const;
1295 KAAlarm nextAlarm(KAAlarm::Type previousType) const;
1296
1304 int alarmCount() const;
1305
1310 void removeExpiredAlarm(KAAlarm::Type type);
1311
1318 void startChanges();
1322 void endChanges();
1323
1328 static int currentCalendarVersion();
1329
1334 static QByteArray currentCalendarVersionString();
1335
1348#ifndef KALARMCAL_USE_KRESOURCES
1349 static bool convertKCalEvents(const KCalCore::Calendar::Ptr&, int calendarVersion);
1350#else
1351 static bool convertKCalEvents(KCal::CalendarLocal&, int calendarVersion);
1352#endif
1353
1354#ifndef KALARMCAL_USE_KRESOURCES
1356 static List ptrList(QVector<KAEvent>& events);
1357#endif
1358
1360 void dumpDebug() const;
1361
1362 private:
1363 QSharedDataPointer<KAEventPrivate> d;
1364};
1365
1366} // namespace KAlarmCal
1367
1368Q_DECLARE_OPERATORS_FOR_FLAGS(KAlarmCal::KAEvent::Flags)
1369Q_DECLARE_METATYPE(KAlarmCal::KAEvent)
1370
1371#endif // KAEVENT_H
1372
1373// vim: et sw=4:
calendar.h
Akonadi::Entity::Id
qint64 Id
KAlarmCal::DateTime
As KDateTime, but with a configurable start-of-day time for date-only values.
Definition datetime.h:43
KAlarmCal::KAAlarm
KAAlarm represents individual alarms within a KAEvent.
Definition kaevent.h:78
KAlarmCal::KAAlarm::KAAlarm
KAAlarm()
Default constructor, which creates an invalid instance.
Definition kaevent.cpp:6125
KAlarmCal::KAAlarm::Action
Action
The basic KAAlarm action types.
Definition kaevent.h:82
KAlarmCal::KAAlarm::EMAIL
@ EMAIL
KCal::Alarm::Email type: send an email.
Definition kaevent.h:86
KAlarmCal::KAAlarm::MESSAGE
@ MESSAGE
KCal::Alarm::Display type: display a text message.
Definition kaevent.h:83
KAlarmCal::KAAlarm::FILE
@ FILE
KCal::Alarm::Display type: display a file (URL given by the alarm text)
Definition kaevent.h:84
KAlarmCal::KAAlarm::AUDIO
@ AUDIO
KCal::Alarm::Audio type: play a sound file.
Definition kaevent.h:87
KAlarmCal::KAAlarm::COMMAND
@ COMMAND
KCal::Alarm::Procedure type: execute a shell command.
Definition kaevent.h:85
KAlarmCal::KAAlarm::Type
Type
Alarm types.
Definition kaevent.h:95
KAlarmCal::KAAlarm::DEFERRED_ALARM
@ DEFERRED_ALARM
Deferred alarm.
Definition kaevent.h:99
KAlarmCal::KAAlarm::REMINDER_ALARM
@ REMINDER_ALARM
Reminder in advance of/after the main alarm.
Definition kaevent.h:98
KAlarmCal::KAAlarm::DEFERRED_REMINDER_ALARM
@ DEFERRED_REMINDER_ALARM
Deferred reminder alarm.
Definition kaevent.h:100
KAlarmCal::KAAlarm::INVALID_ALARM
@ INVALID_ALARM
Not an alarm.
Definition kaevent.h:96
KAlarmCal::KAAlarm::DISPLAYING_ALARM
@ DISPLAYING_ALARM
Copy of the alarm currently being displayed.
Definition kaevent.h:104
KAlarmCal::KAAlarm::MAIN_ALARM
@ MAIN_ALARM
THE real alarm. Must be the first in the enumeration.
Definition kaevent.h:97
KAlarmCal::KAAlarm::AT_LOGIN_ALARM
@ AT_LOGIN_ALARM
Additional repeat-at-login trigger.
Definition kaevent.h:103
KAlarmCal::KAEvent
KAEvent represents a KAlarm event.
Definition kaevent.h:211
KAlarmCal::KAEvent::reinstateFromDisplaying
void reinstateFromDisplaying(const KCalCore::Event::Ptr &event, Akonadi::Collection::Id &colId, bool &showEdit, bool &showDefer)
Reinstate the original event from the 'displaying' event.
Definition kaevent.cpp:3726
KAlarmCal::KAEvent::reminderMinutes
int reminderMinutes() const
Return the number of minutes BEFORE the main alarm when a reminder alarm is set.
Definition kaevent.cpp:2496
KAlarmCal::KAEvent::expired
bool expired() const
Return whether the event has expired.
Definition kaevent.cpp:1833
KAlarmCal::KAEvent::setDeferDefaultMinutes
void setDeferDefaultMinutes(int minutes, bool dateOnly=false)
Set defaults for the deferral dialog.
Definition kaevent.cpp:2671
KAlarmCal::KAEvent::OccurType
OccurType
What type of occurrence is due.
Definition kaevent.h:267
KAlarmCal::KAEvent::FIRST_OR_ONLY_OCCURRENCE_REPEAT
@ FIRST_OR_ONLY_OCCURRENCE_REPEAT
a sub-repetition of the first occurrence
Definition kaevent.h:274
KAlarmCal::KAEvent::OCCURRENCE_REPEAT
@ OCCURRENCE_REPEAT
(bitmask for a sub-repetition of an occurrence)
Definition kaevent.h:273
KAlarmCal::KAEvent::RECURRENCE_DATE_REPEAT
@ RECURRENCE_DATE_REPEAT
a sub-repetition of a date-only recurrence
Definition kaevent.h:275
KAlarmCal::KAEvent::RECURRENCE_DATE_TIME
@ RECURRENCE_DATE_TIME
a recurrence with a date and time
Definition kaevent.h:271
KAlarmCal::KAEvent::RECURRENCE_DATE
@ RECURRENCE_DATE
a recurrence with only a date, not a time
Definition kaevent.h:270
KAlarmCal::KAEvent::FIRST_OR_ONLY_OCCURRENCE
@ FIRST_OR_ONLY_OCCURRENCE
the first occurrence (takes precedence over LAST_RECURRENCE)
Definition kaevent.h:269
KAlarmCal::KAEvent::LAST_RECURRENCE
@ LAST_RECURRENCE
the last recurrence
Definition kaevent.h:272
KAlarmCal::KAEvent::RECURRENCE_DATE_TIME_REPEAT
@ RECURRENCE_DATE_TIME_REPEAT
a sub-repetition of a date/time recurrence
Definition kaevent.h:276
KAlarmCal::KAEvent::LAST_RECURRENCE_REPEAT
@ LAST_RECURRENCE_REPEAT
a sub-repetition of the last recurrence
Definition kaevent.h:277
KAlarmCal::KAEvent::NO_OCCURRENCE
@ NO_OCCURRENCE
no occurrence is due
Definition kaevent.h:268
KAlarmCal::KAEvent::repeatSoundPause
int repeatSoundPause() const
Return how many seconds to pause between repetitions of the sound file.
Definition kaevent.cpp:2337
KAlarmCal::KAEvent::setRepeatAtLogin
void setRepeatAtLogin(bool repeat)
Enable or disable repeat-at-login.
Definition kaevent.cpp:2840
KAlarmCal::KAEvent::deferDefaultDateOnly
bool deferDefaultDateOnly() const
Return the default date-only setting used in the deferral dialog.
Definition kaevent.cpp:2750
KAlarmCal::KAEvent::setRecurDaily
bool setRecurDaily(int freq, const QBitArray &days, int count, const QDate &end)
Set the recurrence to recur daily.
Definition kaevent.cpp:3025
KAlarmCal::KAEvent::setStartOfDay
static void setStartOfDay(const QTime &)
Set the start-of-day time used by all date-only alarms.
Definition kaevent.cpp:2784
KAlarmCal::KAEvent::setReminder
void setReminder(int minutes, bool onceOnly)
Set an additional reminder alarm.
Definition kaevent.cpp:2431
KAlarmCal::KAEvent::emailBcc
bool emailBcc() const
Return whether to send a blind copy of the email to the sender, for an email alarm.
Definition kaevent.cpp:2285
KAlarmCal::KAEvent::mainDateTime
DateTime mainDateTime(bool withRepeats=false) const
Return the next time the main alarm will trigger.
Definition kaevent.cpp:2766
KAlarmCal::KAEvent::audioFile
QString audioFile() const
Return the audio file path.
Definition kaevent.cpp:2312
KAlarmCal::KAEvent::autoClose
bool autoClose() const
Return whether auto-close is enabled, i.e.
Definition kaevent.cpp:2024
KAlarmCal::KAEvent::setCreatedDateTime
void setCreatedDateTime(const KDateTime &dt)
Set the date/time the event was created, or saved in the archive calendar.
Definition kaevent.cpp:2827
KAlarmCal::KAEvent::logFile
QString logFile() const
Return the log file which command alarm output should be written to.
Definition kaevent.cpp:2193
KAlarmCal::KAEvent::holidaysExcluded
bool holidaysExcluded() const
Return whether the alarm is disabled on holiday dates.
Definition kaevent.cpp:2883
KAlarmCal::KAEvent::previousOccurrence
OccurType previousOccurrence(const KDateTime &afterDateTime, DateTime &result, bool includeRepetitions=false) const
Get the date/time of the last previous occurrence of the event, before the specified date/time.
Definition kaevent.cpp:3603
KAlarmCal::KAEvent::emailSubject
QString emailSubject() const
Return the email subject line, for an email alarm.
Definition kaevent.cpp:2270
KAlarmCal::KAEvent::repeatSound
bool repeatSound() const
Return whether the sound file will be repeated indefinitely.
Definition kaevent.cpp:2332
KAlarmCal::KAEvent::mainExpired
bool mainExpired() const
Return whether the event's main alarm has expired.
Definition kaevent.cpp:1828
KAlarmCal::KAEvent::setActions
void setActions(const QString &pre, const QString &post, ExtraActionOptions options)
Set the pre-alarm and post-alarm actions, and their options.
Definition kaevent.cpp:2385
KAlarmCal::KAEvent::List
QVector< KAEvent * > List
A list of pointers to KAEvent objects.
Definition kaevent.h:214
KAlarmCal::KAEvent::recurrenceText
QString recurrenceText(bool brief=false) const
Return the recurrence interval as text suitable for display.
Definition kaevent.cpp:3291
KAlarmCal::KAEvent::setRecurMonthlyByDate
bool setRecurMonthlyByDate(int freq, const QVector< int > &days, int count, const QDate &end)
Set the recurrence to recur monthly, on the specified days within the month.
Definition kaevent.cpp:3074
KAlarmCal::KAEvent::recurInterval
int recurInterval() const
Return the recurrence interval in units of the recurrence period type (minutes, days,...
Definition kaevent.cpp:3214
KAlarmCal::KAEvent::SubAction
SubAction
The sub-action type for the event's main alarm.
Definition kaevent.h:257
KAlarmCal::KAEvent::FILE
@ FILE
display the contents of a file
Definition kaevent.h:259
KAlarmCal::KAEvent::COMMAND
@ COMMAND
execute a command
Definition kaevent.h:260
KAlarmCal::KAEvent::EMAIL
@ EMAIL
send an email
Definition kaevent.h:261
KAlarmCal::KAEvent::MESSAGE
@ MESSAGE
display a message text
Definition kaevent.h:258
KAlarmCal::KAEvent::AUDIO
@ AUDIO
play an audio file
Definition kaevent.h:262
KAlarmCal::KAEvent::setRecurrence
void setRecurrence(const KARecurrence &r)
Initialise the event's recurrence from a KARecurrence.
Definition kaevent.cpp:2973
KAlarmCal::KAEvent::setCollectionId_const
void setCollectionId_const(Akonadi::Collection::Id id) const
Set the ID of the Akonadi Collection which contains the event.
Definition kaevent.cpp:1916
KAlarmCal::KAEvent::setLateCancel
void setLateCancel(int minutes)
Set or clear the late-cancel option.
Definition kaevent.cpp:2005
KAlarmCal::KAEvent::commandXterm
bool commandXterm() const
Return whether to execute the command in a terminal window, for a command alarm.
Definition kaevent.cpp:2095
KAlarmCal::KAEvent::deferred
bool deferred() const
Return whether there is currently a deferred alarm pending.
Definition kaevent.cpp:2677
KAlarmCal::KAEvent::joinEmailAddresses
static QString joinEmailAddresses(const KCalCore::Person::List &addresses, const QString &sep)
Concatenate a list of email addresses into a string.
Definition kaevent.cpp:2252
KAlarmCal::KAEvent::commandDisplay
bool commandDisplay() const
Return whether the command output is to be displayed in an alarm message window.
Definition kaevent.cpp:2100
KAlarmCal::KAEvent::emailAddresses
QStringList emailAddresses() const
Return a list of the email addresses, including names, for an email alarm.
Definition kaevent.cpp:2241
KAlarmCal::KAEvent::compatibility
KACalendar::Compat compatibility() const
Return the event's storage format compatibility compared to the current KAlarm calendar format.
Definition kaevent.cpp:1965
KAlarmCal::KAEvent::collectionId
Akonadi::Collection::Id collectionId() const
Return the ID of the Akonadi Collection which contains the event.
Definition kaevent.cpp:1921
KAlarmCal::KAEvent::customProperties
QMap< QByteArray, QString > customProperties() const
Return the original KCalCore::Event's custom properties in the source calendar.
Definition kaevent.cpp:1970
KAlarmCal::KAEvent::repeatAtLogin
bool repeatAtLogin(bool includeArchived=false) const
Return whether the alarm repeats at login.
Definition kaevent.cpp:2871
KAlarmCal::KAEvent::setCommandError
void setCommandError(CmdErrType error) const
Set or clear the command execution error for the last time the alarm triggered.
Definition kaevent.cpp:2106
KAlarmCal::KAEvent::setExcludeHolidays
void setExcludeHolidays(bool exclude)
Enable or disable the alarm on holiday dates.
Definition kaevent.cpp:2876
KAlarmCal::KAEvent::fadeSeconds
int fadeSeconds() const
Return the fade period in seconds, or 0 if no fade is specified.
Definition kaevent.cpp:2327
KAlarmCal::KAEvent::deferDefaultMinutes
int deferDefaultMinutes() const
Return the default deferral interval used in the deferral dialog.
Definition kaevent.cpp:2745
KAlarmCal::KAEvent::command
QString command() const
Return the command or script to execute, for a command alarm.
Definition kaevent.cpp:2085
KAlarmCal::KAEvent::emailAttachments
QStringList emailAttachments() const
Return the list of file paths of the attachments, for an email alarm.
Definition kaevent.cpp:2275
KAlarmCal::KAEvent::displayMessage
QString displayMessage() const
Return the message text for a display alarm.
Definition kaevent.cpp:2050
KAlarmCal::KAEvent::mainEndRepeatTime
DateTime mainEndRepeatTime() const
Return the time at which the last sub-repetition of the main alarm will occur.
Definition kaevent.cpp:2776
KAlarmCal::KAEvent::convertDisplayingAlarm
KAAlarm convertDisplayingAlarm() const
Return the original alarm which the displaying alarm refers to.
Definition kaevent.cpp:3765
KAlarmCal::KAEvent::category
CalEvent::Type category() const
Return the alarm category (active/archived/template, or displaying).
Definition kaevent.cpp:1885
KAlarmCal::KAEvent::setReadOnly
void setReadOnly(bool ro)
Set the read-only status of the alarm.
Definition kaevent.cpp:1807
KAlarmCal::KAEvent::recurrence
KARecurrence * recurrence() const
Return the full recurrence data for the event.
Definition kaevent.cpp:3206
KAlarmCal::KAEvent::setCompatibility
void setCompatibility(KACalendar::Compat c)
Note the event's storage format compatibility compared to the current KAlarm calendar format.
Definition kaevent.cpp:1960
KAlarmCal::KAEvent::currentCalendarVersion
static int currentCalendarVersion()
Return the current KAlarm calendar storage format version.
Definition kaevent.cpp:446
KAlarmCal::KAEvent::firstAlarm
KAAlarm firstAlarm() const
Return the main alarm for the event.
Definition kaevent.cpp:3877
KAlarmCal::KAEvent::setFirstRecurrence
void setFirstRecurrence()
Adjust the event date/time to the first recurrence of the event, on or after the event start date/tim...
Definition kaevent.cpp:3245
KAlarmCal::KAEvent::bgColour
QColor bgColour() const
Return the message window background color, for a display alarm.
Definition kaevent.cpp:2060
KAlarmCal::KAEvent::startDateTime
DateTime startDateTime() const
Return the start time for the event.
Definition kaevent.cpp:2755
KAlarmCal::KAEvent::copyToKOrganizer
bool copyToKOrganizer() const
Return whether KOrganizer should hold a copy of the event.
Definition kaevent.cpp:2203
KAlarmCal::KAEvent::repetitionText
QString repetitionText(bool brief=false) const
Return the repetition interval as text suitable for display.
Definition kaevent.cpp:3383
KAlarmCal::KAEvent::incrementRevision
void incrementRevision()
Increment the revision number of the event (SEQUENCE property in iCalendar).
Definition kaevent.cpp:1900
KAlarmCal::KAEvent::currentCalendarVersionString
static QByteArray currentCalendarVersionString()
Return the current KAlarm calendar storage format version.
Definition kaevent.cpp:445
KAlarmCal::KAEvent::setTemplate
void setTemplate(const QString &name, int afterTime=-1)
Set the event to be an alarm template.
Definition kaevent.cpp:2357
KAlarmCal::KAEvent::setEventId
void setEventId(const QString &id)
Set the event's unique identifier.
Definition kaevent.cpp:1890
KAlarmCal::KAEvent::soundVolume
float soundVolume() const
Return the sound volume (the final volume if fade is specified).
Definition kaevent.cpp:2317
KAlarmCal::KAEvent::confirmAck
bool confirmAck() const
Return whether alarm acknowledgement must be confirmed by the user, for a display alarm.
Definition kaevent.cpp:2198
KAlarmCal::KAEvent::setCollectionId
void setCollectionId(Akonadi::Collection::Id id)
Set the ID of the Akonadi Collection which contains the event.
Definition kaevent.cpp:1911
KAlarmCal::KAEvent::toBeArchived
bool toBeArchived() const
Return whether the event should be archived when it expires or is deleted.
Definition kaevent.cpp:1823
KAlarmCal::KAEvent::message
QString message() const
Return the message text for a display alarm, or the email body for an email alarm.
Definition kaevent.cpp:2044
KAlarmCal::KAEvent::isWorkingTime
bool isWorkingTime(const KDateTime &dt) const
Check whether a date/time is during working hours and/or holidays, depending on the flags set for the...
Definition kaevent.cpp:2916
KAlarmCal::KAEvent::set
void set(const KCalCore::Event::Ptr &)
Initialise the instance from a KCalCore::Event.
Definition kaevent.cpp:757
KAlarmCal::KAEvent::nextAlarm
KAAlarm nextAlarm(const KAAlarm &previousAlarm) const
Return the next alarm for the event, after the specified alarm.
Definition kaevent.cpp:3898
KAlarmCal::KAEvent::itemId
Akonadi::Item::Id itemId() const
Return the ID of the Akonadi Item which contains the event.
Definition kaevent.cpp:1932
KAlarmCal::KAEvent::setTime
void setTime(const KDateTime &dt)
Set the next time to trigger the alarm (excluding sub-repetitions).
Definition kaevent.cpp:2760
KAlarmCal::KAEvent::createdDateTime
KDateTime createdDateTime() const
Return the date/time the event was created, or saved in the archive calendar.
Definition kaevent.cpp:2832
KAlarmCal::KAEvent::isReadOnly
bool isReadOnly() const
Return the read-only status of the alarm.
Definition kaevent.cpp:1812
KAlarmCal::KAEvent::usingDefaultTime
bool usingDefaultTime() const
Return whether the alarm template does not specify a time.
Definition kaevent.cpp:2375
KAlarmCal::KAEvent::setHolidays
static void setHolidays(const KHolidays::HolidayRegion &region)
Set the holiday region to be used by all KAEvent instances.
Definition kaevent.cpp:2895
KAlarmCal::KAEvent::id
QString id() const
Return the event's unique identifier.
Definition kaevent.cpp:1895
KAlarmCal::KAEvent::Actions
Actions
The basic action type(s) for the event's main alarm.
Definition kaevent.h:245
KAlarmCal::KAEvent::ACT_EMAIL
@ ACT_EMAIL
the alarm sends an email
Definition kaevent.h:249
KAlarmCal::KAEvent::ACT_DISPLAY
@ ACT_DISPLAY
the alarm displays something
Definition kaevent.h:247
KAlarmCal::KAEvent::ACT_NONE
@ ACT_NONE
invalid
Definition kaevent.h:246
KAlarmCal::KAEvent::ACT_DISPLAY_COMMAND
@ ACT_DISPLAY_COMMAND
the alarm displays command output
Definition kaevent.h:251
KAlarmCal::KAEvent::ACT_COMMAND
@ ACT_COMMAND
the alarm executes a command
Definition kaevent.h:248
KAlarmCal::KAEvent::ACT_ALL
@ ACT_ALL
all types mask
Definition kaevent.h:252
KAlarmCal::KAEvent::ACT_AUDIO
@ ACT_AUDIO
the alarm plays an audio file (without any display)
Definition kaevent.h:250
KAlarmCal::KAEvent::nextRepetition
int nextRepetition() const
Return the count of the next sub-repetition which is due.
Definition kaevent.cpp:3375
KAlarmCal::KAEvent::revision
int revision() const
Return the revision number of the event (SEQUENCE property in iCalendar).
Definition kaevent.cpp:1905
KAlarmCal::KAEvent::setRecurMonthlyByPos
bool setRecurMonthlyByPos(int freq, const QVector< MonthPos > &pos, int count, const QDate &end)
Set the recurrence to recur monthly, on the specified weekdays in the specified weeks of the month.
Definition kaevent.cpp:3098
KAlarmCal::KAEvent::OccurOption
OccurOption
How to treat sub-repetitions in nextOccurrence().
Definition kaevent.h:282
KAlarmCal::KAEvent::RETURN_REPETITION
@ RETURN_REPETITION
return a sub-repetition if it's the next occurrence
Definition kaevent.h:284
KAlarmCal::KAEvent::ALLOW_FOR_REPETITION
@ ALLOW_FOR_REPETITION
if a sub-repetition is the next occurrence, return the previous recurrence, not the sub-repetition
Definition kaevent.h:285
KAlarmCal::KAEvent::IGNORE_REPETITION
@ IGNORE_REPETITION
check for recurrences only, ignore sub-repetitions
Definition kaevent.h:283
KAlarmCal::KAEvent::defer
void defer(const DateTime &dt, bool reminder, bool adjustRecurrence=false)
Defer the event to the specified time.
Definition kaevent.cpp:2522
KAlarmCal::KAEvent::dumpDebug
void dumpDebug() const
Output the event's data as debug output.
Definition kaevent.cpp:4044
KAlarmCal::KAEvent::reminderDeferral
bool reminderDeferral() const
Return whether there is currently a deferred reminder alarm pending.
Definition kaevent.cpp:2511
KAlarmCal::KAEvent::lateCancel
int lateCancel() const
Get the late cancellation period.
Definition kaevent.cpp:2014
KAlarmCal::KAEvent::setRecurAnnualByPos
bool setRecurAnnualByPos(int freq, const QVector< MonthPos > &pos, const QVector< int > &months, int count, const QDate &end)
Set the recurrence to recur annually, on the specified weekdays in the specified weeks of the specifi...
Definition kaevent.cpp:3151
KAlarmCal::KAEvent::font
QFont font() const
Return the font to use for alarm message texts.
Definition kaevent.cpp:2080
KAlarmCal::KAEvent::UidAction
UidAction
How to deal with the event UID in updateKCalEvent().
Definition kaevent.h:331
KAlarmCal::KAEvent::UID_SET
@ UID_SET
set the KCal::Event UID to the KAEvent ID
Definition kaevent.h:334
KAlarmCal::KAEvent::UID_CHECK
@ UID_CHECK
verify that the KCal::Event UID is already the same as the KAEvent ID, if the latter is non-empty
Definition kaevent.h:333
KAlarmCal::KAEvent::UID_IGNORE
@ UID_IGNORE
leave KCal::Event UID unchanged
Definition kaevent.h:332
KAlarmCal::KAEvent::emailPureAddresses
QStringList emailPureAddresses() const
Return the list of email addressees, excluding names, for an email alarm.
Definition kaevent.cpp:2260
KAlarmCal::KAEvent::Flag
Flag
Flags for use in D-Bus calls, etc.
Definition kaevent.h:218
KAlarmCal::KAEvent::ANY_TIME
@ ANY_TIME
only a date is specified for the alarm, not a time
Definition kaevent.h:221
KAlarmCal::KAEvent::DISABLED
@ DISABLED
the alarm is currently disabled
Definition kaevent.h:226
KAlarmCal::KAEvent::REPEAT_AT_LOGIN
@ REPEAT_AT_LOGIN
repeat the alarm at every login
Definition kaevent.h:220
KAlarmCal::KAEvent::REPEAT_SOUND
@ REPEAT_SOUND
repeat the sound file while the alarm is displayed
Definition kaevent.h:225
KAlarmCal::KAEvent::EXCL_HOLIDAYS
@ EXCL_HOLIDAYS
don't trigger the alarm on holidays
Definition kaevent.h:232
KAlarmCal::KAEvent::REMINDER_ONCE
@ REMINDER_ONCE
only trigger the reminder on the first recurrence
Definition kaevent.h:235
KAlarmCal::KAEvent::SPEAK
@ SPEAK
speak the message when the alarm is displayed
Definition kaevent.h:230
KAlarmCal::KAEvent::COPY_KORGANIZER
@ COPY_KORGANIZER
KOrganizer should hold a copy of the event.
Definition kaevent.h:231
KAlarmCal::KAEvent::DEFAULT_FONT
@ DEFAULT_FONT
use the default alarm message font
Definition kaevent.h:224
KAlarmCal::KAEvent::WORK_TIME_ONLY
@ WORK_TIME_ONLY
trigger the alarm only during working hours
Definition kaevent.h:233
KAlarmCal::KAEvent::SCRIPT
@ SCRIPT
the command is a script, not a shell command line
Definition kaevent.h:228
KAlarmCal::KAEvent::BEEP
@ BEEP
sound an audible beep when the alarm is displayed
Definition kaevent.h:219
KAlarmCal::KAEvent::CONFIRM_ACK
@ CONFIRM_ACK
closing the alarm message window requires a confirmation prompt
Definition kaevent.h:222
KAlarmCal::KAEvent::EMAIL_BCC
@ EMAIL_BCC
blind copy the email to the user
Definition kaevent.h:223
KAlarmCal::KAEvent::EXEC_IN_XTERM
@ EXEC_IN_XTERM
execute the command in a terminal window
Definition kaevent.h:229
KAlarmCal::KAEvent::DISPLAY_COMMAND
@ DISPLAY_COMMAND
display command output in the alarm window
Definition kaevent.h:234
KAlarmCal::KAEvent::AUTO_CLOSE
@ AUTO_CLOSE
auto-close the alarm window after the late-cancel period
Definition kaevent.h:227
KAlarmCal::KAEvent::postAction
QString postAction() const
Return the shell command to execute after the display alarm is acknowledged.
Definition kaevent.cpp:2407
KAlarmCal::KAEvent::setRepetition
bool setRepetition(const Repetition &r)
Initialise the event's sub-repetition.
Definition kaevent.cpp:3332
KAlarmCal::KAEvent::setNextOccurrence
OccurType setNextOccurrence(const KDateTime &preDateTime)
Set the date/time of the event to the next scheduled occurrence after a specified date/time,...
Definition kaevent.cpp:3453
KAlarmCal::KAEvent::CmdErrType
CmdErrType
Command execution error type for last time the alarm was triggered.
Definition kaevent.h:310
KAlarmCal::KAEvent::CMD_ERROR_PRE
@ CMD_ERROR_PRE
pre-alarm command execution failed
Definition kaevent.h:313
KAlarmCal::KAEvent::CMD_ERROR
@ CMD_ERROR
command alarm execution failed
Definition kaevent.h:312
KAlarmCal::KAEvent::CMD_ERROR_POST
@ CMD_ERROR_POST
post-alarm command execution failed
Definition kaevent.h:314
KAlarmCal::KAEvent::CMD_NO_ERROR
@ CMD_NO_ERROR
no error
Definition kaevent.h:311
KAlarmCal::KAEvent::commandScript
bool commandScript() const
Return whether a command script is specified, for a command alarm.
Definition kaevent.cpp:2090
KAlarmCal::KAEvent::setDefaultFont
static void setDefaultFont(const QFont &font)
Set the global default font for alarm message texts.
Definition kaevent.cpp:2070
KAlarmCal::KAEvent::ptrList
static List ptrList(QVector< KAEvent > &events)
Return a list of pointers to a list of KAEvent objects.
Definition kaevent.cpp:4035
KAlarmCal::KAEvent::deferralLimit
DateTime deferralLimit(DeferLimitType *limitType=0) const
Return the latest time which the alarm can currently be deferred to.
Definition kaevent.cpp:2690
KAlarmCal::KAEvent::enabled
bool enabled() const
Return the enabled status of the alarm.
Definition kaevent.cpp:1801
KAlarmCal::KAEvent::fileName
QString fileName() const
Return the path of the file whose contents are to be shown, for a display alarm.
Definition kaevent.cpp:2055
KAlarmCal::KAEvent::setArchive
void setArchive()
Set the event to be archived when it expires or is deleted.
Definition kaevent.cpp:1818
KAlarmCal::KAEvent::nextTrigger
DateTime nextTrigger(TriggerType type) const
Return the next time the alarm will trigger.
Definition kaevent.cpp:2807
KAlarmCal::KAEvent::endChanges
void endChanges()
Call when a group of changes preceded by startChanges() is complete, to allow resultant updates to oc...
Definition kaevent.cpp:4020
KAlarmCal::KAEvent::nextOccurrence
OccurType nextOccurrence(const KDateTime &preDateTime, DateTime &result, OccurOption option=IGNORE_REPETITION) const
Get the date/time of the next occurrence of the event, after the specified date/time.
Definition kaevent.cpp:3527
KAlarmCal::KAEvent::setRecurMinutely
bool setRecurMinutely(int freq, int count, const KDateTime &end)
Set the recurrence to recur at a minutes interval.
Definition kaevent.cpp:3007
KAlarmCal::KAEvent::actionSubType
SubAction actionSubType() const
Return the action sub-type of the event's main alarm.
Definition kaevent.cpp:1987
KAlarmCal::KAEvent::setRecurAnnualByDate
bool setRecurAnnualByDate(int freq, const QVector< int > &months, int day, KARecurrence::Feb29Type, int count, const QDate &end)
Set the recurrence to recur annually, on the specified day in each of the specified months.
Definition kaevent.cpp:3124
KAlarmCal::KAEvent::setLogFile
void setLogFile(const QString &logfile)
Set the log file to write command alarm output to.
Definition kaevent.cpp:2186
KAlarmCal::KAEvent::reminderActive
bool reminderActive() const
Return whether a reminder is currently due (before the next, or after the last, main alarm/recurrence...
Definition kaevent.cpp:2501
KAlarmCal::KAEvent::setEmail
void setEmail(uint from, const KCalCore::Person::List &, const QString &subject, const QStringList &attachments)
Set the email related data for the event.
Definition kaevent.cpp:2209
KAlarmCal::KAEvent::longestRecurrenceInterval
KCalCore::Duration longestRecurrenceInterval() const
Return the longest interval which can occur between consecutive recurrences.
Definition kaevent.cpp:3235
KAlarmCal::KAEvent::deferDateTime
DateTime deferDateTime() const
Return the time at which the currently pending deferred alarm should trigger.
Definition kaevent.cpp:2682
KAlarmCal::KAEvent::templateAfterTime
int templateAfterTime() const
Return the number of minutes (>= 0) after the default alarm time which is specified in the alarm temp...
Definition kaevent.cpp:2380
KAlarmCal::KAEvent::setItemPayload
bool setItemPayload(Akonadi::Item &, const QStringList &collectionMimeTypes) const
Initialise an Akonadi::Item with the event's data.
Definition kaevent.cpp:1943
KAlarmCal::KAEvent::recurType
KARecurrence::Type recurType() const
Return the recurrence period type for the event.
Definition kaevent.cpp:3201
KAlarmCal::KAEvent::fadeVolume
float fadeVolume() const
Return the initial volume which will fade to the final volume.
Definition kaevent.cpp:2322
KAlarmCal::KAEvent::speak
bool speak() const
Return whether the displayed alarm text should be spoken.
Definition kaevent.cpp:2347
KAlarmCal::KAEvent::setRecurWeekly
bool setRecurWeekly(int freq, const QBitArray &days, int count, const QDate &end)
Set the recurrence to recur weekly, on the specified weekdays.
Definition kaevent.cpp:3054
KAlarmCal::KAEvent::displaying
bool displaying() const
Return whether the alarm is currently being displayed, i.e.
Definition kaevent.cpp:3788
KAlarmCal::KAEvent::adjustStartOfDay
static void adjustStartOfDay(const KAEvent::List &events)
Call when the user changes the start-of-day time, to adjust the data for each date-only event in a li...
Definition kaevent.cpp:2797
KAlarmCal::KAEvent::isValid
bool isValid() const
Return whether the instance represents a valid event.
Definition kaevent.cpp:1791
KAlarmCal::KAEvent::setItemId
void setItemId(Akonadi::Item::Id id)
Set the ID of the Akonadi Item which contains the event.
Definition kaevent.cpp:1927
KAlarmCal::KAEvent::extraActionOptions
ExtraActionOptions extraActionOptions() const
Return the pre- and post-alarm action options.
Definition kaevent.cpp:2412
KAlarmCal::KAEvent::updateKCalEvent
bool updateKCalEvent(const KCalCore::Event::Ptr &event, UidAction u, bool setCustomProperties=true) const
Update an existing KCalCore::Event with the KAEvent data.
Definition kaevent.cpp:1346
KAlarmCal::KAEvent::removeExpiredAlarm
void removeExpiredAlarm(KAAlarm::Type type)
Remove the alarm of the specified type from the event.
Definition kaevent.cpp:3951
KAlarmCal::KAEvent::flags
Flags flags() const
Return the OR of various Flag enum status values.
Definition kaevent.cpp:1838
KAlarmCal::KAEvent::DeferLimitType
DeferLimitType
What type of occurrence currently limits how long the alarm can be deferred.
Definition kaevent.h:290
KAlarmCal::KAEvent::LIMIT_REMINDER
@ LIMIT_REMINDER
a reminder
Definition kaevent.h:295
KAlarmCal::KAEvent::LIMIT_MAIN
@ LIMIT_MAIN
the main alarm
Definition kaevent.h:292
KAlarmCal::KAEvent::LIMIT_RECURRENCE
@ LIMIT_RECURRENCE
a recurrence
Definition kaevent.h:293
KAlarmCal::KAEvent::LIMIT_NONE
@ LIMIT_NONE
there is no limit
Definition kaevent.h:291
KAlarmCal::KAEvent::LIMIT_REPETITION
@ LIMIT_REPETITION
a sub-repetition
Definition kaevent.h:294
KAlarmCal::KAEvent::beep
bool beep() const
Return whether a beep should sound when the alarm is displayed.
Definition kaevent.cpp:2342
KAlarmCal::KAEvent::cleanText
QString cleanText() const
Return the alarm's text.
Definition kaevent.cpp:2039
KAlarmCal::KAEvent::ExtraActionOption
ExtraActionOption
Options for pre- or post-alarm actions.
Definition kaevent.h:322
KAlarmCal::KAEvent::DontShowPreActError
@ DontShowPreActError
do not notify pre-alarm action errors to user
Definition kaevent.h:324
KAlarmCal::KAEvent::ExecPreActOnDeferral
@ ExecPreActOnDeferral
execute pre-alarm action also for deferred alarms
Definition kaevent.h:325
KAlarmCal::KAEvent::CancelOnPreActError
@ CancelOnPreActError
cancel alarm on pre-alarm action error
Definition kaevent.h:323
KAlarmCal::KAEvent::alarm
KAAlarm alarm(KAAlarm::Type type) const
Return the alarm of a specified type.
Definition kaevent.cpp:3796
KAlarmCal::KAEvent::setWorkTime
static void setWorkTime(const QBitArray &days, const QTime &start, const QTime &end)
Set working days and times, to be used by all KAEvent instances.
Definition kaevent.cpp:2937
KAlarmCal::KAEvent::dontShowPreActionError
bool dontShowPreActionError() const
Return whether the user should not be notified if the pre-alarm action fails.
Definition kaevent.cpp:2422
KAlarmCal::KAEvent::recurs
bool recurs() const
Return whether the event recurs.
Definition kaevent.cpp:3196
KAlarmCal::KAEvent::actionTypes
Actions actionTypes() const
Return the OR of the basic action types of the event's main alarm (display, command,...
Definition kaevent.cpp:1992
KAlarmCal::KAEvent::isTemplate
bool isTemplate() const
Return whether the event is an alarm template.
Definition kaevent.cpp:2365
KAlarmCal::KAEvent::fgColour
QColor fgColour() const
Return the message window foreground color, for a display alarm.
Definition kaevent.cpp:2065
KAlarmCal::KAEvent::setAudioFile
void setAudioFile(const QString &filename, float volume, float fadeVolume, int fadeSeconds, int repeatPause=-1, bool allowEmptyFile=false)
Set the audio file related data for the event.
Definition kaevent.cpp:2290
KAlarmCal::KAEvent::TriggerType
TriggerType
Alarm trigger type.
Definition kaevent.h:300
KAlarmCal::KAEvent::MAIN_TRIGGER
@ MAIN_TRIGGER
next trigger, excluding reminders, ignoring working hours & holidays
Definition kaevent.h:302
KAlarmCal::KAEvent::WORK_TRIGGER
@ WORK_TRIGGER
next main working time trigger, excluding reminders
Definition kaevent.h:303
KAlarmCal::KAEvent::ALL_TRIGGER
@ ALL_TRIGGER
next trigger, including reminders, ignoring working hours & holidays
Definition kaevent.h:301
KAlarmCal::KAEvent::ALL_WORK_TRIGGER
@ ALL_WORK_TRIGGER
next actual working time trigger, including reminders
Definition kaevent.h:304
KAlarmCal::KAEvent::DISPLAY_TRIGGER
@ DISPLAY_TRIGGER
next trigger time for display purposes (i.e. excluding reminders)
Definition kaevent.h:305
KAlarmCal::KAEvent::useDefaultFont
bool useDefaultFont() const
Return whether to use the default font (as set by setDefaultFont()) for alarm message texts.
Definition kaevent.cpp:2075
KAlarmCal::KAEvent::mainTime
QTime mainTime() const
Return the time at which the main alarm will next trigger.
Definition kaevent.cpp:2771
KAlarmCal::KAEvent::emailFromId
uint emailFromId() const
Return the email identity to be used as the sender, for an email alarm.
Definition kaevent.cpp:2227
KAlarmCal::KAEvent::occursAfter
bool occursAfter(const KDateTime &preDateTime, bool includeRepetitions) const
Determine whether the event will occur after the specified date/time.
Definition kaevent.cpp:3410
KAlarmCal::KAEvent::cancelOnPreActionError
bool cancelOnPreActionError() const
Return whether the alarm is to be cancelled if the pre-alarm action fails.
Definition kaevent.cpp:2417
KAlarmCal::KAEvent::convertKCalEvents
static bool convertKCalEvents(const KCalCore::Calendar::Ptr &, int calendarVersion)
If a calendar was written by a previous version of KAlarm, do any necessary format conversions on the...
Definition kaevent.cpp:5240
KAlarmCal::KAEvent::startChanges
void startChanges()
Call before making a group of changes to the event, to avoid unnecessary calculation intensive recalc...
Definition kaevent.cpp:4011
KAlarmCal::KAEvent::templateName
QString templateName() const
Return the alarm template's name.
Definition kaevent.cpp:2370
KAlarmCal::KAEvent::setNoRecur
void setNoRecur()
Clear the event's recurrence and sub-repetition data.
Definition kaevent.cpp:2952
KAlarmCal::KAEvent::alarmCount
int alarmCount() const
Return the number of alarms in the event, i.e.
Definition kaevent.cpp:3941
KAlarmCal::KAEvent::activateReminderAfter
void activateReminderAfter(const DateTime &mainAlarmTime)
If there is a reminder which occurs AFTER the main alarm, activate the event's reminder which occurs ...
Definition kaevent.cpp:2458
KAlarmCal::KAEvent::preAction
QString preAction() const
Return the shell command to execute before the alarm is displayed.
Definition kaevent.cpp:2402
KAlarmCal::KAEvent::repetition
Repetition repetition() const
Return the event's sub-repetition data.
Definition kaevent.cpp:3370
KAlarmCal::KAEvent::emailMessage
QString emailMessage() const
Return the email message body, for an email alarm.
Definition kaevent.cpp:2222
KAlarmCal::KAEvent::KAEvent
KAEvent()
Default constructor which creates an invalid event.
KAlarmCal::KAEvent::workTimeOnly
bool workTimeOnly() const
Return whether the alarm is disabled on non-working days and outside working hours.
Definition kaevent.cpp:2907
KAlarmCal::KAEvent::commandError
CmdErrType commandError() const
Return the command execution error for the last time the alarm triggered.
Definition kaevent.cpp:2181
KAlarmCal::KAEvent::cancelDefer
void cancelDefer()
Cancel any deferral alarm which is pending.
Definition kaevent.cpp:2656
KAlarmCal::KAEvent::setCategory
void setCategory(CalEvent::Type type)
Set the alarm category (active/archived/template, or displaying).
Definition kaevent.cpp:1871
KAlarmCal::KAEvent::emailAddressees
KCalCore::Person::List emailAddressees() const
Return the list of email addressees, including names, for an email alarm.
Definition kaevent.cpp:2233
KAlarmCal::KAEvent::setDisplaying
bool setDisplaying(const KAEvent &event, KAAlarm::Type type, Akonadi::Collection::Id colId, const KDateTime &repeatAtLoginTime, bool showEdit, bool showDefer)
Set the event to be a copy of the specified event, making the specified alarm the 'displaying' alarm.
Definition kaevent.cpp:3667
KAlarmCal::KAEvent::setWorkTimeOnly
void setWorkTimeOnly(bool wto)
Enable or disable the alarm on non-working days and outside working hours.
Definition kaevent.cpp:2900
KAlarmCal::KAEvent::setEnabled
void setEnabled(bool enable)
Enable or disable the alarm.
Definition kaevent.cpp:1796
KAlarmCal::KAEvent::setAutoClose
void setAutoClose(bool autoclose)
Enable or disable auto-close for a display alarm, i.e.
Definition kaevent.cpp:2019
KAlarmCal::KAEvent::reminderOnceOnly
bool reminderOnceOnly() const
Return whether the reminder alarm is triggered only for the first recurrence.
Definition kaevent.cpp:2506
KAlarmCal::KARecurrence
Represents recurrences for KAlarm.
Definition karecurrence.h:62
KAlarmCal::KARecurrence::Type
Type
The recurrence's period type.
Definition karecurrence.h:68
KAlarmCal::KARecurrence::Feb29Type
Feb29Type
When annual February 29th recurrences should occur in non-leap years.
Definition karecurrence.h:80
KAlarmCal::Repetition
Represents a sub-repetition, defined by interval and repeat count.
Definition repetition.h:48
KCalCore::Calendar::Ptr
QSharedPointer< Calendar > Ptr
KCalCore::Duration
KCalCore::Event::Ptr
QSharedPointer< Event > Ptr
KCalCore::Person::List
QVector< Ptr > List
KAlarmCal::CalEvent::Type
Type
The category of an event, indicated by the middle part of its UID.
Definition kacalendar.h:156
KHolidays
person.h
KAlarmCal::KAEvent::MonthPos::weeknum
int weeknum
Week in month, or < 0 to count from end of month.
Definition kaevent.h:1085
KAlarmCal::KAEvent::MonthPos::days
QBitArray days
Days in week, element 0 = Monday.
Definition kaevent.h:1086
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KAlarm Library

Skip menu "KAlarm Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal