Class TMsvSelectionOrdering

TMsvSelectionOrdering

Support

Supported from 5.0

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:

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

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

• Priority: in the order high, medium, then low

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

In pre-Unicode versions this class had the import library ment.lib.

Defined in TMsvSelectionOrdering:
ExternalizeL(), GroupByMtm(), GroupByPriority(), GroupByType(), GroupStandardFolders(), GroupingOn(), InternalizeL(), ShowInvisibleEntries(), Sorting(), TMsvSelectionOrdering(), operator==()

See also:

• CMsvEntry
• CMsvServerEntry

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

Description

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

The second constructor sets the group, sort order, and show-invisibility options to those specified in the passed values.

Parameters

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

void InternalizeL(RReadStream& aStream);

Description

Reads an externalised object from the specified stream.

Parameters

RReadStream& aStream Stream from which to read

Leave codes

Standard stream leave codes.

void ExternalizeL(RWriteStream& aStream) const;

Description

Writes the object into the specified stream.

Parameters

RWriteStream& aStream Stream to which to write

Leave codes

Standard stream leave codes.

TBool operator==(const TMsvSelectionOrdering& aEntry) 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& aEntry The object with which to compare

Return value

TBool ETrue if the objects are equal, else EFalse

TBool GroupByMtm() const;

Description

Gets the group-by-MTM flag.

Return value

TBool Group-by-MTM flag

TBool GroupByPriority() const;

Description

Gets the group-by-priority flag.

Return value

TBool Group-by-priority flag

TBool GroupByType() const;

Description

Gets the group-by-entry-type flag.

Return value

TBool Group-by-entry-type flag

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

TBool GroupStandardFolders() const;

Description

Gets the group-by-standard-folders flag.

Return value

TBool Group-by-standard-folders flag

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

TMsvSorting Sorting() const;

Description

Gets the sorting order of entries within groups.

Return value

TMsvSorting Sorting order.

void SetGroupByMtm(TBool aFlag);

Description

Sets the group-by-MTM flag.

Parameters

TBool aFlag Group-by-MTM flag

void SetGroupByPriority(TBool aFlag);

Description

Sets the group-by-priority flag.

Parameters

TBool aFlag Group-by-priority flag

void SetGroupByType(TBool aFlag);

Description

Sets the group-by-entry-type flag.

Parameters

TBool aFlag Group-by-entry-type flag

void SetGroupStandardFolders(TBool aFlag);

Description

Sets the group-by-standard-folders flag.

Parameters

TBool aFlag Group-by-standard-folders flag

void SetShowInvisibleEntries(TBool aFlag);

Description

Sets 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. Setting this flag off is useful if you intend to display the resulting ordered list to the user.

Parameters

TBool aFlag Show-invisible-entries flag

void SetSorting(TMsvSorting aSortType);

Description

Sets the sorting order of entries within groups.

Parameters

TMsvSorting aSortType Sorting order to set.