FCL/sf/app/commonemail: comparison emailuis/nmailuiengine/src/nmmessagelistmodel.cpp

equal deleted inserted replaced

-:2dc6caa42ec3
+:9ba4404ef423
 /*
-* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* Copyright (c) 2009 - 2010 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 */
 #include "nmuiengineheaders.h"
+static const int NmFolderTypeRole = Qt::UserRole+1;
 /*!
 \class NmMessageListModel
 \brief The NmMessageListModel class represents data model for mailbox list.
 @alpha
 data method to get all information needed for one list row for a widget by calling the method
 once.
 */
 /*!
-	Constructor
+	Class constructor.
 */
-NmMessageListModel::NmMessageListModel(NmDataManager &dataManager, QObject *parent)
+NmMessageListModel::NmMessageListModel(NmDataManager &dataManager,
-:QStandardItemModel(parent),
+QObject *parent /* = 0 */)
-mDataManager(dataManager),
+: QStandardItemModel(parent),
-mDividersActive(false),
+mDataManager(dataManager),
-mParentPtr(NULL)
+mDividersActive(false),
+mParentPtr(NULL),
+mCurrentFolderType(NmFolderInbox),
+mIgnoreFolderIds(false)
 {
 // Check for setting whether dividers are active
 // mDividersActive = ...
 // update also the test cases
 }
