Incidenceeditor

alarmpresets.h
1/*
2 SPDX-FileCopyrightText: 2010 Bertjan Broeksema <broeksema@kde.org>
3 SPDX-FileCopyrightText: 2010 Klaralvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>
4
5 SPDX-License-Identifier: LGPL-2.0-or-later
6*/
7
8#pragma once
9
10#include <KCalendarCore/Alarm>
11
12#include <QStringList>
13
14namespace IncidenceEditorNG
15{
16enum {
17 // Fallback in case config is invalid
18 DEFAULT_REMINDER_OFFSET = 15 // minutes
19};
20
21namespace AlarmPresets
22{
23enum When { BeforeStart, BeforeEnd };
24
25/**
26 * Returns the available presets.
27 */
28[[nodiscard]] QStringList availablePresets(When when = BeforeStart);
29
30/**
31 * Returns a recurrence preset for given name. The name <em>must</em> be one
32 * of availablePresets().
33 *
34 * Note: The caller takes ownership over the pointer.
35 */
36[[nodiscard]] KCalendarCore::Alarm::Ptr preset(When when, const QString &name);
37
38/**
39 * Returns an Alarm configured accordingly to the default preset.
40 *
41 * Note: The caller takes ownership over the pointer.
42 */
43[[nodiscard]] KCalendarCore::Alarm::Ptr defaultAlarm(When when);
44
45/**
46 * Returns the index of the preset in availablePresets for the given recurrence,
47 * or -1 if no preset is equal to the given recurrence.
48 */
49[[nodiscard]] int presetIndex(When when, const KCalendarCore::Alarm::Ptr &alarm);
50
51/**
52 Returns the index of the default preset. ( Comes from KCalPrefs ).
53 */
54[[nodiscard]] int defaultPresetIndex();
55}
56}
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:19:37 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.