MCLFContentListingEngine Class Reference

class MCLFContentListingEngine

Content Listing Engine. With Content Listing Engine, client can create item list models, add an observer to get notifications of changed items and send update notifications to server. Client can create an instance this class with ContentListingFactory. Usage:

  // Create a new instance with Content Listing Factory
  MCLFContentListingEngine* engine =
                    ContentListingFactory::NewContentListingEngineLC();

  // Add changed item observer
  engine->AddChangedItemObserverL( *myObserver );

  // Send update notification when item is changed.
  engine->UpdateItemsL();

  // Remember to remove the observer, when it is deleted
  engine->RemoveChangedItemObserver( *myObserver );
ContentListingFramework.lib
Since
S60 3.1

Constructor & Destructor Documentation

~MCLFContentListingEngine()

~MCLFContentListingEngine()[inline, virtual]

Destructor.

Member Functions Documentation

AddCLFProcessObserverL(MCLFProcessObserver &)

voidAddCLFProcessObserverL(MCLFProcessObserver &aObserver)[pure virtual]
Add CLF process observer. Remember to remove the observer before delete the observer object.
Since
S60 3.1

Parameters

MCLFProcessObserver & aObserverProcess observer to be added

AddChangedItemObserverL(MCLFChangedItemObserver &)

voidAddChangedItemObserverL(MCLFChangedItemObserver &aObserver)[pure virtual]
Add a changed item observer to the Engine. Changed item observer will notify you when items are changed, added or removed. Remember to remove the observer before you delete observer object.
Since
S60 3.1

Parameters

MCLFChangedItemObserver & aObserverChanged item observer to be added

CreateListModelLC(MCLFOperationObserver &)

MCLFItemListModel *CreateListModelLC(MCLFOperationObserver &aObserver)[pure virtual]
Create a new instance of the Item List Model.
Since
S60 3.1

Parameters

MCLFOperationObserver & aObserverReference to an Operation Observer

CreateListModelLC(MCLFOperationObserver &, TResourceReader &)

MCLFItemListModel *CreateListModelLC(MCLFOperationObserver &aObserver,
TResourceReader &aResource
)[pure virtual]
Create a new instance of Item List Model from the application resource.
Since
S60 3.1

Parameters

MCLFOperationObserver & aObserverReference to an Operation Observer.
TResourceReader & aResourceResource reader to list model resource. Use resource struct CLF_LIST_MODEL. See CLFContentListing.rh

Extension()

MCLFContentListingEngineExt *Extension()[private, inline, virtual]

This member is internal and not intended for use.

RemoveCLFProcessObserver(MCLFProcessObserver &)

voidRemoveCLFProcessObserver(MCLFProcessObserver &aObserver)[pure virtual]
Remove CLF process observer.
Since
S60 3.1

Parameters

MCLFProcessObserver & aObserverProcess observer to be removed

RemoveChangedItemObserver(MCLFChangedItemObserver &)

voidRemoveChangedItemObserver(MCLFChangedItemObserver &aObserver)[pure virtual]
Remove a changed item observer from the Engine.
Since
S60 3.1

Parameters

MCLFChangedItemObserver & aObserverChanged item observer to be removed

UpdateItemsL()

voidUpdateItemsL()[pure virtual]
Send item update notification. Client must use this method when media item(s) is changed or deleted. This method call will request the CLF server to update its list of items. Unneccesary update notifications should be avoided because they generate load to the system!
Since
S60 3.1

UpdateItemsL(const TArray< TCLFItemId > &)

voidUpdateItemsL(const TArray< TCLFItemId > &aItemIDArray)[pure virtual]
Send item update notification. Client must use this method when media item(s) is changed or deleted. This method call will request the CLF server to update items that are defined in the TArray.
Since
S60 3.1

Parameters

const TArray< TCLFItemId > & aItemIDArrayList of Item IDs of modified items

UpdateItemsL(TInt, const TDesC8 &)

voidUpdateItemsL(TIntaSemanticId,
const TDesC8 &aOpaqueData
)[pure virtual]
Send item update notification. Client must use this method when media item(s) is changed or deleted.
Since
S60 3.1

Parameters

TInt aSemanticIdSematic ID is transfered to server plugins
const TDesC8 & aOpaqueDataOpaque data is transfered to server plugins