messagestatus.h

/*  -*- mode: C++ -*-
    This file is part of Akonadi.
    Copyright (c) 2005 Andreas Gungl <a.gungl@gmx.de>
    Copyright (c) 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
    Copyright (c) 2010 Leo Franchi <lfranchi@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 AKONADI_KMIME_MESSAGESTATUS_H
#define AKONADI_KMIME_MESSAGESTATUS_H

#include <QtCore/QSet>

#include "akonadi-kmime_export.h"

class QString;

namespace Akonadi {

//---------------------------------------------------------------------------
class AKONADI_KMIME_EXPORT MessageStatus
{
  public:
    MessageStatus();

    MessageStatus &operator = ( const MessageStatus &other );

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

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

    bool operator & ( const MessageStatus &other ) const;

    void clear();

    void set( const MessageStatus &other );

    void toggle( const MessageStatus &other );

    /* ----- getters ----------------------------------------------------- */

    bool isOfUnknownStatus() const;

    bool isRead() const;

    bool isDeleted() const;

    bool isReplied() const;

    bool isForwarded() const;

    bool isQueued() const;

    bool isSent() const;

    bool isImportant() const;

    bool isWatched() const;

    bool isIgnored() const;

    bool isToAct() const;

    bool isSpam() const;

    bool isHam() const;

    bool hasAttachment() const;

    bool hasInvitation() const;

    bool isSigned() const;

    bool isEncrypted() const;

    bool hasError() const;

    /* ----- setters ----------------------------------------------------- */

    void setRead( bool read = true );

    void setDeleted( bool deleted = true );

    void setReplied( bool replied = true );

    void setForwarded( bool forwarded = true );

    void setQueued( bool queued = true );

    void setSent( bool sent = true );

    void setImportant( bool important = true );

    void setWatched( bool watched = true );

    void setIgnored( bool ignored = true );

    void setToAct( bool toAct = true );

    void setSpam( bool spam = true );

    void setHam( bool ham = true );

    void setHasAttachment( bool hasAttachment = true );

    void setHasInvitation( bool hasInvitation = true );

    void setSigned( bool value = true );

    void setEncrypted( bool value = true );

    void setHasError( bool value = true );

    /* ----- state representation  --------------------------------------- */

    qint32 toQInt32() const;

    void fromQInt32( qint32 status );

    QString statusStr() const;

    void setStatusFromStr( const QString &aStr );

    QSet<QByteArray> statusFlags() const;

    void setStatusFromFlags( const QSet<QByteArray> &flags );

    /* ----- static accessors to simple states --------------------------- */

    static const MessageStatus statusUnread();

    static const MessageStatus statusRead();

    static const MessageStatus statusDeleted();

    static const MessageStatus statusReplied();

    static const MessageStatus statusForwarded();

    static const MessageStatus statusQueued();

    static const MessageStatus statusSent();

    static const MessageStatus statusImportant();

    static const MessageStatus statusWatched();

    static const MessageStatus statusIgnored();

    static const MessageStatus statusToAct();

    static const MessageStatus statusSpam();

    static const MessageStatus statusHam();

    static const MessageStatus statusHasAttachment();

    static const MessageStatus statusHasInvitation();

    static const MessageStatus statusSigned();

    static const MessageStatus statusEncrypted();

    static const MessageStatus statusHasError();

  private:
    quint32 mStatus;
};

} // namespace Akonadi

#endif