examples/SFExamples/symbian_os_communications_programming_book_v2/chapter8/receivingmessages/CMessageSummaryGenerator.h

// 
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of the License "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
// 
// Initial Contributors:
// Nokia Corporation - initial contribution.
// 
// Contributors:
// 
// Description:
// 

#ifndef _CMESSAGESUMMARYGENERATOR_H
#define _CMESSAGESUMMARYGENERATOR_H

#include <e32base.h>
#include <e32cons.h>

#include <msvstd.h>
#include <msvapi.h>
#include <msvids.h>

#include <smut.h> // For SMS message ID



// The maximum number of messages of a particular type to include in the summary
const TInt KMaxSummaryMessages = 3;

// The maximum number of characters to include from each message in the summary
const TInt KMaxSummaryStringSize = 20;

// How far the subject is indented into the summary screen
const TInt KSubjectIndent = 15;


struct TMessageSummary
        {
        TBuf<KMaxSummaryStringSize> iFrom;
        TBuf<KMaxSummaryStringSize> iSummaryText;
        };

class CMessageSummaryGenerator : public CBase
        {
public:
        CMessageSummaryGenerator(TMsvId aInboxEntry,
                                                                TUid aMessageType,
                                                                CMsvEntry& aMessagingEntry);
                                                                                                                                
        // Extract the appropriate message details into iMessageSummaries
        // Completes with KErrNone when done
        void StartL(TRequestStatus& aStatus);

        // Get the message summary list that has already been generated
        const RArray<TMessageSummary>& MessageSummaries() const;
        
        // If the new message is of the appropriate type and is in the appropriate inbox
        // then update the message summary.
        // Returns ETrue if the message is added.
        // Returns EFalse if the message is of the wrong type or in the wrong folder.
        inline TBool MessageOfCorrectType(const TMsvEntry& aEntry) const;

        ~CMessageSummaryGenerator();

private:
        // Returns an EFalse if there are no more messages to summarise
        TBool SummariseNextMessage();
        
private:
        CMsvEntry& iMessagingEntry;
        TMsvId iInboxEntry;
        TUid iMessageType;
        
private:
        RArray<TMessageSummary> iMessageSummaries;
        };



// If the new message is of the appropriate type and is in the appropriate inbox
// then update the message summary.
// Returns ETrue if the message is added.
// Returns EFalse if the message is of the wrong type or in the wrong folder.
TBool CMessageSummaryGenerator::MessageOfCorrectType(const TMsvEntry& aEntry) const
        {
        if ((aEntry.Parent() == iInboxEntry) // Is the message in the appropriate inbox?
                && (aEntry.iMtm == iMessageType)) // Is the message of the appropriate type?
                return ETrue;
        else
                return EFalse;          
        }

#endif

---