| author | sl |
| Tue, 10 Jun 2014 14:32:02 +0200 | |
| changeset 1 | 260cb5ec6c19 |
| permissions | -rw-r--r-- |
| sl@0 | 1 |
/* |
| sl@0 | 2 |
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies). |
| sl@0 | 3 |
* All rights reserved. |
| sl@0 | 4 |
* This component and the accompanying materials are made available |
| sl@0 | 5 |
* under the terms of the License "Eclipse Public License v1.0" |
| sl@0 | 6 |
* which accompanies this distribution, and is available |
| sl@0 | 7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
| sl@0 | 8 |
* |
| sl@0 | 9 |
* Initial Contributors: |
| sl@0 | 10 |
* Nokia Corporation - initial contribution. |
| sl@0 | 11 |
* |
| sl@0 | 12 |
* Contributors: |
| sl@0 | 13 |
* |
| sl@0 | 14 |
* Description: |
| sl@0 | 15 |
* |
| sl@0 | 16 |
*/ |
| sl@0 | 17 |
|
| sl@0 | 18 |
|
| sl@0 | 19 |
|
| sl@0 | 20 |
#ifndef SORTUTIL_H |
| sl@0 | 21 |
#define SORTUTIL_H |
| sl@0 | 22 |
|
| sl@0 | 23 |
// INCLUDES |
| sl@0 | 24 |
#include <e32base.h> |
| sl@0 | 25 |
|
| sl@0 | 26 |
// DATA TYPES |
| sl@0 | 27 |
/** |
| sl@0 | 28 |
* Type of a sort key. |
| sl@0 | 29 |
*/ |
| sl@0 | 30 |
enum TSortKeyType |
| sl@0 | 31 |
{
|
| sl@0 | 32 |
/// Basic sort key |
| sl@0 | 33 |
ESortKeyBasic, |
| sl@0 | 34 |
/// Pronounciation sort key |
| sl@0 | 35 |
ESortKeyPronounciation |
| sl@0 | 36 |
}; |
| sl@0 | 37 |
|
| sl@0 | 38 |
// CLASS DECLARATION |
| sl@0 | 39 |
|
| sl@0 | 40 |
/** |
| sl@0 | 41 |
* Sort key. A pair of text and TSortKeyType. |
| sl@0 | 42 |
*/ |
| sl@0 | 43 |
class TSortKey |
| sl@0 | 44 |
{
|
| sl@0 | 45 |
public: |
| sl@0 | 46 |
inline TSortKey(const TDesC& aText, TSortKeyType aType) : |
| sl@0 | 47 |
iText(aText), iType(aType) { }
|
| sl@0 | 48 |
|
| sl@0 | 49 |
inline const TDesC& Text() const { return iText; }
|
| sl@0 | 50 |
inline TSortKeyType Type() const { return iType; }
|
| sl@0 | 51 |
|
| sl@0 | 52 |
private: |
| sl@0 | 53 |
TPtrC iText; |
| sl@0 | 54 |
TSortKeyType iType; |
| sl@0 | 55 |
}; |
| sl@0 | 56 |
|
| sl@0 | 57 |
/** |
| sl@0 | 58 |
* An abstract array of TSortKey objects. |
| sl@0 | 59 |
*/ |
| sl@0 | 60 |
class MSortKeyArray |
| sl@0 | 61 |
{
|
| sl@0 | 62 |
public: |
| sl@0 | 63 |
virtual ~MSortKeyArray() { }
|
| sl@0 | 64 |
virtual TInt SortKeyCount() const =0; |
| sl@0 | 65 |
virtual TSortKey SortKeyAt(TInt aIndex) const =0; |
| sl@0 | 66 |
}; |
| sl@0 | 67 |
|
| sl@0 | 68 |
|
| sl@0 | 69 |
/** |
| sl@0 | 70 |
* SortUtil API. |
| sl@0 | 71 |
*/ |
| sl@0 | 72 |
class MSortUtil |
| sl@0 | 73 |
{
|
| sl@0 | 74 |
public: |
| sl@0 | 75 |
/** |
| sl@0 | 76 |
* Compares two MSortKeyArrays. |
| sl@0 | 77 |
* @see MSortKeyArray |
| sl@0 | 78 |
* |
| sl@0 | 79 |
* @param aLhs the left-hand-side sort key array. |
| sl@0 | 80 |
* @param aRhs the right-hand-side sort key array. |
| sl@0 | 81 |
* @return 0 if aLhs and aRhs have equal sorting order. |
| sl@0 | 82 |
* >0 if aLhs is sorted after aRhs |
| sl@0 | 83 |
* <0 if aLhs is sorted before aRhs. |
| sl@0 | 84 |
*/ |
| sl@0 | 85 |
virtual TInt CompareItems(const MSortKeyArray& aLhs, const MSortKeyArray& aRhs) const =0; |
| sl@0 | 86 |
}; |
| sl@0 | 87 |
|
| sl@0 | 88 |
/** |
| sl@0 | 89 |
* CSortUtil instance gives access to MSortUtil interface. |
| sl@0 | 90 |
*/ |
| sl@0 | 91 |
NONSHARABLE_CLASS(CSortUtil) : public CBase |
| sl@0 | 92 |
{
|
| sl@0 | 93 |
public: // Constructors and destructor |
| sl@0 | 94 |
IMPORT_C static CSortUtil* NewL(); |
| sl@0 | 95 |
~CSortUtil(); |
| sl@0 | 96 |
|
| sl@0 | 97 |
public: // New functions |
| sl@0 | 98 |
MSortUtil* Interface() {return iInterface;}
|
| sl@0 | 99 |
|
| sl@0 | 100 |
private: // Private constructors |
| sl@0 | 101 |
CSortUtil(); |
| sl@0 | 102 |
void ConstructL(); |
| sl@0 | 103 |
|
| sl@0 | 104 |
private: // Data |
| sl@0 | 105 |
MSortUtil* iInterface; |
| sl@0 | 106 |
RLibrary iLib; |
| sl@0 | 107 |
}; |
| sl@0 | 108 |
|
| sl@0 | 109 |
#endif // SORTUTIL_H |
| sl@0 | 110 |
|
| sl@0 | 111 |
// End of File |