kde-playground/kdepim/incidenceeditor-ng/alarmpresets.h

78 lines
2.1 KiB
C
Raw Normal View History

/*
Copyright (c) 2010 Bertjan Broeksema <broeksema@kde.org>
Copyright (C) 2010 Klaralvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library 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 Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef INCIDENCEEDITOR_ALARMPRESETS_H
#define INCIDENCEEDITOR_ALARMPRESETS_H
#include <KCalCore/Alarm>
#include <QStringList>
namespace IncidenceEditorNG {
enum {
// Fallback in case config is invalid
DEFAULT_REMINDER_OFFSET = 15 // minutes
};
namespace AlarmPresets {
enum When {
BeforeStart,
BeforeEnd
};
/**
* Returns the available presets.
*/
QStringList availablePresets( When when = BeforeStart );
/**
* Returns a recurrence preset for given name. The name <em>must</em> be one
* of availablePresets().
*
* Note: The caller takes ownership over the pointer.
*/
KCalCore::Alarm::Ptr preset( When when, const QString &name );
/**
* Returns an Alarm configured accordingly to the default preset.
*
* Note: The caller takes ownership over the pointer.
*/
KCalCore::Alarm::Ptr defaultAlarm( When when );
/**
* Returns the index of the preset in availablePresets for the given recurrence,
* or -1 if no preset is equal to the given recurrence.
*/
int presetIndex( When when, const KCalCore::Alarm::Ptr &alarm );
/**
Returns the index of the default preset. ( Comes from KCalPrefs ).
*/
int defaultPresetIndex();
}
}
#endif // INCIDENCEEDITOR_ALARMPRESETS_H