1 /*

     2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description: Message iterator interface

    15 *

    16 */

    17 

    18 #ifndef MMESSAGEITERATOR_H

    19 #define MMESSAGEITERATOR_H

    20 

    21 #include <emailapidefs.h>

    22 

    23 namespace EmailInterface {

    24 

    25 class MEmailMessage;

    26 

    27 /**

    28  * Iterator for email messages. 

    29  * @since S60 v5.0

    30  */

    31 class MMessageIterator : public MEmailInterface

    32 {

    33 public:

    34     /**

    35     * Returns next message. When all messages are iterated, returns NULL

    36     * @return next message. Ownership is not transferred.

    37     */

    38     virtual MEmailMessage* NextL() = 0;

    39     

    40     /**

    41     * Returns previous message. When first message is reached, returns NULL

    42     * @return previous message. Ownership not is transferred.

    43     */

    44     virtual MEmailMessage* PreviousL() = 0;

    45     

    46     /**

    47     * Returns amount of messages accessible from the iterator.

    48     * @return message count

    49     */

    50     virtual TUint Count() const = 0;

    51     

    52 };

    53 

    54 } // EmailInterface

    55 

    56 #endif // MMESSAGEITERATOR_H