Collapse all Symbian^3 Application Developer Library

CPeninputCommonLayout Class Reference

class CPeninputCommonLayout : public CFepUiLayout

Peninput common layout

peninputcommonlayout.lib

Since: S60 v3.2

Inherits from

CPeninputCommonLayout
- CFepUiLayout
  - CBase

Public Member Functions
	~CPeninputCommonLayout ()
IMPORT_C MPeninputDataProvider *	DataMgr ()
IMPORT_C TInt	HandleCommand ( TInt , TUint8 *)
IMPORT_C void	HandleControlEvent ( TInt , CFepUiBaseCtrl *, const TDesC &)
IMPORT_C TBool	HandleRawKeyEventL (const TRawEvent &)
IMPORT_C TBool	IsCapsLockPermitted ()
IMPORT_C TBool	IsShiftPermitted ()
IMPORT_C CPeninputLayoutWindow *	LayoutWindow ()
IMPORT_C TInt	OnAppEditorTextComing (const TFepInputContextFieldData &)
IMPORT_C TInt	PenInputType ()
IMPORT_C TAny *	RequestData ( TPeninputDataType )
IMPORT_C void	SendEventToLayout ( TInt , CFepUiBaseCtrl *, const TDesC &)
IMPORT_C void	SendEventToWindow ( TInt , CFepUiBaseCtrl *, const TDesC &)
IMPORT_C void	Sendkey ( TInt , const TDesC &)
IMPORT_C void	SetData ( TPeninputDataType , TAny *)
IMPORT_C void	SetPositionFromOutside (const TPoint &)
IMPORT_C TInt	SizeChanged (const TAny *)
IMPORT_C MPeninputUiStateMgr *	UiStateMgr ()

Protected Member Functions
	CPeninputCommonLayout ( MLayoutOwner *)
IMPORT_C void	ConstructL (const TAny *)
void	CreateDataMgrL (const TAny *)
void	CreateLayoutWindowL ()
IMPORT_C TRect	Init ()
IMPORT_C TBool	IsValidDestination (const TRect &, CDragBar *, TBool &, TBool &, TBool )
TInt	LayoutType ()
IMPORT_C void	SaveKey ( TInt , TInt )

