RContactViewSortOrder Class Reference

#include <app/cntviewbase.h>

Link against: cntmodel.lib

class RContactViewSortOrder
Public Member Functions
IMPORT_C voidClose()
IMPORT_C voidCopyL(const RContactViewSortOrder &)
TInt Count()
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C TIntExternalizedSize()
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TBooloperator==(const RContactViewSortOrder &)
TFieldType operator[](TInt)

Detailed 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.

Constructor & Destructor Documentation

RContactViewSortOrder ( )


Default C++ constructor.

Member Function Documentation

AppendL ( TFieldType )


Appends a field type to the sort order object.

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.

aSortOrderThe sort order to be copied.

Count ( )

TInt Count()const [inline]

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

Returns: The number of field types in the array.

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises a sort order object to a write stream.

aStreamThe stream to write to.

ExternalizedSize ( )

IMPORT_C TIntExternalizedSize()const

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

Returns: The size of the sort order object.

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises a sort order object from a read stream.

aStreamThe stream to read from.

operator== ( const RContactViewSortOrder & )

IMPORT_C TBooloperator==(const RContactViewSortOrder &aSortOrder)const

Compares two sort order objects for equivalence.

aSortOrderThe sort order object to compare with this one.

Returns: ETrue if the two sort orders are the same, EFalse if not.

operator[] ( TInt )

TFieldType operator[](TIntaIndex)const [inline]

Gets an indexed field type.

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

Returns: The field type located at the indexed position in the array.