mboxentry.h

/*
    Copyright (c) 2010 Tobias Koenig <tokoe@kde.org>

    This library 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.

    This library 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., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef KMBOX_MBOXENTRY_H
#define KMBOX_MBOXENTRY_H

#include "kmbox_export.h"

#include <QtCore/QList>
#include <QtCore/QMetaType>
#include <QtCore/QPair>
#include <QtCore/QSharedDataPointer>

namespace KMBox {

class KMBOX_EXPORT MBoxEntry
{
  public:
    typedef QList<MBoxEntry> List;

    typedef QPair<MBoxEntry, MBoxEntry> Pair;

    MBoxEntry();

    explicit MBoxEntry( quint64 offset );

    MBoxEntry( const MBoxEntry &other );

    ~MBoxEntry();

    MBoxEntry &operator=( const MBoxEntry &other );

    bool operator==( const MBoxEntry &other ) const;

    bool operator!=( const MBoxEntry &other ) const;

    bool isValid() const;

    quint64 messageOffset() const;

    quint64 messageSize() const;

    quint64 separatorSize() const;

  private:
    //@cond PRIVATE
    friend class MBox;

    class Private;
    QSharedDataPointer<Private> d;
    //@endcond
};

}

Q_DECLARE_TYPEINFO( KMBox::MBoxEntry, Q_MOVABLE_TYPE );

#endif // KMBOX_MBOXENTRY_H