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.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description:  Phonebook 2 field property array interface.
williamr@4
    15
*
williamr@4
    16
*/
williamr@4
    17
williamr@4
    18
williamr@4
    19
#ifndef MPBK2FIELDPROPERTYARRAY_H
williamr@4
    20
#define MPBK2FIELDPROPERTYARRAY_H
williamr@4
    21
williamr@4
    22
// INCLUDE FILES
williamr@4
    23
#include <e32def.h>
williamr@4
    24
williamr@4
    25
// FORWARD DECLARATIONS
williamr@4
    26
class MPbk2FieldProperty;
williamr@4
    27
class MVPbkFieldType;
williamr@4
    28
williamr@4
    29
//Use this UID to access field property array extension 2. Used as a parameter
williamr@4
    30
//to FieldPropertyArrayExtension() method.
williamr@4
    31
const TUid KMPbk2FieldPropertyArrayExtension2Uid = { 2 };
williamr@4
    32
williamr@4
    33
/**
williamr@4
    34
 * Phonebook 2 field property array interface.
williamr@4
    35
 *
williamr@4
    36
 * @see MPbk2FieldProperty
williamr@4
    37
 */
williamr@4
    38
class MPbk2FieldPropertyArray
williamr@4
    39
    {
williamr@4
    40
    public: // Interface
williamr@4
    41
williamr@4
    42
        /**
williamr@4
    43
         * Destructor.
williamr@4
    44
         */
williamr@4
    45
        virtual ~MPbk2FieldPropertyArray()
williamr@4
    46
                {}
williamr@4
    47
williamr@4
    48
        /**
williamr@4
    49
         * Returns a property for the field type or NULL.
williamr@4
    50
         *
williamr@4
    51
         * @param aFieldType    The field type whose property is
williamr@4
    52
         *                      searched for.
williamr@4
    53
         * @return  A field property for the field type
williamr@4
    54
         *          or NULL if not found.
williamr@4
    55
         */
williamr@4
    56
        virtual const MPbk2FieldProperty* FindProperty(
williamr@4
    57
                const MVPbkFieldType& aFieldType ) const = 0;
williamr@4
    58
williamr@4
    59
        /**
williamr@4
    60
         * Returns the number of properties in the array.
williamr@4
    61
         *
williamr@4
    62
         * @return Number of properties in the array.
williamr@4
    63
         */
williamr@4
    64
        virtual TInt Count() const = 0;
williamr@4
    65
williamr@4
    66
        /**
williamr@4
    67
         * Returns the property at given index.
williamr@4
    68
         *
williamr@4
    69
         * @param aIndex        The index of the property.
williamr@4
    70
         * @return  Property at given index.
williamr@4
    71
         */
williamr@4
    72
        virtual const MPbk2FieldProperty& At(
williamr@4
    73
                TInt aIndex ) const = 0;
williamr@4
    74
williamr@4
    75
        /**
williamr@4
    76
         * Returns an extension point for this interface or NULL.
williamr@4
    77
         *
williamr@4
    78
         * @param aExtensionUid     Extension UID.
williamr@4
    79
         * @return  Extension point.
williamr@4
    80
         */
williamr@4
    81
        virtual TAny* FieldPropertyArrayExtension(
williamr@4
    82
                TUid /*aExtensionUid*/ )
williamr@4
    83
            {
williamr@4
    84
            return NULL;
williamr@4
    85
            }
williamr@4
    86
    };
williamr@4
    87
williamr@4
    88
#endif // MPBK2FIELDPROPERTYARRAY_H
williamr@4
    89
williamr@4
    90
// End of File