From 6f610544d3db6198c90105b70fab1cc84f5a1fbd Mon Sep 17 00:00:00 2001
From: zecke <zecke>
Date: Sun, 13 Apr 2003 18:07:10 +0000
Subject: More API doc

QString -> const QString&
QString = 0l -> QString::null
---
(limited to 'libopie2/opiepim/backend/ocontactaccessbackend.h')

diff --git a/libopie2/opiepim/backend/ocontactaccessbackend.h b/libopie2/opiepim/backend/ocontactaccessbackend.h
index 821f5bf..ebeb42d 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend.h
+++ b/libopie2/opiepim/backend/ocontactaccessbackend.h
@@ -19,6 +19,11 @@
  * =====================================================================
  * History:
  * $Log$
+ * Revision 1.5  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.4  2002/11/13 14:14:51  eilers
  * Added sorted for Contacts..
  *
@@ -44,15 +49,26 @@
 #include "ocontact.h"
 #include "opimaccessbackend.h"
 
-#include "qregexp.h"
+#include <qregexp.h>
 
+/**
+ * This class represents the interface of all Contact Backends.
+ * Derivates of this class will be used to access the contacts.
+ * As implementation currently XML and vCard exist. This class needs to be implemented
+ * if you want to provide your own storage.
+ * In all queries a list of uids is passed on instead of loading the actual record!
+ *
+ * @see OContactAccessBackend_VCard
+ * @see OContactAccessBackend_XML
+ */
 class OContactAccessBackend: public OPimAccessBackend<OContact> {
  public:
 	OContactAccessBackend() {}
 	virtual ~OContactAccessBackend() {}
 
 
-	/** Return if database was changed externally.
+	/**
+         * Return if database was changed externally.
 	 * This may just make sense on file based databases like a XML-File.
 	 * It is used to prevent to overwrite the current database content
 	 * if the file was already changed by something else !
@@ -68,18 +84,24 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
 	virtual QArray<int> matchRegexp(  const QRegExp &r ) const = 0;
 
-	/** Return all possible settings.
+	/**
+         *  Return all possible settings.
 	 *  @return All settings provided by the current backend
 	 * (i.e.: query_WildCards & query_IgnoreCase)
 	 */
 	virtual const uint querySettings() = 0;
 
-	/** Check whether settings are correct.
+	/**
+         * Check whether settings are correct.
 	 * @return <i>true</i> if the given settings are correct and possible.
 	 */
 	virtual bool hasQuerySettings (uint querySettings) const = 0;
 
-	virtual QArray<int> sorted( bool ascending, int sortOrder, int sortFilter, int cat ) = 0;
+        /**
+         * FIXME!!!
+         * Returns a sorted list of records either ascendinf or descending for a giving criteria and category
+         */
+        virtual QArray<int> sorted( bool ascending, int sortOrder, int sortFilter, int cat ) = 0;
 
 };
 #endif
--
cgit v0.9.0.2