1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkBaseContactFieldCollection.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,84 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-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 base interface for contact field collections.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef MVPBKBASECONTACTFIELDCOLLECTION_H
    1.23 +#define MVPBKBASECONTACTFIELDCOLLECTION_H
    1.24 +
    1.25 +// INCLUDES
    1.26 +#include <e32cmn.h>
    1.27 +#include <e32def.h>
    1.28 +
    1.29 +// FORWARD DECLARATIONS
    1.30 +class MVPbkBaseContact;
    1.31 +class MVPbkBaseContactField;
    1.32 +class MVPbkFieldType;
    1.33 +
    1.34 +// CLASS DECLARATIONS
    1.35 +
    1.36 +/**
    1.37 + * Virtual Phonebook base contact field collection interface.
    1.38 + * An abstract collection of read-only Virtual Phonebook contact fields.
    1.39 + */
    1.40 +class MVPbkBaseContactFieldCollection
    1.41 +    {
    1.42 +    public:  // Destructor
    1.43 +        /**
    1.44 +         * Destructor.
    1.45 +         */
    1.46 +        virtual ~MVPbkBaseContactFieldCollection() { }
    1.47 +
    1.48 +    public:  // Interface
    1.49 +        /**
    1.50 +         * Returns the parent contact of this field set.
    1.51 +         * @return The parent contact of this field set.
    1.52 +         */
    1.53 +        virtual MVPbkBaseContact& ParentContact() const =0;
    1.54 +
    1.55 +        /**
    1.56 +         * Returns the number of fields in this collection.
    1.57 +         * @return The number of fields in this collection.
    1.58 +         */
    1.59 +        virtual TInt FieldCount() const =0;
    1.60 +
    1.61 +        /**
    1.62 +         * Returns a read-only field in this collection.
    1.63 +         *
    1.64 +         * @param aIndex    Zero-based index of the field to return.
    1.65 +         * @return  Reference to a field at aIndex. Reference is 
    1.66 +         *          valid until FieldAt is called again.
    1.67 +         * @see MVPbkBaseContactFieldCollection::ConstFieldAt
    1.68 +         * @precond aIndex >= 0 && aIndex < FieldCount()
    1.69 +         *          Panic VPbkError::EInvalidFieldIndex is raised if the
    1.70 +         *          precondition does not hold.
    1.71 +         */
    1.72 +        virtual const MVPbkBaseContactField& FieldAt(
    1.73 +                TInt aIndex) const =0;
    1.74 +
    1.75 +        /**
    1.76 +         * Returns an extension point for this interface or NULL.
    1.77 +         * @param aExtensionUid Uid of extension
    1.78 +         * @return Extension point or NULL
    1.79 +         */
    1.80 +        virtual TAny* BaseContactFieldCollectionExtension(
    1.81 +                TUid /*aExtensionUid*/) { return NULL; }
    1.82 +    };
    1.83 +
    1.84 +
    1.85 +#endif  // MVPBKBASECONTACTFIELDCOLLECTION_H
    1.86 +
    1.87 +//End of file