S60 3rd Edition API Reference: TPosLmSortPref Class Reference

TPosLmSortPref Class Reference

API published in: S60 3rd Ed

Link against: eposlandmarks.lib

Capability Information

Required Capabilities

LocalServices NetworkServices ReadDeviceData ReadUserData WriteDeviceData WriteUserData

#include <epos_tposlmsortpref.h>

Detailed Description

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.


Public Types

enum  TSortOrder { EAscending = 0, EDescending }
 Specifies the sort order. More...

Public Member Functions

IMPORT_C TPosLmSortPref (CPosLandmark::TAttributes aLandmarkAttribute, TSortOrder aSortOrder=EAscending)
 C++ constructor.
IMPORT_C TSortOrder SortOrder () const
 Gets the preferred sort order.
IMPORT_C CPosLandmark::TAttributes LandmarkAttributeToSortBy () const
 Gets the landmark attribute to sort by.
IMPORT_C void SetSortByLandmarkAttribute (CPosLandmark::TAttributes aLandmarkAttribute, TSortOrder aSortOrder=EAscending)
 Sets the landmark attribute to sort by.

Member Enumeration Documentation

enum TPosLmSortPref::TSortOrder
 

Specifies the sort order.

Enumerator:
EAscending  Ascending sort order.
EDescending  Descending sort order.

Constructor & Destructor Documentation

IMPORT_C TPosLmSortPref::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.

Parameters:
[in] aLandmarkAttribute The landmark attribute to sort by.
[in] aSortOrder Ascending or descending sort order.
Panic:
"Landmarks Client"-EPosNoneOrMultipleLandmarkAttributeSet More than one attribute is specified or no attributes at all.

Member Function Documentation

IMPORT_C CPosLandmark::TAttributes TPosLmSortPref::LandmarkAttributeToSortBy (   )  const
 

Gets the landmark attribute to sort by.

Returns:
The landmark attribute to sort by, or CPosLandmark::ENoAttribute, if sort is not done by landmark attribute.
IMPORT_C void TPosLmSortPref::SetSortByLandmarkAttribute ( CPosLandmark::TAttributes  aLandmarkAttribute,
TSortOrder  aSortOrder = EAscending
) 
 

Sets the landmark attribute to sort by.

Landmark sorting is not case sensitive.

Parameters:
[in] aLandmarkAttribute The landmark attribute to sort by.
[in] aSortOrder The preferred sort order.
Panic:
"Landmarks Client"-EPosNoneOrMultipleLandmarkAttributeSet More than one attribute is specified or no attributes at all.
IMPORT_C TSortOrder TPosLmSortPref::SortOrder (   )  const
 

Gets the preferred sort order.

Returns:
The preferred sort order.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top