KCalendarCore

xcalformat.h
1/*
2 SPDX-FileCopyrightText: 2024 Volker Krause <vkrause@kde.org>
3 SPDX-License-Identifier: LGPL-2.0-or-later
4*/
5
6#ifndef KCALCORE_XCALFORMAT_H
7#define KCALCORE_XCALFORMAT_H
8
9#include "calformat.h"
10
11namespace KCalendarCore
12{
13
14class XCalFormatPrivate;
15
16/** Read support for xCal events.
17 *
18 * This is currently only exposed via the KCalendarCore::FileStorage API.
19 *
20 * Supported variants:
21 * * RFC 6321 (https://datatracker.ietf.org/doc/html/rfc6321)
22 * * The pre-standardized draft version (https://datatracker.ietf.org/doc/html/draft-royer-calsch-xcal-03) used by Pretalx
23 *
24 * @since 6.6
25 */
26class XCalFormat : public CalFormat
27{
28public:
29 explicit XCalFormat();
30 ~XCalFormat() override;
31
32 /**
33 @copydoc
34 CalFormat::load()
35 */
36 bool load(const Calendar::Ptr &calendar, const QString &fileName) override;
37
38 /** Does nothing. */
39 bool save(const Calendar::Ptr &calendar, const QString &fileName) override;
40
41 /**
42 @copydoc
43 CalFormat::fromRawString()
44 */
45 bool fromRawString(const Calendar::Ptr &calendar, const QByteArray &string) override;
46
47 /** Does nothing. */
48 [[nodiscard]] QString toString(const Calendar::Ptr &calendar) override;
49
50private:
51 //@cond PRIVATE
52 Q_DECLARE_PRIVATE(XCalFormat)
53 //@endcond
54};
55
56}
57
58#endif
This file is part of the API for handling calendar data and defines the CalFormat abstract base class...
An abstract base class that provides an interface to various calendar formats.
Definition calformat.h:39
Read support for xCal events.
Definition xcalformat.h:27
bool load(const Calendar::Ptr &calendar, const QString &fileName) override
bool fromRawString(const Calendar::Ptr &calendar, const QByteArray &string) override
QString toString(const Calendar::Ptr &calendar) override
Does nothing.
bool save(const Calendar::Ptr &calendar, const QString &fileName) override
Does nothing.
Namespace for all KCalendarCore types.
Definition alarm.h:37
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 4 2024 12:01:42 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.