uiutils/Findutil/inc/FindUtilThai.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 /*
       
     2 * Copyright (c) 2002-2004 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:         Thai Find Utilities header file. 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 
       
    26 #ifndef __FINDUTILTHAI__
       
    27 #define __FINDUTILTHAI__
       
    28 
       
    29 #include <e32std.h>
       
    30 #include "FindUtilBase.h"
       
    31 
       
    32 // Factory function at first ordinal
       
    33 IMPORT_C MFindUtil* FindUtilFactoryFunctionL();
       
    34 
       
    35 NONSHARABLE_CLASS(CFindUtilThai) : public CFindUtilBase
       
    36     {
       
    37     public:  // Constructors and destructor
       
    38         /**
       
    39          * C++ default constructor.
       
    40          */
       
    41         CFindUtilThai();
       
    42 
       
    43         /**
       
    44          * Destructor.
       
    45          */
       
    46         virtual ~CFindUtilThai();
       
    47 
       
    48     private:  // From MFindUtil
       
    49         /**
       
    50          * From MFindUtil It tests a matching.
       
    51          * @since 2.6
       
    52          * @param aContactsField is a contact field string.
       
    53          * @param aWord is a search string.
       
    54          * @return If aWord has been matched with aContactsField, 
       
    55          *         ETrue is returned.
       
    56          */
       
    57         TBool Match(const TDesC& aContactsField, const TDesC& aWord);
       
    58 
       
    59         /**
       
    60          * From MFindUtil It tests a partial matching.
       
    61          * @since 2.6
       
    62          * @param aItemString is a Contact field string
       
    63          * @param aSearchText is a search string
       
    64          * @return If aSearchText has been found in aItemString, 
       
    65          *         ETrue is returned.
       
    66          */
       
    67         TBool MatchRefineL( const TDesC& aItemString, const TDesC &aSearchText);
       
    68 
       
    69         /**
       
    70          * From MFindUtil It checks whether aWord is valid.
       
    71          * @since 2.6
       
    72          * @param aWord 
       
    73          * @return ETrue is returned always.
       
    74          */
       
    75         TBool IsWordValidForMatching(const TDesC& aWord);
       
    76 	
       
    77         /**
       
    78          * From MFindUtil It tests a partial matching.
       
    79          * @since 5.0
       
    80          * @param aItemString is a field string
       
    81          * @param aSearchText is a search string
       
    82          * @param aNextChars is a reference to buffer where next possible characters are saved. 
       
    83          *        The HBufC buffer may be re-allocated by this method. 
       
    84          *        In that case the pointer reference is modified to point to the re-allocated object.                              
       
    85          * @return If aSearchText has been found in aItemString, 
       
    86          *         ETrue is returned.
       
    87          */
       
    88         TBool MatchAdaptiveRefineL( const TDesC& aItemString, 
       
    89         							const TDesC& aSearchText, 
       
    90         							HBufC*& aNextChars);
       
    91 									
       
    92         /**
       
    93          * From MFindUtil
       
    94          * Current input text is handled by this model 
       
    95          *
       
    96          * @since S60 v3.2.3
       
    97          * @param aItemString Reference to the searching target
       
    98          * @param aSearchText Reference to text in find pane
       
    99          * @param aPolicy Reference to identify the different match policy
       
   100          * @param aConverter Reference to the converter interface, with which the aSearchText 
       
   101          *  will be converted into other kind of str, such numeric string according to
       
   102          *  the ITUT keyboard key map
       
   103          * @return ETrue for handling by this model; otherwise EFalse
       
   104          */
       
   105         virtual TBool MatchRefineL( const TDesC& aItemString, const TDesC& aSearchText, 
       
   106                                     TMatchPolicy aPolicy, MFindStringConverter* aConverter);									
       
   107     };
       
   108 
       
   109 
       
   110 #endif // __FINDUTILTHAI__
       
   111 
       
   112 // End of File