![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
Not applicable
msvstd.h
ment.lib
This class 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 entrys children.
Firstly, the entries will be grouped, if the appropriate grouping option is set, by:
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.
TMsvSelectionOrdering();
TMsvSelectionOrdering(TInt aGroupingKey, TMsvSorting aSorting, TBool aShowInvisible=EFalse);
The first constructor simply 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.
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);
Use this function to read an externalised object from the stream specified by aStream.
RReadStream& aStream |
Stream from which to read |
Standard stream leave codes.
void ExternalizeL(RWriteStream& aStream) const;
Use this function to write the object into the stream specified by aStream.
RWriteStream& aStream |
Stream to which to write |
Standard stream leave codes.
TBool operator==(const TMsvSelectionOrdering& aEntry) const;
Use this operator to test for equality. Two TMsvSelectionOrdering objects are equal if the same grouping and sorting options have been set on each.
const TMsvSelectionOrdering& aEntry |
The object with which to compare |
TBool |
ETrue if the objects are equal, else EFalse |
TBool GroupByMtm() const;
Use this function to get the group-by-MTM flag.
TBool |
Group-by-MTM flag |
TBool GroupByPriority() const;
Use this function to get the group-by-priority flag.
TBool |
Group-by-priority flag |
TBool GroupByType() const;
Use this function to get the group-by-entry-type flag.
TBool |
Group-by-entry-type flag |
TBool GroupingOn() const;
Use this function to check if any grouping option has been set.
TBool |
ETrue if one or more grouping options have been set, else EFalse |
TBool GroupStandardFolders() const;
Use this function to get the group-by-standard-folders flag.
TBool |
Group-by-standard-folders flag |
TBool ShowInvisibleEntries() const;
Use this function to get 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.
TBool |
Show-invisible-entries flag |
TMsvSorting Sorting() const;
Use this function to get the sorting order of entries within groups.
TMsvSorting |
Sorting order. |
void SetGroupByMtm(TBool aFlag);
Use this function to set the group-by-MTM flag.
TBool aFlag |
Group-by-MTM flag |
void SetGroupByPriority(TBool aFlag);
Use this function to set the group-by-priority flag.
TBool aFlag |
Group-by-priority flag |
void SetGroupByType(TBool aFlag);
Use this function to set the group-by-entry-type flag.
TBool aFlag |
Group-by-entry-type flag |
void SetGroupStandardFolders(TBool aFlag);
Use this function to set the group-by-standard-folders flag.
TBool aFlag |
Group-by-standard-folders flag |
void SetShowInvisibleEntries(TBool aFlag);
Use this function to set 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.
TBool aFlag |
Show-invisible-entries flag |
void SetSorting(TMsvSorting aSortType);
Use this function to set the sorting order of entries within groups.
TMsvSorting aSortType |
Sorting order to set. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |