CPeninputCommonLayoutExt Class Reference

class CPeninputCommonLayoutExt : public CFepUiLayout

Peninput common layout

peninputcommonlayout.lib
Since
S60 v3.2

Inherits from

Public Member Functions
~CPeninputCommonLayoutExt()
IMPORT_C MPeninputDataProvider *DataMgr()
IMPORT_C TIntHandleCommand(TInt, TUint8 *)
IMPORT_C voidHandleControlEvent(TInt, CFepUiBaseCtrl *, const TDesC &)
IMPORT_C TBoolHandleRawKeyEventL(const TRawEvent &)
IMPORT_C TBoolIsCapsLockPermitted()
IMPORT_C TBoolIsShiftPermitted()
IMPORT_C CPeninputLayoutWindowExt *LayoutWindow()
IMPORT_C TIntOnAppEditorTextComing(const TFepInputContextFieldData &)
IMPORT_C TIntPenInputType()
IMPORT_C TAny *RequestData(TPeninputDataType)
IMPORT_C voidSendEventToLayout(TInt, CFepUiBaseCtrl *, const TDesC &)
IMPORT_C voidSendEventToWindow(TInt, CFepUiBaseCtrl *, const TDesC &)
IMPORT_C voidSendkey(TInt, const TDesC &)
IMPORT_C voidSetData(TPeninputDataType, TAny *)
IMPORT_C voidSetPositionFromOutside(const TPoint &)
IMPORT_C TIntSizeChanged(const TAny *)
IMPORT_C MPeninputUiStateMgr *UiStateMgr()
Protected Member Functions
CPeninputCommonLayoutExt(MLayoutOwner *)
IMPORT_C voidConstructL(const TAny *)
voidCreateDataMgrL(const TAny *)
voidCreateLayoutWindowL()
IMPORT_C TRectInit()
IMPORT_C TBoolIsValidDestination(const TRect &, CDragBar *, TBool &, TBool &, TBool)
TInt LayoutType()
IMPORT_C voidSaveKey(TInt, TInt)
Private Member Functions
voidChangeInputLanguage(TInt)
voidChangeRange(TInt)
voidSetEnableSettingBtn(TBool)
voidSetEnableSwitchToHwr(TBool)
TInt TranslateRange(TInt)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CFepUiLayout::AddControlL(CCoeControl *,TBool)
CFepUiLayout::AddControlL(CFepUiBaseCtrl *,TBool)
CFepUiLayout::BaseConstructL()
CFepUiLayout::CFepUiLayout(MLayoutOwner *)
CFepUiLayout::ChangeFeedbackArea(TInt,const TRect &,const TRect &)
CFepUiLayout::ChangeFeedbackType(TInt,TInt)
CFepUiLayout::ControlList()
CFepUiLayout::CreateCursor()
CFepUiLayout::DeRegisterFeedbackArea(TInt,const TRect &)
CFepUiLayout::Destroy()
CFepUiLayout::DisableLayoutDrawing(TBool)
CFepUiLayout::DoTactileFeedback(TInt)
CFepUiLayout::DoTactileFeedback(TInt,TBool,TBool)
CFepUiLayout::Draw()
CFepUiLayout::EnableLayoutMoving(CDragBar *)
CFepUiLayout::GetEnabledPluginMode()
CFepUiLayout::GetInputContextFieldMaxLen()
CFepUiLayout::HandleAppInfoChange(const TDesC &,TPeninputAppInfo)
CFepUiLayout::HandleEventL(TEventType,const TAny *)
CFepUiLayout::LayoutOwner()
CFepUiLayout::LayoutReady()
CFepUiLayout::LockArea(const TRect &,CFepUiBaseCtrl *)
CFepUiLayout::LockareaOwner()const
CFepUiLayout::LockedArea()
CFepUiLayout::NotDrawToLayoutDevice()
CFepUiLayout::OnActivate()
CFepUiLayout::OnDeActivate()
CFepUiLayout::OnResourceChange(TInt)
CFepUiLayout::OnSkinChange()
CFepUiLayout::Position()
CFepUiLayout::Rect()
CFepUiLayout::RegisterFeedbackArea(TInt,const TRect &)
CFepUiLayout::RegisterFeedbackArea(TInt,const TRect &,TInt)
CFepUiLayout::RemoveControl(CCoeControl *)
CFepUiLayout::RemoveControl(CFepUiBaseCtrl *)
CFepUiLayout::RootControl()
CFepUiLayout::ScreenSize()
CFepUiLayout::SemiTransparencyRequired()
CFepUiLayout::SetAppEditorCursor(const TCursorSelection &,TBool)
CFepUiLayout::SetLayoutPos(const TPoint &)
CFepUiLayout::SetRect(const TRect &)
CFepUiLayout::SetScreenSize(const TSize &)
CFepUiLayout::SetShadowAreaRect(const TRect &,TShadowBitmapIndex)
CFepUiLayout::SetShadowBmp(CFbsBitmap *,CFbsBitmap *,TShadowBitmapIndex)
CFepUiLayout::SetShadowRect(const TRect &)
CFepUiLayout::SignalOwner(TInt,const TDesC &)
CFepUiLayout::SkinInstance()
CFepUiLayout::SupportTactileFeedback()
CFepUiLayout::TouchFeedbackInstance()
CFepUiLayout::UnLockArea(const TRect &,CFepUiBaseCtrl *)
CFepUiLayout::UpdateArea(const CFepUiBaseCtrl *,const TRect &,TBool,TBool)
CFepUiLayout::~CFepUiLayout()
Protected Attributes
CPeninputDataMgr *iDataMgr
CPeninputLayoutWindowExt *iLayoutWindow
CPeninputUiStateMgr *iUiStateMgr

