libopie PIM API Documentation
	Overview Class Hierarchy Classes Classes (annotated) Members Source Files Todo

ocontactaccess.h

Go to the documentation of this file.

/*
 * 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: ocontactaccess.h,v 1.10 2003/12/22 10:19:26 eilers Exp $
 * =====================================================================
 * History:
 * $Log: ocontactaccess.h,v $
 * Revision 1.10  2003/12/22 10:19:26  eilers
 * Finishing implementation of sql-backend for datebook. But I have to
 * port the PIM datebook application to use it, before I could debug the
 * whole stuff.
 * Thus, PIM-Database backend is finished, but highly experimental. And some
 * parts are still generic. For instance, the "queryByExample()" methods are
 * not (or not fully) implemented. Todo: custom-entries not stored.
 * The big show stopper: matchRegExp() (needed by OpieSearch) needs regular
 * expression search in the database, which is not supported by sqlite !
 * Therefore we need either an extended sqlite or a workaround which would
 * be very slow and memory consuming..
 *
 * Revision 1.9  2003/08/01 12:30:16  eilers
 * Merging changes from BRANCH_1_0 to HEAD
 *
 * Revision 1.8.2.1  2003/06/30 14:34:19  eilers
 * Patches from Zecke:
 * Fixing and cleaning up extraMap handling
 * Adding d_ptr for binary compatibility in the future
 *
 * Revision 1.8  2003/05/08 13:55:09  tille
 * search stuff
 * and match, toRichText & toShortText in oevent
 *
 * Revision 1.7  2003/04/13 18:07:10  zecke
 * More API doc
 * QString -> const QString&
 * QString = 0l -> QString::null
 *
 * Revision 1.6  2003/01/02 14:27:12  eilers
 * Improved query by example: Search by date is possible.. First step
 * for a today plugin for birthdays..
 *
 * Revision 1.5  2002/11/13 14:14:51  eilers
 * Added sorted for Contacts..
 *
 * Revision 1.4  2002/11/01 15:10:42  eilers
 * Added regExp-search in database for all fields in a contact.
 *
 * Revision 1.3  2002/10/16 10:52:40  eilers
 * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
 *
 * 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 OContactAccess: public QObject, public OPimAccessTemplate<OContact>
{
    Q_OBJECT

 public:
    OContactAccess (const QString appname, const QString filename = 0l,
                    OContactAccessBackend* backend = 0l, bool handlesync = true);
    ~OContactAccess ();

    enum QuerySettings {
        WildCards  = 0x0001,
        IgnoreCase = 0x0002,
        RegExp     = 0x0004,
        ExactMatch = 0x0008,
        MatchOne   = 0x0010, // Only one Entry must match
        DateDiff   = 0x0020, // Find all entries from today until given date
        DateYear   = 0x0040, // The year matches
        DateMonth  = 0x0080, // The month matches
        DateDay    = 0x0100, // The day matches
    };


    List sorted( bool ascending, int sortOrder, int sortFilter, int cat ) const;

    const uint querySettings();

    bool hasQuerySettings ( int querySettings ) const;

    bool wasChangedExternally()const;


    bool save();

 signals:
    /* Signal is emitted if the database was changed. Therefore
     * we may need to reload to stay consistent.
     * @param which Pointer to the database who created this event. This pointer
     * is useful if an application has to handle multiple databases at the same time.
     * @see reload()
     */
    void signalChanged ( const OContactAccess *which );


 private:
    // class OContactAccessPrivate;
    // OContactAccessPrivate* d;
        OContactAccessBackend *m_backEnd;
        bool m_loading:1;

 private slots:
    void copMessage( const QCString &msg, const QByteArray &data );

 private:
        class Private;
    Private *d;

};
#endif

This file is part of the documentation for OPIE Version 1.1.

Documentation copyright © 1997-2003 the KDE developers. 2003 OPIE developers
Generated on Tue Feb 10 20:25:19 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001