• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KCalCore Library

  • kcalcore
icalformat.h
Go to the documentation of this file.
1/*
2 This file is part of the kcalcore library.
3
4 Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library 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 GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
28#ifndef KCALCORE_ICALFORMAT_H
29#define KCALCORE_ICALFORMAT_H
30
31#include "incidence.h"
32#include "freebusy.h"
33#include "kcalcore_export.h"
34#include "calformat.h"
35#include "schedulemessage.h"
36
37#include <KDE/KDateTime>
38
39namespace KCalCore {
40
41class FreeBusy;
42class Incidence;
43class IncidenceBase;
44class RecurrenceRule;
45
58class KCALCORE_EXPORT ICalFormat : public CalFormat
59{
60public:
64 ICalFormat();
65
69 virtual ~ICalFormat();
70
75 bool load(const Calendar::Ptr &calendar, const QString &fileName);
76
81 bool save(const Calendar::Ptr &calendar, const QString &fileName);
82
89 bool fromString(const Calendar::Ptr &calendar, const QString &string,
90 bool deleted = false, const QString &notebook = QString());
91
100 Incidence::Ptr fromString(const QString &string);
101
109 bool fromString(RecurrenceRule *rule, const QString &string);
110
115 bool fromRawString(const Calendar::Ptr &calendar, const QByteArray &string,
116 bool deleted = false, const QString &notebook = QString());
117
122 QString toString(const Calendar::Ptr &calendar,
123 const QString &notebook = QString(), bool deleted = false);
124
132 QString toString(const Incidence::Ptr &incidence);
133
142 QByteArray toRawString(const Incidence::Ptr &incidence);
143
151 QString toString(RecurrenceRule *rule);
152
160 QString toICalString(const Incidence::Ptr &incidence);
161
170 QString createScheduleMessage(const IncidenceBase::Ptr &incidence,
171 iTIPMethod method);
172
183 ScheduleMessage::Ptr parseScheduleMessage(const Calendar::Ptr &calendar,
184 const QString &string);
185
194 FreeBusy::Ptr parseFreeBusy(const QString &string);
195
201 void setTimeSpec(const KDateTime::Spec &timeSpec);
202
207 KDateTime::Spec timeSpec() const;
208
213 QString timeZoneId() const;
214
215protected:
220 virtual void virtual_hook(int id, void *data);
221
222private:
223 //@cond PRIVATE
224 Q_DISABLE_COPY(ICalFormat)
225 class Private;
226 Private *const d;
227 //@endcond
228};
229
230}
231
232#endif
calformat.h
This file is part of the API for handling calendar data and defines the CalFormat abstract base class...
KCalCore::CalFormat::CalFormat
CalFormat()
Constructs a new Calendar Format object.
Definition calformat.cpp:68
KCalCore::Calendar::Ptr
QSharedPointer< Calendar > Ptr
A shared pointer to a Calendar.
Definition calendar.h:138
KCalCore::FreeBusy
Provides information about the free/busy time of a calendar.
Definition freebusy.h:53
KCalCore::FreeBusy::Ptr
QSharedPointer< FreeBusy > Ptr
A shared pointer to a FreeBusy object.
Definition freebusy.h:64
KCalCore::ICalFormat::timeSpec
KDateTime::Spec timeSpec() const
Returns the iCalendar time specification.
Definition icalformat.cpp:625
KCalCore::ICalFormat::parseFreeBusy
FreeBusy::Ptr parseFreeBusy(const QString &string)
Converts a QString into a FreeBusy object.
Definition icalformat.cpp:416
KCalCore::ICalFormat::setTimeSpec
void setTimeSpec(const KDateTime::Spec &timeSpec)
Sets the iCalendar time specification (time zone, etc.).
Definition icalformat.cpp:620
KCalCore::ICalFormat::createScheduleMessage
QString createScheduleMessage(const IncidenceBase::Ptr &incidence, iTIPMethod method)
Creates a scheduling message string for an Incidence.
Definition icalformat.cpp:367
KCalCore::ICalFormat::virtual_hook
virtual void virtual_hook(int id, void *data)
Definition icalformat.cpp:636
KCalCore::ICalFormat::fromString
bool fromString(const Calendar::Ptr &calendar, const QString &string, bool deleted=false, const QString &notebook=QString())
Definition icalformat.cpp:142
KCalCore::ICalFormat::toICalString
QString toICalString(const Incidence::Ptr &incidence)
Converts an Incidence to iCalendar formatted text.
Definition icalformat.cpp:296
KCalCore::ICalFormat::toRawString
QByteArray toRawString(const Incidence::Ptr &incidence)
Converts an Incidence to a QByteArray.
Definition icalformat.cpp:308
KCalCore::ICalFormat::save
bool save(const Calendar::Ptr &calendar, const QString &fileName)
Definition icalformat.cpp:104
KCalCore::ICalFormat::load
bool load(const Calendar::Ptr &calendar, const QString &fileName)
Definition icalformat.cpp:79
KCalCore::ICalFormat::timeZoneId
QString timeZoneId() const
Returns the timezone id string used by the iCalendar; an empty string if the iCalendar does not have ...
Definition icalformat.cpp:630
KCalCore::ICalFormat::parseScheduleMessage
ScheduleMessage::Ptr parseScheduleMessage(const Calendar::Ptr &calendar, const QString &string)
Parses a Calendar scheduling message string into ScheduleMessage object.
Definition icalformat.cpp:450
KCalCore::ICalFormat::ICalFormat
ICalFormat()
Constructor a new iCalendar Format object.
Definition icalformat.cpp:68
KCalCore::ICalFormat::toString
QString toString(const Calendar::Ptr &calendar, const QString &notebook=QString(), bool deleted=false)
Definition icalformat.cpp:213
KCalCore::ICalFormat::fromRawString
bool fromRawString(const Calendar::Ptr &calendar, const QByteArray &string, bool deleted=false, const QString &notebook=QString())
Definition icalformat.cpp:148
KCalCore::IncidenceBase
An abstract class that provides a common base for all calendar incidence classes.
Definition incidencebase.h:110
KCalCore::IncidenceBase::Ptr
QSharedPointer< IncidenceBase > Ptr
A shared pointer to an IncidenceBase.
Definition incidencebase.h:115
KCalCore::Incidence
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition incidence.h:70
KCalCore::Incidence::Ptr
QSharedPointer< Incidence > Ptr
A shared pointer to an Incidence.
Definition incidence.h:112
KCalCore::RecurrenceRule
This class represents a recurrence rule for a calendar incidence.
Definition recurrencerule.h:44
KCalCore::ScheduleMessage::Ptr
QSharedPointer< ScheduleMessage > Ptr
A shared pointer to a ScheduleMessage.
Definition schedulemessage.h:72
freebusy.h
This file is part of the API for handling calendar data and defines the FreeBusy class.
incidence.h
This file is part of the API for handling calendar data and defines the Incidence class.
KCalCore
TODO: KDE5:
Definition alarm.h:47
KCalCore::iTIPMethod
iTIPMethod
iTIP methods.
Definition schedulemessage.h:35
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalCore Library

Skip menu "KCalCore Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal