classicui_plat/findutil_api/inc/FindUtil.h
author hgs
Wed, 23 Jun 2010 05:40:10 +0800
changeset 33 b3425bf29f82
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef __FINDUTIL_H__
hgs
parents:
diff changeset
    21
#define __FINDUTIL_H__
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#include <e32base.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
/**
hgs
parents:
diff changeset
    26
* Identify the match policy for FindUtil API
hgs
parents:
diff changeset
    27
*/
hgs
parents:
diff changeset
    28
enum TMatchPolicy
hgs
parents:
diff changeset
    29
{
hgs
parents:
diff changeset
    30
    EDefault,
hgs
parents:
diff changeset
    31
    ECustomConverter
hgs
parents:
diff changeset
    32
};
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
/**
hgs
parents:
diff changeset
    35
* Interface for the conversion of find string
hgs
parents:
diff changeset
    36
*/
hgs
parents:
diff changeset
    37
class MFindStringConverter
hgs
parents:
diff changeset
    38
    {
hgs
parents:
diff changeset
    39
public:
hgs
parents:
diff changeset
    40
    virtual void Converter(const TDesC& aSourStr, TDes& aDestStr) = 0;
hgs
parents:
diff changeset
    41
    };
hgs
parents:
diff changeset
    42
    
hgs
parents:
diff changeset
    43
/**
hgs
parents:
diff changeset
    44
* FindUtil API
hgs
parents:
diff changeset
    45
*/
hgs
parents:
diff changeset
    46
class MFindUtil
hgs
parents:
diff changeset
    47
	{
hgs
parents:
diff changeset
    48
public:
hgs
parents:
diff changeset
    49
	virtual TBool Match(const TDesC& aContactsField, const TDesC& aWord) = 0;
hgs
parents:
diff changeset
    50
	virtual TBool MatchRefineL( const TDesC& aItemString, const TDesC &aSearchText) = 0;
hgs
parents:
diff changeset
    51
	virtual TBool IsWordValidForMatching(const TDesC& aWord) = 0;
hgs
parents:
diff changeset
    52
	virtual TBool MatchAdaptiveRefineL( const TDesC& aItemString, const TDesC &aSearchText, HBufC*& aNextChars ) = 0;	
hgs
parents:
diff changeset
    53
	virtual TBool MatchRefineL( const TDesC& aItemString, const TDesC& aSearchText, 
hgs
parents:
diff changeset
    54
                                TMatchPolicy aPolicy, MFindStringConverter* aConverter) = 0;
hgs
parents:
diff changeset
    55
	};
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
/**
hgs
parents:
diff changeset
    58
* CFindUtil instance gives access to MFindUtil interface.
hgs
parents:
diff changeset
    59
*/
hgs
parents:
diff changeset
    60
NONSHARABLE_CLASS(CFindUtil) : public CBase
hgs
parents:
diff changeset
    61
    {
hgs
parents:
diff changeset
    62
    public: // Constructors and destructor
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
        /**
hgs
parents:
diff changeset
    65
        * Creates a new CFindUtil instance.
hgs
parents:
diff changeset
    66
        * In those language variants, where FindUtil is not used,
hgs
parents:
diff changeset
    67
        * this method returns NULL.
hgs
parents:
diff changeset
    68
        */
hgs
parents:
diff changeset
    69
        IMPORT_C static CFindUtil* NewL();
hgs
parents:
diff changeset
    70
        IMPORT_C ~CFindUtil();
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
    public: // New functions
hgs
parents:
diff changeset
    73
        MFindUtil* Interface() {return iInterface;}
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
    private: // Private constructors
hgs
parents:
diff changeset
    76
        CFindUtil();
hgs
parents:
diff changeset
    77
        void ConstructL();
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
    private: // Data
hgs
parents:
diff changeset
    80
        MFindUtil* iInterface;
hgs
parents:
diff changeset
    81
        RLibrary iLib;
hgs
parents:
diff changeset
    82
    };
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
#endif