Some minor interface updates

7 files changed, 37 insertions, 73 deletions

diff --git a/libopie/pim/DESIGN b/libopie/pim/DESIGN
index 4def7b9..bd92b1b 100644
--- a/libopie/pim/DESIGN
+++ b/libopie/pim/DESIGN
@@ -29,34 +29,28 @@ resource.
 
 Both things need to be implemented for different kind of records. 
 By using templates we can make sure we share code and the reason
 not to use simple inheretance is that we can specialise quite easy.
 
 For example we have OTodoAccess : public OPimAccessTemplate<OTodo>;
 the we would do
 OTodoAccess::List list = otodoAccess.all();
 OTodoAccess::List::Iterator it;
 for( it = list.begin(); it != list.end(); ++it );
 
 
 as you can see from here it just behaves like you expect from Qt or STL.
 
 The kewlest thing is that List and List::Iterator is free to use if you
 want to implement your own OPimAccessTemplate.
 You just have to sub class  it and voila you're done
 
 
 Hope you enjoy using OPIE PIM
 
 regards Holger 'zecke' Freyther
 
 
-Comment by Stefan Eilers:
-
-The opimaccesstemplate defines "SortOrder":
-I think sortorder is the wrong name for the meaning of it and
-it should be defined by the childs of opimaccesstemplate (every 
-implementation may use different values for this..)
 
 
 
 
diff --git a/libopie/pim/ocontactaccess.cpp b/libopie/pim/ocontactaccess.cpp
index b5f358b..e8c0a45 100644
--- a/libopie/pim/ocontactaccess.cpp
+++ b/libopie/pim/ocontactaccess.cpp
@@ -1,93 +1,95 @@
 /*
  * Class to manage the Contacts.
  *
  * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de)
  *
  * =====================================================================
  *	This program 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.
  * =====================================================================
  * Info: This class could just work with a change in the header-file
  *       of the Contact class ! Therefore our libopie only compiles
  *       with our version of libqpe
  * =====================================================================
  * ToDo: XML-Backend: Automatic reload if something was changed...
  *
  *
  * =====================================================================
  * Version: $Id$
  * =====================================================================
  * History:
  * $Log$
+ * Revision 1.4  2002/10/14 16:21:54  eilers
+ * Some minor interface updates
+ *
  * Revision 1.3  2002/10/07 17:34:24  eilers
  * added OBackendFactory for advanced backend access
  *
  * Revision 1.2  2002/10/02 16:18:11  eilers
  * debugged and seems to work almost perfectly ..
  *
  * Revision 1.1  2002/09/27 17:11:44  eilers
  * Added API for accessing the Contact-Database ! It is compiling, but
  * please do not expect that anything is working !
  * I will debug that stuff in the next time ..
  * Please read README_COMPILE for compiling !
  *
  *
  */
 
 #include "ocontactaccess.h"
 #include "obackendfactory.h"
 
 #include <qasciidict.h>
 #include <qdatetime.h>
 #include <qfile.h>
 #include <qregexp.h>
 #include <qlist.h>
 #include <qcopchannel_qws.h>
 
 //#include <qpe/qcopenvelope_qws.h>
 #include <qpe/global.h>
 
 #include <errno.h>
 #include <fcntl.h>
 #include <unistd.h>
 #include <stdlib.h>
 
 #include "ocontactaccessbackend_xml.h"
 
 
 OContactAccess::OContactAccess ( const QString appname, const QString ,
 			 OContactAccessBackend* end, bool autosync ):
 	OPimAccessTemplate<OContact>( end ),
 	m_changed ( false )
 {
         /* take care of the backend. If there is no one defined, we 
 	 * will use the XML-Backend as default (until we have a cute SQL-Backend..).
 	 */
         if( end == 0 ) {
-		// __asm__("int3");
 		qWarning ("Using BackendFactory !");
 		end = OBackendFactory<OContactAccessBackend>::Default( "contact", appname );
         }
 	// Set backend locally and in template
         m_backEnd = end;
 	OPimAccessTemplate<OContact>::setBackEnd (end);
 	
 
 	/* Connect signal of external db change to function */
 	QCopChannel *dbchannel = new QCopChannel( "QPE/PIM", this );
 	connect( dbchannel, SIGNAL(received(const QCString &, const QByteArray &)),
                this, SLOT(copMessage( const QCString &, const QByteArray &)) );
 	if ( autosync ){
 		QCopChannel *syncchannel = new QCopChannel( "QPE/Sync", this );
 		connect( syncchannel, SIGNAL(received(const QCString &, const QByteArray &)),
 			 this, SLOT(copMessage( const QCString &, const QByteArray &)) );
 	}
 
 
 }
 OContactAccess::~OContactAccess ()
 {
 	/* The user may forget to save the changed database, therefore try to
 	 * do it for him..
diff --git a/libopie/pim/ocontactaccess.h b/libopie/pim/ocontactaccess.h
index 54f7f07..adc66cf 100644
--- a/libopie/pim/ocontactaccess.h
+++ b/libopie/pim/ocontactaccess.h
@@ -1,134 +1,105 @@
 /*
  * Class to manage the Contacts.
  *
  * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de)
  * Copyright (c) 2002 by Holger Freyther (zecke@handhelds.org)
  *
  * =====================================================================
  *	This program 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.
  * =====================================================================
  * ToDo: Define enum for query settings
  * =====================================================================
  * Version: $Id$
  * =====================================================================
  * History:
  * $Log$
+ * Revision 1.2  2002/10/14 16:21:54  eilers
+ * Some minor interface updates
+ *
  * Revision 1.1  2002/09/27 17:11:44  eilers
  * Added API for accessing the Contact-Database ! It is compiling, but
  * please do not expect that anything is working !
  * I will debug that stuff in the next time ..
  * Please read README_COMPILE for compiling !
  *
  * =====================================================================
  */
 #ifndef _OCONTACTACCESS_H
 #define _OCONTACTACCESS_H
 
 #include <qobject.h>
 
 #include <qpe/qcopenvelope_qws.h>
 
 #include <qvaluelist.h>
 #include <qfileinfo.h>
 
 #include "ocontact.h"
 #include "ocontactaccessbackend.h"
 #include "opimaccesstemplate.h"
 
 /** Class to access the contacts database.
  * This is just a frontend for the real database handling which is
  * done by the backend.
  */
 class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
 {
     Q_OBJECT
 
-	    
-	    /*    class Iterator{
-	    friend OContactAccess;
-    public:
-	    Iterator();
-	    Iterator ( const Iterator& copy );
-
-	    bool operator== ( const Iterator& it );
-	    bool operator!= ( const Iterator& it );
-	    Iterator& operator= ( const  Iterator& it );
-	    Iterator& operator++ ();      // prefix
-	    Iterator operator++ ( int );  // postfix
-	    Iterator& operator-- ();      // prefix
-	    Iterator operator-- ( int );  // postfix
-	    Contact operator*() const;
-	    Contact operator->() const;
-
-	    Iterator begin();
-	    Iterator end();
-
-	    uint count() const;
-
-    private:
-	    QValueList<int> m_uids;
-	    int m_cur_position;
-	    bool m_end_reached;
-	    OContactAccess *m_db;
-	    
-    };
-
-	    */
-
  public:
 	/** Create Database with contacts (addressbook).
 	 * @param appname Name of application which wants access to the database
 	 * (i.e. "todolist")
 	 * @param filename The name of the database file. If not set, the default one
 	 * is used.
 	 * @param backend Pointer to an alternative Backend. If not set, we will use
 	 * the default backend.
 	 * @param handlesync If <b>true</b> the database stores the current state
 	 * automatically if it receives the signals <i>flush()</i> and <i>reload()</i>
 	 * which are used before and after synchronisation. If the application wants
 	 * to react itself, it should be disabled by setting it to <b>false</b>
-	 * @see OContactBackend
+	 * @see OContactAccessBackend
 	 */
 	OContactAccess (const QString appname, const QString filename = 0l,
                     OContactAccessBackend* backend = 0l, bool handlesync = true);
 	~OContactAccess ();
 
 	/** Constants for query.
 	 * Use this constants to set the query parameters.
 	 * Note: <i>query_IgnoreCase</i> just make sense with one of the other attributes !
 	 * @see queryByExample()
-	 * - why not enum - zecke? 
-	 *   -> Had some implementation problems .. Will use enum soon ! .. (se)
 	 */
-        static const int query_WildCards  = 0x0001;
-	static const int query_IgnoreCase = 0x0002;
-	static const int query_RegExp     = 0x0004;
-	static const int query_ExactMatch = 0x0008;
+	enum QuerySettings {
+		WildCards  = 0x0001,
+		IgnoreCase = 0x0002,
+		RegExp     = 0x0004,
+		ExactMatch = 0x0008,
+	};
 
 	/** Return all possible settings.
 	 *  @return All settings provided by the current backend
 	 * (i.e.: query_WildCards & query_IgnoreCase)
 	 */
 	const uint querySettings();
 
 	/** Check whether settings are correct.
 	 * @return <i>true</i> if the given settings are correct and possible.
 	 */
 	bool hasQuerySettings ( int querySettings ) const;
 
 	/** Add Contact to database.
 	 * @param newcontact The contact to add.
 	 * @return <i>true</i> if added successfully.
 	 */
 	bool add (const OContact& newcontact);
 
 	/** Replace contact.
 	 * Replaces given contact with contact with the user id <i>uid</i>.
 	 * @param uid The user ID
 	 * @param contact The new contact
 	 * @return <i>true</i> if successful.
 	 */
diff --git a/libopie/pim/ocontactaccessbackend_xml.h b/libopie/pim/ocontactaccessbackend_xml.h
index 97ef40f..50ea329 100644
--- a/libopie/pim/ocontactaccessbackend_xml.h
+++ b/libopie/pim/ocontactaccessbackend_xml.h
@@ -1,43 +1,46 @@
 /*
  * XML Backend for the OPIE-Contact Database.
  *
  * Copyright (c) 2002 by Stefan Eilers (Eilers.Stefan@epost.de)
  *
  * =====================================================================
  *	This program 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.
  * =====================================================================
  * ToDo: XML-Backend: Automatic reload if something was changed...
  *
  *
  * =====================================================================
  * Version: $Id$
  * =====================================================================
  * History:
  * $Log$
+ * Revision 1.3  2002/10/14 16:21:54  eilers
+ * Some minor interface updates
+ *
  * Revision 1.2  2002/10/07 17:34:24  eilers
  * added OBackendFactory for advanced backend access
  *
  * Revision 1.1  2002/09/27 17:11:44  eilers
  * Added API for accessing the Contact-Database ! It is compiling, but
  * please do not expect that anything is working !
  * I will debug that stuff in the next time ..
  * Please read README_COMPILE for compiling !
  *
  *
  */
 
 #ifndef _OContactAccessBackend_XML_
 #define _OContactAccessBackend_XML_
 
 #include <qasciidict.h>
 #include <qdatetime.h>
 #include <qfile.h>
 #include <qfileinfo.h>
 #include <qregexp.h>
 #include <qarray.h>
 
 #include <qpe/global.h>
 
@@ -178,110 +181,110 @@ class OContactAccessBackend_XML : public OContactAccessBackend {
 					break;
 				}
 			}
 			if ( found ){
 				foundContact = *it;
 			}
 			
 			return ( foundContact );
 		}
 	
 	QArray<int> queryByExample ( const OContact &query, int settings ){
 		
 		QArray<int> m_currentQuery( m_contactList.count() );
 		QValueListConstIterator<OContact> it;
 		uint arraycounter = 0;
 		
 		for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
 			/* Search all fields and compare them with query object. Store them into list
 			 * if all fields matches.
 			 */
 			bool allcorrect = true;
 			for ( int i = 0; i < Qtopia::rid; i++ ) {
 				/* Just compare fields which are not empty in the query object */
 				if ( !query.field(i).isEmpty() ){
-					switch ( settings & ~OContactAccess::query_IgnoreCase ){
-					case OContactAccess::query_RegExp:{
+					switch ( settings & ~OContactAccess::IgnoreCase ){
+					case OContactAccess::RegExp:{
 						QRegExp expr ( query.field(i),
-							       !(settings & OContactAccess::query_IgnoreCase),
+							       !(settings & OContactAccess::IgnoreCase),
 							       false );
 						if ( expr.find ( (*it).field(i), 0 ) == -1 )
 							allcorrect = false;
 					}
 						break;
-					case OContactAccess::query_WildCards:{
+					case OContactAccess::WildCards:{
 						QRegExp expr ( query.field(i),
-							       !(settings & OContactAccess::query_IgnoreCase),
+							       !(settings & OContactAccess::IgnoreCase),
 							       true );
 						if ( expr.find ( (*it).field(i), 0 ) == -1 )
 							allcorrect = false;
 					}
 						break;
-					case OContactAccess::query_ExactMatch:{
-						if (settings & OContactAccess::query_IgnoreCase){
+					case OContactAccess::ExactMatch:{
+						if (settings & OContactAccess::IgnoreCase){
 							if ( query.field(i).upper() !=
 							     (*it).field(i).upper() )
 								allcorrect = false;
 						}else{
 							if ( query.field(i) != (*it).field(i) )
 								allcorrect = false;
 						}
 					}
 						break;
 					}
 				}
 			}
 			if ( allcorrect ){
 				m_currentQuery[arraycounter++] = (*it).uid();
 			}
 		}
 			
 		// Shrink to fit..
 		m_currentQuery.resize(arraycounter);
 	
 		return m_currentQuery;
 	}
 	
 	const uint querySettings()
 		{
-			return ( OContactAccess::query_WildCards
-				 & OContactAccess::query_IgnoreCase
-				 & OContactAccess::query_RegExp
-				 & OContactAccess::query_ExactMatch );
+			return ( OContactAccess::WildCards
+				 & OContactAccess::IgnoreCase
+				 & OContactAccess::RegExp
+				 & OContactAccess::ExactMatch );
 		}
 	
 	bool hasQuerySettings (uint querySettings) const
 		{
-			/* OContactAccess::query_IgnoreCase may be added with one
+			/* OContactAccess::IgnoreCase may be added with one
 			 * of the other settings, but never used alone.
 			 * The other settings are just valid alone...
 			 */
-			switch ( querySettings & ~OContactAccess::query_IgnoreCase ){
-			case OContactAccess::query_RegExp:
+			switch ( querySettings & ~OContactAccess::IgnoreCase ){
+			case OContactAccess::RegExp:
 				return ( true );
-			case OContactAccess::query_WildCards:
+			case OContactAccess::WildCards:
 				return ( true );
-			case OContactAccess::query_ExactMatch:
+			case OContactAccess::ExactMatch:
 				return ( true );
 			default:
 				return ( false );
 			}
 		}
 	
 	bool add ( const OContact &newcontact )
 		{
 			//qWarning("odefaultbackend: ACTION::ADD");
 			updateJournal (newcontact, OContact::ACTION_ADD);
 			addContact_p( newcontact );
 			return true;
 		}
 	
 	bool replace ( const OContact &contact )
 		{
 			bool found = false;
 			
 			QValueListIterator<OContact> it;
 			for( it = m_contactList.begin(); it != m_contactList.end(); ++it ){
 				if ( (*it).uid() == contact.uid() ){
 					found = true;
 					break;
 				}
diff --git a/libopie/pim/opimaccesstemplate.h b/libopie/pim/opimaccesstemplate.h
index a0d8f63..3e1f393 100644
--- a/libopie/pim/opimaccesstemplate.h
+++ b/libopie/pim/opimaccesstemplate.h
@@ -6,90 +6,84 @@
 #include <opie/opimrecord.h>
 #include <opie/opimaccessbackend.h>
 #include <opie/orecordlist.h>
 
 #include "opimcache.h"
 #include "otemplatebase.h"
 
 /**
  * Thats the frontend to our OPIE PIM
  * Library. Either you want to use it's
  * interface or you want to implement
  * your own Access lib
  * Just create a OPimRecord and inherit from
  * the plugins
  */
 
 template <class T = OPimRecord >
 class OPimAccessTemplate : public OTemplateBase<T> {
 public:
     typedef ORecordList<T> List;
     typedef OPimAccessBackend<T> BackEnd;
     typedef OPimCache<T> Cache;
 
     /**
-     * our sort order
-     * should be safe explaining
-     */
-    enum SortOrder { WildCards = 0, IgnoreCase = 1,
-                     RegExp = 2, ExactMatch = 4 };
-
-    /**
      * c'tor BackEnd
      */
     OPimAccessTemplate( BackEnd* end);
     virtual ~OPimAccessTemplate();
 
     /**
      * load from the backend
      */
     virtual bool load();
 
     /**
      * reload from the backend
      */
     virtual bool reload();
 
     /**
      * save to the backend
      */
     virtual bool save();
 
     /**
      * if the resource was changed externally
      */
     bool wasChangedExternally()const;
 
     /**
      * return a List of records
      * you can iterate over them
      */
     virtual List allRecords()const;
 
     /**
-     * queryByExample
+     * queryByExample)
+     * @see otodoaccess, ocontactaccess
      */
-    virtual List queryByExample( const T& t, int sortOrder );
+    virtual List queryByExample( const T& t, int querySettings );
 
     /**
      * find the OPimRecord uid
      */
     virtual T find( int uid )const;
 
     /**
      * read ahead cache find method ;)
      */
     virtual T find( int uid, const QArray<int>&,
                     uint current, CacheDirection dir = Forward )const;
 
     /* invalidate cache here */
     /**
      * clears the backend and invalidates the backend
      */
     virtual void clear() ;
 
     /**
      * add T to the backend
      */
     virtual bool add( const T& t ) ;
 
     /* only the uid matters */
diff --git a/libopie/pim/otodoaccessxml.cpp b/libopie/pim/otodoaccessxml.cpp
index f3b0783..3b4cab2 100644
--- a/libopie/pim/otodoaccessxml.cpp
+++ b/libopie/pim/otodoaccessxml.cpp
@@ -166,49 +166,49 @@ bool OTodoAccessXML::save() {
         return false;
     }
     /* flush before renaming */
     f.close();
 
     if( ::rename( strNewFile.latin1(),  m_file.latin1() ) < 0 ) {
 //        qWarning("error renaming");
         QFile::remove( strNewFile );
     }
 
     m_changed = false;
     return true;
 }
 QArray<int> OTodoAccessXML::allRecords()const {
     QArray<int> ids( m_events.count() );
     QMap<int, OTodo>::ConstIterator it;
     int i = 0;
 
     for ( it = m_events.begin(); it != m_events.end(); ++it ) {
         ids[i] = it.key();
         i++;
     }
     return ids;
 }
-QArray<int> OTodoAccessXML::queryByExample( const OTodo&, int sort ) {
+QArray<int> OTodoAccessXML::queryByExample( const OTodo&, int ) {
     QArray<int> ids(0);
     return ids;
 }
 OTodo OTodoAccessXML::find( int uid )const {
     OTodo todo;
     todo.setUid( 0 ); // isEmpty()
     QMap<int, OTodo>::ConstIterator it = m_events.find( uid );
     if ( it != m_events.end() )
         todo = it.data();
 
     return todo;
 }
 void OTodoAccessXML::clear() {
     if (m_opened )
         m_changed = true;
 
     m_events.clear();
 }
 bool OTodoAccessXML::add( const OTodo& todo ) {
 //    qWarning("add");
     m_changed = true;
     m_events.insert( todo.uid(), todo );
 
     return true;
diff --git a/libopie/pim/otodoaccessxml.h b/libopie/pim/otodoaccessxml.h
index 1e7e371..dc41c32 100644
--- a/libopie/pim/otodoaccessxml.h
+++ b/libopie/pim/otodoaccessxml.h
@@ -3,49 +3,49 @@
 
 #include <qasciidict.h>
 #include <qmap.h>
 
 #include "otodoaccessbackend.h"
 
 namespace Opie {
     class XMLElement;
 };
 
 class OTodoAccessXML : public OTodoAccessBackend {
 public:
     /**
      * fileName if Empty we will use the default path
      */
     OTodoAccessXML( const QString& appName,
                     const QString& fileName = QString::null );
     ~OTodoAccessXML();
 
     bool load();
     bool reload();
     bool save();
 
     QArray<int> allRecords()const;
-    QArray<int> queryByExample( const OTodo&, int sort );
+    QArray<int> queryByExample( const OTodo&, int querysettings );
     OTodo find( int uid )const;
     void clear();
     bool add( const OTodo& );
     bool remove( int uid );
     bool replace( const OTodo& );
 
     /* our functions */
     QArray<int> effectiveToDos( const QDate& start,
                                 const QDate& end,
                                 bool includeNoDates );
     QArray<int> overDue();
     QArray<int> sorted( bool asc,  int sortOrder,
                         int sortFilter, int cat );
 private:
     void todo( QAsciiDict<int>*, OTodo&,const QCString&,const QString& );
     QString toString( const OTodo& )const;
     QString toString( const QArray<int>& ints ) const;
     QMap<int, OTodo> m_events;
     QString m_file;
     QString m_app;
     bool m_opened : 1;
     bool m_changed : 1;
     class OTodoAccessXMLPrivate;
     OTodoAccessXMLPrivate* d;