RContactViewSortOrder Class Reference

#include <app/cntviewbase.h>

class RContactViewSortOrder

Public Member Functions
	RContactViewSortOrder()
void	AppendL(TFieldType)
IMPORT_C void	Close()
IMPORT_C void	CopyL(const RContactViewSortOrder &)
TInt	Count()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TInt	ExternalizedSize()
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TBool	operator==(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 ( )

IMPORT_C

RContactViewSortOrder

(

)

Default C++ constructor.

Member Function Documentation

AppendL ( TFieldType )

void

AppendL

(

TFieldType

aField

)

[inline]

Appends a field type to the sort order object.

Parameters
aField	The field type to append.

Close ( )

IMPORT_C void

(

)

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

CopyL ( const RContactViewSortOrder & )

IMPORT_C void

CopyL

(

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
aSortOrder	The sort order to be copied.

Count ( )

TInt

Count

(

)

const [inline]

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

Return Value: The number of field types in the array.

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises a sort order object to a write stream.

Parameters
aStream	The stream to write to.

ExternalizedSize ( )

IMPORT_C TInt

ExternalizedSize

(

)

const

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

Return Value: The size of the sort order object.

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises a sort order object from a read stream.

Parameters
aStream	The stream to read from.

operator== ( const RContactViewSortOrder & )

IMPORT_C TBool

operator==

(

const RContactViewSortOrder &

aSortOrder

)

const

Compares two sort order objects for equivalence.

Parameters
aSortOrder	The sort order object to compare with this one.

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

operator[] ( TInt )

TFieldType

operator[]

(

TInt

aIndex

)

const [inline]

Gets an indexed field type.

Parameters
aIndex	Index of the required field type. A panic occurs if this is invalid.

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