1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // Started by BLB, October 1996
15 // Active object for tracking changes in TLocale
21 inline CEnvironmentChangeNotifier::CEnvironmentChangeNotifier(TInt aPriority)
23 {__DECLARE_NAME(_S("CEnvironmentChangeNotifier"));}
26 EXPORT_C CEnvironmentChangeNotifier* CEnvironmentChangeNotifier::NewL(TInt aPriority,const TCallBack& aCallBack)
27 /** Constructs a new environment change notifier object with the specified active
28 object priority and callback function.
30 The function requires a priority value for this active object and a reference
31 to a TCallBack object encapsulating a pointer to the call back function which
32 is to run when change events occur.
34 As part of its implementation, the function:
36 creates a Kernel side change notifier and opens a handle (an RChangeNotifier)
39 adds this active object to the current active scheduler.
41 Note that construction of the environment change notifier does not issue any
42 requests for change events.
44 @param aPriority The priority of this active object. Priority values determine
45 the order in which an active scheduler handles completed active object requests.
46 @param aCallBack A reference to a callback object which the caller must construct
47 to encapsulate the callback function.
48 @return A pointer to the new environment change notifier object.
49 @see CEnvironmentChangeNotifier::Start()
50 @see CActive::TPriority */
52 CEnvironmentChangeNotifier* This=new(ELeave) CEnvironmentChangeNotifier(aPriority);
53 This->iChangeNotifier.Create();
55 CActiveScheduler::Add(This);
59 EXPORT_C CEnvironmentChangeNotifier::~CEnvironmentChangeNotifier()
60 /** Destructor. Frees all resources owned by the object, prior to its destruction.
62 In particular, it cancels any outstanding request to the Kernel side change
63 notifier before closing the handle to it. */
66 iChangeNotifier.Close();
69 EXPORT_C void CEnvironmentChangeNotifier::Start()
70 /** Issues a request for change events.
72 The request completes when change events occur, as signalled by the Kernel
73 side change notifier service. The request may also complete if it is cancelled
74 by calling the Cancel() member function of this active object.
76 When change events occur, the callback function is called.
78 Note that after the first call to this function, the callback function is
79 called immediately; this is because of the way the underlying change notifier
80 is implemented. The changes reported are all those defined by the TChanges
83 @see CActive::Cancel()
87 iChangeNotifier.Logon(iStatus);
90 EXPORT_C TInt CEnvironmentChangeNotifier::Set(const TCallBack& aCallBack)
91 /** Sets the callback function.
93 A callback is normally set when this active object is constructed through
94 the NewL() function. This function replaces any existing callback object with
95 the specified callback object.
97 @param aCallBack A reference to the call back object encapsulating the call
99 @return KErrNone if successful, KErrInUse if this active object currently has
100 an outstanding request for change events, or another of the system-wide error-codes. */
108 void CEnvironmentChangeNotifier::RunL()
110 // Active framework: Call the callback function
113 iChange=iStatus.Int();
117 iCallBack.CallBack();
122 void CEnvironmentChangeNotifier::DoCancel()
124 // Active framework: Cancel the current request
127 iChangeNotifier.LogonCancel();