/*

* 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:  header file of virtual keyboard control

*

*/

#ifndef C_CVIRTUALKEYBOARD_H

#define C_CVIRTUALKEYBOARD_H

#include <AknsConstants.h>

#include <AknLayout2Def.h>

#include <AknsItemID.h>

#include "peninputlayoutbutton.h"

#include "peninputlayoutctrlgroup.h"

class CVirtualKey;

class CVirtualKeyCtrl;

class CBubbleCtrl;

class CPenInputColorIcon;

#define INVALID_COLOR_GROUP -1

typedef struct TVirtualKeyEventData_Tag

    {

    TKeyEvent       iKeyEvent; //key event

    TPtrC           iKeyData;  //data associated with the key

    CVirtualKey*    iKey;	   // virtual key

    } TVirtualKeyEventData;

enum TVirtualKeyBmpType

    {

    EKeyBmpNormal,

    EKeyBmpNormalMask,

    EKeyBmpHighlight,

    EKeyBmpHighlightMask,

    EKeyBmpDim,

    EkeyBmpDimMask,

    EKeyBmpLastType = EkeyBmpDimMask

    };

enum TVirtualKeyTextPos

    {

    EPosLeft,

    EPosRight1,

    EPosRight2,

    EPosRight3,

    EPosLast = EPosRight3

    };

enum TVirtualKeyIrregularKeyType

    {

    EKeyLeftDown,

    EKeyMiddleUp,

    EKeyMiddleDown,

    EKeyRightDown,

    EKeyRightUp

    };

enum TVirtualKeyIrregularKeyState

    {

    EKeyStateNormal,

    EKeyStateNormalMask,

    EKeyStatePressed,

    EKeyStatePressedMask,

    EKeyStateDimmed,

    EKeyStateDimmedMask

    };

struct TVirtualKeyDrawInfo

    {

    TAknsItemID iVKDimLeftImgID;

    TAknsItemID iVKDimMiddleImgID;

    TAknsItemID iVKDimRightImgID;

    TAknsItemID iVKLeftImgID;

    TAknsItemID iVKMiddleImgID;

    TAknsItemID iVKRightImgID;

    TAknsItemID iVKPressedLeftImgID;

    TAknsItemID iVKPressedMiddleImgID;

    TAknsItemID iVKPressedRightImgID;

    TRgb iVKHighlightColor;

    TBool iSupportSkin;

    TVirtualKeyDrawInfo(TAknsItemID aVKDimLeftImgID,

                          TAknsItemID aVKDimMiddleImgID,

                          TAknsItemID aVKDimRightImgID,

                          TAknsItemID aVKLeftImgID,

                          TAknsItemID aVKMiddleImgID,

                          TAknsItemID aVKRightImgID,

                          TAknsItemID aVKPressedLeftImgID,

                          TAknsItemID aVKPressedMiddleImgID,

                          TAknsItemID aVKPressedRightImgID,

                          TRgb aVKHighlightColor,

                          TBool aSupportSkin = EFalse)

        {

        iVKDimLeftImgID = aVKDimLeftImgID;

        iVKDimMiddleImgID = aVKDimMiddleImgID;

        iVKDimRightImgID = aVKDimRightImgID;

        iVKLeftImgID = aVKLeftImgID;

        iVKMiddleImgID = aVKMiddleImgID;

        iVKRightImgID = aVKRightImgID;

        iVKPressedLeftImgID = aVKPressedLeftImgID;

        iVKPressedMiddleImgID = aVKPressedMiddleImgID;

        iVKPressedRightImgID = aVKPressedRightImgID;      

        iVKHighlightColor = aVKHighlightColor;

        iSupportSkin = aSupportSkin;

        };

    TVirtualKeyDrawInfo()

        {

        iSupportSkin = EFalse;

        };

    };    

//class CVirtualKeyboard

/**

 *  CVirtualKeyboard

 *

 *  Keyboard control, it consist of virtual keys

 *

 *  @lib feplayoutcontrol.lib  

 *  @since S60 V4.0

 */

