S60 3rd Edition API Reference: MCLFSortingStyle Class Reference

MCLFSortingStyle Class Reference

API published in: S60 3rd Ed FP 1

Link against: contentlistingframework.lib

Capability Information

Required Capabilities

None

#include <mclfsortingstyle.h>

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.

Public Member Functions

virtual ~MCLFSortingStyle ()
 Destructor.
virtual void ResetL ()=0
 Reset settings of the sorting style to default.
virtual void SetOrdering (TCLFSortingStyleOrdering aOrdering)=0
 Set sort ordering.
virtual TCLFSortingStyleOrdering Ordering () const =0
 Get current sort ordering of the sorting style.
virtual void SetSortingDataType (TCLFItemDataType aDataType)=0
 Set data type of sorting parameter fields.
virtual TCLFItemDataType SortingDataType () const =0
 Get current sorting data type of fields.
virtual void SetUndefinedItemPosition (TCLFUndefinedItemPosition aUndefinedItemPosition)=0
 Set undefined item position.
virtual TCLFUndefinedItemPosition UndefinedItemPosition () const =0
 Get current position of undefined items.
virtual void AddFieldL (TCLFFieldId aFieldId)=0
 Add new field to the sorting style.
virtual void GetFieldsL (RArray< TCLFFieldId > &aArray) const =0
 Get IDs of fields that have been set to the sorting style.

Constructor & Destructor Documentation

virtual MCLFSortingStyle::~MCLFSortingStyle (   )  [inline, virtual]
 

Destructor.

Member Function Documentation

virtual void MCLFSortingStyle::AddFieldL ( TCLFFieldId  aFieldId  )  [pure virtual]
 

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

Parameters:
aFieldId Id of the sorting parameter field
virtual void MCLFSortingStyle::GetFieldsL ( RArray< TCLFFieldId > &  aArray  )  const [pure virtual]
 

Get IDs of fields that have been set to the sorting style.

Parameters:
aArray Array of field IDs
virtual TCLFSortingStyleOrdering MCLFSortingStyle::Ordering (   )  const [pure virtual]
 

Get current sort ordering of the sorting style.

Returns:
Current sort ordering
virtual void MCLFSortingStyle::ResetL (   )  [pure virtual]
 

Reset settings of the sorting style to default.

virtual void MCLFSortingStyle::SetOrdering ( TCLFSortingStyleOrdering  aOrdering  )  [pure virtual]
 

Set sort ordering.

Ordering can be ascending or descending. See TCLFSortingStyleOrdering

Parameters:
aOrdering Sort ordering to be set
virtual void MCLFSortingStyle::SetSortingDataType ( TCLFItemDataType  aDataType  )  [pure virtual]
 

Set data type of sorting parameter fields.

Data type can be text, time or number. See TCLFItemDataType

Parameters:
aDataType Data type to be set
virtual void MCLFSortingStyle::SetUndefinedItemPosition ( TCLFUndefinedItemPosition  aUndefinedItemPosition  )  [pure virtual]
 

Set undefined item position.

Items not having information for defined sorting parameter fields are placed to top or bottom of the model. See TCLFUndefinedItemPosition

Parameters:
aUndefinedItemPosition Position for undefiened items
virtual TCLFItemDataType MCLFSortingStyle::SortingDataType (   )  const [pure virtual]
 

Get current sorting data type of fields.

Returns:
Current data type sorting of sorting fields
virtual TCLFUndefinedItemPosition MCLFSortingStyle::UndefinedItemPosition (   )  const [pure virtual]
 

Get current position of undefined items.

Returns:
Current position for undefined items
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top