epoc32/include/app/MVPbkContactFieldSelector.h
branchSymbian3
changeset 4 837f303aceeb
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
       
     1 /*
       
     2 * Copyright (c) 2002-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:  Virtual Phonebook field selector interface needed 
       
    15 *                by e.g. CVPbkFieldFilter.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef MVPBKCONTACTFIELDSELECTOR_H
       
    21 #define MVPBKCONTACTFIELDSELECTOR_H
       
    22 
       
    23 // INCLUDES
       
    24 #include <e32cmn.h>
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class MVPbkBaseContactField;
       
    28 
       
    29 // CLASS DECLARATIONS
       
    30 
       
    31 /**
       
    32  * Virtual Phonebook Contact field selector interface.
       
    33  * This interface can be used to create a selection object, which
       
    34  * can determine which fields belong to the set criteria.
       
    35  */
       
    36 class MVPbkContactFieldSelector
       
    37     {
       
    38     public:
       
    39         /**
       
    40          * Returns true if aField belongs to the set defined by this field
       
    41          * selector.
       
    42          * 
       
    43          * In case field is an IMPP field service name is compared to 
       
    44          * existing service installations. Only matched IMPP service
       
    45          * providers are included.
       
    46          * 
       
    47          * @param aField    Contact field to check againt criteria.
       
    48          * @return ETrue if the field is included in the set.
       
    49          */
       
    50         virtual TBool IsFieldIncluded(
       
    51                 const MVPbkBaseContactField& aField) const =0;
       
    52     
       
    53         /**
       
    54          * Returns an extension point for this interface or NULL.
       
    55          * @param aExtensionUid Uid of extension
       
    56          * @return Extension point or NULL
       
    57          */
       
    58         virtual TAny* ContactFieldSelectorExtension(
       
    59                 TUid /*aExtensionUid*/) { return NULL; }
       
    60 
       
    61     protected:
       
    62         /**
       
    63          * Destructor.
       
    64          */
       
    65         virtual ~MVPbkContactFieldSelector() { }
       
    66 
       
    67     };
       
    68 
       
    69 #endif  // MVPBKCONTACTFIELDSELECTOR_H
       
    70 
       
    71 //End of file