1 /*

     2 * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Virtual Phonebook interface for field ordering. 

    15 *                Compares two fields.

    16 *

    17 */

    18 

    19 

    20 #ifndef MVPBKCONTACTFIELDORDERING_H

    21 #define MVPBKCONTACTFIELDORDERING_H

    22 

    23 // INCLUDES

    24 #include <e32cmn.h>

    25 

    26 // FORWARD DECLARATIONS

    27 class MVPbkBaseContactField;

    28 

    29 // CLASS DECLARATIONS

    30 

    31 /**

    32  * Virtual Phonebook Contact field ordering interface.

    33  * This inteface is used for comparing two contact fields, when setting up

    34  * a field ordering.

    35  */

    36 class MVPbkContactFieldOrdering

    37     {

    38     public:

    39         /**

    40          * Returns the relative ordering of two fields.

    41          *

    42          * @param aLhs  Left-hand side of the compare.

    43          * @param aRhs  Right-hand side of the compare.

    44          * @return <0 if aLhs < aRhs, >0 if aLhs > aRhs or 0 if aLhs==aRhs.

    45          */

    46         virtual TInt CompareFields(

    47                 const MVPbkBaseContactField& aLhs, 

    48                 const MVPbkBaseContactField& aRhs) const =0;

    49 

    50         /**

    51          * Returns an extension point for this interface or NULL.

    52          * @param aExtensionUid Uid of extension.

    53          * @return Extension point or NULL.

    54          */

    55         virtual TAny* ContactFieldOrderingExtension(

    56                 TUid /*aExtensionUid*/) { return NULL; }

    57 

    58     protected:

    59         /**

    60          * Destructor.

    61          */

    62         virtual ~MVPbkContactFieldOrdering() { }

    63 

    64     };

    65 

    66 #endif  // MVPBKCONTACTFIELDORDERING_H

    67 

    68 // End of File