localisation/apparchitecture/inc/apgnotif.h
branchSymbian3
changeset 57 b8d18c84f71c
parent 6 c108117318cb
--- a/localisation/apparchitecture/inc/apgnotif.h	Wed Jul 28 16:03:37 2010 +0100
+++ b/localisation/apparchitecture/inc/apgnotif.h	Tue Aug 03 10:20:34 2010 +0100
@@ -1,7 +1,7 @@
 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
 // All rights reserved.
 // This component and the accompanying materials are made available
-// under the terms of the License "Eclipse Public License v1.0"
+// under the terms of "Eclipse Public License v1.0"
 // which accompanies this distribution, and is available
 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
 //
@@ -21,7 +21,7 @@
 
 class MApaAppListServObserver
 /**
-MApaAppListServObserver
+MApaAppListServObserver is interface to get application list change notifications.
 
 @publishedPartner
 @released
@@ -44,9 +44,45 @@
 
 
 class CApaAppListNotifier : public CActive
-/** An application list change notifier. 
-
-It provides notification whenever an application is added or deleted.
+/** 
+ * CApaAppListNotifier is an active object which notifies the client when an application list is changed.
+ * Provides notification when applications are added, deleted or if the localisable data of an application
+ * is modified.
+ * 
+ * Clients can create instance of this class using NewL function which takes MApaAppListServObserver
+ * observer as one of the parameters. When application list is changed, CApaAppListNotifier will call 
+ * HandleAppListEvent function of the provided observer. 
+ * 
+ * 
+ * Example:
+ * 
+ * //Implementation of observer interface
+ * class CAppListChangeObserver:public CBase, public MApaAppListServObserver
+ * {
+ * public:
+ *     void HandleAppListEvent(TInt aEvent);    
+ *     CApaAppListNotifier* iNotifier;    
+ * };
+ * 
+ * //This function is called by CApaAppListNotifier when an application list is changed 
+ * void CAppListChangeObserver::HandleAppListEvent(TInt aEvent)
+ * {
+ *     //Handle application list change event
+ *     ...
+ * }
+ * 
+ * 
+ * TInt E32Main()
+ * {
+ * ....
+ * 
+ * CAppListChangeObserver* obs=new(ELeave) CAppListChangeObserver();
+ * CApaAppListNotifier *notif=CApaAppListNotifier::NewL(obs, CActive::EPriorityStandard);
+ * 
+ * ....
+ * }
+ * 
+ * 
 
 @publishedPartner
 @released */
@@ -57,6 +93,7 @@
 private: // from CActive
 	void DoCancel();
 	void RunL();
+    TInt RunError(TInt aError);	
 private:
 	CApaAppListNotifier(MApaAppListServObserver& aObserver, TPriority aPriority);
 	void ConstructL();