williamr@2: /*
williamr@2: * Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:  ?Description
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #if !defined(__AKNWSEVENTOBSERVER_H__)
williamr@2: #define __AKNWSEVENTOBSERVER_H__
williamr@2: 
williamr@2: // INCLUDES
williamr@2: #include <e32std.h>
williamr@2: //#include <w32std.h>
williamr@2: #include <coecntrl.h>
williamr@2: 
williamr@2: // CONSTANTS
williamr@2: 
williamr@2: enum TAknWsEventObserverPanic
williamr@2: 	{
williamr@2: 	EAknWsEventObserverFailedToAddObserver,
williamr@2: 	EAknWsEventObserverUnknownObserverRemoved
williamr@2: 	};
williamr@2: 
williamr@2: GLREF_C void Panic(TAknWsEventObserverPanic aPanic);
williamr@2: 
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2: *  Support for events to be sent independent of the control stack to other 
williamr@2: *  consumers yet internal to the application.
williamr@2: *
williamr@2: *  
williamr@2: */
williamr@2: class MAknWsEventObserver
williamr@2: 	{
williamr@2: public:
williamr@2: 	virtual void HandleWsEventL(const TWsEvent& aEvent,CCoeControl* aDestination) = 0;
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2: *  This class distributes events to the window server event observers; 
williamr@2: *  It is itself a window server event observer.
williamr@2: *
williamr@2: *  @since Series 60 0.9
williamr@2: */
williamr@2: class CAknWsEventMonitor: public CBase, public MAknWsEventObserver
williamr@2: {
williamr@2: public:
williamr@2: 
williamr@2:     /**
williamr@2:     * Two-phased constructor.
williamr@2:     */
williamr@2: 	static CAknWsEventMonitor* NewL();
williamr@2: 
williamr@2:     /**
williamr@2:     * Destructor.
williamr@2:     */
williamr@2: 	virtual ~CAknWsEventMonitor();
williamr@2: 
williamr@2:     /**
williamr@2:     * Two-phased constructor.
williamr@2:     */
williamr@2: 	void ConstructL();
williamr@2: 
williamr@2:     /**
williamr@2:     * Adds an event observer if there is not one yet.
williamr@2:     * @param aEventObserver A pointer to the event observer.
williamr@2:     */
williamr@2: 	IMPORT_C void AddObserverL(MAknWsEventObserver* aEventObserver);
williamr@2: 
williamr@2:     /**
williamr@2:     * Removes the event observer.
williamr@2:     * @param aEventObserver A pointer to the event observer. (not used in default implementation)
williamr@2:     */
williamr@2: 	IMPORT_C void RemoveObserver(const MAknWsEventObserver* aEventObserver);
williamr@2: 
williamr@2:     /**
williamr@2:     * Window server event handler.
williamr@2:     * @param aEvent The event.
williamr@2:     * @param aDestination Event destination.
williamr@2:     */
williamr@2: 	IMPORT_C void HandleWsEventL(const TWsEvent& aEvent,CCoeControl* aDestination);
williamr@2: 	
williamr@2:     /**
williamr@2:     * Enables / disables event observer. AknAppUi provides all window server events to enabled monitor automatically
williamr@2:     *
williamr@2:     * @since S60 3.2
williamr@2:     */
williamr@2:     IMPORT_C void Enable(TBool aEnable = ETrue);
williamr@2: 	
williamr@2: 	/**
williamr@2: 	* Internal to Avkon
williamr@2: 	*
williamr@2: 	* @since S60 3.2
williamr@2: 	*/	
williamr@2: 	TBool IsEnabled();
williamr@2: 	
williamr@2: 	
williamr@2: 
williamr@2: private:
williamr@2: 	RPointerArray<MAknWsEventObserver>* iEventObservers;
williamr@2: 	TBool iEnabled; // was TInt iSpare;
williamr@2: 
williamr@2: private:
williamr@2: // reserved virtual function space
williamr@2: 	IMPORT_C virtual void Reserved_1();
williamr@2: 
williamr@2: };
williamr@2: 
williamr@2: 
williamr@2: #endif  // __AKNWSEVENTOBSERVER_H__