Collapse all Symbian^3 Product Developer Library

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

CPosLmCategoryCriteria
- CPosLmSearchCriteria
  - CBase

Public Member Functions
	~CPosLmCategoryCriteria()
IMPORT_C TPosLmItemId	CategoryItemId()
IMPORT_C TPtrC	CategoryName()
IMPORT_C TPosLmGlobalCategory	GlobalCategory()
IMPORT_C CPosLmCategoryCriteria *	NewLC()
IMPORT_C void	SetCategoryItemId(TPosLmItemId)
IMPORT_C void	SetCategoryNameL(const TDesC &)
IMPORT_C void	SetGlobalCategory(TPosLmGlobalCategory)

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

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
HBufC *	iCategoryName
TPosLmGlobalCategory	iGlobalCategory
TPosLmItemId	iItemId

Constructor & Destructor Documentation

CPosLmCategoryCriteria()

CPosLmCategoryCriteria

(

)

[private]

CPosLmCategoryCriteria(const CPosLmCategoryCriteria &)

CPosLmCategoryCriteria

(

const CPosLmCategoryCriteria &

)

[private]

Parameters

const CPosLmCategoryCriteria &

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.