Constructor & Destructor Documentation

CPeninputCommonLayoutExt(MLayoutOwner *)

IMPORT_CCPeninputCommonLayoutExt(MLayoutOwner *aLayoutOwner)[protected]

2nd phase construction - constructor

Since
S60 v3.2

Parameters

MLayoutOwner * aLayoutOwnerThe owner of layout

~CPeninputCommonLayoutExt()

IMPORT_C~CPeninputCommonLayoutExt()[virtual]

Destructor

Since
S60 v3.2

Member Functions Documentation

ChangeInputLanguage(TInt)

voidChangeInputLanguage(TIntaLangID)[private]

Change input language

Since
S60 v3.2

Parameters

TInt aLangIDThe language id you want to change to

ChangeRange(TInt)

voidChangeRange(TIntaRange)[private]

Change current range

Since
S60 v3.2

Parameters

TInt aRangeThe range need to set

ConstructL(const TAny *)

IMPORT_C voidConstructL(const TAny *aInitData)[protected]

2nd phase construction - second constructor

Since
S60 v3.2

Parameters

const TAny * aInitDataInit data of layout

CreateDataMgrL(const TAny *)

voidCreateDataMgrL(const TAny *aInitData)[protected, pure virtual]

Factory method for creation resource config. It is enough at present to create and initialize resource config. Any necessary extension will be implemented in subclasses.

Since
S60 v3.2

Parameters

const TAny * aInitData

CreateLayoutWindowL()

voidCreateLayoutWindowL()[protected, pure virtual]

Factory method for creation of layout window. The decision which layout window(VKB or HWR) is created will be postboned in subclasses of this class.

Since
S60 v3.2

DataMgr()

IMPORT_C MPeninputDataProvider *DataMgr()const

Get data manager

Since
S60 v3.2

HandleCommand(TInt, TUint8 *)

IMPORT_C TIntHandleCommand(TIntaCmd,
TUint8 *aData
)

From CFepUiLayout Handle layout command event

Since
S60 v3.2

Parameters

TInt aCmdCommand Id
TUint8 * aDataData for command

HandleControlEvent(TInt, CFepUiBaseCtrl *, const TDesC &)

IMPORT_C voidHandleControlEvent(TIntaEventType,
CFepUiBaseCtrl *aCtrl,
const TDesC &aEventData
)[virtual]

From CFepUiLayout Handle the event from control

Since
S60 v3.2

Parameters

TInt aEventTypeThe event type
CFepUiBaseCtrl * aCtrlThe sender
const TDesC & aEventDataThe event data

HandleRawKeyEventL(const TRawEvent &)

IMPORT_C TBoolHandleRawKeyEventL(const TRawEvent &aKeyEvent)[virtual]

From CFepUiLayout Handle raw event key

Since
S60 v3.2

Parameters

const TRawEvent & aKeyEventThe key raw event data

Init()

IMPORT_C TRectInit()[protected, virtual]

Init layout owner

Since
S60 v3.2

IsCapsLockPermitted()

IMPORT_C TBoolIsCapsLockPermitted()

IsShiftPermitted()

IMPORT_C TBoolIsShiftPermitted()

IsValidDestination(const TRect &, CDragBar *, TBool &, TBool &, TBool)

IMPORT_C TBoolIsValidDestination(const TRect &aRect,
CDragBar *aDragBar,
TBool &aVInfo,
TBool &aHInfo,
TBoolaFlag
)[protected, virtual]

From CFepUiLayout Test whether the position is valid This is used to test the target position when draging controls to some place

Since
S60 v4.0

Parameters

const TRect & aRectThe rect to be checked
CDragBar * aDragBar
TBool & aVInfoThe valid information in vertial dirtection. ETrue is vertical moving is valid.It's only used when aRect is not valid but moving in vertical direction is valid
TBool & aHInfoThe valid information in horizontal dirtection ETrue is horizontal moving is valid.It's only used when aRect is not valid but moving in vertical direction is valid
TBool aFlagETrue if whole layout is moving, otherwise, only components moving

