1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the Qt Mobility Components.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 #ifndef QMESSAGEMANAGER_H

    42 #define QMESSAGEMANAGER_H

    43 #include <QObject>

    44 #include <QSet>

    45 #include <QMetaType>

    46 

    47 #include <qmessageglobal.h>

    48 #include <qmessagefilter.h>

    49 #include <qmessagesortorder.h>

    50 #include <qmessagefoldersortorder.h>

    51 #include <qmessageaccountsortorder.h>

    52 #include <qmessage.h>

    53 #include <qmessagefolder.h>

    54 #include <qmessageaccount.h>

    55 

    56 

    57 QTM_BEGIN_NAMESPACE

    58 

    59 class QMessageStore;

    60 

    61 class Q_MESSAGING_EXPORT QMessageManager : public QObject

    62 {

    63     Q_OBJECT

    64 

    65     friend class QMessageStorePrivate;

    66 

    67 public:

    68     enum RemovalOption

    69     {

    70         RemoveLocalCopyOnly = 1,

    71         RemoveOnOriginatingServer

    72     };

    73 

    74     enum Error

    75     {

    76         NoError = 0,

    77         InvalidId,

    78         ConstraintFailure,

    79         ContentInaccessible,

    80         NotYetImplemented,

    81         FrameworkFault,

    82         WorkingMemoryOverflow,

    83         Busy,

    84         RequestIncomplete

    85     };

    86 

    87     typedef int NotificationFilterId;

    88     typedef QSet<QMessageManager::NotificationFilterId> NotificationFilterIdSet;

    89 

    90     QMessageManager(QObject *parent = 0);

    91     ~QMessageManager();

    92 

    93     QMessageManager::Error error() const;

    94 

    95     QMessageIdList queryMessages(const QMessageFilter &filter = QMessageFilter(), const QMessageSortOrder &sortOrder = QMessageSortOrder(), uint limit = 0, uint offset = 0) const;

    96     QMessageIdList queryMessages(const QMessageFilter &filter, const QList<QMessageSortOrder> &sortOrders, uint limit = 0, uint offset = 0) const;

    97 

    98     QMessageIdList queryMessages(const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags = 0, const QMessageSortOrder &sortOrder = QMessageSortOrder(), uint limit = 0, uint offset = 0) const;

    99     QMessageIdList queryMessages(const QMessageFilter &filter, const QString &body, QMessageDataComparator::MatchFlags matchFlags, const QList<QMessageSortOrder> &sortOrders, uint limit = 0, uint offset = 0) const;

   100 

   101     QMessageFolderIdList queryFolders(const QMessageFolderFilter &filter = QMessageFolderFilter(), const QMessageFolderSortOrder &sortOrder = QMessageFolderSortOrder(), uint limit = 0, uint offset = 0) const;

   102     QMessageFolderIdList queryFolders(const QMessageFolderFilter &filter, const QList<QMessageFolderSortOrder> &sortOrders, uint limit = 0, uint offset = 0) const;

   103 

   104     QMessageAccountIdList queryAccounts(const QMessageAccountFilter &filter = QMessageAccountFilter(), const QMessageAccountSortOrder &sortOrder = QMessageAccountSortOrder(), uint limit = 0, uint offset = 0) const;

   105     QMessageAccountIdList queryAccounts(const QMessageAccountFilter &filter, const QList<QMessageAccountSortOrder> &sortOrders, uint limit = 0, uint offset = 0) const;

   106 

   107     int countMessages(const QMessageFilter &filter = QMessageFilter()) const;

   108     int countFolders(const QMessageFolderFilter &filter = QMessageFolderFilter()) const;

   109     int countAccounts(const QMessageAccountFilter &filter = QMessageAccountFilter()) const;

   110 

   111     bool addMessage(QMessage *m);

   112     bool updateMessage(QMessage *m);

   113     bool removeMessage(const QMessageId &id, RemovalOption option = RemoveOnOriginatingServer);

   114     bool removeMessages(const QMessageFilter &filter, RemovalOption option = RemoveOnOriginatingServer);

   115 

   116     QMessage message(const QMessageId &id) const;

   117     QMessageFolder folder(const QMessageFolderId &id) const;

   118     QMessageAccount account(const QMessageAccountId &id) const;

   119 

   120     NotificationFilterId registerNotificationFilter(const QMessageFilter &filter);

   121     void unregisterNotificationFilter(NotificationFilterId filterId);

   122 

   123 signals:

   124     void messageAdded(const QMessageId &id, const QMessageManager::NotificationFilterIdSet &matchingFilterIds);

   125     void messageRemoved(const QMessageId &id, const QMessageManager::NotificationFilterIdSet &matchingFilterIds);

   126     void messageUpdated(const QMessageId &id, const QMessageManager::NotificationFilterIdSet &matchingFilterIds);

   127 

   128 private:

   129     QMessageStore *store;

   130 };

   131 QTM_END_NAMESPACE

   132 

   133 Q_DECLARE_METATYPE(QTM_PREPEND_NAMESPACE(QMessageManager::NotificationFilterId))

   134 Q_DECLARE_METATYPE(QTM_PREPEND_NAMESPACE(QMessageManager::NotificationFilterIdSet))

   135 

   136 

   137 #endif