1 /*

     2 * Copyright (c) 2008 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:  Declaration of interface MFscContactLinkIterator.

    15 *

    16 */

    17 

    18 

    19 #ifndef M_FSCCONTACTLINKITERATOR_H

    20 #define M_FSCCONTACTLINKITERATOR_H

    21 

    22 #include <e32base.h>

    23 

    24 // FORWARD DECLARATIONS

    25 class MVPbkContactLink;

    26 

    27 /**

    28  *  Contact link iterator.

    29  *  Defines an interface for contact link iterator.

    30  *

    31  *  @since S60 3.1

    32  */

    33 class MFscContactLinkIterator

    34     {

    35    

    36 public: // Contact related methods.

    37     

    38     /**

    39      * Returns contacts count.

    40      * 

    41      * @return contact count 

    42      */

    43     virtual TInt ContactCount() const = 0;

    44     

    45     /**

    46      * Checks if iterator has more contacts links.

    47      * 

    48      * @return ETrue if the iterator has more contacts.

    49      */

    50     virtual TBool HasNextContact() const = 0;

    51     

    52     /**

    53      * Operation for retrieving contact link.

    54      * Gets current contact link and moves iterator to next one. 

    55      */

    56     virtual MVPbkContactLink* NextContactL() = 0;

    57     

    58     /**

    59      * Sets the iterator to point to the first contact link in the list.

    60      */

    61     virtual void SetToFirstContact() = 0;

    62     

    63 public: // Contact group related methods

    64     

    65     /**

    66      * Group count.

    67      *

    68      * @return group count.

    69      */

    70     virtual TInt GroupCount() const = 0;

    71     

    72     /**

    73      * Checks if iterator has more groups.

    74      *

    75      * @return ETrue if the iterator has more groups. 

    76      */

    77     virtual TBool HasNextGroup() const = 0;

    78     

    79     /**

    80      * Operation for retrieving contact link for group.

    81      * 

    82      */

    83     virtual MVPbkContactLink* NextGroupL() = 0;

    84     

    85     /**

    86      * Sets the iterator to point to the first group in the list.

    87      */

    88     virtual void SetToFirstGroup() = 0;

    89 

    90 public: 

    91 

    92     /**

    93      * Destructor.

    94      */

    95     virtual ~MFscContactLinkIterator() {}

    96     

    97     };

    98 

    99 #endif // M_FSCCONTACTLINKITERATOR_H