MCLFSortingStyle Class Reference
#include
<mw/MCLFSortingStyle.h>
Link against: ContentListingFramework.lib
Detailed Description
Sorting style for Content Listing Framework. This class can be used to define primary and secondary sorting styles for Content Listing Framework list model. Sorting styles are used to sort the list model. Secondary sorting style is used to sort items that could not be sorted by the primary sorting style. In other words, items that do not have the field defined by primary or any previous secondary sorting style, the items are sorted using the next secondary sorting style. When a secondary sorting style is appended, it becomes the least significant sorting style until a new one is added after it. Items with undefined fields are placed before or after items with defined fields, depending on the undefined field position setting in
MCLFSortingStyle. Usage:
// Create a sorting style instance
MCLFSortingStyle* sortingStyle = ContentListingFactory::NewSortingStyleLC();
// Set sort ordering
sortingStyle->SetOrdering( ECLFOrderingDescending );
// Set undefied item position. Undefined items are items that doesn't
// have field that is defined in sorting style fields
sortingStyle->SetUndefinedItemPosition( ECLFSortingStyleUndefinedEnd );
// All sorting style parameter fields are string type
sortingStyle->SetSortingDataType( ECLFItemDataTypeDesC );
// Set default sorting parameter
sortingStyle->AddFieldL( ECLFFieldIdSongName );
// Set secondary sorting parameter
sortingStyle->AddFieldL( ECLFFieldIdFileName );
// If item doesn't have ECLFFieldIdSongName field then
// ECLFFieldIdFileName field is used to sort item.
Constructor & Destructor Documentation
~MCLFSortingStyle ( )
~MCLFSortingStyle | ( | ) | [inline, virtual] |
Member Function Documentation
AddFieldL ( TCLFFieldId )
Add new field to the sorting style. First added field will be the default field. Remember to set type of field(s) with SetSortingDataType. Fields that are some other type will be ignored. See TCLFDefaultFieldId in CLFContentListing.hrh
- Since
- S60 3.1
Parameter | Description | aFieldId | Id of the sorting parameter field |
GetFieldsL ( RArray< TCLFFieldId > & )
Get IDs of fields that have been set to the sorting style.
- Since
- S60 3.1
Parameter | Description | aArray | Array of field IDs |
Ordering ( )
Get current sort ordering of the sorting style.
- Since
- S60 3.1
Returns: Current sort ordering
ResetL ( )
void | ResetL | ( | ) | [pure virtual] |
Reset settings of the sorting style to default.
- Since
- S60 3.1
SetOrdering ( TCLFSortingStyleOrdering )
Set sort ordering. Ordering can be ascending or descending. See TCLFSortingStyleOrdering
- Since
- S60 3.1
Parameter | Description | aOrdering | Sort ordering to be set |
SetSortingDataType ( TCLFItemDataType )
Set data type of sorting parameter fields. Data type can be text, time or number. See TCLFItemDataType
- Since
- S60 3.1
Parameter | Description | aDataType | Data type to be set |
SetUndefinedItemPosition ( TCLFUndefinedItemPosition )
Set undefined item position. Items not having information for defined sorting parameter fields are placed to top or bottom of the model. See TCLFUndefinedItemPosition
- Since
- S60 3.1
Parameter | Description | aUndefinedItemPosition | Position for undefiened items |
SortingDataType ( )
Get current sorting data type of fields.
- Since
- S60 3.1
Returns: Current data type sorting of sorting fields
UndefinedItemPosition ( )
Get current position of undefined items.
- Since
- S60 3.1
Returns: Current position for undefined items