| class TMsvSelectionOrdering |
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.
CMsvServerEntry
| Public Member Functions | |
|---|---|
| TMsvSelectionOrdering() | |
| TMsvSelectionOrdering(TInt, TMsvSorting, TBool) | |
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| TBool | GroupByMtm() |
| TBool | GroupByPriority() |
| TBool | GroupByType() |
| TBool | GroupStandardFolders() |
| TBool | GroupingOn() |
| IMPORT_C void | InternalizeL(RReadStream &) |
| void | SetGroupByMtm(TBool) |
| void | SetGroupByPriority(TBool) |
| void | SetGroupByType(TBool) |
| void | SetGroupStandardFolders(TBool) |
| void | SetShowInvisibleEntries(TBool) |
| void | SetSorting(TMsvSorting) |
| IMPORT_C void | SetSubjectSkipString(const TDesC &) |
| TBool | ShowInvisibleEntries() |
| TMsvSorting | Sorting() |
| IMPORT_C const TDesC & | SubjectSkipString() |
| IMPORT_C TBool | operator==(const TMsvSelectionOrdering &) |
| Private Member Enumerations | |
|---|---|
| enum | TMsvGroupingPrivate { KMsvInvisibleFlag = 0x1, KMsvStandardFolders = 0x4, KMsvAllGroupingFlags = 0x1e } |
| Private Attributes | |
|---|---|
| TInt | iGrouping |
| TMsvSorting | iSortType |
| TBuf< KMaxSubjectSkipStringLength > | iSubjectSkipString |
| IMPORT_C | TMsvSelectionOrdering | ( | TInt | aGroupingKey, |
| TMsvSorting | aSorting, | |||
| TBool | aShowInvisible = EFalse | |||
| ) | ||||
| TInt aGroupingKey | |
| TMsvSorting aSorting | |
| TBool aShowInvisible = EFalse |
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
| RWriteStream & aStream |
| TBool | GroupByPriority | ( | ) | const [inline] |
Gets the group-by-priority flag.
Group-by-priority flag
| TBool | GroupByType | ( | ) | const [inline] |
Gets the group-by-entry-type flag.
Group-by-entry-type flag
| TBool | GroupStandardFolders | ( | ) | const [inline] |
Gets the group-by-standard-folders flag.
Group-by-standard-folders flag
| TBool | GroupingOn | ( | ) | const [inline] |
Tests whether any grouping option has been set.
ETrue if one or more grouping options have been set, else EFalse
| IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
| RReadStream & aStream |
| void | SetGroupStandardFolders | ( | TBool | aFlag | ) | [inline] |
| TBool aFlag |
| void | SetShowInvisibleEntries | ( | TBool | aFlag | ) | [inline] |
| TBool aFlag |
| void | SetSorting | ( | TMsvSorting | aSortType | ) | [inline] |
| TMsvSorting aSortType |
| IMPORT_C void | SetSubjectSkipString | ( | const TDesC & | aSubjectSkipString | ) |
| const TDesC & aSubjectSkipString |
| TBool | ShowInvisibleEntries | ( | ) | const [inline] |
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.
Show-invisible-entries flag
| TMsvSorting | Sorting | ( | ) | const [inline] |
Gets the sorting order of entries within groups.
Sorting order.
| IMPORT_C TBool | operator== | ( | const TMsvSelectionOrdering & | aOrdering | ) | const |
| const TMsvSelectionOrdering & aOrdering |
| KMsvInvisibleFlag = 0x1 | |
| KMsvStandardFolders = 0x4 | |
| KMsvAllGroupingFlags = 0x1e |
| TBuf< KMaxSubjectSkipStringLength > | iSubjectSkipString | [private] |