1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/textandloc/textandlocutils/sortutil/inc/SortUtil.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,111 @@
     1.4 +/*
     1.5 +* Copyright (c) 2002-2004 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 the License "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:  
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +#ifndef SORTUTIL_H
    1.24 +#define SORTUTIL_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <e32base.h>
    1.28 +
    1.29 +// DATA TYPES
    1.30 +/**
    1.31 + * Type of a sort key.
    1.32 + */
    1.33 +enum TSortKeyType
    1.34 +    {
    1.35 +    /// Basic sort key
    1.36 +    ESortKeyBasic,
    1.37 +    /// Pronounciation sort key
    1.38 +    ESortKeyPronounciation
    1.39 +    };
    1.40 +
    1.41 +// CLASS DECLARATION
    1.42 +
    1.43 +/**
    1.44 + * Sort key. A pair of text and TSortKeyType.
    1.45 + */
    1.46 +class TSortKey
    1.47 +    {
    1.48 +public:
    1.49 +    inline TSortKey(const TDesC& aText, TSortKeyType aType) :
    1.50 +        iText(aText), iType(aType) { }
    1.51 +
    1.52 +    inline const TDesC& Text() const { return iText; }
    1.53 +    inline TSortKeyType Type() const { return iType; }
    1.54 +
    1.55 +private:
    1.56 +    TPtrC iText;
    1.57 +    TSortKeyType iType;
    1.58 +    };
    1.59 +
    1.60 +/**
    1.61 + * An abstract array of TSortKey objects.
    1.62 + */
    1.63 +class MSortKeyArray
    1.64 +    {
    1.65 +public:
    1.66 +    virtual ~MSortKeyArray() { }
    1.67 +    virtual TInt SortKeyCount() const =0;
    1.68 +    virtual TSortKey SortKeyAt(TInt aIndex) const =0;
    1.69 +    };
    1.70 +
    1.71 +
    1.72 +/**
    1.73 + * SortUtil API.
    1.74 + */
    1.75 +class MSortUtil
    1.76 +    {
    1.77 +public:
    1.78 +    /**
    1.79 +     * Compares two MSortKeyArrays.
    1.80 +     * @see MSortKeyArray
    1.81 +     *
    1.82 +     * @param aLhs  the left-hand-side sort key array.
    1.83 +     * @param aRhs  the right-hand-side sort key array.
    1.84 +     * @return  0  if aLhs and aRhs have equal sorting order.
    1.85 +     *         >0  if aLhs is sorted after aRhs
    1.86 +     *         <0  if aLhs is sorted before aRhs.
    1.87 +     */
    1.88 +    virtual TInt CompareItems(const MSortKeyArray& aLhs, const MSortKeyArray& aRhs) const =0;
    1.89 +    };
    1.90 +
    1.91 +/**
    1.92 +* CSortUtil instance gives access to MSortUtil interface.
    1.93 +*/
    1.94 +NONSHARABLE_CLASS(CSortUtil) : public CBase
    1.95 +    {
    1.96 +    public: // Constructors and destructor
    1.97 +        IMPORT_C static CSortUtil* NewL();
    1.98 +        ~CSortUtil();
    1.99 +
   1.100 +    public: // New functions
   1.101 +        MSortUtil* Interface() {return iInterface;}
   1.102 +
   1.103 +    private: // Private constructors
   1.104 +        CSortUtil();
   1.105 +        void ConstructL();
   1.106 +
   1.107 +    private: // Data
   1.108 +        MSortUtil* iInterface;
   1.109 +        RLibrary iLib;
   1.110 +    };
   1.111 +
   1.112 +#endif // SORTUTIL_H
   1.113 +
   1.114 +// End of File