messagestatus.h

/*  -*- mode: C++ -*-
    This file is part of Akonadi.
    SPDX-FileCopyrightText: 2005 Andreas Gungl <[email protected]>
    SPDX-FileCopyrightText: 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
    SPDX-FileCopyrightText: 2010 Leo Franchi <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef AKONADI_KMIME_MESSAGESTATUS_H
#define AKONADI_KMIME_MESSAGESTATUS_H

#include <QSet>

#include "akonadi-mime_export.h"

class QString;

namespace Akonadi {
//---------------------------------------------------------------------------
class AKONADI_MIME_EXPORT MessageStatus
{
public:
    MessageStatus();

    bool operator==(MessageStatus other) const;

    bool operator!=(MessageStatus other) const;

    bool operator&(MessageStatus other) const;

    void clear();

    void set(MessageStatus other);

    void toggle(MessageStatus other);

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

    Q_REQUIRED_RESULT bool isOfUnknownStatus() const;

    Q_REQUIRED_RESULT bool isRead() const;

    Q_REQUIRED_RESULT bool isDeleted() const;

    Q_REQUIRED_RESULT bool isReplied() const;

    Q_REQUIRED_RESULT bool isForwarded() const;

    Q_REQUIRED_RESULT bool isQueued() const;

    Q_REQUIRED_RESULT bool isSent() const;

    Q_REQUIRED_RESULT bool isImportant() const;

    Q_REQUIRED_RESULT bool isWatched() const;

    Q_REQUIRED_RESULT bool isIgnored() const;

    Q_REQUIRED_RESULT bool isToAct() const;

    Q_REQUIRED_RESULT bool isSpam() const;

    Q_REQUIRED_RESULT bool isHam() const;

    Q_REQUIRED_RESULT bool hasAttachment() const;

    Q_REQUIRED_RESULT bool hasInvitation() const;

    Q_REQUIRED_RESULT bool isSigned() const;

    Q_REQUIRED_RESULT bool isEncrypted() const;

    Q_REQUIRED_RESULT 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  --------------------------------------- */

    Q_REQUIRED_RESULT qint32 toQInt32() const;

    void fromQInt32(qint32 status);

    Q_REQUIRED_RESULT QString statusStr() const;

    void setStatusFromStr(const QString &aStr);

    Q_REQUIRED_RESULT 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