kalarmiface.h

Go to the documentation of this file.

/*
 *  kalarmiface.h  -  DCOP interface to KAlarm
 *  Program:  kalarm
 *  Copyright © 2004-2006,2008 by David Jarvie <djarvie@kde.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
#ifndef KALARMIFACE_H
#define KALARMIFACE_H
 
// No forward declarations - dcopidl2cpp won't work
#include <dcopobject.h>
#include <kurl.h>
#include <tqstringlist.h>
class TQString;
 
class KAlarmIface : virtual public DCOPObject
{
    K_DCOP
    public:
    enum Flags
    {
        REPEAT_AT_LOGIN = 0x01,    // repeat alarm at every login
        BEEP            = 0x02,    // sound audible beep when alarm is displayed
        REPEAT_SOUND    = 0x08,    // repeat sound file while alarm is displayed
        CONFIRM_ACK     = 0x04,    // closing the alarm message window requires confirmation prompt
        AUTO_CLOSE      = 0x10,    // auto-close alarm window after late-cancel period
        EMAIL_BCC       = 0x20,    // blind copy the email to the user
        DISABLED        = 0x40,    // alarm is currently disabled
        SCRIPT          = 0x80,    // command is a script, not a shell command line
        EXEC_IN_XTERM   = 0x100,   // execute command alarm in terminal window
        SPEAK           = 0x200,   // speak the alarm message when it is displayed
        SHOW_IN_KORG    = 0x400    // show the alarm as an event in KOrganizer
    };
    enum RecurType
    {
        MINUTELY = 1,    // the repeat interval is measured in minutes
        DAILY    = 2,    // the repeat interval is measured in days
        WEEKLY   = 3,    // the repeat interval is measured in weeks
        MONTHLY  = 4,    // the repeat interval is measured in months
        YEARLY   = 5     // the repeat interval is measured in years
    };
 
    k_dcop:
    virtual bool cancelEvent(const TQString& url, const TQString& eventId) = 0;
 
    virtual bool triggerEvent(const TQString& url, const TQString& eventId) = 0;
 
    virtual bool scheduleMessage(const TQString& message, const TQString& startDateTime, int lateCancel, unsigned flags,
                                 const TQString& bgColor, const TQString& fgColor, const TQString& font,
                                 const KURL& audioFile, int reminderMins, const TQString& recurrence,
                                 int repeatInterval, int repeatCount) = 0;
    virtual bool scheduleMessage(const TQString& message, const TQString& startDateTime, int lateCancel, unsigned flags,
                                 const TQString& bgColor, const TQString& fgColor, const TQString& font,
                                 const KURL& audioFile, int reminderMins,
                                 int repeatType, int repeatInterval, int repeatCount) = 0;
    virtual bool scheduleMessage(const TQString& message, const TQString& startDateTime, int lateCancel, unsigned flags,
                                 const TQString& bgColor, const TQString& fgColor, const TQString& font,
                                 const KURL& audioFile, int reminderMins,
                                 int repeatType, int repeatInterval, const TQString& endDateTime) = 0;
    
    virtual bool scheduleFile(const KURL& file, const TQString& startDateTime, int lateCancel, unsigned flags, const TQString& bgColor,
                              const KURL& audioFile, int reminderMins, const TQString& recurrence,
                              int repeatInterval, int repeatCount) = 0;
    virtual bool scheduleFile(const KURL& file, const TQString& startDateTime, int lateCancel, unsigned flags, const TQString& bgColor,
                              const KURL& audioFile, int reminderMins, int repeatType, int repeatInterval, int repeatCount) = 0;
    virtual bool scheduleFile(const KURL& file, const TQString& startDateTime, int lateCancel, unsigned flags, const TQString& bgColor,
                              const KURL& audioFile, int reminderMins,
                              int repeatType, int repeatInterval, const TQString& endDateTime) = 0;
    
    virtual bool scheduleCommand(const TQString& commandLine, const TQString& startDateTime, int lateCancel, unsigned flags,
                                 const TQString& recurrence, int repeatInterval, int repeatCount) = 0;
    virtual bool scheduleCommand(const TQString& commandLine, const TQString& startDateTime, int lateCancel, unsigned flags,
                                 int repeatType, int repeatInterval, int repeatCount) = 0;
    virtual bool scheduleCommand(const TQString& commandLine, const TQString& startDateTime, int lateCancel, unsigned flags,
                                 int repeatType, int repeatInterval, const TQString& endDateTime) = 0;
 
    virtual bool scheduleEmail(const TQString& fromID, const TQString& addresses, const TQString& subject, const TQString& message,
                               const TQString& attachments, const TQString& startDateTime, int lateCancel, unsigned flags,
                               const TQString& recurrence, int repeatInterval, int repeatCount) = 0;
    virtual bool scheduleEmail(const TQString& fromID, const TQString& addresses, const TQString& subject, const TQString& message,
                               const TQString& attachments, const TQString& startDateTime, int lateCancel, unsigned flags,
                               int repeatType, int repeatInterval, int repeatCount) = 0;
    virtual bool scheduleEmail(const TQString& fromID, const TQString& addresses, const TQString& subject, const TQString& message,
                               const TQString& attachments, const TQString& startDateTime, int lateCancel, unsigned flags,
                               int repeatType, int repeatInterval, const TQString& endDateTime) = 0;
    virtual bool edit(const TQString& eventID) = 0;
    virtual bool editNew(const TQString& templateName) = 0;
};
 
#endif // KALARMIFACE_H