AknFind Class Reference

Link against: avkon.lib eikcore.lib

Capability Information

Required Capabilities

None

#include <AknUtils.h>

Detailed Description

This class implements find requirements from component specifications.

This class works also as documentation of how to use different find components. (The implementation has been copied from the example application which implements find and replaced the code with calls to these static functions).

There is no reason for an application to use this class directly. Application should use CAknSelectionListDialog instead. This class is public only because sometimes it is necessary to access the low level behaviour of find to implement similar functionality in places independent of find; or if CAknSelectionListDialog is not used for some reason.


Static Public Member Functions
static IMPORT_C void  HandleFindPopupProcessCommandL (TInt aCommand, CEikListBox *aListBox, CAknSearchField *aSearchField, CCoeControl *aParentControl)
static IMPORT_C TKeyResponse  HandleFindOfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType, CCoeControl *aListBoxParent, CEikListBox *aListBox, CAknSearchField *aSearchField, TBool isFindPopup, TBool &aNeedRefresh)
static IMPORT_C void  HandleFindSizeChanged (CCoeControl *aParentControl, CEikListBox *aListBox, CAknSearchField *aSearchField, TBool ispopup=ETrue, TInt aFindWindowResourceId=R_AVKON_POPUP_FIND_WINDOW, TInt aListAreaId=R_AVKON_LIST_GEN_PANE, TInt aListResourceIdWithFindPopup=R_AVKON_LIST_GEN_PANE_WITH_FIND_POPUP, TInt aFindWindowParentResourceId=R_AVKON_MAIN_PANE_WITH_STATUS_PANE)
static IMPORT_C void  HandleFixedFindSizeChanged (CCoeControl *aParentControl, CAknColumnListBox *aListBox, CAknSearchField *aSearchField)
  This is the new typesafe (and easier to use) version of HandleFindSizeChanged().
static IMPORT_C void  HandlePopupFindSizeChanged (CCoeControl *aParentControl, CEikListBox *aListBox, CAknSearchField *aSearchField)
  This is the new typesafe(and easier to use) version of HandleFindSizeChanged().
static IMPORT_C void  HandleFindSizeChangedLayouts (CCoeControl *aParentControl, CEikListBox *aListBox, CAknSearchField *aSearchField, const TAknWindowLineLayout &aFindWindow, const TAknWindowLineLayout &aListArea, TBool aIsPopup, const TAknWindowLineLayout &aFindWindowParent)
  Creates layout for a find pane and for a list.
static IMPORT_C TBool  IsFindMatch (const TDesC &aItemText, const TDesC &aSearchText)
  Checks if aItemText matches aSearchText.
static IMPORT_C TBool  IsFindWordSeparator (TChar aCh)
  Tests if aCh is a word separator character as described in S60.
static IMPORT_C TBool  IsAdaptiveFindMatch (const TDesC &aItemText, const TDesC &aSearchText, HBufC *&aNextChars)
  Checks if aItemText matches aSearchText.
static void  UpdateNextCharsL (HBufC *&aNextChars, TChar aCh)
  Update next characters if find pane state was changed.
static void  UpdateNextCharsL (HBufC *&aNextChars, const TDesC &aItemString)
  For Devanagari adaptive search Update next characters if find pane state was changed.
static IMPORT_C void  UpdateNextCharsFromString (HBufC *&aNextChars, const TDesC &aItemString)
  Update next chars from the list box item text, when search field if empty.
static IMPORT_C void  UpdateItemTextAccordingToFlag (const TDesC &aInputText, TBitFlags32 aColumnFlag, TDes &aOutText)
  Update next chars from the list box item text according to the bitflag.
static void  HandleFindPaneVisibility (CAknSearchField *aSearchField, TBool ispopup, TBool textchanged, TBool &aNeedRefresh)
  Helper function to handle find pane's visibility.

Member Function Documentation

static IMPORT_C TKeyResponse AknFind::HandleFindOfferKeyEventL (  const TKeyEvent &  aKeyEvent,
TEventCode  aType,
CCoeControl *  aListBoxParent,
CEikListBox *  aListBox,
CAknSearchField *  aSearchField,
TBool  isFindPopup,
TBool &  aNeedRefresh
)  [static]
 
static void AknFind::HandleFindPaneVisibility (  CAknSearchField *  aSearchField,
TBool  ispopup,
TBool  textchanged,
TBool &  aNeedRefresh
)  [static]
 

Helper function to handle find pane's visibility.

Parameters:
aSearchField  Pointer to search field control.
ispopup  ETrue if popup find pane, EFalse if normal find pane.
textchanged  ETrue when text in CAknSearchField has changed.
aNeedRefresh  ETrue when find pane is redrawn.
static IMPORT_C void AknFind::HandleFindPopupProcessCommandL (  TInt  aCommand,
CEikListBox *  aListBox,
CAknSearchField *  aSearchField,
CCoeControl *  aParentControl
)  [static]
 
