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 interface for field ordering. 
williamr@4: *                Compares two fields.
williamr@4: *
williamr@4: */
williamr@4: 
williamr@4: 
williamr@4: #ifndef MVPBKCONTACTFIELDORDERING_H
williamr@4: #define MVPBKCONTACTFIELDORDERING_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 ordering interface.
williamr@4:  * This inteface is used for comparing two contact fields, when setting up
williamr@4:  * a field ordering.
williamr@4:  */
williamr@4: class MVPbkContactFieldOrdering
williamr@4:     {
williamr@4:     public:
williamr@4:         /**
williamr@4:          * Returns the relative ordering of two fields.
williamr@4:          *
williamr@4:          * @param aLhs  Left-hand side of the compare.
williamr@4:          * @param aRhs  Right-hand side of the compare.
williamr@4:          * @return <0 if aLhs < aRhs, >0 if aLhs > aRhs or 0 if aLhs==aRhs.
williamr@4:          */
williamr@4:         virtual TInt CompareFields(
williamr@4:                 const MVPbkBaseContactField& aLhs, 
williamr@4:                 const MVPbkBaseContactField& aRhs) 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* ContactFieldOrderingExtension(
williamr@4:                 TUid /*aExtensionUid*/) { return NULL; }
williamr@4: 
williamr@4:     protected:
williamr@4:         /**
williamr@4:          * Destructor.
williamr@4:          */
williamr@4:         virtual ~MVPbkContactFieldOrdering() { }
williamr@4: 
williamr@4:     };
williamr@4: 
williamr@4: #endif  // MVPBKCONTACTFIELDORDERING_H
williamr@4: 
williamr@4: // End of File