incidenceeditor-ng/alarmpresets.h

   1 /*
   2   Copyright (c) 2010 Bertjan Broeksema <broeksema@kde.org>
   3   Copyright (C) 2010 Klaralvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>
   4
   5   This library is free software; you can redistribute it and/or modify it
   6   under the terms of the GNU Library General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or (at your
   8   option) any later version.
   9
  10   This library is distributed in the hope that it will be useful, but WITHOUT
  11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  13   License for more details.
  14
  15   You should have received a copy of the GNU Library General Public License
  16   along with this library; see the file COPYING.LIB.  If not, write to the
  17   Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18   02110-1301, USA.
  19 */
  20
  21 #ifndef INCIDENCEEDITOR_ALARMPRESETS_H
  22 #define INCIDENCEEDITOR_ALARMPRESETS_H
  23
  24 #include <KCalCore/Alarm>
  25
  26 class QStringList;
  27
  28 namespace IncidenceEditorNG {
  29
  30 namespace AlarmPresets {
  31
  32   enum When {
  33     BeforeStart,
  34     BeforeEnd
  35   };
  36
  37   /**
  38    * Returns the available presets.
  39    */
  40   QStringList availablePresets( When when = BeforeStart );
  41
  42   /**
  43    * Returns a recurrence preset for given name. The name <em>must</em> be one
  44    * of availablePresets().
  45    *
  46    * Note: The caller takes ownership over the pointer.
  47    */
  48   KCalCore::Alarm::Ptr preset( When when, const QString &name );
  49
  50   /**
  51    * Returns the index of the preset in availablePresets for the given recurrence,
  52    * or -1 if no preset is equal to the given recurrence.
  53    */
  54   int presetIndex( When when, const KCalCore::Alarm::Ptr &alarm );
  55
  56 }
  57
  58 }
  59
  60 #endif