1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*
This file is part of libkcal.
Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
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 KCAL_ICALFORMAT_H
#define KCAL_ICALFORMAT_H
#include <qstring.h>
#include "scheduler.h"
#include "calformat.h"
#include <kdepimmacros.h>
namespace KCal {
class ICalFormatImpl;
class FreeBusy;
/**
This class implements the iCalendar format. It provides methods for
loading/saving/converting iCalendar format data into the internal KOrganizer
representation as Calendar and Events.
@short iCalendar format implementation
*/
class LIBKCAL_EXPORT ICalFormat : public CalFormat
{
public:
ICalFormat();
virtual ~ICalFormat();
/**
Loads a calendar on disk in iCalendar format into calendar.
Returns true if successful, else returns false. Provides more error
information by exception().
@param calendar Calendar object to be filled.
@param fileName The name of the calendar file on disk.
*/
bool load( Calendar * calendar, const QString &fileName );
/**
Writes out the calendar to disk in iCalendar format. Returns true if
successful and false on error.
@param calendar The Calendar object to be written.
@param fileName The name of the calendar file on disk.
*/
bool save( Calendar * calendar, const QString &fileName );
/**
Parse string and populate calendar with that information.
*/
bool fromString( Calendar * calendar, const QString & );
/**
Parse string and return first ical component.
*/
Incidence *fromString( const QString & );
/**
Return calendar information as string.
*/
QString toString( Calendar * );
/**
Return incidence as full iCalendar formatted text.
*/
QString toICalString( Incidence * );
/**
Return incidence as iCalendar formatted text.
*/
QString toString( Incidence * );
/**
Return recurrence rule as iCalendar formatted text.
*/
QString toString( RecurrenceRule * );
/**
Parse string and fill recurrence object with
that information
*/
bool fromString ( RecurrenceRule *, const QString& );
/**
Create a scheduling message for event @p e using method @p m.
*/
QString createScheduleMessage(IncidenceBase *e,Scheduler::Method m);
/**
Parse scheduling message provided as string @p s.
*/
ScheduleMessage *parseScheduleMessage( Calendar *, const QString &s);
/**
Parse FREEBUSY object.
*/
FreeBusy *parseFreeBusy( const QString & );
/**
Set id of used time zone and whether this time zone is UTC or not.
*/
void setTimeZone( const QString &id, bool utc );
/**
Return id string of timezone used.
*/
QString timeZoneId() const;
/**
Return true if timezone used is UTC, otherwise return false.
*/
bool utc() const;
protected:
/**
Parse string and return first ical component of a raw byte array of
a utf8 encoded string. This is an overload used for efficiency reading
to avoid utf8 conversions, which are expensive, when reading from disk.
*/
bool fromRawString( Calendar * calendar, const QCString & );
void setImplementation( ICalFormatImpl *impl );
private:
ICalFormatImpl *mImpl;
QString mTimeZoneId;
bool mUtc;
class Private;
Private *d;
};
}
#endif
|
