Class TMsvSelectionOrdering

class TMsvSelectionOrdering;

Description

Defines the sorting and grouping rules used to prepare a selection of entries.

It is used in the interfaces of CMsvEntry and CMsvServerEntry to set the ordering of an entry's children.

Firstly, the entries will be grouped, if the appropriate grouping option is set, by:

1. Standard folders: any entries marked as standard folders are placed first, in the order they were created.

2. Entry type: in the order services, folders, messages, attachments, unknown

3. Priority: in the order high, medium, then low

4. MTM: either in the MTM order set by CMsvEntry::SetMtmListL() or just in MTM Uid value

Grouping options are simply Boolean flags that can be set on or off by functions of this class.

Secondly, the order of entries within these groups is defined by a sorting order option.

Members

Defined in TMsvSelectionOrdering:
ExternalizeL(), GroupByMtm(), GroupByPriority(), GroupByType(), GroupStandardFolders(), GroupingOn(), InternalizeL(), SetGroupByMtm(), SetGroupByPriority(), SetGroupByType(), SetGroupStandardFolders(), SetShowInvisibleEntries(), SetSorting(), SetSubjectSkipString(), ShowInvisibleEntries(), Sorting(), SubjectSkipString(), TMsvSelectionOrdering(), TMsvSelectionOrdering(), operator==()

See also:

• CMsvEntry
• CMsvServerEntry

IMPORT_C TMsvSelectionOrdering();

Description

Default constructor.

Creates a new object with no grouping, and sets the sorting to EMsvSortByNone.

IMPORT_C TMsvSelectionOrdering(TInt aGroupingKey, TMsvSorting aSorting, TBool aShowInvisible=EFalse);

Description

Creates a new object, sets the group, sort order, and show-invisibility options to those specified in the parameters.

Parameters

TInt aGroupingKey A bitmask of grouping options. For the values to use, see TMsvGrouping. TMsvSorting aSorting Sorting order. TBool aShowInvisible Determines whether invisible entries are included in the selection

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Reads an externalised object from the specified stream.

Parameters

RReadStream &aStream Stream from which to read

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Writes the object into the specified stream.

Parameters

RWriteStream &aStream Stream to which to write

IMPORT_C TBool operator==(const TMsvSelectionOrdering &aOrdering) const;

Description

Tests two TMsvSelectionOrdering objects for equality.

Two TMsvSelectionOrdering objects are equal if the same grouping and sorting options have been set on each.

Parameters

const TMsvSelectionOrdering &aOrdering The object with which to compare

Return value

TBool ETrue if the objects are equal, else EFalse

IMPORT_C void SetSubjectSkipString(const TDesC &aSubjectSkipString);

Description

Set the subject skip string up to maximum length of KMaxSubjectSkipStringLength

Parameters

const TDesC &aSubjectSkipString

Panic codes

USER 11, if the length of the descriptor aSubjectSkipString is greater than KMaxSubjectSkipStringLength (defined in <msvstd.h>)

IMPORT_C const TDesC &SubjectSkipString() const;

Description

Get the current subject skip string

Return value

const TDesC & The current subject skip string

inline TMsvSorting Sorting() const;

Description

Gets the sorting order of entries within groups.

Return value

TMsvSorting Sorting order.

inline TBool GroupByType() const;

Description

Gets the group-by-entry-type flag.

Return value

TBool Group-by-entry-type flag

inline TBool GroupStandardFolders() const;

Description

Gets the group-by-standard-folders flag.

Return value

TBool Group-by-standard-folders flag

inline TBool GroupByPriority() const;

Description

Gets the group-by-priority flag.

Return value

TBool Group-by-priority flag

inline TBool GroupByMtm() const;

Description

Gets the group-by-MTM flag.

Return value

TBool Group-by-MTM flag

inline TBool ShowInvisibleEntries() const;

Description

Gets the show-invisible-entries flag. Entries whose entry visible flag index field is not set are included in the ordered list only if this is set.

Return value

TBool Show-invisible-entries flag

inline TBool GroupingOn() const;

Description

Tests whether any grouping option has been set.

Return value

TBool ETrue if one or more grouping options have been set, else EFalse

inline void SetGroupByType(TBool aFlag);

Description

Parameters

TBool aFlag

inline void SetGroupStandardFolders(TBool aFlag);

Description

Parameters

TBool aFlag

inline void SetGroupByPriority(TBool aFlag);

Description

Parameters

TBool aFlag

inline void SetGroupByMtm(TBool aFlag);

Description

Parameters

TBool aFlag

inline void SetShowInvisibleEntries(TBool aFlag);

Description

Parameters

TBool aFlag

inline void SetSorting(TMsvSorting aSortType);

Description

Parameters

TMsvSorting aSortType