Item Finder API

From Forum Nokia Wiki

Reviewer Approved

Note!
This API is not part of the public SDK. It can be found in the SDK API Plug-in.

APIPurpose

Plugin utility used for automatic tags ( http, email, phone numbers )

Header:

#include <aknitemfinder.h>

Note!
In series 60 5th edition extensions plug-in, the API is changed to CItemFinder and the same can be located at epoc32\include\itemfinder.h

Use cases

The CAKnItemFinder class provides the functionality of highlighting, selecting and retrieving items like phone number, URL, http address in text viewer editors.

Example code

iAutoFinder = CAknItemFinder::NewL(); 
//Must be called before editor creation in order to have effect
iAutoFinder->SetFindModeL(CAknItemFinder::EPhoneNumber |
                          CAknItemFinder::EUrlAddress |
                          CAknItemFinder::EEmailAddress );
 
iAutoFinder->SetEditor((CEikRichTextEditor**)&iDialText); // iDial is any editor.

The following code is used to scroll down for the found items through the editor

TBool iReturn = iAutoFinder->NextItemOrScrollL( CAknItemFinder::ENextDown );

The following code is used to retrieve the selected item.

HBufC* iBuff = iAutoFinder->CurrentItem().iItemDescriptor;

Sample Application

Item finder example

Community: Wiki