/*

* Copyright (c) 2005-2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* 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".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Defination for peninput server

*

*/

#ifndef C_CPENINPUTSERVER_H

#define C_CPENINPUTSERVER_H

//  INCLUDES

#include <e32base.h>

#include <w32std.h>

#include <e32msgqueue.h>

#include <peninputlayoutplugininterface.h>

#include <peninputlayouteng.h>

#include "peninputmsgqueue.h"

#include <e32property.h>

#include <centralrepository.h>

#include "peninputcmdparamext.h"

// the maximum count of TUpdateArea that area pool can hold

const TInt KMaxRectNumInBuf = 100;

class CCoeControl;

class CPeninputAnimObj;

class CPeninputUiLayoutOwner;

class CPenUiWndCtrl;

class CInternalBkCtrl;

class CKeyRotator;

class CPenInputCrpServiceClient;

// panic code

enum TPeninputServerPanic

    {

    EBadRequest = -2000,

    EBadDescriptor,

    EMainSchedulerError,

    ESvrCreateServer,

    ESvrStartServer,

    ECreateTrapCleanup,

    ENotImplementedYet,

    ESessionTimeout,

    ENullSession

    };

//#define __LOG_WNDGROU__

// ==================== GLOBAL FUNCTIONS ====================

/** 

 * Function to panic the server

 *

 * @since S60 ?S60_version

 * @param aPanic The panic id

 */

GLREF_C void PanicServer(TPeninputServerPanic aPanic );

// CONSTANTS

// FORWARD DECLARATIONS

class CPeninputServerSession;

class RMessage;

class CEventQueue;

class CPtiEngine;

class CAknLayoutChangeWatcher;

// DESCRIPTION

/**

 * Class MRawEventHandler

 * Raw event handler interface

 *

 * @since S60 v4.0

 */

class MRawEventHandler

    {

public:

    /**

     * Handle event. Handle raw event from pen input animation

     *

     * @since S60 v4.0

     * @param aEvent The event to be processed

     */                

    virtual void HandleRawEventL(const TRawEvent& aEvent) = 0 ;

    };

// DESCRIPTION

/**

 * The server class; an active object.

 *

 * Contains an instance of RServer; a handle to the kernel server representation which is used 

 * to receive messages. 

 *

 * @since S60 v4.0

 */

NONSHARABLE_CLASS(CPeninputServer) : public CServer2, MRawEventHandler

