diff options
Diffstat (limited to 'kresources/scalix/kabc/resourcescalix.h')
| -rw-r--r-- | kresources/scalix/kabc/resourcescalix.h | 170 |
1 files changed, 170 insertions, 0 deletions
diff --git a/kresources/scalix/kabc/resourcescalix.h b/kresources/scalix/kabc/resourcescalix.h new file mode 100644 index 000000000..10d3d8aa5 --- /dev/null +++ b/kresources/scalix/kabc/resourcescalix.h @@ -0,0 +1,170 @@ +/* + This file is part of the scalix resource - based on the kolab resource. + + Copyright (c) 2002 - 2004 Klarälvdalens Datakonsult AB + <info@klaralvdalens-datakonsult.se> + + 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. + + In addition, as a special exception, the copyright holders give + permission to link the code of this program with any edition of + the Qt library by Trolltech AS, Norway (or with modified versions + of Qt that use the same license as Qt), and distribute linked + combinations including the two. You must obey the GNU General + Public License in all respects for all of the code used other than + Qt. If you modify this file, you may extend this exception to + your version of the file, but you are not obligated to do so. If + you do not wish to do so, delete this exception statement from + your version. +*/ + +#ifndef KABC_RESOURCESCALIX_H +#define KABC_RESOURCESCALIX_H + +#include <libkdepim/resourceabc.h> +#include <dcopobject.h> +#include "../shared/resourcescalixbase.h" +#include "../shared/subresource.h" +#include <kmail/kmailicalIface.h> +#include <kdepimmacros.h> + +namespace KABC { + + class FormatPlugin; + +/** + * This class implements a KAddressBook resource that keeps its + * addresses in an Scalix folder in KMail (or other conforming email + * clients). + */ +class KDE_EXPORT ResourceScalix : public KPIM::ResourceABC, + public Scalix::ResourceScalixBase +{ + Q_OBJECT + +public: + /** + * Constructor + */ + ResourceScalix( const KConfig* ); + + /** + * Destructor. + */ + virtual ~ResourceScalix(); + + /** + * Open the contacts list + */ + virtual bool doOpen(); + + /** + * Request a ticket, you have to pass through save() to + * allow locking. + */ + virtual Ticket *requestSaveTicket(); + + /** + Releases the ticket previousely requested with requestSaveTicket(). + The resource has to remove its locks in this function. + */ + virtual void releaseSaveTicket( Ticket* ); + + /** + * Load all addressees to the addressbook + */ + virtual bool load(); + + /** + * Save all addressees to the addressbook. + * + * @param ticket The ticket you get by requestSaveTicket() + */ + virtual bool save( Ticket *ticket ); + + /** + Insert an addressee into the resource. + */ + virtual void insertAddressee( const Addressee& ); + + /** + * Removes a addressee from resource. This method is mainly + * used by record-based resources like LDAP or SQL. + */ + virtual void removeAddressee( const Addressee& addr ); + + // Listen to KMail changes in the amount of sub resources + void fromKMailAddSubresource( const QString& type, const QString& id, + const QString& label, bool writable ); + void fromKMailDelSubresource( const QString& type, const QString& id ); + + bool fromKMailAddIncidence( const QString& type, const QString& resource, + Q_UINT32 sernum, int format, const QString& contact ); + void fromKMailDelIncidence( const QString& type, const QString& resource, + const QString& contact ); + void fromKMailRefresh( const QString& type, const QString& resource ); + + void fromKMailAsyncLoadResult( const QMap<Q_UINT32, QString>& map, + const QString& type, + const QString& folder ); + + /// Return the list of subresources. + QStringList subresources() const; + + /// Is this subresource active? + bool subresourceActive( const QString& ) const; + /// Is this subresource writabel? + bool subresourceWritable( const QString& ) const; + + virtual void setSubresourceActive( const QString &, bool ); + + /// Completion weight for a given subresource + virtual int subresourceCompletionWeight( const QString& ) const; + + /// Label for a given subresource + virtual QString subresourceLabel( const QString& ) const; + + /// Set completion weight for a given subresource + virtual void setSubresourceCompletionWeight( const QString&, int ); + + /// Give the uidmap. Used for ordered searching + QMap<QString, QString> uidToResourceMap() const; + +protected: + bool kmailUpdateAddressee( const Addressee& ); + + void doClose(); + + void loadSubResourceConfig( KConfig& config, const QString& name, + const QString& label, bool writable ); + bool loadSubResource( const QString& subResource ); + bool loadSubResourceHelper( const QString& subResource, const char* mimetype, KMailICalIface::StorageFormat format ); + QString loadContact( const QString& contactData, const QString& subResource, + Q_UINT32 sernum, const KMailICalIface::StorageFormat format ); + + QString configFile() const { + return Scalix::ResourceScalixBase::configFile( "kabc" ); + } + + // The list of subresources + Scalix::ResourceMap mSubResources; + QString mCachedSubresource; + bool mLocked; +}; + +} + +#endif // KABC_RESOURCESCALIX_H |