epoc32/include/app/MVPbkContactFieldSelector.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkContactFieldSelector.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,71 @@
     1.4 +/*
     1.5 +* Copyright (c) 2002-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:  Virtual Phonebook field selector interface needed 
    1.18 +*                by e.g. CVPbkFieldFilter.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef MVPBKCONTACTFIELDSELECTOR_H
    1.24 +#define MVPBKCONTACTFIELDSELECTOR_H
    1.25 +
    1.26 +// INCLUDES
    1.27 +#include <e32cmn.h>
    1.28 +
    1.29 +// FORWARD DECLARATIONS
    1.30 +class MVPbkBaseContactField;
    1.31 +
    1.32 +// CLASS DECLARATIONS
    1.33 +
    1.34 +/**
    1.35 + * Virtual Phonebook Contact field selector interface.
    1.36 + * This interface can be used to create a selection object, which
    1.37 + * can determine which fields belong to the set criteria.
    1.38 + */
    1.39 +class MVPbkContactFieldSelector
    1.40 +    {
    1.41 +    public:
    1.42 +        /**
    1.43 +         * Returns true if aField belongs to the set defined by this field
    1.44 +         * selector.
    1.45 +         * 
    1.46 +         * In case field is an IMPP field service name is compared to 
    1.47 +         * existing service installations. Only matched IMPP service
    1.48 +         * providers are included.
    1.49 +         * 
    1.50 +         * @param aField    Contact field to check againt criteria.
    1.51 +         * @return ETrue if the field is included in the set.
    1.52 +         */
    1.53 +        virtual TBool IsFieldIncluded(
    1.54 +                const MVPbkBaseContactField& aField) const =0;
    1.55 +    
    1.56 +        /**
    1.57 +         * Returns an extension point for this interface or NULL.
    1.58 +         * @param aExtensionUid Uid of extension
    1.59 +         * @return Extension point or NULL
    1.60 +         */
    1.61 +        virtual TAny* ContactFieldSelectorExtension(
    1.62 +                TUid /*aExtensionUid*/) { return NULL; }
    1.63 +
    1.64 +    protected:
    1.65 +        /**
    1.66 +         * Destructor.
    1.67 +         */
    1.68 +        virtual ~MVPbkContactFieldSelector() { }
    1.69 +
    1.70 +    };
    1.71 +
    1.72 +#endif  // MVPBKCONTACTFIELDSELECTOR_H
    1.73 +
    1.74 +//End of file