kalarm/src/dbushandler.h

0001 /*
0002  *  dbushandler.h  -  handler for D-Bus calls by other applications
0003  *  Program:  kalarm
0004  *  SPDX-FileCopyrightText: 2001-2022 David Jarvie <djarvie@kde.org>
0005  *
0006  *  SPDX-License-Identifier: GPL-2.0-or-later
0007  */
0008
0009 #pragma once
0010
0011 #include "kalarmiface.h"
0012
0013 #include "kalarmcalendar/kaevent.h"
0014
0015 #include <KCalendarCore/Duration>
0016
0017 class QUrl;
0018
0019 using namespace KAlarmCal;
0020
0021
0022 class DBusHandler : public QObject, public KAlarmIface
0023 {
0024     Q_OBJECT
0025     Q_CLASSINFO("D-Bus Interface", "org.kde.kalarm.kalarm")
0026 public:
0027     DBusHandler();
0028
0029 public Q_SLOTS:
0030     Q_SCRIPTABLE bool cancelEvent(const QString& eventId);
0031     Q_SCRIPTABLE bool triggerEvent(const QString& eventId);
0032     Q_SCRIPTABLE QString list();
0033
0034     // Create a display alarm with a specified text message.
0035     Q_SCRIPTABLE bool scheduleMessage(const QString& name, const QString& message, const QString& startDateTime, int lateCancel, unsigned flags,
0036                                       const QString& bgColor, const QString& fgColor, const QString& font,
0037                                       const QString& audioUrl, int reminderMins, const QString& recurrence,
0038                                       int subRepeatInterval, int subRepeatCount);
0039     Q_SCRIPTABLE bool scheduleMessage(const QString& name, const QString& message, const QString& startDateTime, int lateCancel, unsigned flags,
0040                                       const QString& bgColor, const QString& fgColor, const QString& font,
0041                                       const QString& audioUrl, int reminderMins, int recurType, int recurInterval, int recurCount);
0042     Q_SCRIPTABLE bool scheduleMessage(const QString& name, const QString& message, const QString& startDateTime, int lateCancel, unsigned flags,
0043                                       const QString& bgColor, const QString& fgColor, const QString& font,
0044                                       const QString& audioUrl, int reminderMins, int recurType, int recurInterval, const QString& endDateTime);
0045     // Deprecated: Create a display alarm with a specified text message.
0046     Q_SCRIPTABLE bool scheduleMessage(const QString& message, const QString& startDateTime, int lateCancel, unsigned flags,
0047                                       const QString& bgColor, const QString& fgColor, const QString& font,
0048                                       const QString& audioUrl, int reminderMins, const QString& recurrence,
0049                                       int subRepeatInterval, int subRepeatCount);
0050     Q_SCRIPTABLE bool scheduleMessage(const QString& message, const QString& startDateTime, int lateCancel, unsigned flags,
0051                                       const QString& bgColor, const QString& fgColor, const QString& font,
0052                                       const QString& audioUrl, int reminderMins, int recurType, int recurInterval, int recurCount);
0053     Q_SCRIPTABLE bool scheduleMessage(const QString& message, const QString& startDateTime, int lateCancel, unsigned flags,
0054                                       const QString& bgColor, const QString& fgColor, const QString& font,
0055                                       const QString& audioUrl, int reminderMins, int recurType, int recurInterval, const QString& endDateTime);
0056
0057     // Create a display alarm showing a file's contents.
0058     Q_SCRIPTABLE bool scheduleFile(const QString& name, const QString& url, const QString& startDateTime, int lateCancel, unsigned flags, const QString& bgColor,
0059                                    const QString& audioUrl, int reminderMins, const QString& recurrence,
0060                                    int subRepeatInterval, int subRepeatCount);
0061     Q_SCRIPTABLE bool scheduleFile(const QString& name, const QString& url, const QString& startDateTime, int lateCancel, unsigned flags, const QString& bgColor,
0062                                    const QString& audioUrl, int reminderMins, int recurType, int recurInterval, int recurCount);
0063     Q_SCRIPTABLE bool scheduleFile(const QString& name, const QString& url, const QString& startDateTime, int lateCancel, unsigned flags, const QString& bgColor,
0064                                    const QString& audioUrl, int reminderMins, int recurType, int recurInterval, const QString& endDateTime);
0065     // Deprecated: Create a display alarm showing a file's contents.
0066     Q_SCRIPTABLE bool scheduleFile(const QString& url, const QString& startDateTime, int lateCancel, unsigned flags, const QString& bgColor,
0067                                    const QString& audioUrl, int reminderMins, const QString& recurrence,
0068                                    int subRepeatInterval, int subRepeatCount);
0069     Q_SCRIPTABLE bool scheduleFile(const QString& url, const QString& startDateTime, int lateCancel, unsigned flags, const QString& bgColor,
0070                                    const QString& audioUrl, int reminderMins, int recurType, int recurInterval, int recurCount);
0071     Q_SCRIPTABLE bool scheduleFile(const QString& url, const QString& startDateTime, int lateCancel, unsigned flags, const QString& bgColor,
0072                                    const QString& audioUrl, int reminderMins, int recurType, int recurInterval, const QString& endDateTime);
0073
0074     // Create a command alarm.
0075     Q_SCRIPTABLE bool scheduleCommand(const QString& name, const QString& commandLine, const QString& startDateTime, int lateCancel, unsigned flags,
0076                                       const QString& recurrence, int subRepeatInterval, int subRepeatCount);
0077     Q_SCRIPTABLE bool scheduleCommand(const QString& name, const QString& commandLine, const QString& startDateTime, int lateCancel, unsigned flags,
0078                                       int recurType, int recurInterval, int recurCount);
0079     Q_SCRIPTABLE bool scheduleCommand(const QString& name, const QString& commandLine, const QString& startDateTime, int lateCancel, unsigned flags,
0080                                       int recurType, int recurInterval, const QString& endDateTime);
0081     // Deprecated: Create a command alarm.
0082     Q_SCRIPTABLE bool scheduleCommand(const QString& commandLine, const QString& startDateTime, int lateCancel, unsigned flags,
0083                                       const QString& recurrence, int subRepeatInterval, int subRepeatCount);
0084     Q_SCRIPTABLE bool scheduleCommand(const QString& commandLine, const QString& startDateTime, int lateCancel, unsigned flags,
0085                                       int recurType, int recurInterval, int recurCount);
0086     Q_SCRIPTABLE bool scheduleCommand(const QString& commandLine, const QString& startDateTime, int lateCancel, unsigned flags,
0087                                       int recurType, int recurInterval, const QString& endDateTime);
0088
0089     // Create an email alarm.
0090     Q_SCRIPTABLE bool scheduleEmail(const QString& name, const QString& fromID, const QString& addresses, const QString& subject, const QString& message,
0091                                     const QString& attachments, const QString& startDateTime, int lateCancel, unsigned flags,
0092                                     const QString& recurrence, int subRepeatInterval, int subRepeatCount);
0093     Q_SCRIPTABLE bool scheduleEmail(const QString& name, const QString& fromID, const QString& addresses, const QString& subject, const QString& message,
0094                                     const QString& attachments, const QString& startDateTime, int lateCancel, unsigned flags,
0095                                     int recurType, int recurInterval, int recurCount);
0096     Q_SCRIPTABLE bool scheduleEmail(const QString& name, const QString& fromID, const QString& addresses, const QString& subject, const QString& message,
0097                                     const QString& attachments, const QString& startDateTime, int lateCancel, unsigned flags,
0098                                     int recurType, int recurInterval, const QString& endDateTime);
0099     // Deprecated: Create an email alarm.
0100     Q_SCRIPTABLE bool scheduleEmail(const QString& fromID, const QString& addresses, const QString& subject, const QString& message,
0101                                     const QString& attachments, const QString& startDateTime, int lateCancel, unsigned flags,
0102                                     const QString& recurrence, int subRepeatInterval, int subRepeatCount);
0103     Q_SCRIPTABLE bool scheduleEmail(const QString& fromID, const QString& addresses, const QString& subject, const QString& message,
0104                                     const QString& attachments, const QString& startDateTime, int lateCancel, unsigned flags,
0105                                     int recurType, int recurInterval, int recurCount);
0106     Q_SCRIPTABLE bool scheduleEmail(const QString& fromID, const QString& addresses, const QString& subject, const QString& message,
0107                                     const QString& attachments, const QString& startDateTime, int lateCancel, unsigned flags,
0108                                     int recurType, int recurInterval, const QString& endDateTime);
0109
0110     // Create an audio alarm.
0111     Q_SCRIPTABLE bool scheduleAudio(const QString& name, const QString& audioUrl, int volumePercent, const QString& startDateTime, int lateCancel,
0112                                     unsigned flags, const QString& recurrence, int subRepeatInterval, int subRepeatCount);
0113     Q_SCRIPTABLE bool scheduleAudio(const QString& name, const QString& audioUrl, int volumePercent, const QString& startDateTime, int lateCancel,
0114                                     unsigned flags, int recurType, int recurInterval, int recurCount);
0115     Q_SCRIPTABLE bool scheduleAudio(const QString& name, const QString& audioUrl, int volumePercent, const QString& startDateTime, int lateCancel,
0116                                     unsigned flags, int recurType, int recurInterval, const QString& endDateTime);
0117     // Deprecated: Create an audio alarm.
0118     Q_SCRIPTABLE bool scheduleAudio(const QString& audioUrl, int volumePercent, const QString& startDateTime, int lateCancel,
0119                                     unsigned flags, const QString& recurrence, int subRepeatInterval, int subRepeatCount);
0120     Q_SCRIPTABLE bool scheduleAudio(const QString& audioUrl, int volumePercent, const QString& startDateTime, int lateCancel,
0121                                     unsigned flags, int recurType, int recurInterval, int recurCount);
0122     Q_SCRIPTABLE bool scheduleAudio(const QString& audioUrl, int volumePercent, const QString& startDateTime, int lateCancel,
0123                                     unsigned flags, int recurType, int recurInterval, const QString& endDateTime);
0124
0125     // Edit an alarm.
0126     Q_SCRIPTABLE bool edit(const QString& eventID);
0127     Q_SCRIPTABLE bool editNew(int type);
0128     Q_SCRIPTABLE bool editNew(const QString& templateName);
0129
0130 private:
0131     static bool scheduleMessage(const QString& name, const QString& message, const KADateTime& start, int lateCancel, unsigned flags,
0132                                 const QString& bgColor, const QString& fgColor, const QString& fontStr,
0133                                 const QUrl& audioFile, int reminderMins, const KARecurrence&,
0134                                 const KCalendarCore::Duration& subRepeatDuration = KCalendarCore::Duration(0), int subRepeatCount = 0);
0135     static bool scheduleFile(const QString& name, const QUrl& file, const KADateTime& start, int lateCancel, unsigned flags, const QString& bgColor,
0136                              const QUrl& audioFile, int reminderMins, const KARecurrence&,
0137                              const KCalendarCore::Duration& subRepeatDuration = KCalendarCore::Duration(0), int subRepeatCount = 0);
0138     static bool scheduleCommand(const QString& name, const QString& commandLine, const KADateTime& start, int lateCancel, unsigned flags,
0139                                 const KARecurrence&, const KCalendarCore::Duration& subRepeatDuration = KCalendarCore::Duration(0), int subRepeatCount = 0);
0140     static bool scheduleEmail(const QString& name, const QString& fromID, const QString& addresses, const QString& subject, const QString& message,
0141                               const QString& attachments, const KADateTime& start, int lateCancel, unsigned flags,
0142                               const KARecurrence&, const KCalendarCore::Duration& subRepeatDuration = KCalendarCore::Duration(0), int subRepeatCount = 0);
0143     static bool scheduleAudio(const QString& name, const QString& audioUrl, int volumePercent, const KADateTime& start, int lateCancel, unsigned flags,
0144                               const KARecurrence&, const KCalendarCore::Duration& subRepeatDuration = KCalendarCore::Duration(0), int subRepeatCount = 0);
0145     static KADateTime convertDateTime(const QString& dateTime, const KADateTime& = KADateTime());
0146     static KAEvent::Flags convertStartFlags(const KADateTime& start, unsigned flags);
0147     static QColor    convertBgColour(const QString& bgColor);
0148     static bool      convertRecurrence(KADateTime& start, KARecurrence&, const QString& startDateTime, const QString& icalRecurrence, int subRepeatInterval, KCalendarCore::Duration& subRepeatDuration);
0149     static bool      convertRecurrence(KADateTime& start, KARecurrence&, const QString& startDateTime, int recurType, int recurInterval, int recurCount);
0150     static bool      convertRecurrence(KADateTime& start, KARecurrence&, const QString& startDateTime, int recurType, int recurInterval, const QString& endDateTime);
0151     static bool      convertRecurrence(KARecurrence&, const KADateTime& start, int recurType, int recurInterval, int recurCount, const KADateTime& end);
0152 };
0153
0154 // vim: et sw=4: