MCLFContentListingEngine Class Reference
#include
<mw/MCLFContentListingEngine.h>
Link against: ContentListingFramework.lib
| class MCLFContentListingEngine |
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 );
Constructor & Destructor Documentation
~MCLFContentListingEngine ( )
| ~MCLFContentListingEngine | ( | ) | [inline, virtual] |
Member Function Documentation
AddCLFProcessObserverL ( MCLFProcessObserver & )
Add CLF process observer. Remember to remove the observer before delete the observer object.
- Since
- S60 3.1
| Parameter | Description | | aObserver | Process observer to be added |
AddChangedItemObserverL ( MCLFChangedItemObserver & )
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
| Parameter | Description | | aObserver | Changed item observer to be added |
CreateListModelLC ( MCLFOperationObserver & )
Create a new instance of the Item List Model.
- Since
- S60 3.1
| Parameter | Description | | aObserver | Reference to an Operation Observer |
Returns: New instance of the Item List Model. Ownership is transfered to the client application.
CreateListModelLC ( MCLFOperationObserver &, TResourceReader & )
Create a new instance of Item List Model from the application resource.
- Since
- S60 3.1
| Parameter | Description | | 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.
RemoveCLFProcessObserver ( MCLFProcessObserver & )
Remove CLF process observer.
- Since
- S60 3.1
| Parameter | Description | | aObserver | Process observer to be removed |
RemoveChangedItemObserver ( MCLFChangedItemObserver & )
Remove a changed item observer from the Engine.
- Since
- S60 3.1
| Parameter | Description | | aObserver | Changed item observer to be removed |
UpdateItemsL ( )
| void | 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!
- Since
- S60 3.1
UpdateItemsL ( const TArray< TCLFItemId > & )
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
| Parameter | Description | | aItemIDArray | List of Item IDs of modified items |
UpdateItemsL ( TInt, const TDesC8 & )
| void | 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.
- Since
- S60 3.1
| Parameter | Description | | aSemanticId | Sematic ID is transfered to server plugins |
| aOpaqueData | Opaque data is transfered to server plugins |