Nokia N97 SDK
Example Applications Guide

CCEOperationObserver Class Reference

#include <CCEOperationObserver.h>

Inheritance diagram for CCEOperationObserver:

List of all members.

Detailed Description

CLF Operation Observer. Example of CLF Operation Observer that receives operation events of Content Listing Framework. Operation event is generated when asynchronous refresh operation of List Model is finished.

Definition at line 35 of file CCEOperationObserver.h.


Public Member Functions

virtual  ~CCEOperationObserver ()
TBool  IsRefreshOngoing ()
void  PrepareForRefresh (CActiveSchedulerWait &aWait)
void  SetMusicView (CCEMusicView *aTarget)
void  RemoveMusicView ()

Static Public Member Functions

static CCEOperationObserver *  NewL ()

Protected Member Functions

void  HandleOperationEventL (TCLFOperationEvent aOperationEvent, TInt aError)

Private Member Functions

  CCEOperationObserver ()

Private Attributes

CActiveSchedulerWait *  iWait
TBool  iRefreshOngoing
CCEMusicView *  iTarget


Constructor & Destructor Documentation

CCEOperationObserver::~CCEOperationObserver (   )  [virtual]
 

Destructor.

Definition at line 53 of file CCEOperationObserver.cpp.

00054     {
00055     }

CCEOperationObserver::CCEOperationObserver (   )  [private]
 

C++ default constructor.

Definition at line 37 of file CCEOperationObserver.cpp.

00038     {
00039     }


Member Function Documentation

CCEOperationObserver * CCEOperationObserver::NewL (   )  [static]
 

Creates and returns a new instance of this class.

Returns:
Pointer to the CCEOperationObserver object

Definition at line 46 of file CCEOperationObserver.cpp.

Referenced by CCEAppUi::ConstructL().

00047     {
00048     CCEOperationObserver* self = new (ELeave) CCEOperationObserver;
00049     return self;
00050     }

void CCEOperationObserver::HandleOperationEventL (  TCLFOperationEvent  aOperationEvent,
TInt  aError
)  [protected]
 

From MCLFOperationObserver. Method to handle list model operation events.

Parameters:
aOperationEvent  List model operation event
aError  System wide error code

Definition at line 62 of file CCEOperationObserver.cpp.

References iRefreshOngoing, and iWait.

00065     {
00066     // Waiting is stopped when an event for refresh completion is received
00067     if( aOperationEvent == ECLFRefreshComplete )
00068         {
00069         iRefreshOngoing = EFalse;
00070 
00071         if( iWait && iWait->IsStarted() )
00072             {
00073             iWait->AsyncStop();
00074             }
00075         }
00076     else if( aOperationEvent == ECLFModelOutdated )
00077         {
00078         if( iTarget )
00079             {
00080             // Report the music files view that there are new/changed files
00081             // in the file system.
00082             iTarget->ItemsChangedL();
00083             }
00084         }
00085     }

TBool CCEOperationObserver::IsRefreshOngoing (   ) 
 

Check if there is a refresh operation is ongoing.

Returns:
ETrue if refresh is not finished, EFalse if refresh is finished

Definition at line 92 of file CCEOperationObserver.cpp.

References iRefreshOngoing.

Referenced by CCEGroupView::HandleCommandL().

00093     {
00094     return iRefreshOngoing;
00095     }

void CCEOperationObserver::PrepareForRefresh (  CActiveSchedulerWait &  aWait  ) 
 

Prepare for a refresh operation to start.

Parameters:
aWait  The wait instance to stop when refreshing is completed

Definition at line 102 of file CCEOperationObserver.cpp.

References iRefreshOngoing, and iWait.

Referenced by CCEGroupView::DoActivateL(), and CCEMusicView::ItemsChangedL().

00103     {
00104     // Store the wait instance
00105     iWait = &aWait;
00106 
00107     // Refresh operation will be started in a moment
00108     iRefreshOngoing = ETrue;
00109     }

void CCEOperationObserver::SetMusicView (  CCEMusicView *  aTarget  ) 
 

Set Music view

Parameters:
aTarget  Music view that will be notified about item changes

Definition at line 115 of file CCEOperationObserver.cpp.

References iTarget.

00116     {
00117     iTarget = aTarget;
00118     }

void CCEOperationObserver::RemoveMusicView (   ) 
 

Remove Music view

Definition at line 124 of file CCEOperationObserver.cpp.

References iTarget.

Referenced by CCEMusicView::~CCEMusicView().

00125     {
00126     iTarget = NULL;
00127     }


The documentation for this class was generated from the following files:

© Nokia 2009

Back to top