#include <cntviewfindconfig.h>
| class CContactViewFindConfigInterface : public CBase, public CBase |
| Public Member Functions | |
|---|---|
| virtual | ~CContactViewFindConfigInterface() |
| pure virtual void | Close() |
| pure virtual TBool | IsWordValidForMatching(const TDesC &) |
| pure virtual TBool | Match(const TDesC &, const TDesC &) |
| pure virtual TBool | MatchRefineL(const TDesC &, const TDesC &) |
| CContactViewFindConfigInterface * | NewL(TUid) |
| pure virtual void | OpenL() |
An interface class that enables implementers to configure the way in which words are matched in CContactViewBase::ContactsMatchingCriteriaL() and CContactViewBase::ContactsMatchingPrefixL().
By default these two functions use TDesC16::MatchC() to do the matching, but where this is not appropriate, for instance in Chinese locales, a plug-in that implements this interface should be supplied. The plug-in's UID should be passed to CContactViewBase::SetViewFindConfigPlugin(), then the plug-in will be loaded when ContactsMatchingCriteriaL() or ContactsMatchingPrefixL() is called. Note that the plug-in is only loaded once per view, not each time a find is requested. Note also that the plug-in is optional. If no plug-in is supplied, TDesC16::MatchC() is used instead.
| ~CContactViewFindConfigInterface | ( | ) | [inline, virtual] |
Virtual destructor.
| void | Close | ( | ) | [pure virtual] |
May be used by the implementor of the interface to provide destruction-like behaviour.
For example, it might be used to close a connection to a predictive text input database, or might be used for reference counting of shared objects (using TLS to store the data).
Tests whether a specified word is valid to be matched by the plug-in's implementation of Match().
For instance, in an implementation for a Chinese locale, this function would return EFalse for non-Chinese words.
Any words that are not valid to be matched by the plug-in will be matched using TDesC16::MatchC() instead.
| Parameters | |
|---|---|
| aWord | The word to be checked. Note that it contains a '*' wildcard character at the end and optionally one at the beginning, depending on whether ContactsMatchingCriteriaL() or ContactsMatchingPrefixL() was called. |
Searches for a string with wildcards in a single field in a contact item.
| Parameters | |
|---|---|
| aContactsField | The contents of the contact item field to search. |
| aWord | The string to search for in aContactsField. Note that it contains a '*' wildcard character at the end and optionally one at the beginning, depending on whether ContactsMatchingCriteriaL() or ContactsMatchingPrefixL() was called. |
An optimisation function that may be used to implement incremental find, i.e. involving only the results of a previous search, rather than the entire view.
This function is not called in v7.0s, but is provided for possible future use.
| Parameters | |
|---|---|
| aItemString | The string that is being searched. |
| aSearchText | The string to search for. |
| CContactViewFindConfigInterface * | NewL | ( | TUid | aImplementationUid | ) | [static, inline] |
Allocates and constructs an instance of the plug-in interface.
| Parameters | |
|---|---|
| aImplementationUid | The UID of the find configuration implementation to instantiate. |
| void | OpenL | ( | ) | [pure virtual] |
May be used by the implementor of the interface to provide construction-like behaviour.
For example, it might be used to open a connection to a predictive text input database, or might be used for reference counting of shared objects (using TLS to store the data).