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