RContactViewSortOrder Class Reference

class RContactViewSortOrder

Specifies the sort order for a contact view.

It is implemented as an array of TFieldType UIDs, which define the fields whose contents are used to sort on, and their order.

The sort order for all concrete contact view classes can be retrieved using their implementation of CContactViewBase::SortOrderL(). The sort order is set during construction of local and remote views.

Constructor & Destructor Documentation

RContactViewSortOrder()

IMPORT_CRContactViewSortOrder()

Default C++ constructor.

Member Functions Documentation

AppendL(TFieldType)

voidAppendL(TFieldTypeaField)[inline]

Appends a field type to the sort order object.

Parameters

TFieldType aFieldThe field type to append.

Close()

IMPORT_C voidClose()

Closes the sort order array and frees all memory allocated to it.

CopyL(const RContactViewSortOrder &)

IMPORT_C voidCopyL(const RContactViewSortOrder &aSortOrder)

Copies the field types contained in the specified sort order object into this object.

Any existing field types in this object are replaced.

Parameters

const RContactViewSortOrder & aSortOrderThe sort order to be copied.

Count()

TInt Count()const [inline]

Gets the number of field types in the sort order array.

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises a sort order object to a write stream.

Parameters

RWriteStream & aStreamThe stream to write to.

ExternalizedSize()

IMPORT_C TIntExternalizedSize()const

Retrieves the number of bytes required to store the sort order when externalised.

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises a sort order object from a read stream.

Parameters

RReadStream & aStreamThe stream to read from.

operator==(const RContactViewSortOrder &)

IMPORT_C TBooloperator==(const RContactViewSortOrder &aSortOrder)const

Compares two sort order objects for equivalence.

Parameters

const RContactViewSortOrder & aSortOrderThe sort order object to compare with this one.

operator[](TInt)

TFieldType operator[](TIntaIndex)const [inline]

Gets an indexed field type.

Parameters

TInt aIndexIndex of the required field type. A panic occurs if this is invalid.

Member Data Documentation

RArray< TFieldType > iFields

RArray< TFieldType >iFields[private]

TInt iSpare

TInt iSpare[private]

TInt32 iSpare2

TInt32 iSpare2[private]

TInt32 iSpare3

TInt32 iSpare3[private]