sl@0: /*
sl@0: * Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies). 
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of the License "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:  
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: 
sl@0: #ifndef SORTUTIL_H
sl@0: #define SORTUTIL_H
sl@0: 
sl@0: //  INCLUDES
sl@0: #include <e32base.h>
sl@0: 
sl@0: // DATA TYPES
sl@0: /**
sl@0:  * Type of a sort key.
sl@0:  */
sl@0: enum TSortKeyType
sl@0:     {
sl@0:     /// Basic sort key
sl@0:     ESortKeyBasic,
sl@0:     /// Pronounciation sort key
sl@0:     ESortKeyPronounciation
sl@0:     };
sl@0: 
sl@0: // CLASS DECLARATION
sl@0: 
sl@0: /**
sl@0:  * Sort key. A pair of text and TSortKeyType.
sl@0:  */
sl@0: class TSortKey
sl@0:     {
sl@0: public:
sl@0:     inline TSortKey(const TDesC& aText, TSortKeyType aType) :
sl@0:         iText(aText), iType(aType) { }
sl@0: 
sl@0:     inline const TDesC& Text() const { return iText; }
sl@0:     inline TSortKeyType Type() const { return iType; }
sl@0: 
sl@0: private:
sl@0:     TPtrC iText;
sl@0:     TSortKeyType iType;
sl@0:     };
sl@0: 
sl@0: /**
sl@0:  * An abstract array of TSortKey objects.
sl@0:  */
sl@0: class MSortKeyArray
sl@0:     {
sl@0: public:
sl@0:     virtual ~MSortKeyArray() { }
sl@0:     virtual TInt SortKeyCount() const =0;
sl@0:     virtual TSortKey SortKeyAt(TInt aIndex) const =0;
sl@0:     };
sl@0: 
sl@0: 
sl@0: /**
sl@0:  * SortUtil API.
sl@0:  */
sl@0: class MSortUtil
sl@0:     {
sl@0: public:
sl@0:     /**
sl@0:      * Compares two MSortKeyArrays.
sl@0:      * @see MSortKeyArray
sl@0:      *
sl@0:      * @param aLhs  the left-hand-side sort key array.
sl@0:      * @param aRhs  the right-hand-side sort key array.
sl@0:      * @return  0  if aLhs and aRhs have equal sorting order.
sl@0:      *         >0  if aLhs is sorted after aRhs
sl@0:      *         <0  if aLhs is sorted before aRhs.
sl@0:      */
sl@0:     virtual TInt CompareItems(const MSortKeyArray& aLhs, const MSortKeyArray& aRhs) const =0;
sl@0:     };
sl@0: 
sl@0: /**
sl@0: * CSortUtil instance gives access to MSortUtil interface.
sl@0: */
sl@0: NONSHARABLE_CLASS(CSortUtil) : public CBase
sl@0:     {
sl@0:     public: // Constructors and destructor
sl@0:         IMPORT_C static CSortUtil* NewL();
sl@0:         ~CSortUtil();
sl@0: 
sl@0:     public: // New functions
sl@0:         MSortUtil* Interface() {return iInterface;}
sl@0: 
sl@0:     private: // Private constructors
sl@0:         CSortUtil();
sl@0:         void ConstructL();
sl@0: 
sl@0:     private: // Data
sl@0:         MSortUtil* iInterface;
sl@0:         RLibrary iLib;
sl@0:     };
sl@0: 
sl@0: #endif // SORTUTIL_H
sl@0: 
sl@0: // End of File