• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • akonadi
  • kmime
messagestatus.h
1/* -*- mode: C++ -*-
2 This file is part of Akonadi.
3 Copyright (c) 2005 Andreas Gungl <a.gungl@gmx.de>
4 Copyright (c) 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
5 Copyright (c) 2010 Leo Franchi <lfranchi@kde.org>
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU Library General Public License for more details.
16
17 You should have received a copy of the GNU Library General Public License
18 along with this library; see the file COPYING.LIB. If not, write to the
19 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA.
21*/
22#ifndef AKONADI_KMIME_MESSAGESTATUS_H
23#define AKONADI_KMIME_MESSAGESTATUS_H
24
25#include <QtCore/QSet>
26
27#include "akonadi-kmime_export.h"
28
29class QString;
30
31namespace Akonadi {
32
33//---------------------------------------------------------------------------
51class AKONADI_KMIME_EXPORT MessageStatus
52{
53 public:
55 MessageStatus();
56
62 MessageStatus &operator = ( const MessageStatus &other );
63
68 bool operator == ( const MessageStatus &other ) const;
69
74 bool operator != ( const MessageStatus &other ) const;
75
81 bool operator & ( const MessageStatus &other ) const;
82
84 void clear();
85
93 void set( const MessageStatus &other );
94
100 void toggle( const MessageStatus &other );
101
102 /* ----- getters ----------------------------------------------------- */
103
107 bool isOfUnknownStatus() const;
108
112 bool isRead() const;
113
117 bool isDeleted() const;
118
122 bool isReplied() const;
123
127 bool isForwarded() const;
128
132 bool isQueued() const;
133
137 bool isSent() const;
138
142 bool isImportant() const;
143
147 bool isWatched() const;
148
152 bool isIgnored() const;
153
157 bool isToAct() const;
158
162 bool isSpam() const;
163
167 bool isHam() const;
168
172 bool hasAttachment() const;
173
177 bool hasInvitation() const;
178
182 bool isSigned() const;
183
187 bool isEncrypted() const;
188
192 bool hasError() const;
193
194 /* ----- setters ----------------------------------------------------- */
195
200 void setRead( bool read = true );
201
205 void setDeleted( bool deleted = true );
206
210 void setReplied( bool replied = true );
211
215 void setForwarded( bool forwarded = true );
216
220 void setQueued( bool queued = true );
221
225 void setSent( bool sent = true );
226
230 void setImportant( bool important = true );
231
235 void setWatched( bool watched = true );
236
240 void setIgnored( bool ignored = true );
241
245 void setToAct( bool toAct = true );
246
250 void setSpam( bool spam = true );
251
255 void setHam( bool ham = true );
256
260 void setHasAttachment( bool hasAttachment = true );
261
265 void setHasInvitation( bool hasInvitation = true );
266
270 void setSigned( bool value = true );
271
275 void setEncrypted( bool value = true );
276
280 void setHasError( bool value = true );
281
282 /* ----- state representation --------------------------------------- */
283
289 qint32 toQInt32() const;
290
296 void fromQInt32( qint32 status );
297
304 QString statusStr() const;
305
313 void setStatusFromStr( const QString &aStr );
314
318 QSet<QByteArray> statusFlags() const;
319
323 void setStatusFromFlags( const QSet<QByteArray> &flags );
324
325 /* ----- static accessors to simple states --------------------------- */
326
330 static const MessageStatus statusUnread();
331
336 static const MessageStatus statusRead();
337
342 static const MessageStatus statusDeleted();
343
348 static const MessageStatus statusReplied();
349
354 static const MessageStatus statusForwarded();
355
360 static const MessageStatus statusQueued();
361
366 static const MessageStatus statusSent();
367
372 static const MessageStatus statusImportant();
373
378 static const MessageStatus statusWatched();
379
384 static const MessageStatus statusIgnored();
385
390 static const MessageStatus statusToAct();
391
396 static const MessageStatus statusSpam();
397
402 static const MessageStatus statusHam();
403
408 static const MessageStatus statusHasAttachment();
409
414 static const MessageStatus statusHasInvitation();
415
420 static const MessageStatus statusSigned();
421
426 static const MessageStatus statusEncrypted();
427
432 static const MessageStatus statusHasError();
433
434 private:
435 quint32 mStatus;
436};
437
438} // namespace Akonadi
439
440#endif
Akonadi::MessageStatus::setQueued
void setQueued(bool queued=true)
Set the status for queued.
Definition messagestatus.cpp:340
Akonadi::MessageStatus::setHam
void setHam(bool ham=true)
Set the status to not spam.
Definition messagestatus.cpp:409
Akonadi::MessageStatus::MessageStatus
MessageStatus()
Constructor - sets status initially to unknown.
Definition messagestatus.cpp:59
Akonadi::MessageStatus::statusRead
static const MessageStatus statusRead()
Return a predefined status initialized as Read as is useful e.g.
Definition messagestatus.cpp:693
Akonadi::MessageStatus::fromQInt32
void fromQInt32(qint32 status)
Set the status as a whole e.g.
Definition messagestatus.cpp:469
Akonadi::MessageStatus::statusStr
QString statusStr() const
Convert the status to a string representation.
Definition messagestatus.cpp:474
Akonadi::MessageStatus::setHasError
void setHasError(bool value=true)
Set the status to error.
Definition messagestatus.cpp:455
Akonadi::MessageStatus::statusSent
static const MessageStatus statusSent()
Return a predefined status initialized as Sent as is useful e.g.
Definition messagestatus.cpp:728
Akonadi::MessageStatus::statusUnread
static const MessageStatus statusUnread()
Return a special status that expresses Unread.
Definition messagestatus.cpp:686
Akonadi::MessageStatus::statusHasAttachment
static const MessageStatus statusHasAttachment()
Return a predefined status initialized as Attachment as is useful e.g.
Definition messagestatus.cpp:777
Akonadi::MessageStatus::statusSpam
static const MessageStatus statusSpam()
Return a predefined status initialized as Spam as is useful e.g.
Definition messagestatus.cpp:763
Akonadi::MessageStatus::isEncrypted
bool isEncrypted() const
Check for Encrypted status.
Definition messagestatus.cpp:294
Akonadi::MessageStatus::setEncrypted
void setEncrypted(bool value=true)
Set the status to encrypted.
Definition messagestatus.cpp:446
Akonadi::MessageStatus::setRead
void setRead(bool read=true)
Set the status to read.
Definition messagestatus.cpp:304
Akonadi::MessageStatus::isRead
bool isRead() const
Check for Read status.
Definition messagestatus.cpp:219
Akonadi::MessageStatus::toQInt32
qint32 toQInt32() const
Get the status as a whole e.g.
Definition messagestatus.cpp:464
Akonadi::MessageStatus::setHasInvitation
void setHasInvitation(bool hasInvitation=true)
Set the status for an invitation.
Definition messagestatus.cpp:428
Akonadi::MessageStatus::statusSigned
static const MessageStatus statusSigned()
Return a predefined status initialized as Signed as is useful e.g.
Definition messagestatus.cpp:791
Akonadi::MessageStatus::isWatched
bool isWatched() const
Check for Watched status.
Definition messagestatus.cpp:254
Akonadi::MessageStatus::isImportant
bool isImportant() const
Check for Important status.
Definition messagestatus.cpp:249
Akonadi::MessageStatus::isIgnored
bool isIgnored() const
Check for Ignored status.
Definition messagestatus.cpp:259
Akonadi::MessageStatus::statusHasInvitation
static const MessageStatus statusHasInvitation()
Return a predefined status initialized as Invitation as is useful e.g.
Definition messagestatus.cpp:784
Akonadi::MessageStatus::setForwarded
void setForwarded(bool forwarded=true)
Set the status for forwarded.
Definition messagestatus.cpp:331
Akonadi::MessageStatus::statusDeleted
static const MessageStatus statusDeleted()
Return a predefined status initialized as Deleted as is useful e.g.
Definition messagestatus.cpp:700
Akonadi::MessageStatus::statusReplied
static const MessageStatus statusReplied()
Return a predefined status initialized as Replied as is useful e.g.
Definition messagestatus.cpp:707
Akonadi::MessageStatus::setSigned
void setSigned(bool value=true)
Set the status to signed.
Definition messagestatus.cpp:437
Akonadi::MessageStatus::setSpam
void setSpam(bool spam=true)
Set the status to spam.
Definition messagestatus.cpp:399
Akonadi::MessageStatus::setDeleted
void setDeleted(bool deleted=true)
Set the status for deleted.
Definition messagestatus.cpp:313
Akonadi::MessageStatus::setStatusFromFlags
void setStatusFromFlags(const QSet< QByteArray > &flags)
Set the status as a whole e.g.
Definition messagestatus.cpp:638
Akonadi::MessageStatus::statusImportant
static const MessageStatus statusImportant()
Return a predefined status initialized as Important as is useful e.g.
Definition messagestatus.cpp:735
Akonadi::MessageStatus::isSent
bool isSent() const
Check for Sent status.
Definition messagestatus.cpp:244
Akonadi::MessageStatus::statusWatched
static const MessageStatus statusWatched()
Return a predefined status initialized as Watched as is useful e.g.
Definition messagestatus.cpp:742
Akonadi::MessageStatus::hasInvitation
bool hasInvitation() const
Check for Invitation status.
Definition messagestatus.cpp:284
Akonadi::MessageStatus::isDeleted
bool isDeleted() const
Check for Deleted status.
Definition messagestatus.cpp:224
Akonadi::MessageStatus::clear
void clear()
Clear all status flags, this resets to unknown.
Definition messagestatus.cpp:93
Akonadi::MessageStatus::setIgnored
void setIgnored(bool ignored=true)
Set the status to ignored.
Definition messagestatus.cpp:379
Akonadi::MessageStatus::setStatusFromStr
void setStatusFromStr(const QString &aStr)
Set the status based on a string representation.
Definition messagestatus.cpp:522
Akonadi::MessageStatus::isSigned
bool isSigned() const
Check for Signed status.
Definition messagestatus.cpp:289
Akonadi::MessageStatus::isForwarded
bool isForwarded() const
Check for Forwarded status.
Definition messagestatus.cpp:234
Akonadi::MessageStatus::setToAct
void setToAct(bool toAct=true)
Set the status to action item.
Definition messagestatus.cpp:389
Akonadi::MessageStatus::setSent
void setSent(bool sent=true)
Set the status for sent.
Definition messagestatus.cpp:349
Akonadi::MessageStatus::statusForwarded
static const MessageStatus statusForwarded()
Return a predefined status initialized as Forwarded as is useful e.g.
Definition messagestatus.cpp:714
Akonadi::MessageStatus::setReplied
void setReplied(bool replied=true)
Set the status for replied.
Definition messagestatus.cpp:322
Akonadi::MessageStatus::setHasAttachment
void setHasAttachment(bool hasAttachment=true)
Set the status for an attachment.
Definition messagestatus.cpp:419
Akonadi::MessageStatus::hasError
bool hasError() const
Check for error status.
Definition messagestatus.cpp:299
Akonadi::MessageStatus::statusToAct
static const MessageStatus statusToAct()
Return a predefined status initialized as Action Item as is useful e.g.
Definition messagestatus.cpp:756
Akonadi::MessageStatus::isQueued
bool isQueued() const
Check for Queued status.
Definition messagestatus.cpp:239
Akonadi::MessageStatus::statusQueued
static const MessageStatus statusQueued()
Return a predefined status initialized as Queued as is useful e.g.
Definition messagestatus.cpp:721
Akonadi::MessageStatus::hasAttachment
bool hasAttachment() const
Check for Attachment status.
Definition messagestatus.cpp:279
Akonadi::MessageStatus::statusIgnored
static const MessageStatus statusIgnored()
Return a predefined status initialized as Ignored as is useful e.g.
Definition messagestatus.cpp:749
Akonadi::MessageStatus::statusHam
static const MessageStatus statusHam()
Return a predefined status initialized as Ham as is useful e.g.
Definition messagestatus.cpp:770
Akonadi::MessageStatus::statusHasError
static const MessageStatus statusHasError()
Return a predefined status initialized as Error as is useful e.g.
Definition messagestatus.cpp:805
Akonadi::MessageStatus::isSpam
bool isSpam() const
Check for Spam status.
Definition messagestatus.cpp:269
Akonadi::MessageStatus::setImportant
void setImportant(bool important=true)
Set the status for important.
Definition messagestatus.cpp:359
Akonadi::MessageStatus::statusEncrypted
static const MessageStatus statusEncrypted()
Return a predefined status initialized as Encrypted as is useful e.g.
Definition messagestatus.cpp:798
Akonadi::MessageStatus::statusFlags
QSet< QByteArray > statusFlags() const
Get the status as a whole e.g.
Definition messagestatus.cpp:573
Akonadi::MessageStatus::isReplied
bool isReplied() const
Check for Replied status.
Definition messagestatus.cpp:229
Akonadi::MessageStatus::setWatched
void setWatched(bool watched=true)
Set the status to watched.
Definition messagestatus.cpp:369
Akonadi::MessageStatus::set
void set(const MessageStatus &other)
Set / add stati described by another MessageStatus object.
Definition messagestatus.cpp:98
Akonadi::MessageStatus::isToAct
bool isToAct() const
Check for ToAct status.
Definition messagestatus.cpp:264
Akonadi::MessageStatus::isHam
bool isHam() const
Check for Ham status.
Definition messagestatus.cpp:274
Akonadi::MessageStatus::toggle
void toggle(const MessageStatus &other)
Toggle one or more stati described by another MessageStatus object.
Definition messagestatus.cpp:159
Akonadi::MessageStatus::isOfUnknownStatus
bool isOfUnknownStatus() const
Check for Unknown status.
Definition messagestatus.cpp:214
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal