/*

* Copyright (c) 2005-2007 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:  header file of HWR window base and transparent window control

*

*/

#ifndef C_CHWRWNDBASE_H

#define C_CHWRWNDBASE_H

#include <peninputlayoutbasecontrol.h>

#include <centralrepository.h>

class CPeninputPenTraceDecorator;

/**

 *  CHwrWndBase

 *

 *  Base control for all hwr window.

 *

 *  @lib feplayoutcontrol.lib

 *  @since S60 V4.0

 */

class CHwrWndBase : public CFepUiBaseCtrl, public MTimerHandler

                    //public MEventObserver

    {

public:    

    /**

     * Destructor.        

     *

     * @since S60 V4.0        

     */           

    IMPORT_C virtual ~CHwrWndBase();

    /**

     * Clear all strokes

     *

     * @since S60 V4.0

     */                               

    IMPORT_C virtual void ClearStroke(); 

    /**

     * Add guiding line

     *

     * @since S60 V4.0

     * @param aStart The start point of the guiding line

     * @param aEnd The end point of the guilding line

     */                                               

    IMPORT_C void AddGuidingLine(const TPoint& aStart, const TPoint& aEnd);                

    /**

     * A callback function. Called when finishing one stroke (pen up).

     *

     * @since S60 V4.0

     * @param aCharacterTimerFlag Flag indicates whether needs to set character timer        

     *                            Default value is ETrue, set the character timer   

     */                               

    /**

     * A callback function. Called when character timer out.

     * @since S60 V4.0

     */                                       

    virtual void EndStrokeAndClearL();            

    /**

     * Set stroke end mark. A stroke end mark indicates end of a stroke

     *

     * @since S60 V4.0

     * @param aPt The stroke end point        

     */                       

    inline void SetStrokeEndMark(const TPoint& aPt);

    /**

     * Set character timer. A character timer defines the maximum writing period.

     * Only those traces within the writing period, are considered belonging 

     * to the same character

     *

     * @since S60 V4.0

     * @param aCharDelay The character timer in micro seconds.

     */                                               

    inline void SetCharacterDelay(TTimeIntervalMicroSeconds32 aCharDelay);

    /**

     * Get the stroke list.

     *

     * @since S60 V4.0

     * @return The stroke list

     */                                                       

    inline const RArray<TPoint>& StrokeList();

    /**

     * Set stroke delay. A stroke delay defines the time when to start doing 

     * the recognition before next stroke starts.

     *

     * @since S60 V4.0

     * @param aStrokeDelay

     * @return The stroke list

     */       

    inline void SetStrokeDelay(TTimeIntervalMicroSeconds32 aStrokeDelay);    

    //maskcol       

    /**

     * get stroke end mark

     *

     * @since S60 V4.0        

     * @return The stroke end mark

     */        

    inline const TPoint& StrokeEndMark();

    /**

     * Do we have new trace

     *

     * @since S60 V4.0        

     * @return New trace flag

     */    

    inline TBool HasNewTrace();        

    /**

     * Get frame color

     *

     * Obsolete. Use BorderColor() instead.

     * @since S60 V4.0        

     * @return current frame color

     */        

    inline const TRgb& FrameCol();

    /**

     * Set frame color

     * Obsolete. Use SetBorderColor instead.

     *

     * @since S60 V4.0        

     * @param The new frame color

     */        

    inline void SetFrameCol(const TRgb& aCol);        

    /**

     * Cancel the writing. It will stops the timer and clear all strokes

     *

     * @since S60 V4.0        

     */

    IMPORT_C virtual void CancelCharWriting();        

    //from CFepUiBaseCtrl

    /**

     * From CFepUiBaseCtrl

     * Draw control

     *

     * @since S60 V4.0

     */                       

    IMPORT_C virtual void Draw();

    /**

     * From CFepUiBaseCtrl

     * Cancel pointer down event.

     * This will be called when a control has pointer down but pointer up 

     * event happens in other ways.

     *

     * @since S60 V4.0

     * @param aFocusedFlag ETrue if got focused, otherwise EFalse

     */                                

    virtual void CancelPointerDownL();

    //From base class MTimerHandler

    /**

     * From MTimerHandler

     * HandleTimerOut. Handling time out event

     *

     * @since S60 V4.0

     * @param aTimeType The timer type

     */                    

    IMPORT_C void HandleTimerOut(TInt aTimeType);           

    /**

     * Update the region where other control made dirty.

     *

     * @since S60 V4.0        

     * @return Current dirty rect

     */        

    IMPORT_C void UpdateRegion(CFepUiBaseCtrl* aCtrl);    

    /**

     * From CFepUiBaseCtrl

     * OnDeActivate. Called when the layout is going to be hidden

     *

     * @since S60 v4.0

     */        

    IMPORT_C void OnDeActivate();   

    /**

     * From CFepUiBaseCtrl

     * Call back function when layout starts dragging

     *

     * @since S60 V4.0

     */

    IMPORT_C void OnLayoutDraggingStart();

    /**

     * From CFepUiBaseCtrl    

     * Call back function when layout ends dragging

     *

     * @since S60 V4.0

     */

    IMPORT_C void OnLayoutDraggingEnd();

protected:

    /**

     * Constructor

     *

     * @since S60 V4.0

     * @param aRect The rectangle area for this control

     * @param aUiLayout Ui layout who contains this control.Ownership not transferred

     * @param aControlId control Id

     */       

    IMPORT_C CHwrWndBase(const TRect& aRect,CFepUiLayout* aUiLayout,TInt aControlId);    

    /**

     * Second phrase constructor.

     *

     * @since S60 V4.0

     */

    IMPORT_C void ConstructL();

    /**

     * Get dirty rect

     *

     * @since S60 V4.0        

     * @return Current dirty rect

     */        

    inline TRect& DirtyRect();   

    /**

     * From CFepUiBaseCtrl    

     * Handle pointer down event

     *

     * @since S60 V4.0

     * @param aPoint The point position relative the layout

     * @return The control which handles the event.     

     */                                        

    IMPORT_C virtual CFepUiBaseCtrl* HandlePointerDownEventL(const TPoint& aPoint);

    /**

     * From CFepUiBaseCtrl    

     * Handle pointer move event

     *

     * @since S60 V4.0

     * @param aPoint The point position relative the layout

     * @return The control which handles the event.     

     */                  

    IMPORT_C virtual CFepUiBaseCtrl* HandlePointerMoveEventL(const TPoint& aPoint);

    /**

     * From CFepUiBaseCtrl

     * Handle pointer up event

     *

     * @since S60 V4.0

     * @param aPoint The point position relative the layout

     * @return The control which handles the event.     

     */                  

    IMPORT_C virtual CFepUiBaseCtrl* HandlePointerUpEventL(const TPoint& aPoint);

private:

    /**

     * From CHwrWndBase

     * Draw point

     *

     * @since S60 V4.0

     * @param aPoint The point to be drawn

     * @param aDrawFlag Flag to tell whether to draw or erase stroke

     * @return The affected rect

     */        

    virtual TRect DrawPoint(const TPoint& aPoint,TBool aDrawFlag) =0;

    /**

     * From CHwrWndBase

     * Draw line

     *

     * @since S60 V4.0

     * @param aPt1 The start point

     * @param aPt2 The end point

     * @param aDrawFlag Flag to tell whether to draw or erase stroke

     * @return The affected rect

     */        

    virtual TRect DrawLine(const TPoint& aPt1,const TPoint& aPt2,TBool aDrawFlag ) =0;

    /**

     * Draw or erace current stroke

     * @param aDrawFlag ETrue if drawing, otherwise erase the trace

     * @return The minimum rect which current drawing/erasing affects

     */       

    IMPORT_C virtual TRect DrawStroke(TBool aDrawFlag);    

private:   

    /**

     * stoke end mark

     */

    TPoint iStrokeEndMark;

    /**

     * Previous point drawed

     */

    TPoint iPtPrev;

    /**

     * Character delay for character timer

     */

    TTimeIntervalMicroSeconds32 iCharDelay;

    /**

     * stroke delay for stroke timer.

     */

    TTimeIntervalMicroSeconds32 iStrokeDelay;            

    /**

     * Indicates whether we have new pen trace

     */

    TBool iHasNewTrace;

    TBool iSubmitted;

    /**

     * The rect which confines the trace.Due to pen size, the dirty rect would

     * sometimes bigger than iRect even trace can't be draw outside of the window. 

     */

    TRect iDirtyRect;

    /**

     * Frame color

     */

     //TRgb iFrameCol;

    /**

     * The trace data -- pointer list

     */

    RArray<TPoint> iListOfPoints;

    /**

     * stroke timer. Recognition stargs after timer out

     * Own.

     */

    CLayoutTimer* iStrokeTimer;

    /**

     * character time. Character writing finished after timer out.

     * Own.

     */

    CLayoutTimer* iCharacterTimer;

    /**

     * Reserved item1

     */

     TInt iReserved1;

    /**

     * Reserved item2

     */

     TInt iReserved2;    

    };

