CPosLmCategoryCriteria Class Reference

class CPosLmCategoryCriteria : public CPosLmSearchCriteria

Criterion used for searching for landmarks which belong to a certain category.

A category has an ID in the database and it has also a unique name. There are also some global categories which are known by all databases. It is possible to specify either a local category in a specific landmark database, a global category or the name of the category. If one is set, the others are reset and not used.

It is also possible to search for uncategorized landmarks, i.e. landmarks which do not contain any categories. If neither item ID, global ID nor name are set, then CPosLandmarkSearch::StartLandmarkSearchL will search for uncategorized landmarks.

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

Constructor & Destructor Documentation

CPosLmCategoryCriteria()

CPosLmCategoryCriteria ( ) [private]

CPosLmCategoryCriteria(const CPosLmCategoryCriteria &)

CPosLmCategoryCriteria ( const CPosLmCategoryCriteria & ) [private]

Parameters

const CPosLmCategoryCriteria &

~CPosLmCategoryCriteria()

~CPosLmCategoryCriteria ( ) [virtual]

Destructor.

Member Functions Documentation

CategoryItemId()

IMPORT_C TPosLmItemId CategoryItemId ( ) const

Returns the item ID of the category which should be used as landmark search criterion.

CategoryName()

IMPORT_C TPtrC CategoryName ( ) const

Returns the name of the category which should be used as landmark search criterion.

ConstructL()

void ConstructL ( ) [private]

GlobalCategory()

IMPORT_C TPosLmGlobalCategory GlobalCategory ( ) const

Returns the global category which should be used as landmark search criterion.

NewLC()

IMPORT_C CPosLmCategoryCriteria * NewLC ( ) [static]

Two-phased constructor.

SetCategoryItemId(TPosLmItemId)

IMPORT_C void SetCategoryItemId ( TPosLmItemId aItemId )

Sets the item ID of the category which should be used as landmark search criterion.

Passing KPosLmNullItemId means uncategorized landmarks search.

Parameters

TPosLmItemId aItemId The item ID of the category.

SetCategoryNameL(const TDesC &)

IMPORT_C void SetCategoryNameL ( const TDesC & aCategoryName )

Sets the name of the category which should be used as landmark search criterion.

The exact category name must be specified. Wild-card characters are not used as such, they will be considered as ordinary characters. It is possible to use CPosLmCatNameCriteria to list categories which match a category name pattern containing wild-card characters.

The matching is case sensitive.

An empty descriptor means uncategorized landmarks search.

leave
KErrArgument The category name is longer than KPosLmMaxCategoryNameLength .

Parameters

const TDesC & aCategoryName The category name.

SetGlobalCategory(TPosLmGlobalCategory)

IMPORT_C void SetGlobalCategory ( TPosLmGlobalCategory aGlobalCategory )

Sets the global category which should be used as landmark search criterion.

Passing KPosLmNullGlobalCategory means uncategorized landmarks search.

Parameters

TPosLmGlobalCategory aGlobalCategory The global category.

operator=(const CPosLmCategoryCriteria &)

CPosLmCategoryCriteria & operator= ( const CPosLmCategoryCriteria & ) [private]

Parameters

const CPosLmCategoryCriteria &

Member Data Documentation

HBufC * iCategoryName

HBufC * iCategoryName [private]

TPosLmGlobalCategory iGlobalCategory

TPosLmGlobalCategory iGlobalCategory [private]

TPosLmItemId iItemId

TPosLmItemId iItemId [private]