Class RContactViewSortOrder

class RContactViewSortOrder;

Description

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.

Members

Defined in RContactViewSortOrder:

• AppendL()Appends a field type to the sort order object
• Close()Closes the sort order array and frees all memory allocated to it
• CopyL()Copies the field types contained in the specified sort order object into this object
• Count()Gets the number of field types in the sort order array
• ExternalizeL()Externalises a sort order object to a write stream
• ExternalizedSize()Retrieves the number of bytes required to store the sort order when externalised
• InternalizeL()Internalises a sort order object from a read stream
• RContactViewSortOrder()Default C++ constructor
• operator==()Compares two sort order objects for equivalence
• operator[]()Gets an indexed field type

IMPORT_C RContactViewSortOrder();

Description

Default C++ constructor.

IMPORT_C void Close();

Description

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

IMPORT_C void CopyL(const RContactViewSortOrder &aSortOrder);

Description

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

Any existing field types in this object are replaced.

Parameters

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a sort order object from a read stream.

Parameters

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a sort order object to a write stream.

Parameters

IMPORT_C TInt ExternalizedSize() const;

Description

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

Return value

IMPORT_C TBool operator==(const RContactViewSortOrder &aSortOrder) const;

Description

Compares two sort order objects for equivalence.

Parameters

Return value

inline void AppendL(TFieldType aField);

Description

Appends a field type to the sort order object.

Parameters

inline TFieldType operator[](TInt aIndex) const;

Description

Gets an indexed field type.

Parameters

Return value

inline TInt Count() const;

Description

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

Return value