epoc32/include/app/MVPbkContactBookmarkCollection.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkContactBookmarkCollection.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,68 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  Virtual Phonebook interface for contact bookmark collections.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef MVPBKCONTACTBOOKMARKCOLLECTION_H
    1.23 +#define MVPBKCONTACTBOOKMARKCOLLECTION_H
    1.24 +
    1.25 +#include <e32def.h>
    1.26 +
    1.27 +// FORWARD DECLARATIONS
    1.28 +class MVPbkContactBookmark;
    1.29 +
    1.30 +/**
    1.31 + * Virtual Phonebook interface for contact bookmark collections.
    1.32 + *
    1.33 + * A bookmark collection owns its bookmarks and the destructor
    1.34 + * will delete all the bookmarks in the array.
    1.35 + */
    1.36 +class MVPbkContactBookmarkCollection
    1.37 +    {
    1.38 +    public:
    1.39 +        /**
    1.40 +         * Destructor.
    1.41 +         */
    1.42 +        virtual ~MVPbkContactBookmarkCollection() {}
    1.43 +        
    1.44 +        /**
    1.45 +         * Returns the number of bookmarks in the collections.
    1.46 +         *
    1.47 +         * @return The number of bookmarks in the collections.
    1.48 +         */
    1.49 +        virtual TInt Count() const = 0;
    1.50 +        
    1.51 +        /**
    1.52 +         * Returns a bookmark at given position.
    1.53 +         *
    1.54 +         * @param aIndex    Position of the bookmark in the collection.
    1.55 +         * @return A bookmark at given position.
    1.56 +         */ 
    1.57 +        virtual const MVPbkContactBookmark& At( TInt aIndex ) const = 0;
    1.58 +        
    1.59 +        /**
    1.60 +         * Returns an extension point for this interface or NULL.
    1.61 +         * @param aExtensionUid Extension identifier.
    1.62 +         * @return Extension object.
    1.63 +         */
    1.64 +        virtual TAny* ContactBookmarkCollectionExtension(
    1.65 +                TUid /*aExtensionUid*/) { return NULL; }
    1.66 +
    1.67 +    };
    1.68 +
    1.69 +#endif // MVPBKCONTACTBOOKMARKCOLLECTION_H
    1.70 +
    1.71 +// End of File