epoc32/include/app/MVPbkContactFieldOrdering.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkContactFieldOrdering.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,68 @@
     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 interface for field ordering. 
    1.18 +*                Compares two fields.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef MVPBKCONTACTFIELDORDERING_H
    1.24 +#define MVPBKCONTACTFIELDORDERING_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 ordering interface.
    1.36 + * This inteface is used for comparing two contact fields, when setting up
    1.37 + * a field ordering.
    1.38 + */
    1.39 +class MVPbkContactFieldOrdering
    1.40 +    {
    1.41 +    public:
    1.42 +        /**
    1.43 +         * Returns the relative ordering of two fields.
    1.44 +         *
    1.45 +         * @param aLhs  Left-hand side of the compare.
    1.46 +         * @param aRhs  Right-hand side of the compare.
    1.47 +         * @return <0 if aLhs < aRhs, >0 if aLhs > aRhs or 0 if aLhs==aRhs.
    1.48 +         */
    1.49 +        virtual TInt CompareFields(
    1.50 +                const MVPbkBaseContactField& aLhs, 
    1.51 +                const MVPbkBaseContactField& aRhs) const =0;
    1.52 +
    1.53 +        /**
    1.54 +         * Returns an extension point for this interface or NULL.
    1.55 +         * @param aExtensionUid Uid of extension.
    1.56 +         * @return Extension point or NULL.
    1.57 +         */
    1.58 +        virtual TAny* ContactFieldOrderingExtension(
    1.59 +                TUid /*aExtensionUid*/) { return NULL; }
    1.60 +
    1.61 +    protected:
    1.62 +        /**
    1.63 +         * Destructor.
    1.64 +         */
    1.65 +        virtual ~MVPbkContactFieldOrdering() { }
    1.66 +
    1.67 +    };
    1.68 +
    1.69 +#endif  // MVPBKCONTACTFIELDORDERING_H
    1.70 +
    1.71 +// End of File