-/*!
-	Destructor
+/*!
-*/
+	Class destructor.
+*/
 NmMessageListModel::~NmMessageListModel()
 {
 clear();
 }
 /*!
 Returns data specified by \a index. Only Qt::DisplayRole is supported in \a role.
 The refresh method must have been called before this method can return any real data.
 */
 QVariant NmMessageListModel::data(const QModelIndex &index, int role) const
 {
 QVariant qVariant;
-if (index.isValid() && Qt::DisplayRole == role) {
-	NmMessageListModelItem *item = static_cast<NmMessageListModelItem*>(itemFromIndex(index));
+if (index.isValid()){
-qVariant = QVariant::fromValue(item);
+if (role == Qt::DisplayRole) {
-}
+NmMessageListModelItem *item =
+static_cast<NmMessageListModelItem*>(itemFromIndex(index));
+qVariant = QVariant::fromValue(item);
+}
+else if (role == NmFolderTypeRole) {
+qVariant = QVariant(mCurrentFolderType);
+}
+}
 return qVariant;
 }
 /*!
 This refreshes the data of the model.
-*/
+\param mailboxId The ID of the mailbox.
+\param folderId The ID of the folder.
+\param messageEnvelopeList A list containing the message meta data.
+*/
 void NmMessageListModel::refresh(
 const NmId mailboxId,
 const NmId folderId,
 const QList<NmMessageEnvelope*> &messageEnvelopeList)
 {
-// Store current mailbox and folder id
+// Store the current mailbox and folder IDs.
 mCurrentMailboxId = mailboxId;
 mCurrentFolderId = folderId;
-// clear the model
+// Store the type of the currently displayed folder.
+mCurrentFolderType = mDataManager.folderTypeById(mailboxId, folderId);
+// Clear the model.
 clear();
-// Add items
+// Add the items from the given list.
 NmMessageEnvelope* insertedMessage(NULL);
 int parentCount(0);
 int childCount(0);
 for (int i(0); i < messageEnvelopeList.count(); i++) {
 NmMessageEnvelope* nextMessage = messageEnvelopeList[i];
-if (mDividersActive && !messagesBelongUnderSameDivider(
-		insertedMessage, nextMessage)) {
+if (mDividersActive &&
+!messagesBelongUnderSameDivider(insertedMessage, nextMessage)) {
 insertDividerIntoModel(nextMessage, parentCount);
 parentCount++;
 childCount = 0;
 }
 insertMessageIntoModel(nextMessage, childCount, false);
 insertedMessage = nextMessage;
 childCount++;
 }
-//NMLOG(QString("nmailuiengine: model row count = %1").arg(rowCount()));
+}
-}
 /*!
 insertDividerIntoModel. Function inserts divider into model.
 */
 void NmMessageListModel::insertDividerIntoModel(
 NmMessageEnvelope *messageForDivider,
 int parentRow)
 {
 mParentPtr = createTitleDividerItem(messageForDivider);
 }
 /*!
 Function inserts message into model. Message can be inserted
 either to root or to parent. If parent is zero, item is added into root.
 */
 void NmMessageListModel::insertMessageIntoModel(
 		NmMessageEnvelope *messageEnvelope, int childRow, bool emitSignal)
 {
 NmMessageListModelItem *mailItem = createMessageItem(messageEnvelope);
 if (mParentPtr) {
 }
 /*!
 Function checks whether the messages can be drawn under same title divider
 Check is done depending of the current sorting criteria
 */
 bool NmMessageListModel::messagesBelongUnderSameDivider(
 const NmMessageEnvelope *message1,
 const NmMessageEnvelope *message2) const
 {
 bool retVal(false);
 return retVal;
 }
 /*!
-Function handles message events
+Handles the message events.
-*/
-void NmMessageListModel::handleMessageEvent(
+\param event The type of the message event.
-NmMessageEvent event,
+\param folderId The folder containing the message.
-const NmId &folderId,
+\param messageIds A list of message IDs related to the event.
-const QList<NmId> &messageIds)
+*/
-{
+void NmMessageListModel::handleMessageEvent(NmMessageEvent event,
+const NmId &folderId,
+const QList<NmId> &messageIds)
+{
+NMLOG(QString("nmmessagelistmodel::handleMessageEvent()"));
 NmId mailboxId = mCurrentMailboxId;
+const int idCount = messageIds.count();
-if (folderId == 0) {
-// const cast is used here because also the input parameter has to be changed
+// Folder ID does not concern us if this model instance is used for e.g.
-const_cast<NmId&>(folderId) = mDataManager.getStandardFolderId(mailboxId, NmFolderInbox);
+// searching messages.
-NmUiStartParam *startParam = new NmUiStartParam(NmUiViewMessageList, mailboxId, folderId);
+if (!mIgnoreFolderIds) {
-emit setNewParam(startParam);
+if (folderId == 0) {
-}
+// Const cast is used here because also the input parameter has to
-if (mCurrentFolderId == 0) {
+// be changed.
-// Folder id was not known at time mailbox opened
+const_cast<NmId&>(folderId) =
-// and we know subscription is valid only for current
+mDataManager.getStandardFolderId(mailboxId, NmFolderInbox);
-// mailbox, because of events.
+NmUiStartParam *startParam =
-mCurrentFolderId = folderId;
+new NmUiStartParam(NmUiViewMessageList, mailboxId, folderId);
-}
+emit setNewParam(startParam);
-// Handle events if they concern currently displayed folder
+}
-if (mCurrentFolderId == folderId) {
-NMLOG(QString("nmailuiengine: handleMessageEvent"));
+if (mCurrentFolderId == 0) {
-if (NmMessageChanged == event) {
+// Folder ID was not known at time when the mailbox opened and we
-for (int a(0); a < messageIds.count(); a++) {
+// know that because of events the subscription is valid only for
-updateMessageEnvelope(mailboxId, folderId,messageIds[a]);
+// the current mailbox.
-}
+mCurrentFolderId = folderId;
 }
-else if (NmMessageCreated == event) {
-for (int a(0); a < messageIds.count(); a++) {
+if (mCurrentFolderId != folderId) {
-if(!itemFromModel(messageIds[a])) {
+// The event does not concern the folder currently being displayed.
-insertNewMessageIntoModel(mailboxId, folderId, messageIds[a]);
+// Thus, ignore it.
+return;
+}
+}
+// Go through the given message IDs and do the appropriate operations
+// according to the type of the event.
+for (int i(0); i < idCount; ++i) {
+switch (event) {
+case NmMessageChanged: {
+updateMessageEnvelope(mailboxId, folderId, messageIds[i]);
+break;
+}
+case NmMessageCreated:
+case NmMessageFound: {
+if (!itemFromModel(messageIds[i])) {
+insertNewMessageIntoModel(mailboxId, folderId, messageIds[i]);
 }
-}
-} else {
+break;
-for (int a(0); a < messageIds.count(); a++) {
+}
-removeMessageFromModel(messageIds[a]);
+case NmMessageDeleted: {
-}
+removeMessageFromModel(messageIds[i]);
-}
+break;
 }
 }
+}
+}
 /*!
 Function inserts new message into correct position to model.
 A new title divider is created if it is needed.
 */
 void NmMessageListModel::insertNewMessageIntoModel(
 const NmId &mailboxId,
 const NmId &folderId,
 const NmId &msgId)
 {
 }
 /*!
 Function check model index in which the new message should be inserted
 with the currently active sort mode.
 */
 int NmMessageListModel::getInsertionIndex(
 const NmMessageEnvelope &envelope) const
 {
 // NMLOG(QString("nmailuiengine: getInsertionIndex"));
 int ret(NmNotFoundError);
 }
 /*!
 Function finds preceding title divider index and sets the
 mParentPtr variable.
 */
 int NmMessageListModel::dividerInsertionIndex(int messageIndex)
 {
 bool found(false);
 int ret(NmNoError);
 QModelIndex index;
 return ret;
 }
 /*!
 Create title divider item
 */
 NmMessageListModelItem *NmMessageListModel::createTitleDividerItem(
 		NmMessageEnvelope *messageForDivider)
 {
 NmMessageListModelItem *item = new NmMessageListModelItem();
 item->setItemType(NmMessageListModelItem::NmMessageItemTitleDivider);
 return item;
 }
 /*!
 Create message item
 */
 NmMessageListModelItem *NmMessageListModel::createMessageItem(
 		NmMessageEnvelope *envelope)
 {
 NmMessageListModelItem *mailItem = new NmMessageListModelItem();
 return mailItem;
 }
 /*!
 Returns divider state
 */
 bool NmMessageListModel::dividersActive()
 {
 return mDividersActive;
 }
 /*!
 Set divider state
 */
 void NmMessageListModel::setDividers(bool active)
 {
 mDividersActive = active;
 }
 /*!
 Change item property if differs
 */
 void NmMessageListModel::setEnvelopeProperties(
 NmEnvelopeProperties property,
 const QList<NmId> &messageIds)
 {
 for (int i(0); i < messageIds.count(); i++) {
 updateEnvelope(property, messageIds[i]);
 }
 }
-/*!
-Returns the id of the current mailbox
+/*!
-*/
+Returns the ID of the current mailbox.
+*/
 NmId NmMessageListModel::currentMailboxId()
 {
 return mCurrentMailboxId;
 }
+/*!
+Sets whether the model should ignore the folder IDs or not. The folder IDs
+should be ignored e.g. when the model is used for searching messages
+(i.e. used by the search view).
+\param ignore If true, will ignore the folder IDs.
+*/
+void NmMessageListModel::setIgnoreFolderIds(bool ignore)
+{
+mIgnoreFolderIds = ignore;
+}
 /*!
 Remove message from model if message exists in model
 */
 void NmMessageListModel::removeMessageFromModel(const NmId &msgId)
 {
 QList<QStandardItem*> items = findItems("*", Qt::MatchWildcard | Qt::MatchRecursive);
 int count(items.count());
 bool found(false);
 items.clear();
 }
 /*!
 Helper function to remove row
 */
 void NmMessageListModel::removeItem(int row, NmMessageListModelItem &item)
 {
 QStandardItem *parent = item.parent();
 removeRow(row, indexFromItem(parent));
 }
 /*!
 Search item from model
 */
 NmMessageListModelItem *NmMessageListModel::itemFromModel(const NmId &messageId)
 {
 QList<QStandardItem*> items = findItems("*", Qt::MatchWildcard | Qt::MatchRecursive);
 int count(items.count());
 bool found(false);
 return ret;
 }
 /*!
 Helper function for envelope comparison
 */
 bool NmMessageListModel::changed(const NmMessageEnvelope &first, const NmMessageEnvelope &second)
 {
 return first != second;
 }
 /*!
 Updates envelope if something is changed
 */
 void NmMessageListModel::updateMessageEnvelope(const NmId &mailboxId,
 const NmId &folderId,
 const NmId &msgId)
 {
 NmMessageListModelItem *item = itemFromModel(msgId);
 }
 }
 /*!
 Update envelope property
 */
 void NmMessageListModel::updateEnvelope(NmEnvelopeProperties property, const NmId &msgId)
 {
 NmMessageListModelItem *item = itemFromModel(msgId);
 if (item) {
 bool changed(false);

changeset 27	9ba4404ef423
parent 23	2dc6caa42ec3
child 30	759dc5235cdb