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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
|
/*
This file is part of libkabc.
Copyright (c) 2001 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 KABC_RESOURCE_H
#define KABC_RESOURCE_H
#include <kresources/resource.h>
#include "addressbook.h"
#include "plugin.h"
namespace KABC {
/**
* @short Helper class for handling coordinated save of address books.
*
* This class is used as helper class for saving address book.
* @see requestSaveTicket(), save().
*/
class KABC_EXPORT Ticket
{
friend class Resource;
public:
~Ticket();
Resource *resource();
private:
Ticket( Resource *resource );
Resource *mResource;
};
/**
* @internal
*/
class KABC_EXPORT Resource : public KRES::Resource
{
Q_OBJECT
public:
/**
@short Resource Iterator
This class provides an iterator for resource entries.
By default it points to a QValueList<Addressee>::Iterator,
but you can reimplement this class to fit your own needs.
*/
class KABC_EXPORT Iterator
{
public:
Iterator();
Iterator( const Iterator & );
virtual ~Iterator();
virtual Iterator &operator=( const Iterator & );
virtual const Addressee &operator*() const;
virtual Addressee &operator*();
virtual Iterator &operator++();
virtual Iterator &operator++( int );
virtual Iterator &operator--();
virtual Iterator &operator--( int );
virtual bool operator==( const Iterator &it );
virtual bool operator!=( const Iterator &it );
struct IteratorData;
IteratorData *d;
};
/**
@short Resource Const Iterator
This class provides a const iterator for resource entries.
*/
class KABC_EXPORT ConstIterator
{
public:
ConstIterator();
ConstIterator( const ConstIterator & );
ConstIterator( const Iterator & );
virtual ~ConstIterator();
virtual ConstIterator &operator=( const ConstIterator & );
virtual const Addressee &operator*() const ;
virtual ConstIterator &operator++();
virtual ConstIterator &operator++( int );
virtual ConstIterator &operator--();
virtual ConstIterator &operator--( int );
virtual bool operator==( const ConstIterator &it );
virtual bool operator!=( const ConstIterator &it );
struct ConstIteratorData;
ConstIteratorData *d;
};
/**
Constructor.
@param config The config object where the derived classes can
read out their settings.
*/
Resource( const KConfig *config );
/**
Destructor.
*/
virtual ~Resource();
/**
Returns an iterator pointing to the first addressee in the resource.
This iterator equals end() if the resource is empty.
*/
virtual ConstIterator begin() const;
/**
This is an overloaded member function, provided for convenience. It
behaves essentially like the above function.
*/
virtual Iterator begin();
/**
Returns an iterator pointing to the last addressee in the resource.
This iterator equals begin() if the resource is empty.
*/
virtual ConstIterator end() const;
/**
This is an overloaded member function, provided for convenience. It
behaves essentially like the above function.
*/
virtual Iterator end();
/**
Returns a pointer to the addressbook.
*/
AddressBook *addressBook();
/**
Writes the resource specific config to file.
*/
virtual void writeConfig( KConfig *config );
/**
Request a ticket, you have to pass through save() to
allow locking. The resource has to create its locks
in this function.
*/
virtual Ticket *requestSaveTicket() = 0;
/**
Releases the ticket previousely requested with requestSaveTicket().
The resource has to remove its locks in this function.
This function is also responsible for deleting the ticket.
*/
virtual void releaseSaveTicket( Ticket* ) = 0;
/**
Loads all addressees synchronously.
@returns Whether the loading was successfully.
*/
virtual bool load() = 0;
/**
Loads all addressees asyncronously. You have to make sure that either
the loadingFinished() or loadingError() signal is emitted from within
this function.
The default implementation simply calls the synchronous load.
@return Whether the synchronous part of loading was successfully.
*/
virtual bool asyncLoad();
/**
Insert an addressee into the resource.
*/
virtual void insertAddressee( const Addressee& );
/**
Removes an addressee from resource.
*/
virtual void removeAddressee( const Addressee& addr );
/**
Saves all addressees synchronously.
@param ticket You have to release the ticket later with
releaseSaveTicket() explicitely.
@return Whether the saving was successfully.
*/
virtual bool save( Ticket *ticket ) = 0;
/**
Saves all addressees asynchronously. You have to make sure that either
the savingFinished() or savingError() signal is emitted from within
this function.
The default implementation simply calls the synchronous save.
@param ticket You have to release the ticket later with
releaseSaveTicket() explicitely.
@return Whether the saving was successfully.
*/
virtual bool asyncSave( Ticket *ticket );
/**
Searches an addressee with the specified unique identifier.
@param uid The unique identifier you are looking for.
@return The addressee with the specified unique identifier or an
empty addressee.
*/
virtual Addressee findByUid( const QString &uid );
/**
Searches all addressees which match the specified name.
@param name The name you are looking for.
@return A list of all matching addressees.
*/
virtual Addressee::List findByName( const QString &name );
/**
Searches all addressees which match the specified email address.
@param email The email address you are looking for.
@return A list of all matching addressees.
*/
virtual Addressee::List findByEmail( const QString &email );
/**
Searches all addressees which belongs to the specified category.
@param category The category you are looking for.
@return A list of all matching addressees.
*/
virtual Addressee::List findByCategory( const QString &category );
/**
Removes all addressees from the resource.
*/
virtual void clear();
/**
@internal
Sets the address book of the resource.
*/
void setAddressBook( AddressBook* );
signals:
/**
This signal is emitted when the resource has finished the loading of all
addressees from the backend to the internal cache.
@param resource The pointer to the resource which emitted this signal.
*/
void loadingFinished( Resource *resource );
/**
This signal is emitted when an error occured during loading the
addressees from the backend to the internal cache.
@param resource The pointer to the resource which emitted this signal.
@param msg A translated error message.
*/
void loadingError( Resource *resource, const QString &msg );
/**
This signal is emitted when the resource has finished the saving of all
addressees from the internal cache to the backend.
@param resource The pointer to the resource which emitted this signal.
*/
void savingFinished( Resource *resource );
/**
This signal is emitted when an error occured during saving the
addressees from the internal cache to the backend.
@param resource The pointer to the resource which emitted this signal.
@param msg A translated error message.
*/
void savingError( Resource *resource, const QString &msg );
protected:
Ticket *createTicket( Resource * );
Addressee::Map mAddrMap;
private:
AddressBook *mAddressBook;
class ResourcePrivate;
ResourcePrivate *d;
};
}
#endif
|