CPosLmTextCriteria Class Reference

API published in: S60 3rd Ed

Link against: eposlmsearchlib.lib eposlmmultidbsearch.lib

Capability Information

Required Capabilities

None

Exceptions

The capability ReadUserData is required in:

CPosLandmarkSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLandmarkSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, const TPosLmSortPref & aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLandmarkSearch::StartCategorySearchL( const CPosLmSearchCriteria & aCriteria, CPosLmCategoryManager::TCategorySortPref aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, const TPosLmSortPref & aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartCategorySearchL( const CPosLmSearchCriteria & aCriteria, CPosLmCategoryManager::TCategorySortPref aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

Other Information

The capability NetworkServices is required to work with remote databases.

#include <epos_cposlmtextcriteria.h>

Inherits CPosLmSearchCriteria.

Detailed Description

Criterion for searching for landmarks which contain a certain text.

The search is defined by providing a text to search for and the position fields and text attributes to search.

If no attributes are specified for the search, all text attributes in the landmarks are searched. If no position fields are specified, then all fields are searched.

If this criterion is passed to CPosLandmarkSearch::StartLandmarkSearchL, only landmarks which contain the specified text are returned.

Wild-card characters are supported.

This criterion is only valid when searching for landmarks, i.e. if it is passed to CPosLandmarkSearch::StartCategorySearchL, the function will fail with error code KErrArgument.


Public Member Functions
virtual  ~CPosLmTextCriteria ()
  Destructor.
IMPORT_C TPtrC  Text () const
  Retrieves the text to search for.
IMPORT_C void  SetTextL (const TDesC &aText)
  Sets the search string.
IMPORT_C CPosLandmark::TAttributes  AttributesToSearch () const
  Retrieves the landmark attributes which should be searched.
IMPORT_C void  SetAttributesToSearch (CPosLandmark::TAttributes aAttributes)
  Sets which landmark attributes to search.
IMPORT_C void  GetPositionFieldsToSearchL (RArray< TUint > &aFieldArray) const
  Retrieves a list of the position fields to search.
IMPORT_C void  SetPositionFieldsToSearchL (const RArray< TUint > &aFieldArray)
  Sets the position fields to search.
IMPORT_C void  ClearPositionFieldsToSearch ()
  Clears the position fields list used in a search.

Static Public Member Functions
static IMPORT_C CPosLmTextCriteria *  NewLC ()
  Two-phased constructor.

Constructor & Destructor Documentation

virtual CPosLmTextCriteria::~CPosLmTextCriteria (   )  [virtual]
 

Destructor.

Member Function Documentation

IMPORT_C CPosLandmark::TAttributes CPosLmTextCriteria::AttributesToSearch (   )  const
 

Retrieves the landmark attributes which should be searched.

This function returns a bitmap of landmark attributes. The landmark attributes are defined by CPosLandmark::_TAttributes. It is only possible to search the ELandmarkName and EDescription attributes.

Returns:
A bitmap indicating which landmark attributes should be searched.
IMPORT_C void CPosLmTextCriteria::ClearPositionFieldsToSearch (   ) 
 

Clears the position fields list used in a search.

IMPORT_C void CPosLmTextCriteria::GetPositionFieldsToSearchL (  RArray< TUint > &  aFieldArray  )  const
 

Retrieves a list of the position fields to search.

Parameters:
[out]  aFieldArray  On return, contains a list of the position fields which are used in a search. If no position fields have been set, the array is empty. Position fields are identified by values defined in TPositionFieldId.
static IMPORT_C CPosLmTextCriteria* CPosLmTextCriteria::NewLC (   )  [static]
 

Two-phased constructor.

Returns:
A new instance of this class.
IMPORT_C void CPosLmTextCriteria::SetAttributesToSearch (  CPosLandmark::TAttributes  aAttributes  ) 
 

Sets which landmark attributes to search.

The client passes a bitmap of the landmark attributes to search. It is only possible to search the ELandmarkName and EDescription attributes.

Parameters:
aAttributes  A bitmap indicating which landmark attributes should be searched.
Panic:
"Landmarks Client"-EPosInvalidLandmarkAttribute Unsupported attribute is passed.
IMPORT_C void CPosLmTextCriteria::SetPositionFieldsToSearchL (  const RArray< TUint > &  aFieldArray  ) 
 

Sets the position fields to search.

Any previously set position fields are cleared by this call.

Parameters:
[in]  aFieldArray  A list of the position fields to search. Position fields are identified by values defined in TPositionFieldId.
IMPORT_C void CPosLmTextCriteria::SetTextL (  const TDesC &  aText  ) 
 

Sets the search string.

A non-empty text string must be set, otherwise CPosLandmarkSearch::StartLandmarkSearchL will leave with error code KErrArgument.

The search is case insensitive.

Wild-card characters "?" and "*" are supported in the search string. "?" matches a single occurrence of any character and "*" matches zero or more consecutive occurrences of any characters.

A landmark matches the criterion if specified text is found anywhere in selected attributes or position fields.

Parameters:
aText  The text to search for.
Leave:
KErrArgument The search string is longer than KPosLmMaxSearchStringLength.
IMPORT_C TPtrC CPosLmTextCriteria::Text (   )  const
 

Retrieves the text to search for.

Returns:
The text to search for.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top