email_plat/email_client_api/mmessageiterator.h
author hgs
Thu, 24 Jun 2010 14:32:18 +0300
changeset 47 f83bd4ae1fe3
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
47
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: Message iterator interface
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef MMESSAGEITERATOR_H
hgs
parents:
diff changeset
    19
#define MMESSAGEITERATOR_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include <emailapidefs.h>
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
namespace EmailInterface {
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
class MEmailMessage;
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/**
hgs
parents:
diff changeset
    28
 * Iterator for email messages. 
hgs
parents:
diff changeset
    29
 * @since S60 v5.0
hgs
parents:
diff changeset
    30
 */
hgs
parents:
diff changeset
    31
class MMessageIterator : public MEmailInterface
hgs
parents:
diff changeset
    32
{
hgs
parents:
diff changeset
    33
public:
hgs
parents:
diff changeset
    34
    /**
hgs
parents:
diff changeset
    35
    * Returns next message. When all messages are iterated, returns NULL
hgs
parents:
diff changeset
    36
    * @return next message. Ownership is not transferred.
hgs
parents:
diff changeset
    37
    */
hgs
parents:
diff changeset
    38
    virtual MEmailMessage* NextL() = 0;
hgs
parents:
diff changeset
    39
    
hgs
parents:
diff changeset
    40
    /**
hgs
parents:
diff changeset
    41
    * Returns previous message. When first message is reached, returns NULL
hgs
parents:
diff changeset
    42
    * @return previous message. Ownership not is transferred.
hgs
parents:
diff changeset
    43
    */
hgs
parents:
diff changeset
    44
    virtual MEmailMessage* PreviousL() = 0;
hgs
parents:
diff changeset
    45
    
hgs
parents:
diff changeset
    46
    /**
hgs
parents:
diff changeset
    47
    * Returns amount of messages accessible from the iterator.
hgs
parents:
diff changeset
    48
    * @return message count
hgs
parents:
diff changeset
    49
    */
hgs
parents:
diff changeset
    50
    virtual TUint Count() const = 0;
hgs
parents:
diff changeset
    51
    
hgs
parents:
diff changeset
    52
};
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
} // EmailInterface
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
#endif // MMESSAGEITERATOR_H