Some minor interface updates

3 files changed, 16 insertions, 49 deletions

diff --git a/libopie2/opiepim/core/ocontactaccess.cpp b/libopie2/opiepim/core/ocontactaccess.cpp
index b5f358b..e8c0a45 100644
--- a/libopie2/opiepim/core/ocontactaccess.cpp
+++ b/libopie2/opiepim/core/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/libopie2/opiepim/core/ocontactaccess.h b/libopie2/opiepim/core/ocontactaccess.h
index 54f7f07..adc66cf 100644
--- a/libopie2/opiepim/core/ocontactaccess.h
+++ b/libopie2/opiepim/core/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/libopie2/opiepim/core/opimaccesstemplate.h b/libopie2/opiepim/core/opimaccesstemplate.h
index a0d8f63..3e1f393 100644
--- a/libopie2/opiepim/core/opimaccesstemplate.h
+++ b/libopie2/opiepim/core/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 */