Private Member Functions
void	ChangeInputLanguage ( TInt )
void	ChangeRange ( TInt )
void	SetEnableSettingBtn ( TBool )
void	SetEnableSwitchToHwr ( 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
CPeninputLayoutWindow *	iLayoutWindow
CPeninputUiStateMgr *	iUiStateMgr

Constructor & Destructor Documentation

CPeninputCommonLayout(MLayoutOwner *)

IMPORT_C

CPeninputCommonLayout

(

MLayoutOwner *

aLayoutOwner

)

[protected]

2nd phase construction - constructor

Since: S60 v3.2

Parameters

MLayoutOwner * aLayoutOwner

The owner of layout

~CPeninputCommonLayout()

IMPORT_C

~CPeninputCommonLayout

(

)

[virtual]

Destructor

Since: S60 v3.2

Member Functions Documentation

ChangeInputLanguage(TInt)

void

ChangeInputLanguage

(

TInt

aLangID

)

[private]

Change input language

Since: S60 v3.2

Parameters

TInt aLangID

The language id you want to change to

ChangeRange(TInt)

void

ChangeRange

(

TInt

aRange

)

[private]

Change current range

Since: S60 v3.2

Parameters

TInt aRange

The range need to set

ConstructL(const TAny *)

IMPORT_C void

ConstructL

(

const TAny *

aInitData

)

[protected]

2nd phase construction - second constructor

Since: S60 v3.2

Parameters

const TAny * aInitData

Init data of layout

CreateDataMgrL(const TAny *)

void

CreateDataMgrL

(

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()

void

CreateLayoutWindowL

(

)

[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 TInt	HandleCommand	(	TInt	aCmd,
			TUint8 *	aData
		)

From CFepUiLayout Handle layout command event

Since: S60 v3.2

Parameters

TInt aCmd	Command Id
TUint8 * aData	Data for command

HandleControlEvent(TInt, CFepUiBaseCtrl *, const TDesC &)

IMPORT_C void	HandleControlEvent	(	TInt	aEventType,
			CFepUiBaseCtrl *	aCtrl,
			const TDesC &	aEventData
		)	[virtual]

From CFepUiLayout Handle the event from control

Since: S60 v3.2

Parameters

TInt aEventType	The event type
CFepUiBaseCtrl * aCtrl	The sender
const TDesC & aEventData	The event data

HandleRawKeyEventL(const TRawEvent &)

IMPORT_C TBool

HandleRawKeyEventL

(

const TRawEvent &

aKeyEvent

)

[virtual]

From CFepUiLayout Handle raw event key

Since: S60 v3.2

Parameters

const TRawEvent & aKeyEvent

The key raw event data

Init()

IMPORT_C TRect

Init

(

)

[protected, virtual]

Init layout owner

Since: S60 v3.2

IsCapsLockPermitted()

IMPORT_C TBool

IsCapsLockPermitted

(

)

IsShiftPermitted()

IMPORT_C TBool

IsShiftPermitted

(

)

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

IMPORT_C TBool	IsValidDestination	(	const TRect &	aRect,
			CDragBar *	aDragBar,
			TBool &	aVInfo,
			TBool &	aHInfo,
			TBool	aFlag
		)	[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 & aRect	The rect to be checked
CDragBar * aDragBar
TBool & aVInfo	The 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 & aHInfo	The 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 aFlag	ETrue 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 CPeninputLayoutWindow *

LayoutWindow

(

)

const

Get layout window

Since: S60 v3.2

OnAppEditorTextComing(const TFepInputContextFieldData &)

IMPORT_C TInt

OnAppEditorTextComing

(

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 & aData

Editor Text Coming data

PenInputType()

IMPORT_C TInt

PenInputType

(

)

[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

(

TPeninputDataType

aDataType

)

Request data from data provider

Since: S60 v3.2

Parameters

TPeninputDataType aDataType

The data request

SaveKey(TInt, TInt)

IMPORT_C void	SaveKey	(	TInt	aKey,
			TInt	aValue
		)	[protected, virtual]

Save a virtual keybroad key to the repository

Since: S60 v3.2

Parameters

TInt aKey	The key name in repository
TInt aValue	The unicode of key

SendEventToLayout(TInt, CFepUiBaseCtrl *, const TDesC &)

IMPORT_C void	SendEventToLayout	(	TInt	aEventType,
			CFepUiBaseCtrl *	aCtrl,
			const TDesC &	aEventData = KNullDesC
		)

Send event to layout

Since: S60 v3.2

Parameters

TInt aEventType	The event type
CFepUiBaseCtrl * aCtrl	The sender
const TDesC & aEventData = KNullDesC	The event data

SendEventToWindow(TInt, CFepUiBaseCtrl *, const TDesC &)

IMPORT_C void	SendEventToWindow	(	TInt	aEventType,
			CFepUiBaseCtrl *	aCtrl,
			const TDesC &	aEventData = KNullDesC
		)

Send event to window

Since: S60 v3.2

Parameters

TInt aEventType	The event type
CFepUiBaseCtrl * aCtrl	The sender
const TDesC & aEventData = KNullDesC	The event data

Sendkey(TInt, const TDesC &)

IMPORT_C void	Sendkey	(	TInt	aEventType,
			const TDesC &	aEventData = KNullDesC
		)

Sendkey to fep

Since: S60 v3.2

Parameters

TInt aEventType	Event type
const TDesC & aEventData = KNullDesC	Event data

SetData(TPeninputDataType, TAny *)

IMPORT_C void	SetData	(	TPeninputDataType	aDataType,
			TAny *	aData
		)

Set resource utils

Since: S60 v3.2

Parameters

TPeninputDataType aDataType	Data type
TAny * aData	Data value

SetEnableSettingBtn(TBool)

void

SetEnableSettingBtn

(

TBool

aEnable

)

[private]

Set if enable option button and language switch button

Since: S60 v3.2

Parameters

TBool aEnable

The enable flag

SetEnableSwitchToHwr(TBool)

void

SetEnableSwitchToHwr

(

TBool

aEnable

)

[private]

Set if enable switch to hwr

Since: S60 v3.2

Parameters

TBool aEnable

The enable flag

SetPositionFromOutside(const TPoint &)

IMPORT_C void

SetPositionFromOutside

(

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 TInt

SizeChanged

(

const TAny *

aData

)

[virtual]

From CFepUiLayout Inform layout the size changing event

Since: S60 v3.2

Parameters

const TAny * aData

The event data

TranslateRange(TInt)

TInt

TranslateRange

(

TInt

aRange

)

[private]

Translate range for some languages

Since: S60 v3.2

Parameters

TInt aRange

The 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

CPeninputLayoutWindow * iLayoutWindow

CPeninputLayoutWindow *

iLayoutWindow

[protected]

The layout window Own

CPeninputUiStateMgr * iUiStateMgr

CPeninputUiStateMgr *

iUiStateMgr

[protected]

The ui state manager Own