static IMPORT_C void AknFind::HandleFindSizeChanged (  CCoeControl *  aParentControl,
CEikListBox *  aListBox,
CAknSearchField *  aSearchField,
TBool  ispopup = ETrue,
TInt  aFindWindowResourceId = R_AVKON_POPUP_FIND_WINDOW,
TInt  aListAreaId = R_AVKON_LIST_GEN_PANE,
TInt  aListResourceIdWithFindPopup = R_AVKON_LIST_GEN_PANE_WITH_FIND_POPUP,
TInt  aFindWindowParentResourceId = R_AVKON_MAIN_PANE_WITH_STATUS_PANE
)  [static]
 
static IMPORT_C void AknFind::HandleFindSizeChangedLayouts (  CCoeControl *  aParentControl,
CEikListBox *  aListBox,
CAknSearchField *  aSearchField,
const TAknWindowLineLayout &  aFindWindow,
const TAknWindowLineLayout &  aListArea,
TBool  aIsPopup,
const TAknWindowLineLayout &  aFindWindowParent
)  [static]
 

Creates layout for a find pane and for a list.

This method must be called in SizeChanged() method of an container.

Since:
2.6
Parameters:
aParentControl  Parent control.
aListBox  Pointer to listbox control.
aSearchField  Pointer to search field control.
aFindWindow  LAF specific table line for find window.
aListArea  LAF specific table for list box area.
aIsPopup  ETrue if popup find pane, EFalse if normal find pane.
aFindWindowParent  LAF specific table line for find parent.
static IMPORT_C void AknFind::HandleFixedFindSizeChanged (  CCoeControl *  aParentControl,
CAknColumnListBox *  aListBox,
CAknSearchField *  aSearchField
)  [static]
 

This is the new typesafe (and easier to use) version of HandleFindSizeChanged().

Use this instead of (deprecated) HandleFindSizeChanged().

Parameters:
aParentControl  Parent control.
aListBox  Column list, optional and available only with column lists.
aSearchField  Pointer to search field control.
static IMPORT_C void AknFind::HandlePopupFindSizeChanged (  CCoeControl *  aParentControl,
CEikListBox *  aListBox,
CAknSearchField *  aSearchField
)  [static]
 

This is the new typesafe(and easier to use) version of HandleFindSizeChanged().

Use this instead of (deprecated) HandleFindSizeChanged().

Parameters:
aParentControl  Parent control.
aListBox  Pointer to listbox control.
aSearchField  Pointer to search field control.
static IMPORT_C TBool AknFind::IsAdaptiveFindMatch (  const TDesC &  aItemText,
const TDesC &  aSearchText,
HBufC *&  aNextChars
)  [static]
 

Checks if aItemText matches aSearchText.

Calls UpdateNextCharsL() if findutil is not supported.

Since:
5.0
Parameters:
aItemText  List box item text.
aSearchText  Searched text.
aNextChars  Reference to the next characters for the adaptive search grid The HBufC buffer may be re-allocated by this method. In that case the pointer reference is modified to point to the re-allocated object.
Returns:
ETrue if list box item text aItemText matches aSearchText otherwise EFalse.
static IMPORT_C TBool AknFind::IsFindMatch (  const TDesC &  aItemText,
const TDesC &  aSearchText
)  [static]
 

Checks if aItemText matches aSearchText.

Parameters:
aItemText  List box item text.
aSearchText  Searched text.
Returns:
ETrue if list box item text aItemText matches aSearchText otherwise EFalse.
static IMPORT_C TBool AknFind::IsFindWordSeparator (  TChar  aCh  )  [static]
 

Tests if aCh is a word separator character as described in S60.

Parameters:
aCh  Comperative character.
Returns:
ETrue if aCh is a word separator character as described in S60 otherwise EFalse.
static IMPORT_C void AknFind::UpdateItemTextAccordingToFlag (  const TDesC &  aInputText,
TBitFlags32  aColumnFlag,
TDes &  aOutText
)  [static]
 

Update next chars from the list box item text according to the bitflag.

Use to exclude columns from the listbox string. For example icon index columns.

Since:
5.0
Parameters:
aInputText  List box item text
aColumnFlag  The bit flag shows which columns take into account
aOutText  Updated list box item text accoding to bit flag
static IMPORT_C void AknFind::UpdateNextCharsFromString (  HBufC *&  aNextChars,
const TDesC &  aItemString
)  [static]
 

Update next chars from the list box item text, when search field if empty.

This need to be done for update next characters for adaptive grid works faster then calling IsAdaptiveFindMatch().

Since:
5.0
Parameters:
aNextChars  Reference to the next characters for the adaptive search grid The HBufC buffer may be re-allocated by this method. In that case the pointer reference is modified to point to the re-allocated object.
aItemString  List box item text.
static void AknFind::UpdateNextCharsL (  HBufC *&  aNextChars,
const TDesC &  aItemString
)  [static]
 

For Devanagari adaptive search Update next characters if find pane state was changed.

Since:
5.0
Parameters:
aNextChars  reference to the next characters for the adaptive search grid
aItemString  string we are searching.
static void AknFind::UpdateNextCharsL (  HBufC *&  aNextChars,
TChar  aCh
)  [static]
 

Update next characters if find pane state was changed.

Since:
5.0
Parameters:
aNextChars  Next characters for the adaptive search grid
aCh  Criteria from the search field.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top