epoc32/include/app/MPbk2FieldPropertyArray.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MPbk2FieldPropertyArray.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,90 @@
     1.4 +/*
     1.5 +* Copyright (c) 2005-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:  Phonebook 2 field property array interface.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef MPBK2FIELDPROPERTYARRAY_H
    1.23 +#define MPBK2FIELDPROPERTYARRAY_H
    1.24 +
    1.25 +// INCLUDE FILES
    1.26 +#include <e32def.h>
    1.27 +
    1.28 +// FORWARD DECLARATIONS
    1.29 +class MPbk2FieldProperty;
    1.30 +class MVPbkFieldType;
    1.31 +
    1.32 +//Use this UID to access field property array extension 2. Used as a parameter
    1.33 +//to FieldPropertyArrayExtension() method.
    1.34 +const TUid KMPbk2FieldPropertyArrayExtension2Uid = { 2 };
    1.35 +
    1.36 +/**
    1.37 + * Phonebook 2 field property array interface.
    1.38 + *
    1.39 + * @see MPbk2FieldProperty
    1.40 + */
    1.41 +class MPbk2FieldPropertyArray
    1.42 +    {
    1.43 +    public: // Interface
    1.44 +
    1.45 +        /**
    1.46 +         * Destructor.
    1.47 +         */
    1.48 +        virtual ~MPbk2FieldPropertyArray()
    1.49 +                {}
    1.50 +
    1.51 +        /**
    1.52 +         * Returns a property for the field type or NULL.
    1.53 +         *
    1.54 +         * @param aFieldType    The field type whose property is
    1.55 +         *                      searched for.
    1.56 +         * @return  A field property for the field type
    1.57 +         *          or NULL if not found.
    1.58 +         */
    1.59 +        virtual const MPbk2FieldProperty* FindProperty(
    1.60 +                const MVPbkFieldType& aFieldType ) const = 0;
    1.61 +
    1.62 +        /**
    1.63 +         * Returns the number of properties in the array.
    1.64 +         *
    1.65 +         * @return Number of properties in the array.
    1.66 +         */
    1.67 +        virtual TInt Count() const = 0;
    1.68 +
    1.69 +        /**
    1.70 +         * Returns the property at given index.
    1.71 +         *
    1.72 +         * @param aIndex        The index of the property.
    1.73 +         * @return  Property at given index.
    1.74 +         */
    1.75 +        virtual const MPbk2FieldProperty& At(
    1.76 +                TInt aIndex ) const = 0;
    1.77 +
    1.78 +        /**
    1.79 +         * Returns an extension point for this interface or NULL.
    1.80 +         *
    1.81 +         * @param aExtensionUid     Extension UID.
    1.82 +         * @return  Extension point.
    1.83 +         */
    1.84 +        virtual TAny* FieldPropertyArrayExtension(
    1.85 +                TUid /*aExtensionUid*/ )
    1.86 +            {
    1.87 +            return NULL;
    1.88 +            }
    1.89 +    };
    1.90 +
    1.91 +#endif // MPBK2FIELDPROPERTYARRAY_H
    1.92 +
    1.93 +// End of File