williamr@4: /*
williamr@4: * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4: * All rights reserved.
williamr@4: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@4: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4: *
williamr@4: * Initial Contributors:
williamr@4: * Nokia Corporation - initial contribution.
williamr@4: *
williamr@4: * Contributors:
williamr@4: *
williamr@4: * Description:  Virtual Phonebook field selector interface needed 
williamr@4: *                by e.g. CVPbkFieldFilter.
williamr@4: *
williamr@4: */
williamr@4: 
williamr@4: 
williamr@4: #ifndef MVPBKCONTACTFIELDSELECTOR_H
williamr@4: #define MVPBKCONTACTFIELDSELECTOR_H
williamr@4: 
williamr@4: // INCLUDES
williamr@4: #include <e32cmn.h>
williamr@4: 
williamr@4: // FORWARD DECLARATIONS
williamr@4: class MVPbkBaseContactField;
williamr@4: 
williamr@4: // CLASS DECLARATIONS
williamr@4: 
williamr@4: /**
williamr@4:  * Virtual Phonebook Contact field selector interface.
williamr@4:  * This interface can be used to create a selection object, which
williamr@4:  * can determine which fields belong to the set criteria.
williamr@4:  */
williamr@4: class MVPbkContactFieldSelector
williamr@4:     {
williamr@4:     public:
williamr@4:         /**
williamr@4:          * Returns true if aField belongs to the set defined by this field
williamr@4:          * selector.
williamr@4:          * 
williamr@4:          * In case field is an IMPP field service name is compared to 
williamr@4:          * existing service installations. Only matched IMPP service
williamr@4:          * providers are included.
williamr@4:          * 
williamr@4:          * @param aField    Contact field to check againt criteria.
williamr@4:          * @return ETrue if the field is included in the set.
williamr@4:          */
williamr@4:         virtual TBool IsFieldIncluded(
williamr@4:                 const MVPbkBaseContactField& aField) const =0;
williamr@4:     
williamr@4:         /**
williamr@4:          * Returns an extension point for this interface or NULL.
williamr@4:          * @param aExtensionUid Uid of extension
williamr@4:          * @return Extension point or NULL
williamr@4:          */
williamr@4:         virtual TAny* ContactFieldSelectorExtension(
williamr@4:                 TUid /*aExtensionUid*/) { return NULL; }
williamr@4: 
williamr@4:     protected:
williamr@4:         /**
williamr@4:          * Destructor.
williamr@4:          */
williamr@4:         virtual ~MVPbkContactFieldSelector() { }
williamr@4: 
williamr@4:     };
williamr@4: 
williamr@4: #endif  // MVPBKCONTACTFIELDSELECTOR_H
williamr@4: 
williamr@4: //End of file