S60 3rd Edition API Reference: MCLFModifiableItem Class Reference

MCLFModifiableItem Class Reference

API published in: S60 3rd Ed FP 1

Link against: contentlistingframework.lib

Capability Information

Required Capabilities

None

#include <mclfmodifiableitem.h>

Inherits MCLFItem.

Detailed Description

Modifiable item for Content Listing Framework.

Use ContentListingFactory to create modifiable items. These new items are used as groups in the custom grouper (see MCLFCustomGrouper). Modifiable item is like MCLFItem but you can add new fields to the modifiable item. One item can contain multiple fields, but normally it is not needed in a custom grouper. The field consists of a Field ID and field data. Type of the field is defined with Field ID. See TCLFDefaultFieldId in CLFContentListing.hrh.

Example: 

  // Create a modifiable item and add one string field to it.
  // Field id is ECLFFieldIdArtist and field value is "test".
  _LIT( KTest, "test" );
  MCLFModifiableItem* item = ContentListingFactory::NewModifiableItemLC();
  item->AddFieldL( ECLFFieldIdArtist, KTest );
  CleanupStack::Pop(); // item

Public Member Functions

virtual ~MCLFModifiableItem ()
 Destructor.
virtual void AddFieldL (TCLFFieldId aFieldId, const TDesC &aValue)=0
 Add new string field to the item.
virtual void AddFieldL (TCLFFieldId aFieldId, TInt32 aValue)=0
 Add new integer field to the item.
virtual void AddFieldL (TCLFFieldId aFieldId, const TTime &aValue)=0
 Add new time field to the item.

Constructor & Destructor Documentation

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

Destructor.

Member Function Documentation

virtual void MCLFModifiableItem::AddFieldL ( TCLFFieldId  aFieldId,
const TTime &  aValue
)  [pure virtual]
 

Add new time field to the item.

Parameters:
aFieldId Field ID
aValue Field value
virtual void MCLFModifiableItem::AddFieldL ( TCLFFieldId  aFieldId,
TInt32  aValue
)  [pure virtual]
 

Add new integer field to the item.

Parameters:
aFieldId Field ID
aValue Field value
virtual void MCLFModifiableItem::AddFieldL ( TCLFFieldId  aFieldId,
const TDesC &  aValue
)  [pure virtual]
 

Add new string field to the item.

Parameters:
aFieldId Field ID
aValue Field value
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top