epoc32/include/app/MVPbkContactSelector.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkContactSelector.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,63 @@
     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 contact selector interface for a 
    1.18 +*                filtered view, CVPbkFilteredContactView .
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 + 
    1.23 +#ifndef MVPBKCONTACTSELECTOR_H
    1.24 +#define MVPBKCONTACTSELECTOR_H
    1.25 +
    1.26 +// INCLUDES
    1.27 +#include <e32cmn.h>
    1.28 +
    1.29 +// FORWARD DECLARATIONS
    1.30 +class MVPbkBaseContact;
    1.31 +
    1.32 +// CLASS DECLARATIONS
    1.33 +
    1.34 +/**
    1.35 + * Virtual Phonebook contact selector interface.
    1.36 + * This inteface is used to create a contact selector object,
    1.37 + */
    1.38 +class MVPbkContactSelector
    1.39 +    {
    1.40 +    public: // Interface
    1.41 +        /**
    1.42 +         * Returns true if aContact belongs to the set defined
    1.43 +         * by this contact selector.
    1.44 +         *
    1.45 +         * @param aContact  The contact to check.
    1.46 +         * @return  ETrue if contact is included.
    1.47 +         */
    1.48 +        virtual TBool IsContactIncluded(
    1.49 +                const MVPbkBaseContact& aContact ) = 0;
    1.50 +    
    1.51 +        /**
    1.52 +         * Returns an extension point for this interface or NULL.
    1.53 +         * @param aExtensionUid Uid of extension.
    1.54 +         * @return Extension point or NULL.
    1.55 +         */
    1.56 +        virtual TAny* ContactSelectorExtension(
    1.57 +                TUid /*aExtensionUid*/) { return NULL; }
    1.58 +
    1.59 +    protected:
    1.60 +        virtual ~MVPbkContactSelector() { }
    1.61 +
    1.62 +    };
    1.63 +
    1.64 +#endif  // MVPBKCONTACTSELECTOR_H
    1.65 +
    1.66 +//End of file