AknFind Class Reference

API published in: S60 1st Ed

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 in the sense described in S60.
static IMPORT_C TBool  IsFindWordSeparator (TChar aCh)
  Tests if aCh is a word separator character as described in S60.
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.

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::IsFindMatch (  const TDesC &  aItemText,
const TDesC &  aSearchText
)  [static]
 

Checks if aItemText matches aSearchText in the sense described in S60.

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.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top