{

public:

    // reasons for server panic

    // Constructors and destructor

    /** 

     * Epoc constructor. Leaves the created object on cleanup stack.

     *

     * @since S60 v4.0

     */

    static CPeninputServer* NewL();    

    /**

     * Destructor

     *

     * @since S60 v4.0

     */

    virtual ~CPeninputServer();

    /**

     * Increase number of sessions

     *

     * @since S60 v4.0

     */

    void IncreaseSessionCount();

    /**

     * Decrease number of sessions

     *

     * @since S60 v4.0

     * @param aSession The session to be closed.

     */

    void DecreaseSessionCount(CPeninputServerSession* aSession);

    /**

     * Handle client command

     *

     * @since S60 v4.0

     * @param aMessage The client messasge

     * @return Operation result code

     */

    TInt HandleCommandL(const RMessage2& aMessage);

    /**

     * Handle client message

     *

     * @since S60 v4.0

     * @param aMessage The client messasge

     * @return KErrNone if operation successfully. Otherwise any operation 

     *                  specified error

     */

    TInt HandleMessageL(const RMessage2& aMessage);

    /**

     * Signal server obserer

     *

     * @since S60 v4.0

     * @param aEventId The event id

     * @param aEventData The event data

     */

    void SignalObserverL(TInt aEventId , const TDesC& aEventData);

    /**

     * Create ui layout

     *

     * @since S60 v4.0

     * @param aLayoutId The layout id

     * @return ETrue if creation successfully. Otherwise EFalse

     */

    TBool SetLayoutId(TInt aLayoutId);

    /**

     * Handling client sieze change event

     *

     * @since S60 v4.0

     */

    void SizeChanged();

    /**

     * Change display mode

     *

     * @since S60 v4.0

     * @param aMode The new display mode

     * @param aMaskMode The new display mode for mask device

     */    

    void ChangeDisplayModeL(TDisplayMode aMode,TDisplayMode aMaskMode);

    /**

     * Timer call back for CPeriod

     *

     * @since S60 v4.0

     * @param aPtr The data passed to callback function

     * @return The processed result. Always ETrue, not used here.

     */  

    static TInt FlushTimerCallBack(TAny *aPtr);    

    /**

     * Flush the window session. This causes all bufferd command sent to pen 

     * input animation.

     *

     * @since S60 v4.0     

     */      

     void FlushWsSession();

    /**

     * low priority construction.

     *

     * @since S60 v4.0     

     */           

    void DoIdleConstructL();

    /**

     * Handle application resource change

     *

     * @since S60 v4.0     

     * @param aType The event type

     */               

    void HandleResourceChange(TInt aType);

    /**

     * Handle property change

     *

     * @since S60 v4.0     

     * @param aData The event data

     */                   

    static TInt PropertyChangeCallBack(TAny* aData);

    /**

     * Hide layout temporary

     *

     * @since S60 v4.0     

     * @param aData The event data

     */                       

    void HideLayoutTemporaryL();    

    void PrepareExit();

    /**

     * Set new disabled layouts of current session

     *

     * @since S60 v4.0     

     * @return KErrNone if everything ok.

     */         

    TInt SetDisabledLayouts( TInt aDisabledLayouts );

    /**

     * Get new disabled layouts of current TProcessId

     *

     * @since S60 v4.0     

     * @return KErrNone if everything ok.

     */  

    TInt GetProcessLayouts( const TProcessId& aProcessId, TInt& aLayouts );

    /**

     * Set new disabled layouts of current TProcessId

     *

     * @since S60 v4.0     

     * @return KErrNone if everything ok.

     */  

    TInt SetProcessLayouts( const TProcessId& aProcessId, TInt aLayouts);

    /**

     * Delete new disabled layouts of current TProcessId

     *

     * @since S60 v4.0     

     * @return KErrNone if everything ok.

     */  

    void DelProcessLayouts( const TProcessId& aProcessId );

    //from base class CServer2

    /** 

     * From CServer2

     * Create sesssion

     *

     * @since S60 v4.0

     * @param aVersion server version

     * @param aMessage Client message

     * @return a CSharableSession instance

     */

    CSession2* NewSessionL(const TVersion& aVersion, const RMessage2& aMessage) const;

public: // From MRawEventHandler

    /**

     * From MRawEventHandler

     * handle raw event

     *

     * @since S60 v4.0

     * @param aEvent The event to be processed.

     */    

    void HandleRawEventL(const TRawEvent& aEvent);

public: // handle layoutowner event

    /** 

     * Update the UI area

     * @since S60 v4.0

     * @param aRect The rect to be updated

     * @param aFullUpdate Full update flag

     * @param aImmedFlag Flags indicates immediately update

     */

    void UpdateArea(const TRect& aRect,TBool aFullUpdate, TBool aImmedFlag );

    /**

     * Set layout position

     *

     * @since S60 v4.0

     * @param aNewPos The layout position

     */

    TPoint SetPosition(const TPoint& aNewPos);

    /**

     * Get bitmap context

     *

     * @since S60 v4.0

     * @return The bitmap context

     */

    CBitmapContext* BitmapContext();

    /**

     * Get bitmap device

     *

     * @since S60 v4.0

     * @return The bitmap device

     */

    CFbsBitmapDevice* BitmapDevice();

    /**

     * Get mask bitmap device

     *

     * @since S60 v4.0

     * @return The mask bitmap device

     */

    CFbsBitmapDevice* MaskBmpDevice();

    /**

     * Show or hide sprite

     *

     * @since S60 v4.0

     * @param aHideFlag ETrue if hide sprite, otherwise show.

     */

    void Hide(TBool aHideFlag=ETrue);

    /**

     * Signal owner that there is an event

     *

     * @since S60 v4.0     

     * @param aEventType The event type

     * @param aEventData The event data

     */        

    void SignalOwner(TInt aEventType, const TDesC& aEventData);

    /**

     * Handle layout size change event

     *

     * @since S60 v4.0

     * @param aBut The character buffer

     * @param aCtrlId The control which sends the data

     */

    TInt LayoutSizeChanged(const TSize& aSize, TBool aNeedUpdate = ETrue);

    /**

     * Get layout position and it's rect.

     * The position is relative to it's parent window or screen.

     * The size includes all invisible layout area.

     *

     * @since S60 v4.0     

     * @return layout position.

     */       

    TRect LayoutRect();    

    void ExecutePendingAnimCmd();

    void HandleWsEventL(const TWsEvent &aEvent, CCoeControl *aDestination);    

    TBool AnimOpNeedWaiting(TInt aSignalCode);

    TInt HandleAppInfoChange(CPeninputServerSession* aSession,

                            const TDesC& aAppInfo, TPeninputAppInfo aType) const;

protected:  // New functions

    /**

     * Default constructor.

     *

     * @since S60 v4.0

     * @param aPriority priority of the server

     */

    CPeninputServer( TInt aPriority );

    //from base class CServer2

    /**

     * From CServer.

     *Handles possible leaves in 

     *

     * @since S60 v4.0

     * @param aError leave code of ServiceL()

     * @return error code after error handling

     */

    TInt RunError( TInt aError );

private:    // New functions

    /**

     * Second phase constructror.

     *

     * @since S60 v4.0

     */

    void ConstructL( );

    /**

     * Constructs the sprite anim ie. PENINPUT UI which is a window server plugin

     *

     * @since S60 v4.0

     */

    void ConstructSpriteL();

    /**

     * Constructs the sprite anim ie. PENINPUT UI which is a window server plugin

     *

     * @since S60 v4.0

     */

    void ConstructAnimL();    

    /**

     * Creates bimaps for the sprite.

     *

     * @since S60 v4.0

     * @param aBitmapSize size of the bitmap

     * @param aDisplayMode display mode of the bitmap

     * @return The initialized bitmap object (cleared to white)

     */

    CFbsBitmap* CreateBitmapL( const TSize& aBitmapSize, TDisplayMode aDisplayMode ) const;

    /**

     * Make peninput window visible

     *

     * @since S60 v4.0

     */

    void ActivateSprite();

    /**

     * Make peninput window visible

     *

     * @since S60 v5.0

     * @param aScrMode The required screen mode

     */

    void ActivateSprite(TInt aScrMode);

    /**

     * Show pen UI in global notes editor.

     *

     * @since S60 v5.0

     */

    void ActivateSpriteInGlobalNotesL();

    /**

     * Make peninput window invisible

     *

     * @since S60 v4.0

     * @param aImmediateHideFlag ETrue if UI is asked to be hidden immediately. Otherwise

     * hidding is wait until UI observer handles the notification

     */

    void DeactivateSprite(TBool aImmediateHideFlag = EFalse, TBool aRotation = EFalse);

    /**

     * Deactivate pen ui, but not close the UI.

     *

     * @since S60 v4.0

     * @param aWaitFlag Flag indicates whether operation should be waited until

     * observer processed.

     * @return ETrue if operation sucessfully.     

     */    

    TBool DeactivatePenUiLayout(TBool aWaitFlag);    

    /**

     * Deactivate pen ui, but not close the UI.

     *

     * @since S60 v4.0

     * @param aWaitFlag Flag indicates whether operation should be waited until

     * observer processed.

     * @return ETrue if operation sucessfully.     

     */    

    TBool DeactivateDimPenUiLayout(TBool aWaitFlag); 

    /**

     * Activate pen ui, but not redraw/open the UI.

     *

     * @since S60 v4.0

     * @param aWaitFlag Flag indicates whether operation should be waited until

     * observer processed.

     * @return ETrue if operation sucessfully.

     */    

    TBool ActivatePenUiLayout(TBool aWaitFlag, TBool aSkipDraw = EFalse);    

    /**

     * Create UI layout.

     *

     * @since S60 v4.0

     * @param aMessage The msg data from client

     * @return KErrNone if layout is created. Otherwise KErrNoLayout.

     */    

    TInt CreateLayoutL(const RMessage2& aMessage );

    /**

     * Clear the sprite

     *

     * @since S60 v4.0

     */        

    void ClearSpriteGc();

    /**

     * Draw sprite. It will draw the UI layout

     *

     * @since S60 v4.0

     */        

    void DrawSprite();

    /**

     * Get the session represents the foreground application

     *

     * @since S60 v4.0

     * @return The session represents foregound application

     */