CContactDatabase::TSortPref Class Reference

#include <app/cntdb.h>

Link against: cntmodel.lib

class CContactDatabase::TSortPref
Public Attributes
TFieldType iFieldType
TOrder iOrder
Public Member Enumerations
enumTOrder { EAsc, EDesc }
Public Member Functions
TSortPref()
TSortPref(TFieldType, TOrder)
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)

Detailed Description

Specifies the field type and order preferences used for sorting items in the contacts database.

The contents of the first field in a contact item matching the field type is used as the data to sort on. The order can either be ascending or descending.

See also: CContactDatabase::SortL() CContactDatabase::SortArrayL()

Deprecated

Member Attribute Documentation

iFieldType

TFieldType iFieldType

The first field matching this field type is used for the text to sort on.

iOrder

TOrder iOrder

Specifies whether the sort should be ascending or descending.

Member Enumeration Documentation

Enum TOrder

The sort order.

EnumeratorValueDescription
EAsc

Ascending sort order.

EDesc

Descending sort order.

Constructor & Destructor Documentation

TSortPref ( )

TSortPref()[inline]

Constructs a TSortPref object. The order is initialised to EAsc and the field type to KNullUid. Deprecated

TSortPref ( TFieldType, TOrder )

TSortPref(TFieldTypeaFieldType,
TOrderaOrder = EAsc
)[inline]

Constructs the TSortPref object with a field type and an order. Deprecated

ParameterDescription
aFieldTypeSpecifies the field type to sort on.
aOrderSpecifies the sort order.

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Store this TSortPref object in the given stream.

ParameterDescription
aStreamStream to write TSortPref object state to.

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Initialise this TSortPref object from the given stream.

ParameterDescription
aStreamStream to read TSortPref object state from.