LayoutType()

TInt LayoutType()[protected, pure virtual]

Get the layout type, vkb or hwr, child class must rewrite the function.

Since
S60 v3.2

LayoutWindow()

IMPORT_C CPeninputLayoutWindowExt *LayoutWindow()const

Get layout window

Since
S60 v3.2

OnAppEditorTextComing(const TFepInputContextFieldData &)

IMPORT_C TIntOnAppEditorTextComing(const TFepInputContextFieldData &aData)[virtual]

From CFepUiLayout Handle editor text coming Called by animation dll when app editor text is coming If a ui layout has a editor area, it must implements this function to get the text

Since
S60 v3.2

Parameters

const TFepInputContextFieldData & aDataEditor Text Coming data

PenInputType()

IMPORT_C TIntPenInputType()[virtual]

From CFepUiLayout Get the layout type, vkb or hwr. It's now similar to LayoutType which defines in another interface.

Since
S60 v3.2

RequestData(TPeninputDataType)

IMPORT_C TAny *RequestData(TPeninputDataTypeaDataType)

Request data from data provider

Since
S60 v3.2

Parameters

TPeninputDataType aDataTypeThe data request

SaveKey(TInt, TInt)

IMPORT_C voidSaveKey(TIntaKey,
TIntaValue
)[protected, virtual]

Save a virtual keybroad key to the repository

Since
S60 v3.2

Parameters

TInt aKeyThe key name in repository
TInt aValueThe unicode of key

SendEventToLayout(TInt, CFepUiBaseCtrl *, const TDesC &)

IMPORT_C voidSendEventToLayout(TIntaEventType,
CFepUiBaseCtrl *aCtrl,
const TDesC &aEventData =  KNullDesC
)

Send event to layout

Since
S60 v3.2

Parameters

TInt aEventTypeThe event type
CFepUiBaseCtrl * aCtrlThe sender
const TDesC & aEventData =  KNullDesC The event data

SendEventToWindow(TInt, CFepUiBaseCtrl *, const TDesC &)

IMPORT_C voidSendEventToWindow(TIntaEventType,
CFepUiBaseCtrl *aCtrl,
const TDesC &aEventData =  KNullDesC
)

Send event to window

Since
S60 v3.2

Parameters

TInt aEventTypeThe event type
CFepUiBaseCtrl * aCtrlThe sender
const TDesC & aEventData =  KNullDesC The event data

Sendkey(TInt, const TDesC &)

IMPORT_C voidSendkey(TIntaEventType,
const TDesC &aEventData =  KNullDesC
)

Sendkey to fep

Since
S60 v3.2

Parameters

TInt aEventTypeEvent type
const TDesC & aEventData =  KNullDesC Event data

SetData(TPeninputDataType, TAny *)

IMPORT_C voidSetData(TPeninputDataTypeaDataType,
TAny *aData
)

Set resource utils

Since
S60 v3.2

Parameters

TPeninputDataType aDataTypeData type
TAny * aDataData value

SetEnableSettingBtn(TBool)

voidSetEnableSettingBtn(TBoolaEnable)[private]

Set if enable option button and language switch button

Since
S60 v3.2

Parameters

TBool aEnableThe enable flag

SetEnableSwitchToHwr(TBool)

voidSetEnableSwitchToHwr(TBoolaEnable)[private]

Set if enable switch to hwr

Since
S60 v3.2

Parameters

TBool aEnableThe enable flag

SetPositionFromOutside(const TPoint &)

IMPORT_C voidSetPositionFromOutside(const TPoint &aNewPos)

SetPositionFromOutside. Inform UI that the position is change from outside of UI.

Since
S60 v5.0

Parameters

const TPoint & aNewPos

SizeChanged(const TAny *)

IMPORT_C TIntSizeChanged(const TAny *aData)[virtual]

From CFepUiLayout Inform layout the size changing event

Since
S60 v3.2

Parameters

const TAny * aDataThe event data

TranslateRange(TInt)

TInt TranslateRange(TIntaRange)[private]

Translate range for some languages

Since
S60 v3.2

Parameters

TInt aRangeThe range need to set

UiStateMgr()

IMPORT_C MPeninputUiStateMgr *UiStateMgr()const

Get ui state manager

Since
S60 v3.2

Member Data Documentation

CPeninputDataMgr * iDataMgr

CPeninputDataMgr *iDataMgr[protected]

The data manager Own

CPeninputLayoutWindowExt * iLayoutWindow

CPeninputLayoutWindowExt *iLayoutWindow[protected]

The layout window Own

CPeninputUiStateMgr * iUiStateMgr

CPeninputUiStateMgr *iUiStateMgr[protected]

The ui state manager Own