TPosLmSortPref Class Reference

class TPosLmSortPref

Class for specifying sort preference.

A sort pref object can be passed to some listing and searching functions in the API, to specify a sorting order for the returned landmark list.

Landmark sorting is not case sensitive.

eposlandmarks.lib
Since
S60 3.0

Constructor & Destructor Documentation

TPosLmSortPref(CPosLandmark::TAttributes, TSortOrder)

IMPORT_C TPosLmSortPref ( CPosLandmark::TAttributes aLandmarkAttribute,
TSortOrder aSortOrder = EAscending
)

C++ constructor.

Only one landmark attribute can be specified here, not a bitmap of landmark attributes.

Landmark sorting is not case sensitive.

panic
"Landmarks Client"-EPosNoneOrMultipleLandmarkAttributeSet More than one attribute is specified or no attributes at all.

Parameters

CPosLandmark::TAttributes aLandmarkAttribute The landmark attribute to sort by.
TSortOrder aSortOrder = EAscending Ascending or descending sort order.

Member Functions Documentation

LandmarkAttributeToSortBy()

IMPORT_C CPosLandmark::TAttributes LandmarkAttributeToSortBy ( ) const

Gets the landmark attribute to sort by.

SetSortByLandmarkAttribute(CPosLandmark::TAttributes, TSortOrder)

IMPORT_C void SetSortByLandmarkAttribute ( CPosLandmark::TAttributes aLandmarkAttribute,
TSortOrder aSortOrder = EAscending
)

Sets the landmark attribute to sort by.

Landmark sorting is not case sensitive.

panic
"Landmarks Client"-EPosNoneOrMultipleLandmarkAttributeSet More than one attribute is specified or no attributes at all.

Parameters

CPosLandmark::TAttributes aLandmarkAttribute The landmark attribute to sort by.
TSortOrder aSortOrder = EAscending The preferred sort order.

SortOrder()

IMPORT_C TSortOrder SortOrder ( ) const

Gets the preferred sort order.

Member Enumerations Documentation

Enum TSortOrder

Specifies the sort order.

Enumerators

EAscending = 0

Ascending sort order

EDescending

Descending sort order

Member Data Documentation

CPosLandmark::TAttributes iLandmarkAttribute

CPosLandmark::TAttributes iLandmarkAttribute [private]

TSortOrder iSortOrder

TSortOrder iSortOrder [private]

TUint8 iUnusedData

TUint8 iUnusedData [private]