opimrecord.h

Go to the documentation of this file.

/*
                             This file is part of the Opie Project
                             Copyright (C) The Main Author <main-author@whereever.org>
              =.             Copyright (C) The Opie Team <opie-devel@handhelds.org>
            .=l.
           .>+-=
 _;:,     .>    :=|.         This program is free software; you can
.> <`_,   >  .   <=          redistribute it and/or  modify it under
:`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
.="- .-=="i,     .._         License as published by the Free Software
 - .   .-<_>     .<>         Foundation; either version 2 of the License,
     ._= =}       :          or (at your option) any later version.
    .%`+i>       _;_.
    .i_,=:_.      -<s.       This program 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.
*/

#ifndef OPIMRECORD_H
#define OPIMRECORD_H

/* OPIE */
#include <opie2/opimxrefmanager.h>
#include <opie2/opimglobal.h>

/*
 * we need to get customMap which is private...
 */
#define private protected
#include <qpe/palmtoprecord.h>
#undef private

/* QT */
#include <qdatastream.h>
#include <qmap.h>
#include <qstring.h>
#include <qstringlist.h>

namespace Opie
{
class OPimRecord : public Qtopia::Record
{
  public:
    OPimRecord( UID uid = 0 );
    ~OPimRecord();

    OPimRecord( const OPimRecord& rec );

    OPimRecord &operator=( const OPimRecord& );

    QStringList categoryNames( const QString& appname ) const;

    void setCategoryNames( const QStringList& );

    void addCategoryName( const QString& );

    virtual bool isEmpty() const;

    virtual QString toRichText() const = 0;

    virtual QString toShortText() const = 0;

    virtual QString type() const = 0;

    virtual bool match( const QString &regexp ) const
    {
        setLastHitField( -1 );
        return Qtopia::Record::match( QRegExp( regexp ) );
    };

    int lastHitField() const;

    virtual QMap<int, QString> toMap() const = 0;
    // virtual fromMap( const <int, QString>& map ) = 0; // Should be added in the future (eilers)

    QMap<QString, QString> toExtraMap() const;
    void setExtraMap( const QMap<QString, QString>& );


    virtual QString           recordField( int )    const = 0;
//    virtual QArray<int>       recordAttributes()const = 0;
//    virtual QMap<int,QString> recordAttributesTranslated() const = 0;
//    QString                   recordAttributeTranslated(int field)const;

    OPimXRefManager& xrefmanager();

    virtual void setUid( int uid );

    /*
     * used inside the Templates for casting
     * REIMPLEMENT in your ....
     */
    virtual int rtti() const;

    virtual bool loadFromStream( QDataStream& );
    virtual bool saveToStream( QDataStream& stream ) const;

  protected:
    // need to be const cause it is called from const methods
    mutable int m_lastHit;
    void setLastHitField( int lastHit ) const;
    Qtopia::UidGen &uidGen();
    //    QString crossToString()const;

  private:
    class OPimRecordPrivate;
    OPimRecordPrivate *d;
    OPimXRefManager m_xrefman;
    static Qtopia::UidGen m_uidGen;

  private:
    void flush( const OPimXRefPartner&, QDataStream& stream ) const;
    OPimXRefPartner partner( QDataStream& );
};

}

#endif

---