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 S60 3.0

Constructor & Destructor Documentation

TPosLmSortPref(CPosLandmark::TAttributes, TSortOrder)

IMPORT_CTPosLmSortPref(CPosLandmark::TAttributesaLandmarkAttribute,
TSortOrderaSortOrder = 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 aLandmarkAttributeThe landmark attribute to sort by.
TSortOrder aSortOrder = EAscendingAscending or descending sort order.

Member Functions Documentation

LandmarkAttributeToSortBy()

IMPORT_C CPosLandmark::TAttributesLandmarkAttributeToSortBy()const

Gets the landmark attribute to sort by.

The landmark attribute to sort by, or CPosLandmark::ENoAttribute, if sort is not done by landmark attribute.

SetSortByLandmarkAttribute(CPosLandmark::TAttributes, TSortOrder)

IMPORT_C voidSetSortByLandmarkAttribute(CPosLandmark::TAttributesaLandmarkAttribute,
TSortOrderaSortOrder = 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 aLandmarkAttributeThe landmark attribute to sort by.
TSortOrder aSortOrder = EAscendingThe preferred sort order.

SortOrder()

IMPORT_C TSortOrderSortOrder()const

Gets the preferred sort order.

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]