//end  of class CHwrWndBase

/**

 *  CTransparentHwrWnd

 *

 *  Transparent hwr window. This could be used for full-screen or non full screen hwr

 *

 *  @lib feplayoutcontrol.lib  

 *  @since S60 V4.0

 */

class CTransparentHwrWnd : public CHwrWndBase

    {

public:

    /**

     * Factory function.        

     *

     * @since S60 V4.0        

     * @param aRect The rectangle area for this control

     * @param aUiLayout Ui layout who contains this control.Ownership not transferred

     * @param aControlId control Id

     * @param aFullScreenFlag Fullscreen window flag. 

     *          ETrue if it's fullscreen window.

     * @return An instance of CTransparentHwrWnd class        

     */                           

    IMPORT_C static CTransparentHwrWnd* NewL(const TRect& aRect,CFepUiLayout* aUiLayout,

                            TInt aControlId,TBool aFullScreenFlag=EFalse);

    /**

     * Enable or disable whether trace can be outside of the writing window.

     *

     * @since S60 V4.0

     * @param aFlag ETrue if trace could be outside of window. Otherwise EFalse

     */       

    IMPORT_C void EnableTraceOutsideWindow(TBool aFlag);

    /**

     * Destructor.        

     *

     * @since S60 V4.0        

     */                                   

    IMPORT_C virtual ~CTransparentHwrWnd();

    /**

     * Set transpanrency grade

     *

     * @since S60 V4.0        

     * @param The transparancy factor. Opaque if 0, full transparency if 255    

     */

    IMPORT_C void SetWndTransparencyFactor(TUint8 aFactor);

    //from base class CFepUiBaseCtrl   

    /**

     * From CFepUiBaseCtrl

     * Draw control.

     *

     * @since S60 V4.0

     */               

    IMPORT_C virtual void Draw();

    /**

     * From CFepUiBaseCtrl

     * Update control's region when other control change its displaying status

     *

     * @since S60 V4.0

     * @param aCtrl The control whose hiding status changed. If NULL, recalulate the region.

     * @param bFlag tells control is removed or not. 

     */        

    IMPORT_C virtual void UpdateValidRegion(CFepUiBaseCtrl* aCtrl,TBool bRemoveFlag);

    /**

     * From CHwrWndBase

     * Clear all strokes

     *

     * @since S60 v5.0

     * @return none.

     */     

    IMPORT_C virtual void ClearStroke();

    /**

     * Install a new pen trace decorator.

     * 

     * @since S60 v5.0

     * @param aDecoratorName Specifies the name of new decorator

     * @param aEnable Specifies whether to enable the new decorator after install

     * @return ETrue if success.

     */

    IMPORT_C TBool InstallPenTraceDecoratorL(const TDesC& aDecoratorName, TBool aEnable = ETrue );

    /**

     * Test whether this window support pen trace decoration.

     * 

     * @since S60 v5.0

     * @return ETrue if support.

     */

    IMPORT_C TBool SupportPenTraceDecoration();

    /**

     * Test whether pen trace decoration is activated.

     * 

     * @since S60 v5.0

     * @return ETrue if support.

     */

    IMPORT_C TBool PenTraceDecorationActivated();

    /**

     * Activate/Deactivate pen trace decoration.

     * 

     * @since S60 v5.0

     * @param aActive Specifies whether to activate or deactivate

     * @param aReleaseBuffer Specifies whether to release buffer when deactivate

     * @return none

     */

    IMPORT_C void ActivatePenTraceDecoration(TBool aActive,TBool aReleaseBuffer=EFalse );

protected:

    /**

     * Default constructor.        

     *

     * @since S60 V4.0        

     * @param aRect The rectangle area for this control

     * @param aUiLayout Ui layout who contains this control.Ownership not transferred

     * @param aControlId control Id

     * @param aFullScreenFlag Fullscreen window flag. ETrue if it's fullscreen window.

     * @return An instance of CTransparentHwrWnd class        

     */                               

    IMPORT_C CTransparentHwrWnd(const TRect& aRect,CFepUiLayout* aUiLayout,

                                TInt aControlId,TBool aFullScreenFlag);        

    /**

     * From CFepUiBaseCtrl

     * Handle pointer down event

     *

     * @since S60 V4.0

     * @param aPoint The point position relative the layout

     * @return The control which handles the event.     

     */                                        

    IMPORT_C virtual CFepUiBaseCtrl* HandlePointerDownEventL(const TPoint& aPoint);

    /**

     * From CFepUiBaseCtrl

     * Handle pointer up event

     *

     * @since S60 V4.0

     * @param aPoint The point position relative the layout

     * @return The control which handles the event.     

     */                  

    IMPORT_C virtual CFepUiBaseCtrl* HandlePointerUpEventL(const TPoint& aPoint);

    /**

     * From CFepUiBaseCtrl

     * Handle pointer move event

     *

     * @since S60 V4.0