epoc32/include/app/MPbk2FieldPropertyArray.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) 2005-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:  Phonebook 2 field property array interface.
    15 *
    16 */
    17 
    18 
    19 #ifndef MPBK2FIELDPROPERTYARRAY_H
    20 #define MPBK2FIELDPROPERTYARRAY_H
    21 
    22 // INCLUDE FILES
    23 #include <e32def.h>
    24 
    25 // FORWARD DECLARATIONS
    26 class MPbk2FieldProperty;
    27 class MVPbkFieldType;
    28 
    29 //Use this UID to access field property array extension 2. Used as a parameter
    30 //to FieldPropertyArrayExtension() method.
    31 const TUid KMPbk2FieldPropertyArrayExtension2Uid = { 2 };
    32 
    33 /**
    34  * Phonebook 2 field property array interface.
    35  *
    36  * @see MPbk2FieldProperty
    37  */
    38 class MPbk2FieldPropertyArray
    39     {
    40     public: // Interface
    41 
    42         /**
    43          * Destructor.
    44          */
    45         virtual ~MPbk2FieldPropertyArray()
    46                 {}
    47 
    48         /**
    49          * Returns a property for the field type or NULL.
    50          *
    51          * @param aFieldType    The field type whose property is
    52          *                      searched for.
    53          * @return  A field property for the field type
    54          *          or NULL if not found.
    55          */
    56         virtual const MPbk2FieldProperty* FindProperty(
    57                 const MVPbkFieldType& aFieldType ) const = 0;
    58 
    59         /**
    60          * Returns the number of properties in the array.
    61          *
    62          * @return Number of properties in the array.
    63          */
    64         virtual TInt Count() const = 0;
    65 
    66         /**
    67          * Returns the property at given index.
    68          *
    69          * @param aIndex        The index of the property.
    70          * @return  Property at given index.
    71          */
    72         virtual const MPbk2FieldProperty& At(
    73                 TInt aIndex ) const = 0;
    74 
    75         /**
    76          * Returns an extension point for this interface or NULL.
    77          *
    78          * @param aExtensionUid     Extension UID.
    79          * @return  Extension point.
    80          */
    81         virtual TAny* FieldPropertyArrayExtension(
    82                 TUid /*aExtensionUid*/ )
    83             {
    84             return NULL;
    85             }
    86     };
    87 
    88 #endif // MPBK2FIELDPROPERTYARRAY_H
    89 
    90 // End of File