CPosLmDisplayItem Class Reference

#include <mw/EPos_CPosLmDisplayItem.h>

Link against: eposlmsearchlib.lib

class CPosLmDisplayItem : public CBase

Inherits from

CPosLmDisplayItem

Public Member Enumerations
enum	TDisplayItemType { ELandmarkItem, ECategoryItem }

Public Member Functions
virtual	~CPosLmDisplayItem()
IMPORT_C const CPosLandmarkCategory &	Category()
IMPORT_C TUint	DatabaseIndex()
IMPORT_C TDisplayItemType	DisplayItemType()
IMPORT_C TInt	GetDistance(TReal32 &)
IMPORT_C const CPosLandmark &	Landmark()
IMPORT_C CPosLmDisplayItem *	NewL(CPosLandmark *, TUint)
IMPORT_C CPosLmDisplayItem *	NewL(CPosLandmarkCategory *, TUint)
void	SetDatabaseIndex(TUint)
void	SetDistance(TReal32)

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()

Detailed Description

Displayable item.

A displayable item consists of a landmark or category and its database index. Database index is 0 if running single database search, and it is in the range [0, CPosLmMultiDbSearch::NumOfDatabasesInSearch - 1] in case of multiple database search. Thus, this class is a link between a landmark or a category and its database.

The class is usually not instantiated by client applications.

Since: S60 3.0

Member Enumeration Documentation

Enum TDisplayItemType

Display item type.

Enumerator	Value	Description
ELandmarkItem	0	Landmark display item. This indicates that the item contains a landmark and the Landmark function can be called to access it.
ECategoryItem		Category display item. This indicates that the item contains a category and the Category function can be called to access it.

Constructor & Destructor Documentation

~CPosLmDisplayItem ( )

~CPosLmDisplayItem

(

)

[virtual]

Destructor.

Member Function Documentation

Category ( )

IMPORT_C const CPosLandmarkCategory &

DatabaseIndex ( )

IMPORT_C TUint

DatabaseIndex

(

)

const

Returns the index of the database, which contained item belongs to.

The database index is associated with a database URI from the list of databases specified in CPosLmMultiDbSearch .

If display data is used in CPosLandmarkSearch , this function always returns 0.

Returns: The database index of this displayable item.

DisplayItemType ( )

IMPORT_C TDisplayItemType

DisplayItemType

(

)

const

Returns the type of the display item.

Returns: The display item type.

GetDistance ( TReal32 & )

IMPORT_C TInt

GetDistance

(

TReal32 &

aDistance

)

const

Returns the distance to a position specified in the CPosLmNearestCriteria . The distance data is only used when searching with this criteria.

Parameter	Description
aDistance	Distance to the position specified in a CPosLmNearestCriteria .

Returns: KErrNone if distance is available. KErrNotFound otherwise.

Landmark ( )

IMPORT_C const CPosLandmark &

Landmark

(

)

const

Returns the landmark contained in the displayable item.

panic: "Landmarks Client"-EPosInvalidItemType The item type is not a landmark displayable item. See DisplayItemType .

Returns: The landmark.

NewL ( CPosLandmark *, TUint )

IMPORT_C CPosLmDisplayItem *	NewL	(	CPosLandmark *	aLandmark,
			TUint	aDatabaseIndex = 0
		)	[static]

Two-phased constructor.

Parameter	Description
aLandmark	A landmark.
aDatabaseIndex	A database index.

Returns: A new instance of this class.

NewL ( CPosLandmarkCategory *, TUint )

IMPORT_C CPosLmDisplayItem *	NewL	(	CPosLandmarkCategory *	aCategory,
			TUint	aDatabaseIndex = 0
		)	[static]

Two-phased constructor.

Parameter	Description
aCategory	A category.
aDatabaseIndex	A database index.

Returns: A new instance of this class.

SetDatabaseIndex ( TUint )

void

SetDatabaseIndex

(

TUint

aDatabaseIndex

)

SetDistance ( TReal32 )

void

SetDistance

(

TReal32

aDistance

)