MCLFContentListingEngine Class Reference

API published in: S60 3rd Ed FP 1

Link against: contentlistingframework.lib

Capability Information

Required Capabilities

None

#include <mclfcontentlistingengine.h>

Detailed Description

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 );

Public Member Functions
virtual  ~MCLFContentListingEngine ()
  Destructor.
virtual MCLFItemListModel *  CreateListModelLC (MCLFOperationObserver &aObserver)=0
  Create a new instance of the Item List Model.
virtual MCLFItemListModel *  CreateListModelLC (MCLFOperationObserver &aObserver, TResourceReader &aResource)=0
  Create a new instance of Item List Model from the application resource.
virtual void  AddChangedItemObserverL (MCLFChangedItemObserver &aObserver)=0
  Add a changed item observer to the Engine.
virtual void  RemoveChangedItemObserver (MCLFChangedItemObserver &aObserver)=0
  Remove a changed item observer from the Engine.
virtual void  AddCLFProcessObserverL (MCLFProcessObserver &aObserver)=0
  Add CLF process observer.
virtual void  RemoveCLFProcessObserver (MCLFProcessObserver &aObserver)=0
  Remove CLF process observer.
virtual void  UpdateItemsL ()=0
  Send item update notification.
virtual void  UpdateItemsL (const TArray< TCLFItemId > &aItemIDArray)=0
  Send item update notification.
virtual void  UpdateItemsL (TInt aSemanticId, const TDesC8 &aOpaqueData)=0
  Send item update notification.

Constructor & Destructor Documentation

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

Destructor.

Member Function Documentation

virtual void MCLFContentListingEngine::AddChangedItemObserverL (  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.

Parameters:
aObserver  Changed item observer to be added
virtual void MCLFContentListingEngine::AddCLFProcessObserverL (  MCLFProcessObserver &  aObserver  )  [pure virtual]
 

Add CLF process observer.

Remember to remove the observer before delete the observer object.

Parameters:
aObserver  Process observer to be added
virtual MCLFItemListModel* MCLFContentListingEngine::CreateListModelLC (  MCLFOperationObserver &  aObserver,
TResourceReader &  aResource
)  [pure virtual]
 

Create a new instance of Item List Model from the application resource.

Parameters:
aObserver  Reference to an Operation Observer.
aResource  Resource reader to list model resource. Use resource struct CLF_LIST_MODEL. See CLFContentListing.rh
Returns:
New instance of Item List Model. Ownership is transfered to the client application.
virtual MCLFItemListModel* MCLFContentListingEngine::CreateListModelLC (  MCLFOperationObserver &  aObserver  )  [pure virtual]
 

Create a new instance of the Item List Model.

Parameters:
aObserver  Reference to an Operation Observer
Returns:
New instance of the Item List Model. Ownership is transfered to the client application.
virtual void MCLFContentListingEngine::RemoveChangedItemObserver (  MCLFChangedItemObserver &  aObserver  )  [pure virtual]
 

Remove a changed item observer from the Engine.

Parameters:
aObserver  Changed item observer to be removed
virtual void MCLFContentListingEngine::RemoveCLFProcessObserver (  MCLFProcessObserver &  aObserver  )  [pure virtual]
 

Remove CLF process observer.

Parameters:
aObserver  Process observer to be removed
virtual void MCLFContentListingEngine::UpdateItemsL (  TInt  aSemanticId,
const TDesC8 &  aOpaqueData
)  [pure virtual]
 

Send item update notification.

Client must use this method when media item(s) is changed or deleted.

Parameters:
aSemanticId  Sematic ID is transfered to server plugins
aOpaqueData  Opaque data is transfered to server plugins
virtual void MCLFContentListingEngine::UpdateItemsL (  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.

Parameters:
aItemIDArray  List of Item IDs of modified items
virtual void MCLFContentListingEngine::UpdateItemsL (   )  [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!

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top