class CVirtualKeyboard : public CControlGroup

    {

protected:    

    enum TVirtualKeyEvent 

    	{

    	EVirtualKeyDown,

    	EVirtualKeyUp

    	};

public: 

    /**

     * class factory function

     *

     * @since S60 V4.0     

     * @param aRect The keyboard position relative to layout

     * @param aUiLayout The layout contains the keyboard. Owner ship not transferred.

     * @param aControlId Id for this keyboard control

     * @param aFontSpec The font used for key drawing.

     */

    IMPORT_C static CVirtualKeyboard* NewL(const TRect& aRect, 

                                           CFepUiLayout* aUiLayout,

                                           TInt aControlId,

                                           const TFontSpec& aFontSpec,

                                           TBool aIrregular = EFalse);

    /**

     * class factory function

     *

     * @since S60 V4.0     

     * @param aRect The keyboard position relative to layout

     * @param aUiLayout The layout contains the keyboard. Owner ship not transferred.

     * @param aControlId Id for this keyboard control

     * @param aFont The font used for key drawing.

     */

    IMPORT_C static CVirtualKeyboard* NewL(const TRect& aRect, 

                            CFepUiLayout* aUiLayout,TInt aControlId,

                                           CFont* aFont,

                                           TBool aIrregular = EFalse);

    /**

     * Destructor

     *

     * @since S60 V4.0     

     */

    IMPORT_C virtual ~CVirtualKeyboard();

    /**

     * Add a key to keyboard

     *

     * @since S60 V4.0     

     * @param aKey The key to be added

     */    

    IMPORT_C virtual void AddKeyL(CVirtualKey* aKey);

    /**

     * Add a raw key to keyboard. Raw key works like a hardware key which

     * will generates( by simulating) raw key event when it's pressed.

     *

     * @since S60 V4.0     

     * @param aKey The key to be added

     */    

    IMPORT_C virtual void AddRawKeyL(CVirtualKey* aKey);

    /**

     * Create and add a key to keyboard

     *

     * @since S60 V4.0     

     * @param aCode The key code for the adding key

     * @param aScanCode The scancode for the adding key

     * @param aRect The key position. Relative to key board

     * @param aTextRect The rect for key drawing

     * @param aBaseline The baseline for char drawing

     * @param aHighlightBmpIdx The bitmap index for highlighging key

                        background. Bitmap is stored in virtual key board.

     * @param aHighlightMaskIdx The mask bitmap index for highlighging key

                        background. Bitmap is stored in virtual key board.

     */    

    IMPORT_C void CreateKeyL(TUint aCode, TUint aScanCode, const TRect& aRect,

                                const TRect& aTextRect, TInt aBaseline,

                                TInt aHighlightBmpIdx = -1,

                                TInt aHighlightMaskBmpId = -1);

    /**

     * Create and add a key to keyboard

     *

     * @since S60 V4.0     

     * @param aCode The key code for the adding key

     * @param aScanCode The scancode for the adding key

     * @param aRect The key position. Relative to key board

     * @param aTextRect The rect for key drawing

     * @param aBaseline The baseline for char drawing

     * @param aHighlightBmpIdx The bitmap index for highlighging key

                        background. Bitmap is stored in virtual key board.

     * @param aHighlightMaskIdx The mask bitmap index for highlighging key

                        background. Bitmap is stored in virtual key board.      

     */    

    IMPORT_C void CreateKeyL(const TDesC& aCode, TUint aScanCode, 

                             const TRect& aRect,const TRect& aTextRect, 

                             TInt aBaseline, TInt aHighlightBmpIdx = -1,

                             TInt aHighlightMaskBmpId = -1);

    /**

     * Create and add a raw key to keyboard

     *

     * @since S60 V4.0     

     * @param aCode The key code for the adding key

     * @param aScanCode The scancode for the adding key

     * @param aRect The key position. Relative to key board

     * @param aTextRect The rect for key drawing

     * @param aBaseline The baseline for char drawing

     * @param aHighlightBmpIdx The bitmap index for highlighging key

                        background. Bitmap is stored in virtual key board.

     * @param aHighlightMaskIdx The mask bitmap index for highlighging key

                        background. Bitmap is stored in virtual key board.

     */    

    IMPORT_C void CreateRawKeyL(TUint aCode, TUint aScanCode, const TRect& aRect,

                                const TRect& aTextRect, TInt aBaseline,

                                TInt aHighlightBmpIdx = -1,

                                TInt aHighlightMaskBmpId = -1);

    /**

     * Create and add a raw key to keyboard

     *

     * @since S60 V4.0     

     * @param aCode The key code for the adding key

     * @param aScanCode The scancode for the adding key

     * @param aRect The key position. Relative to key board

     * @param aTextRect The rect for key drawing

     * @param aBaseline The baseline for char drawing

     * @param aHighlightBmpIdx The bitmap index for highlighging key

                        background. Bitmap is stored in virtual key board.

     * @param aHighlightMaskIdx The mask bitmap index for highlighging key

                        background. Bitmap is stored in virtual key board.      

     */    

    IMPORT_C void CreateRawKeyL(const TDesC& aCode, TUint aScanCode, 

                             const TRect& aRect,const TRect& aTextRect, 

                             TInt aBaseline, TInt aHighlightBmpIdx = -1,

                             TInt aHighlightMaskBmpId = -1);

    IMPORT_C void CreateRawKeyL(RPointerArray<HBufC>& aUnicodesList,

                                TInt aScanCode,

                                const TRect& aRect);

    /**

     * Remove a key from keyboard. Key is not destroyed.

     *

     * @since S60 V4.0     

     * @param aKey The key to be removed

     */                                 

    IMPORT_C void RemoveKey(CVirtualKey* aKey);                    

    /**

     * Remove a key from keyboard. Key is not destroyed.

     *

     * @since S60 V4.0     

     * @param aIndex The key index. Index is not checked.

     */                                 

    inline void RemoveKey(TInt aIndex);                    

    /* Set the font for candidate

     *

     * @since S60 V4.0

     * @param aFontSpec the font spec to be used.

     */                                                   

    IMPORT_C void SetFont(const TFontSpec& aFontSpec);

    /**

     * Set font information

     *

     * @since S60 V4.0          

     * @param aFont The font info for key drawing.Ownership not transferred

     */

    IMPORT_C void SetFont(const CFont* aFont);    

    /**

     * Set key font color information.

     *     

     * @since S60 V4.0          

     * @param aFontColor The font color info for key drawing.

     */

    IMPORT_C void SetFontColor( const TRgb aFontColor );

    /**

     * Dim key

     *

     * @since S60 V4.0          

     * @param aKey The key to be dimmed

     */    

    IMPORT_C void DimKey(CVirtualKey* aKey,TBool aFlag);

    IMPORT_C void EnableKeyFeedback( CVirtualKey* aKey, TBool aEnable );

    /**

     * Set key dim bitmap

     *

     * @since S60 V4.0          

     * @param aBitmap The dim bitmap

     */

    inline void SetDimKeyBmp(CFbsBitmap* aBitmap);

    /**

     * Set key dim mask bitmap

     *

     * @since S60 V4.0          

     * @param aBitmap The dim mask bitmap

     */

    inline void SetDimKeyMaskBmp(CFbsBitmap* aBitmap);

    /**

     * Add key higilight bitmap

     * @since S60 V4.0

     * @param aBmp The key hight light bitmap. Owner ship transferred.

     */

    IMPORT_C void AddKeyHighLightBitmapL(CFbsBitmap* aBmp);

    /**

     * Remove highlight bitmap by index. The bitmap itself is not destroyed.

     * @since S60 V4.0

     * @param aIndex. 

     */

    IMPORT_C void RemoveKeyHighLightBitmap(TInt aIndex);    

    /**

     * Add key highlight mask bitmap

     * @since S60 V4.0

     * @param aBmp The key hight light mask bitmap. Owner ship transferred.

     */

    IMPORT_C void AddKeyHighLightMaskBitmapL(CFbsBitmap* aBmp);    

    /**

     * Remove highlight bitmap by index. The bitmap itself is not destroyed.

     * @since S60 V4.0

     * @param aIndex. 

     */

    IMPORT_C void RemoveKeyHighLightMaskBitmap(TInt aIndex);    

    /**

     * Set fading parameter. Key pressing effect is done by fading the key.

     * 

     * @since S60 V4.0

     * @param aBlackMap Black map fading parameter. 

     *      See CBitmapContext::SetFadingParameters for more information

     * @param aWhiteMap White map fading parameter

     */                                                                 

    inline void SetFadingParameters(TUint8 aBlackMap, TUint8 aWhiteMap);    

    /**

     * Return key array

     *

     * @since S60 V4.0

     * @return The key array

     */    

    inline const RPointerArray<CVirtualKey>& KeyArray();

    /**

     * Return highlight bmp list

     *

     * @since S60 V4.0

     * @return highlight bmp list

     */    

    inline const RPointerArray<CFbsBitmap>& KeyHighlightBmpList();

    /**

     * Return highlight mask bmp list

     *

     * @since S60 V4.0

     * @return highlight mask bmp list

     */        

    inline const RPointerArray<CFbsBitmap>& KeyHighlightMaskBmpList();

    inline void SetKeySkinId(TVirtualKeyBmpType aBmpType, TAknsItemID aSkinId);

    inline TAknsItemID KeySkinId(TVirtualKeyBmpType aBmpType);

    inline void SetTextLineLayout(TAknTextLineLayout aTextLine, TVirtualKeyTextPos aPos);

    inline TAknTextLineLayout TextLineLayout(TVirtualKeyTextPos aPos);

    inline void SetTextLineLayout(TAknTextLineLayout aTextLine);

    inline TAknTextLineLayout TextLineLayout();

    inline TBool TextLineLayoutSet(TVirtualKeyTextPos aPos);

    inline void SetDrawOpaqueBackground(TBool aNeedDraw);

    /**

     * Set keyboard text color group

     *

     * @since S60 V4.0

     * @param color group index

     */        

    inline void SetKeyTextColorGroup(TInt aColorGroup);

    inline TInt KeyTextColorGroup() const;

    //from base class CFepUiBaseCtrl    

    /**

     * From CFepUiBaseCtrl

     * Draw control

     *

     * @since S60 V4.0

     */                       

    IMPORT_C virtual void Draw();     

    IMPORT_C void SetRect(const TRect& aRect);    

    /**

     * Add key higilight bitmap

     * @since S60 V4.0

     * @param aBmp The key hight light bitmap. Owner ship transferred.

     */

    IMPORT_C void AddIrregularKeyBitmapL(TVirtualKeyIrregularKeyType aKeyType,

                                         TVirtualKeyIrregularKeyState aKeyState,

                                         CFbsBitmap* aBmp);

    /**

     * Remove highlight bitmap by index. The bitmap itself is not destroyed.

     * @since S60 V4.0

     * @param aIndex. 

     */

    IMPORT_C void RemoveIrregularKeyBitmapL(TVirtualKeyIrregularKeyType aKeyType,

                                            TVirtualKeyIrregularKeyState aKeyState);

    /**

     * Remove highlight bitmap by index. The bitmap itself is not destroyed.

     * @since S60 V4.0

     * @param aIndex. 

     */

    IMPORT_C CFbsBitmap* IrregularKeyBitmap(TVirtualKeyIrregularKeyType aKeyType,

                                            TVirtualKeyIrregularKeyState aKeyState);

    IMPORT_C TBool IsIrregularKeyBoard();

    IMPORT_C void SetIrregularKeyBoard(TBool aIrregular);

    /**

     * Add nonirregular key bitmap

     * @since S60 V4.0

     * @param aBmp The key bitmap. Owner ship transferred.

     */

    IMPORT_C void SetNonIrregularKeyBitmapL(TVirtualKeyBmpType aBmpType, CFbsBitmap* aBmp);

    /**

     * Get non irregularkey bitmap by index. The bitmap itself is not destroyed.

     * @since S60 V4.0

     * @param aIndex. 

     */

    IMPORT_C CFbsBitmap* NonIrregularKeyBitmap(TVirtualKeyBmpType aBmpType);

    /**

     * Hide or show the bubble.

     * @param aFlag. 

     * @since S60 V4.0

     */

    IMPORT_C void ShowBubble(TBool aFlag);

    /**

     * Set bubble bitmap effect.

     * @since S60 V4.0

     * @param aBmpId. 

     * @param aMaskBmpId. 

     * @param aBgSkinId. 

     */

    IMPORT_C void SetBubbleBitmapParam(CFbsBitmap* aBmpId,

                                       CFbsBitmap* aMaskBmpId,

                                       TAknsItemID aBgSkinId);

    /**

     * Test that keep pointer down effect or not when the pointer is down and moving

     * @since S60 V4.0

     */    

    IMPORT_C TBool GowithPointerDown();    

    /**

     * Set keeping pointer down effect when the pointer is down and moving

     * @since S60 V4.0

     * @param aFlag. 

     */    

    IMPORT_C void SetGowithPointerDown(TBool aFlag);

    /**

     * Set the size of bubble

     *

     * @since S60 V4.0          

     * @param aSize The size of bubble

     */ 

    IMPORT_C void SetBubbleSize(const TSize& aSize);