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
|
/*
This file is part of the kcalcore library.
Copyright (c) 2002,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.
*/
/**
@file
This file is part of the API for handling calendar data and
defines the CalStorage abstract base class.
@author Cornelius Schumacher \<schumacher@kde.org\>
*/
#ifndef KCALCORE_CALSTORAGE_H
#define KCALCORE_CALSTORAGE_H
#include "kcalcore_export.h"
#include "calendar.h"
#include <QtCore/QObject>
namespace KCalCore {
/**
@brief
An abstract base class that provides a calendar storage interface.
This is the base class for calendar storage. It provides an interface for the
loading and saving of calendars.
*/
class KCALCORE_EXPORT CalStorage : public QObject
{
Q_OBJECT
public:
/**
Construcst a new storage object for a calendar.
@param calendar is a pointer to a valid Calendar object.
*/
explicit CalStorage( const Calendar::Ptr &calendar );
/**
Destuctor.
*/
virtual ~CalStorage();
/**
Returns a pointer to the calendar whose storage is being managed.
*/
Calendar::Ptr calendar() const;
/**
Opens the calendar for storage.
@return true if the open was successful; false otherwise.
*/
virtual bool open() = 0;
/**
Loads the calendar into memory.
@return true if the load was successful; false otherwise.
*/
virtual bool load() = 0;
/**
Saves the calendar.
@return true if the save was successful; false otherwise.
*/
virtual bool save() = 0;
/**
Closes the calendar storage.
@return true if the close was successful; false otherwise.
*/
virtual bool close() = 0;
private:
//@cond PRIVATE
Q_DISABLE_COPY( CalStorage )
class Private;
Private *const d;
//@endcond
};
}
#endif
|