kalarm/kalarmiface.h

   1 /*
   2  *  kalarmiface.h  -  D-Bus interface to KAlarm
   3  *  Program:  kalarm
   4  *  Copyright © 2004-2009 by David Jarvie <djarvie@kde.org>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License along
  17  *  with this program; if not, write to the Free Software Foundation, Inc.,
  18  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef KALARMIFACE_H
  22 #define KALARMIFACE_H
  23
  24 /** @file kalarmiface.h - D-Bus interface to KAlarm */
  25
  26 /** KAlarmIface provides a D-Bus interface for other applications to request
  27  *  KAlarm actions.
  28  */
  29
  30 class KAlarmIface
  31 {
  32     public:
  33         /** Bit values for the @p flags parameter of "scheduleXxxx()" D-Bus calls.
  34          *  The bit values may be OR'ed together.
  35          *  @li REPEAT_AT_LOGIN - repeat the alarm at every login.
  36          *  @li BEEP            - sound an audible beep when the alarm is displayed.
  37          *  @li SPEAK           - speak the alarm message when it is displayed.
  38          *  @li REPEAT_SOUND    - repeat the sound file while the alarm is displayed.
  39          *  @li CONFIRM_ACK     - closing the alarm message window requires a confirmation prompt.
  40          *  @li AUTO_CLOSE      - auto-close the alarm window after the late-cancel period.
  41          *  @li DISPLAY_COMMAND - display command output in the alarm window.
  42          *  @li SCRIPT          - the command to execute is a script, not a shell command line.
  43          *  @li EXEC_IN_XTERM   - execute the command alarm in a terminal window.
  44          *  @li EMAIL_BCC       - send a blind copy the email to the user.
  45          *  @li SHOW_IN_KORG    - show the alarm as an event in KOrganizer
  46          *  @li EXCL_HOLIDAYS   - do not trigger the alarm on holidays
  47          *  @li WORK_TIME_ONLY  - do not trigger the alarm outside working hours (or on holidays)
  48          *  @li DISABLED        - set the alarm status to disabled.
  49          */
  50         enum Flags
  51         {
  52             REPEAT_AT_LOGIN = 0x01,    // repeat alarm at every login
  53             BEEP            = 0x02,    // sound audible beep when alarm is displayed
  54             REPEAT_SOUND    = 0x08,    // repeat sound file while alarm is displayed
  55             CONFIRM_ACK     = 0x04,    // closing the alarm message window requires confirmation prompt
  56             AUTO_CLOSE      = 0x10,    // auto-close alarm window after late-cancel period
  57             EMAIL_BCC       = 0x20,    // blind copy the email to the user
  58             DISABLED        = 0x40,    // alarm is currently disabled
  59             SCRIPT          = 0x80,    // command is a script, not a shell command line
  60             EXEC_IN_XTERM   = 0x100,   // execute command alarm in terminal window
  61             SPEAK           = 0x200,   // speak the alarm message when it is displayed
  62             SHOW_IN_KORG    = 0x400,   // show the alarm as an event in KOrganizer
  63             DISPLAY_COMMAND = 0x800,   // display command output in alarm window
  64             EXCL_HOLIDAYS   = 0x1000,  // don't trigger alarm on holidays
  65             WORK_TIME_ONLY  = 0x2000   // trigger only during working hours
  66         };
  67         /** Values for the @p repeatType parameter of "scheduleXxxx()" D-Bus calls.
  68          *  @li MINUTELY - the repeat interval is measured in minutes.
  69          *  @li DAILY    - the repeat interval is measured in days.
  70          *  @li WEEKLY   - the repeat interval is measured in weeks.
  71          *  @li MONTHLY  - the repeat interval is measured in months.
  72          *  @li YEARLY   - the repeat interval is measured in years.
  73          */
  74         enum RecurType
  75         {
  76             MINUTELY = 1,    // the repeat interval is measured in minutes
  77             DAILY    = 2,    // the repeat interval is measured in days
  78             WEEKLY   = 3,    // the repeat interval is measured in weeks
  79             MONTHLY  = 4,    // the repeat interval is measured in months
  80             YEARLY   = 5     // the repeat interval is measured in years
  81         };
  82         /** Values for the @p type parameter of "editNew()" D-Bus call.
  83          *  @li DISPLAY - create a display alarm.
  84          *  @li COMMAND - create a command alarm.
  85          *  @li EMAIL   - create an email alarm.
  86          */
  87         enum AlarmType
  88         {
  89             DISPLAY = 1,    // display alarm
  90             COMMAND = 2,    // command alarm
  91             EMAIL   = 3,    // email alarm
  92             AUDIO   = 4     // audio alarm
  93         };
  94 };
  95
  96 #endif // KALARMIFACE_H
  97
  98 // vim: et sw=4: