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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
This file is part of libkabc.
Copyright (c) 2001 Cornelius Schumacher <[email protected]>
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 KABC_RESOURCEFILE_H
#define KABC_RESOURCEFILE_H
#include <kconfig.h>
#include <kdirwatch.h>
#include <sys/types.h>
#include <kabc/resource.h>
namespace KABC {
class FormatPlugin;
class ResourceConfigWidget;
class Lock;
/**
This resource allows access to a local file.
*/
class KABC_EXPORT ResourceFile : public Resource
{
Q_OBJECT
public:
/**
Constructor.
@param cfg The config object where custom resource settings are stored.
*/
ResourceFile( const KConfig *cfg );
/**
Construct file resource on file @arg fileName using format @arg formatName.
*/
ResourceFile( const QString &fileName, const QString &formatName = "vcard" );
/**
Destructor.
*/
~ResourceFile();
/**
Writes the config back.
*/
virtual void writeConfig( KConfig *cfg );
/**
Tries to open the file and checks for the proper format.
This method should be called before load().
*/
virtual bool doOpen();
/**
Closes the file again.
*/
virtual void doClose();
/**
Requests a save ticket, that is used by save()
*/
virtual Ticket *requestSaveTicket();
virtual void releaseSaveTicket( Ticket* );
/**
Loads all addressees from file to the address book.
Returns true if all addressees could be loaded otherwise false.
*/
virtual bool load();
virtual bool asyncLoad();
/**
Saves all addresses from address book to file.
Returns true if all addressees could be saved otherwise false.
@param ticket The ticket returned by requestSaveTicket()
*/
virtual bool save( Ticket *ticket );
virtual bool asyncSave( Ticket *ticket );
/**
Set name of file to be used for saving.
*/
void setFileName( const QString & );
/**
Return name of file used for loading and saving the address book.
*/
QString fileName() const;
/**
Sets a new format by name.
*/
void setFormat( const QString &name );
/**
Returns the format name.
*/
QString format() const;
/**
Remove a addressee from its source.
This method is mainly called by KABC::AddressBook.
*/
virtual void removeAddressee( const Addressee& addr );
private slots:
void emitLoadingFinished();
void emitLoadingError();
void emitSavingFinished();
void emitSavingError();
protected slots:
void fileChanged();
protected:
void init( const QString &fileName, const QString &format );
bool lock( const QString &fileName );
void unlock( const QString &fileName );
private:
QString mFileName;
QString mFormatName;
FormatPlugin *mFormat;
Lock *mLock;
KDirWatch mDirWatch;
bool mAsynchronous;
class ResourceFilePrivate;
ResourceFilePrivate *d;
};
}
#endif
|
