Collapse all Symbian^3 Application Developer Library

CPosLmTextCriteria Class Reference

class CPosLmTextCriteria : public CPosLmSearchCriteria

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 .

eposlmsearchlib.lib

Since: S60 3.0

Inherits from

CPosLmTextCriteria
- CPosLmSearchCriteria
  - CBase

Public Member Functions
	~CPosLmTextCriteria ()
IMPORT_C CPosLandmark::TAttributes	AttributesToSearch ()
IMPORT_C void	ClearPositionFieldsToSearch ()
IMPORT_C void	GetPositionFieldsToSearchL ( RArray < TUint > &)
IMPORT_C CPosLmTextCriteria *	NewLC ()
IMPORT_C void	SetAttributesToSearch ( CPosLandmark::TAttributes )
IMPORT_C void	SetPositionFieldsToSearchL (const RArray < TUint > &)
IMPORT_C void	SetTextL (const TDesC &)
IMPORT_C TPtrC	Text ()

Private Member Functions
	CPosLmTextCriteria ()
	CPosLmTextCriteria (const CPosLmTextCriteria &)
void	ConstructL ()
CPosLmTextCriteria &	operator= (const CPosLmTextCriteria &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CPosLmSearchCriteria::CPosLmSearchCriteria(TCriteriaType)
	CPosLmSearchCriteria::CriteriaType()const
	CPosLmSearchCriteria::~CPosLmSearchCriteria()

Inherited Enumerations
	CPosLmSearchCriteria:TCriteriaType

Private Attributes
CPosLandmark::TAttributes	iAttributes
RArray < TUint >	iPositionFieldArray
HBufC *	iText

Constructor & Destructor Documentation

CPosLmTextCriteria()

CPosLmTextCriteria

(

)

[private]

CPosLmTextCriteria(const CPosLmTextCriteria &)

CPosLmTextCriteria

(

const CPosLmTextCriteria &

)

[private]

Parameters

const CPosLmTextCriteria &

~CPosLmTextCriteria()

~CPosLmTextCriteria

(

)

[virtual]

Destructor.

Member Functions Documentation

AttributesToSearch()

IMPORT_C CPosLandmark::TAttributes

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.

ClearPositionFieldsToSearch()

IMPORT_C void

ClearPositionFieldsToSearch

(

)

Clears the position fields list used in a search.

ConstructL()

void

ConstructL

(

)

[private]

GetPositionFieldsToSearchL(RArray< TUint > &)

IMPORT_C void

GetPositionFieldsToSearchL

(

RArray < TUint > &

aFieldArray

)

const

Retrieves a list of the position fields to search.

Parameters

RArray < TUint > & 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.

NewLC()

IMPORT_C CPosLmTextCriteria *

NewLC

(

)

[static]

Two-phased constructor.

SetAttributesToSearch(CPosLandmark::TAttributes)

IMPORT_C void

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.

panic: "Landmarks Client"-EPosInvalidLandmarkAttribute Unsupported attribute is passed.

Parameters

CPosLandmark::TAttributes aAttributes

A bitmap indicating which landmark attributes should be searched.

SetPositionFieldsToSearchL(const RArray< TUint > &)

IMPORT_C void

SetPositionFieldsToSearchL

(

const RArray < TUint > &

aFieldArray

)

Sets the position fields to search.

Any previously set position fields are cleared by this call.

Parameters

const RArray < TUint > & aFieldArray

A list of the position fields to search. Position fields are identified by values defined in TPositionFieldId.

SetTextL(const TDesC &)

IMPORT_C void

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.

leave: KErrArgument The search string is longer than KPosLmMaxSearchStringLength .

Parameters

const TDesC & aText

The text to search for.

Text()

IMPORT_C TPtrC

Text

(

)

const

Retrieves the text to search for.

operator=(const CPosLmTextCriteria &)

CPosLmTextCriteria &

operator=

(

const CPosLmTextCriteria &

)

[private]

Parameters

const CPosLmTextCriteria &

Member Data Documentation

CPosLandmark::TAttributes iAttributes

CPosLandmark::TAttributes

iAttributes

[private]

RArray< TUint > iPositionFieldArray

RArray < TUint >

iPositionFieldArray

[private]

HBufC * iText

HBufC *

iText

[private]