class CVirtualKeyboard : public CControlGroup |
Protected Member Functions | |
---|---|
CVirtualKeyboard (const TRect &, CFepUiLayout *, TInt , const TFontSpec &, TBool ) | |
IMPORT_C void | ConstructL () |
CVirtualKeyCtrl * | FindKeyCtrlByPosition (const TPoint &) |
IMPORT_C CFepUiBaseCtrl * | HandlePointerMoveEventL (const TPoint &) |
IMPORT_C void | HandleResourceChange ( TInt ) |
Protected Member Enumerations | |
---|---|
enum | TVirtualKeyEvent { EVirtualKeyDown , EVirtualKeyUp } |
Inherited Enumerations | |
---|---|
CFepUiBaseCtrl:TZOrder |
Protected Attributes | |
---|---|
CVirtualKey * | iPressedKey |
IMPORT_C | CVirtualKeyboard | ( | const TRect & | aRect, |
CFepUiLayout * | aUiLayout, | |||
TInt | aControlId, | |||
const TFontSpec & | aFontSpec, | |||
TBool | aIrregular = EFalse | |||
) | [protected] |
Default constructor
const TRect & aRect | The keyboard position relative to layout |
CFepUiLayout * aUiLayout | The layout contains the keyboard. Owner ship not transferred. |
TInt aControlId | Id for this keyboard control |
const TFontSpec & aFontSpec | |
TBool aIrregular = EFalse |
IMPORT_C void | AddIrregularKeyBitmapL | ( | TVirtualKeyIrregularKeyType | aKeyType, |
TVirtualKeyIrregularKeyState | aKeyState, | |||
CFbsBitmap * | aBmp | |||
) |
TVirtualKeyIrregularKeyType aKeyType | |
TVirtualKeyIrregularKeyState aKeyState | |
CFbsBitmap * aBmp | The key hight light bitmap. Owner ship transferred. |
void | AddKeyControlL | ( | CVirtualKeyCtrl * | aKeyCtrl | ) | [private] |
From CFepUiBaseCtrl Handle pointer levae event. This will be called only when it's got pointer down event before and now pointer leaves without pointer up event
CVirtualKeyCtrl * aKeyCtrl | The key to be added |
IMPORT_C void | AddKeyHighLightBitmapL | ( | CFbsBitmap * | aBmp | ) |
CFbsBitmap * aBmp | The key hight light bitmap. Owner ship transferred. |
IMPORT_C void | AddKeyHighLightMaskBitmapL | ( | CFbsBitmap * | aBmp | ) |
CFbsBitmap * aBmp | The key hight light mask bitmap. Owner ship transferred. |
IMPORT_C void | AddKeyL | ( | CVirtualKey * | aKey | ) | [virtual] |
Add a key to keyboard
CVirtualKey * aKey | The key to be added |
IMPORT_C void | AddRawKeyL | ( | CVirtualKey * | aKey | ) | [virtual] |
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.
CVirtualKey * aKey | The key to be added |
void | ConstructOneIrregularBmp | ( | RPointerArray < CFbsBitmap > & | iBmpList | ) | [private] |
RPointerArray < CFbsBitmap > & iBmpList |
CVirtualKeyCtrl * | CreateKeyCtrlL | ( | CVirtualKey * | aKeyInfo, |
TBool | aRawKeyFlag | |||
) | [private] |
CVirtualKey * aKeyInfo | |
TBool aRawKeyFlag |
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
TUint aCode | The key code for the adding key |
TUint aScanCode | The scancode for the adding key |
const TRect & aRect | The key position. Relative to key board |
const TRect & aTextRect | The rect for key drawing |
TInt aBaseline | The baseline for char drawing |
TInt aHighlightBmpIdx = -1 | The bitmap index for highlighging key background. Bitmap is stored in virtual key board. |
TInt aHighlightMaskBmpId = -1 |
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 key to keyboard
const TDesC & aCode | The key code for the adding key |
TUint aScanCode | The scancode for the adding key |
const TRect & aRect | The key position. Relative to key board |
const TRect & aTextRect | The rect for key drawing |
TInt aBaseline | The baseline for char drawing |
TInt aHighlightBmpIdx = -1 | The bitmap index for highlighging key background. Bitmap is stored in virtual key board. |
TInt aHighlightMaskBmpId = -1 |
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
TUint aCode | The key code for the adding key |
TUint aScanCode | The scancode for the adding key |
const TRect & aRect | The key position. Relative to key board |
const TRect & aTextRect | The rect for key drawing |
TInt aBaseline | The baseline for char drawing |
TInt aHighlightBmpIdx = -1 | The bitmap index for highlighging key background. Bitmap is stored in virtual key board. |
TInt aHighlightMaskBmpId = -1 |
IMPORT_C void | CreateRawKeyL | ( | 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
const TDesC & aCode | The key code for the adding key |
TUint aScanCode | The scancode for the adding key |
const TRect & aRect | The key position. Relative to key board |
const TRect & aTextRect | The rect for key drawing |
TInt aBaseline | The baseline for char drawing |
TInt aHighlightBmpIdx = -1 | The bitmap index for highlighging key background. Bitmap is stored in virtual key board. |
TInt aHighlightMaskBmpId = -1 |
IMPORT_C void | CreateRawKeyL | ( | RPointerArray < HBufC > & | aUnicodesList, |
TInt | aScanCode, | |||
const TRect & | aRect | |||
) |
RPointerArray < HBufC > & aUnicodesList | |
TInt aScanCode | |
const TRect & aRect |
IMPORT_C void | DimKey | ( | CVirtualKey * | aKey, |
TBool | aFlag | |||
) |
Dim key
CVirtualKey * aKey | The key to be dimmed |
TBool aFlag |
void | DrawBubble | ( | CVirtualKey * | aKey | ) | [private] |
CVirtualKey * aKey |
void | DrawKey | ( | const CVirtualKey * | aKey | ) | [private] |
Draw a key
const CVirtualKey * aKey | The key to be drawn |
IMPORT_C void | EnableKeyFeedback | ( | CVirtualKey * | aKey, |
TBool | aEnable | |||
) |
CVirtualKey * aKey | |
TBool aEnable |
CVirtualKeyCtrl * | FindCtrlForKey | ( | const CVirtualKey * | aKey | ) | [private] |
Set a key event and report to observer
const CVirtualKey * aKey | The key to be drawn |
CVirtualKeyCtrl * | FindKeyCtrlByPosition | ( | const TPoint & | aPt | ) | [protected] |
find the key in a position
const TPoint & aPt |
IMPORT_C TBool | GowithPointerDown | ( | ) |
IMPORT_C CFepUiBaseCtrl * | HandlePointerMoveEventL | ( | const TPoint & | aPt | ) | [protected, virtual] |
From CFepUiBaseCtrl Handle pointer down event
const TPoint & aPt |
IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [protected, virtual] |
Handle system resource change
TInt aType | The system resource change type |
IMPORT_C CFbsBitmap * | IrregularKeyBitmap | ( | TVirtualKeyIrregularKeyType | aKeyType, |
TVirtualKeyIrregularKeyState | aKeyState | |||
) |
TVirtualKeyIrregularKeyType aKeyType | |
TVirtualKeyIrregularKeyState aKeyState |
const RPointerArray < CVirtualKey > & | KeyArray | ( | ) | [inline] |
Return key array
const RPointerArray < CFbsBitmap > & | KeyHighlightBmpList | ( | ) | [inline] |
Return highlight bmp list
const RPointerArray < CFbsBitmap > & | KeyHighlightMaskBmpList | ( | ) | [inline] |
Return highlight mask bmp list
TAknsItemID | KeySkinId | ( | TVirtualKeyBmpType | aBmpType | ) | [inline] |
TVirtualKeyBmpType aBmpType |
IMPORT_C CVirtualKeyboard * | NewL | ( | const TRect & | aRect, |
CFepUiLayout * | aUiLayout, | |||
TInt | aControlId, | |||
const TFontSpec & | aFontSpec, | |||
TBool | aIrregular = EFalse | |||
) | [static] |
class factory function
const TRect & aRect | The keyboard position relative to layout |
CFepUiLayout * aUiLayout | The layout contains the keyboard. Owner ship not transferred. |
TInt aControlId | Id for this keyboard control |
const TFontSpec & aFontSpec | The font used for key drawing. |
TBool aIrregular = EFalse |
IMPORT_C CVirtualKeyboard * | NewL | ( | const TRect & | aRect, |
CFepUiLayout * | aUiLayout, | |||
TInt | aControlId, | |||
CFont * | aFont, | |||
TBool | aIrregular = EFalse | |||
) | [static] |
class factory function
const TRect & aRect | The keyboard position relative to layout |
CFepUiLayout * aUiLayout | The layout contains the keyboard. Owner ship not transferred. |
TInt aControlId | Id for this keyboard control |
CFont * aFont | The font used for key drawing. |
TBool aIrregular = EFalse |
IMPORT_C CFbsBitmap * | NonIrregularKeyBitmap | ( | TVirtualKeyBmpType | aBmpType | ) |
TVirtualKeyBmpType aBmpType |
TBool | PrepareHighlightKeyBmp | ( | const TRect & | aRect, |
const TRect & | aInnerRect, | |||
const TRect & | aKeyRect | |||
) | [private] |
TBool | PrepareKeyBmp | ( | CFbsBitmap * | aBmp, |
CFbsBitmapDevice * | aDev, | |||
const TRect & | aRect, | |||
const TRect & | aInnerRect, | |||
const TAknsItemID & | aFrameID, | |||
const TAknsItemID & | aCenterID, | |||
const TRect & | aKeyRect | |||
) | [private] |
CFbsBitmap * aBmp | |
CFbsBitmapDevice * aDev | |
const TRect & aRect | |
const TRect & aInnerRect | |
const TAknsItemID & aFrameID | |
const TAknsItemID & aCenterID | |
const TRect & aKeyRect |
CFbsBitmap * | PrepareKeyBmpL | ( | CFbsBitGc * | aGc, |
const TDisplayMode & | aMode, | |||
const TRect & | aRect, | |||
const TRect & | aInnerRect, | |||
const TAknsItemID & | aFrameID, | |||
const TAknsItemID & | aCenterID, | |||
const TRect & | aKeyRect | |||
) | [private] |
CFbsBitGc * aGc | |
const TDisplayMode & aMode | |
const TRect & aRect | |
const TRect & aInnerRect | |
const TAknsItemID & aFrameID | |
const TAknsItemID & aCenterID | |
const TRect & aKeyRect |
CFbsBitmap * | PrepareMaskBmpL | ( | CFbsBitGc * | aGc, |
const TDisplayMode & | aMode, | |||
const TRect & | aRect | |||
) | [private] |
TBool | PrepareNormalKeyBmp | ( | const TRect & | aRect, |
const TRect & | aInnerRect, | |||
const TRect & | aKeyRect | |||
) | [private] |
IMPORT_C void | RemoveIrregularKeyBitmapL | ( | TVirtualKeyIrregularKeyType | aKeyType, |
TVirtualKeyIrregularKeyState | aKeyState | |||
) |
TVirtualKeyIrregularKeyType aKeyType | |
TVirtualKeyIrregularKeyState aKeyState |
IMPORT_C void | RemoveKey | ( | CVirtualKey * | aKey | ) |
Remove a key from keyboard. Key is not destroyed.
CVirtualKey * aKey | The key to be removed |
void | RemoveKey | ( | TInt | aIndex | ) | [inline] |
Remove a key from keyboard. Key is not destroyed.
TInt aIndex | The key index. Index is not checked. |
void | RemoveKeyControl | ( | CVirtualKeyCtrl * | aKeyCtrl | ) | [private] |
Remove a key control from keyboard. The control is removed and should be used later
CVirtualKeyCtrl * aKeyCtrl | The key to be removed. |
IMPORT_C void | RemoveKeyHighLightBitmap | ( | TInt | aIndex | ) |
TInt aIndex |
IMPORT_C void | RemoveKeyHighLightMaskBitmap | ( | TInt | aIndex | ) |
TInt aIndex |
IMPORT_C void | SetBubbleBitmapParam | ( | CFbsBitmap * | aBmpId, |
CFbsBitmap * | aMaskBmpId, | |||
TAknsItemID | aBgSkinId | |||
) |
CFbsBitmap * aBmpId | |
CFbsBitmap * aMaskBmpId | |
TAknsItemID aBgSkinId |
IMPORT_C void | SetBubbleSize | ( | const TSize & | aSize | ) |
Set the size of bubble
const TSize & aSize | The size of bubble |
IMPORT_C void | SetBubbleVerticalMargin | ( | TInt | aMargin | ) |
Set the margin between the bottom of bubble and top of the key
TInt aMargin |
void | SetDimKeyBmp | ( | CFbsBitmap * | aBitmap | ) | [inline] |
Set key dim bitmap
CFbsBitmap * aBitmap | The dim bitmap |
void | SetDimKeyMaskBmp | ( | CFbsBitmap * | aBitmap | ) | [inline] |
Set key dim mask bitmap
CFbsBitmap * aBitmap | The dim mask bitmap |
void | SetDrawOpaqueBackground | ( | TBool | aNeedDraw | ) | [inline] |
TBool aNeedDraw |
void | SetFadingParameters | ( | TUint8 | aBlackMap, |
TUint8 | aWhiteMap | |||
) | [inline] |
Set fading parameter. Key pressing effect is done by fading the key.
IMPORT_C void | SetFont | ( | const TFontSpec & | aFontSpec | ) |
const TFontSpec & aFontSpec |
IMPORT_C void | SetFont | ( | const CFont * | aFont | ) |
Set font information
const CFont * aFont | The font info for key drawing.Ownership not transferred |
IMPORT_C void | SetFontColor | ( | const TRgb | aFontColor | ) |
Set key font color information.
const TRgb aFontColor | The font color info for key drawing. |
IMPORT_C void | SetFrameDiff | ( | TInt | aLeftDiff, |
TInt | aTopDiff, | |||
TInt | aRightDiff, | |||
TInt | aBottomDiff | |||
) |
Set the size of bubble frame inner rect
IMPORT_C void | SetGowithPointerDown | ( | TBool | aFlag | ) |
TBool aFlag |
IMPORT_C void | SetIrregularKeyBoard | ( | TBool | aIrregular | ) |
TBool aIrregular |
void | SetKeySkinId | ( | TVirtualKeyBmpType | aBmpType, |
TAknsItemID | aSkinId | |||
) | [inline] |
TVirtualKeyBmpType aBmpType | |
TAknsItemID aSkinId |
void | SetKeyTextColorGroup | ( | TInt | aColorGroup | ) | [inline] |
Set keyboard text color group
TInt aColorGroup |
IMPORT_C void | SetNonIrregularKeyBitmapL | ( | TVirtualKeyBmpType | aBmpType, |
CFbsBitmap * | aBmp | |||
) |
TVirtualKeyBmpType aBmpType | |
CFbsBitmap * aBmp | The key bitmap. Owner ship transferred. |
IMPORT_C void | SetPreviewBubbleRenderer | ( | MPeninputVkbPreviewBubbleRenderer * | aRenderer | ) |
Install preview bubble renderer
MPeninputVkbPreviewBubbleRenderer * aRenderer | Preview bubble renderer. Ownership transfered(shared by all targets of aRenderer) |
IMPORT_C void | SetRect | ( | const TRect & | aRect | ) | [virtual] |
Set control's rectangle
const TRect & aRect | The new control area |
IMPORT_C void | SetShiftIcon | ( | CPenInputColorIcon * | aIcon | ) |
Set shift icon showing on the key
CPenInputColorIcon * aIcon | shift icon |
IMPORT_C void | SetStarIcon | ( | CPenInputColorIcon * | aIcon | ) |
CPenInputColorIcon * aIcon |
IMPORT_C void | SetTextFormat | ( | TAknTextLineLayout | aTextFormat | ) |
Set text format
TAknTextLineLayout aTextFormat | The format of text on bubble |
void | SetTextLineLayout | ( | TAknTextLineLayout | aTextLine, |
TVirtualKeyTextPos | aPos | |||
) | [inline] |
TAknTextLineLayout aTextLine | |
TVirtualKeyTextPos aPos |
void | SetTextLineLayout | ( | TAknTextLineLayout | aTextLine | ) | [inline] |
TAknTextLineLayout aTextLine |
IMPORT_C void | SetVirtualKeyImgID | ( | TVirtualKeyDrawInfo | aVirtualKeyDrawInfo | ) |
TVirtualKeyDrawInfo aVirtualKeyDrawInfo |
IMPORT_C void | ShowBubble | ( | TBool | aFlag | ) |
TBool aFlag |
TAknTextLineLayout | TextLineLayout | ( | TVirtualKeyTextPos | aPos | ) | [inline] |
TVirtualKeyTextPos aPos |
TBool | TextLineLayoutSet | ( | TVirtualKeyTextPos | aPos | ) | [inline] |
TVirtualKeyTextPos aPos |
TUint8 | iFadingParamBlack | [private] |
Fading parameter. Used for pressed key effect
TUint8 | iFadingParamWhite | [private] |
Fading parameter. Used for pressed key effect
CFont * | iFont | [private] |
Font object for key drawing Ownership depends on flag iFontOwnership.
TBool | iFontOwnership | [private] |
Flag ownership flag. ETrue if CFont object is owned by this control.
RPointerArray < CVirtualKey > | iKeyArray | [private] |
Virtuak Key array
RPointerArray < CFbsBitmap > | iKeyHighLightBmpList | [private] |
High light bitmap list for different size of keys
RPointerArray < CFbsBitmap > | iKeyHighLightMaskBmpList | [private] |
High light mask bitmap list for different size of keys
RPointerArray < CFbsBitmap > | iKeyLeftDownBmpList | [private] |
RPointerArray < CFbsBitmap > | iKeyMiddleDownBmpList | [private] |
RPointerArray < CFbsBitmap > | iKeyMiddleUpBmpList | [private] |
RPointerArray < CFbsBitmap > | iKeyRightDownBmpList | [private] |
RPointerArray < CFbsBitmap > | iKeyRightUpBmpList | [private] |
RPointerArray < CFbsBitmap > | iNonIrregularKeyBmpList | [private] |
bitmap list for different size of keys
MPeninputVkbPreviewBubbleRenderer * | iPreviewBubbleRenderer | [private] |
CPenInputColorIcon * | iShiftIcon | [private] |
The shift icon showing on the key
CPenInputColorIcon * | iStarIcon | [private] |
The star icon showing on the key
RArray < TAknTextLineLayout > | iTextLineLayout | [private] |
RPointerArray < CVirtualKeyCtrl > | iUnUsedKeyCtrlPool | [private] |
Unused key pool. When key is removed from key board, it's added to the pool. This is a patch for current vkb UI implementation, as they will remove keys when a key is handling pointer event.
RPointerArray < CVirtualKeyCtrl > | iUnUsedRawKeyCtrlPool | [private] |
Unused raw key pool. When key is removed from key board, it's added to the pool. This is a patch for current vkb UI implementation, as they will remove keys when a key is handling pointer event.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.