epoc32/include/app/MVPbkContactBookmarkCollection.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2006-2007 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:  Virtual Phonebook interface for contact bookmark collections.
    15 *
    16 */
    17 
    18 
    19 #ifndef MVPBKCONTACTBOOKMARKCOLLECTION_H
    20 #define MVPBKCONTACTBOOKMARKCOLLECTION_H
    21 
    22 #include <e32def.h>
    23 
    24 // FORWARD DECLARATIONS
    25 class MVPbkContactBookmark;
    26 
    27 /**
    28  * Virtual Phonebook interface for contact bookmark collections.
    29  *
    30  * A bookmark collection owns its bookmarks and the destructor
    31  * will delete all the bookmarks in the array.
    32  */
    33 class MVPbkContactBookmarkCollection
    34     {
    35     public:
    36         /**
    37          * Destructor.
    38          */
    39         virtual ~MVPbkContactBookmarkCollection() {}
    40         
    41         /**
    42          * Returns the number of bookmarks in the collections.
    43          *
    44          * @return The number of bookmarks in the collections.
    45          */
    46         virtual TInt Count() const = 0;
    47         
    48         /**
    49          * Returns a bookmark at given position.
    50          *
    51          * @param aIndex    Position of the bookmark in the collection.
    52          * @return A bookmark at given position.
    53          */ 
    54         virtual const MVPbkContactBookmark& At( TInt aIndex ) const = 0;
    55         
    56         /**
    57          * Returns an extension point for this interface or NULL.
    58          * @param aExtensionUid Extension identifier.
    59          * @return Extension object.
    60          */
    61         virtual TAny* ContactBookmarkCollectionExtension(
    62                 TUid /*aExtensionUid*/) { return NULL; }
    63 
    64     };
    65 
    66 #endif // MVPBKCONTACTBOOKMARKCOLLECTION_H
    67 
    68 // End of File