Initial revision

1 files changed, 162 insertions, 0 deletions

diff --git a/kabc/plugins/file/resourcefile.h b/kabc/plugins/file/resourcefile.h
new file mode 100644
index 0000000..4522d78
--- a/dev/null
+++ b/kabc/plugins/file/resourcefile.h
@@ -0,0 +1,162 @@
+/*
+    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., 59 Temple Place - Suite 330,
+    Boston, MA 02111-1307, USA.
+*/
+
+/*
+Enhanced Version of the file for platform independent KDE tools.
+Copyright (c) 2004 Ulf Schenk
+
+$Id$
+*/
+
+
+#ifndef KABC_RESOURCEFILE_H
+#define KABC_RESOURCEFILE_H
+
+#include <kconfig.h>
+#include <kdirwatch.h>
+
+#include <sys/types.h>
+
+#include <resource.h>
+
+class QTimer;
+class FormatPlugin;
+
+namespace KABC {
+
+//US class FormatPlugin;
+class ResourceConfigWidget;
+
+/**
+  @internal
+*/
+class 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 @ref load().
+   */
+  virtual bool doOpen();
+
+  /**
+   * Closes the file again.
+   */
+  virtual void doClose();
+  
+  /**
+   * Requests a save ticket, that is used by @ref save()
+   */
+  virtual Ticket *requestSaveTicket();
+
+  /**
+   * Loads all addressees from file to the address book.
+   * Returns true if all addressees could be loaded otherwise false.
+   */
+  virtual bool load();
+
+  /**
+   * Saves all addresses from address book to file.
+   * Returns true if all addressees could be saved otherwise false.
+   *
+   * @param ticket  The ticket returned by @ref requestSaveTicket()
+   */
+  virtual bool save( 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 );
+
+  /**
+   * This method is called by an error handler if the application
+   * crashed
+   */
+  virtual void cleanUp();
+
+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;
+
+  QString mLockUniqueName;
+    
+  KDirWatch mDirWatch;
+};
+
+}
+
+#endif