Collapse all Symbian^3 Product Developer Library

RPeninputServer Class Reference

class RPeninputServer

Public Member Functions
	RPeninputServer()
IMPORT_C void	ActivateLayout(TBool)
IMPORT_C void	ActivatePeninputInNotesL()
IMPORT_C TInt	AddPenUiActivationHandler(MPenUiActivationHandler *, TInt)
IMPORT_C void	AddPeninputServerObserverL(MPeninputServerEventHandler *)
IMPORT_C TBool	AutoOpen()
IMPORT_C void	BackgroudDefaultOri(TInt)
IMPORT_C void	ClearServerEvent()
IMPORT_C void	ClearTouchUI()
IMPORT_C void	Close()
IMPORT_C TInt	Connect()
IMPORT_C TInt	ConnectAsyc(TRequestStatus &)
IMPORT_C void	DimUiLayout(TBool)
IMPORT_C TInt	DisabledLayout()
IMPORT_C void	EnablePriorityChangeOnOriChange(TBool)
IMPORT_C void	GetImePluginIdListL(TInt, TInt, RArray< TInt > &)
IMPORT_C TInt	GetServerEventData(TDes &)
IMPORT_C TInt	HandleCommand(TInt, const TDesC8 &)
IMPORT_C TInt	HandleCommand(TInt)
IMPORT_C TInt	HandleCommand(TInt, const TDesC8 &, TInt &)
IMPORT_C TBool	IsDimmed()
IMPORT_C TBool	IsForeground()
IMPORT_C TBool	IsVisible()
IMPORT_C void	LoseForeground()
IMPORT_C void	PenSupportLanguagesL(RArray< TInt > &)
IMPORT_C TPluginInputMode	PreferredUiMode()
IMPORT_C void	RemovePenUiActivationHandler()
IMPORT_C void	RemovePenUiActivationHandler(MPenUiActivationHandler *)
IMPORT_C void	RemovePeninputServerObserver()
IMPORT_C void	RemovePeninputServerObserver(MPeninputServerEventHandler *)
IMPORT_C void	ResourceChanged(TInt)
IMPORT_C TInt	ServerEventDataNum()
IMPORT_C void	SetAutoOpen(TBool)
IMPORT_C void	SetDataQueryPopped(TBool)
IMPORT_C void	SetDisabledLayout(TInt)
IMPORT_C void	SetDisplayMode(TDisplayMode, TDisplayMode)
IMPORT_C void	SetEditorPriority(TInt)
IMPORT_C TBool	SetForeground(TBool)
IMPORT_C void	SetGlobalNotes(TBool)
IMPORT_C TInt	SetInputLanguage(TInt)
IMPORT_C void	SetInternalPopUp(TBool)
IMPORT_C void	SetPreferredUiMode(TPluginInputMode)
IMPORT_C void	SetResourceChange(TBool)
IMPORT_C TInt	SetUiLayoutId(TUid)
IMPORT_C TInt	SetUiLayoutId(TUid, const TDesC8 &)
IMPORT_C TInt	SetUiLayoutPos(const TPoint &)
IMPORT_C TInt	SupportInputMode(TInt)
IMPORT_C TPoint	UiLayoutPos()
IMPORT_C TSize	UiLayoutSize()
IMPORT_C void	UpdateAppInfo(const TDesC &, TPeninputAppInfo)
IMPORT_C TVersion	Version()

Private Attributes
RPeninputServerImpl *	iSingletonServer

Constructor & Destructor Documentation

RPeninputServer()

IMPORT_C

RPeninputServer

(

)

Constructor

Since: S60 v4.0

Member Functions Documentation

ActivateLayout(TBool)

IMPORT_C void

ActivateLayout

(

TBool

aFlag

)

Activate/Deactivate the layout

Since: S60 V4.0

Parameters

TBool aFlag

The activation flag. ETrue if activated

ActivatePeninputInNotesL()

IMPORT_C void

ActivatePeninputInNotesL

(

)

AddPenUiActivationHandler(MPenUiActivationHandler *, TInt)

IMPORT_C TInt	AddPenUiActivationHandler	(	MPenUiActivationHandler *	aHandler,
			TInt	aType
		)

Add pen input UI activation observer. Only one handler can be added. If need to change the handler, the old handler must be first removed.

Since: S60 V4.0

Parameters

MPenUiActivationHandler * aHandler	The callback handler when pen input UI activated/deactivated
TInt aType	The pen ui type to be handled. The available type is defined in TPenInputUiType

AddPeninputServerObserverL(MPeninputServerEventHandler *)

IMPORT_C void

AddPeninputServerObserverL

(

MPeninputServerEventHandler *

aObserver

)

Add server observer. An observer will be notified when server has event

Since: S60 V4.0

Parameters

MPeninputServerEventHandler * aObserver

The server observer

AutoOpen()

IMPORT_C TBool

AutoOpen

(

)

BackgroudDefaultOri(TInt)

IMPORT_C void

BackgroudDefaultOri

(

TInt

aOri

)

Parameters

TInt aOri

ClearServerEvent()

IMPORT_C void

ClearServerEvent

(

)

ClearTouchUI()

IMPORT_C void

ClearTouchUI

(

)

Close()

IMPORT_C void

(

)

Closes the connection to the server.

Since: S60 v4.0

Connect()

IMPORT_C TInt

Connect

(

)

Makes a connection to the server.

Since: S60 v4.0

ConnectAsyc(TRequestStatus &)

IMPORT_C TInt

ConnectAsyc

(

TRequestStatus &

aStatus

)

Parameters

TRequestStatus & aStatus

DimUiLayout(TBool)

IMPORT_C void

DimUiLayout

(

TBool

aFlag

)

Dim the UI layout

Since: S60 V5.0

Parameters

TBool aFlag

The dim flag. ETrue if going to dim the ui layout

DisabledLayout()

IMPORT_C TInt

DisabledLayout

(

)

EnablePriorityChangeOnOriChange(TBool)

IMPORT_C void

EnablePriorityChangeOnOriChange

(

TBool

aEnabled

)

Parameters

TBool aEnabled

GetImePluginIdListL(TInt, TInt, RArray< TInt > &)

IMPORT_C void	GetImePluginIdListL	(	TInt	aLanguage,
			TInt	aPluginMode,
			RArray< TInt > &	aImplmentationIds
		)

Return requried Ime plugin list

Since: S60 V4.0

Parameters

TInt aLanguage	The required supporting language
TInt aPluginMode	The required supporting mode
RArray< TInt > & aImplmentationIds	A reference to a client owned array which will be filled with IME plugin implementation.

GetServerEventData(TDes &)

IMPORT_C TInt

GetServerEventData

(

TDes &

aBuf

)

Get server event data. When server oberver got a event notification, it calls this to get data

Since: S60 V4.0

Parameters

TDes & aBuf

buf to save the event data on return

HandleCommand(TInt, const TDesC8 &)

IMPORT_C TInt	HandleCommand	(	TInt	aCmd,
			const TDesC8 &	aBuf
		)

HandleCommandL, handle command from client

Since: S60 v4.0

Parameters

TInt aCmd	The commandid
const TDesC8 & aBuf	Command data

HandleCommand(TInt)

IMPORT_C TInt

HandleCommand

(

TInt

aCmd

)

HandleCommandL, handle command from client

Since: S60 v4.0

Parameters

TInt aCmd

The commandid

HandleCommand(TInt, const TDesC8 &, TInt &)

IMPORT_C TInt	HandleCommand	(	TInt	aCmd,
			const TDesC8 &	aBuf,
			TInt &	aResult
		)

HandleCommandL, handle command from client

Since: S60 v4.0

Parameters

TInt aCmd	The commandid
const TDesC8 & aBuf	Command data
TInt & aResult	The result of layout handle

IsDimmed()

IMPORT_C TBool

IsDimmed

(

)

Get PENINPUT UI dim status

Since: S60 v4.0

IsForeground()

IMPORT_C TBool

IsForeground

(

)

Test whether this session is the forground application session

Since: S60 V4.0

IsVisible()

IMPORT_C TBool

IsVisible

(

)

Get PENINPUT UI visibility

Since: S60 v4.0

LoseForeground()

IMPORT_C void

LoseForeground

(

)

Indicates current client lost foregound.

Since: S60 V5.0

PenSupportLanguagesL(RArray< TInt > &)

IMPORT_C void

PenSupportLanguagesL

(

RArray< TInt > &

aLanguageLists

)

Return all supporing touch input languages

Since: S60 V4.0

Parameters

RArray< TInt > & aLanguageLists

A reference to a client owned array which will be filled with supporting languages.

PreferredUiMode()

IMPORT_C TPluginInputMode

PreferredUiMode

(

)

RemovePenUiActivationHandler()

IMPORT_C void

RemovePenUiActivationHandler

(

)

Remove all pen input UI activation observer

Since: S60 V4.0

RemovePenUiActivationHandler(MPenUiActivationHandler *)

IMPORT_C void

RemovePenUiActivationHandler

(

MPenUiActivationHandler *

aHandler

)

Remove a pen input UI activation observer

Since: S60 V5.0

Parameters

MPenUiActivationHandler * aHandler

RemovePeninputServerObserver()

IMPORT_C void

RemovePeninputServerObserver

(

)

Remove all pen input observer

Since: S60 V4.0

RemovePeninputServerObserver(MPeninputServerEventHandler *)

IMPORT_C void

RemovePeninputServerObserver

(

MPeninputServerEventHandler *

aObserver

)

Remove pen input observer

Since: S60 V4.0

Parameters

MPeninputServerEventHandler * aObserver

The server observer to be remvoed

ResourceChanged(TInt)

IMPORT_C void

ResourceChanged

(

TInt

aType

)

Called when resource changed, e.g, screen size changed. To inform layout that resource change event.

Since: S60 v4.0

Parameters

TInt aType

ServerEventDataNum()

IMPORT_C TInt

ServerEventDataNum

(

)

Get current pended server event number

Since: S60 V4.0

SetAutoOpen(TBool)

IMPORT_C void

SetAutoOpen

(

TBool

aFlag

)

Parameters

TBool aFlag

SetDataQueryPopped(TBool)

IMPORT_C void

SetDataQueryPopped

(

TBool

aFlag

)

Parameters

TBool aFlag

SetDisabledLayout(TInt)

IMPORT_C void

SetDisabledLayout

(

TInt

aLayouts

)

Parameters

TInt aLayouts

SetDisplayMode(TDisplayMode, TDisplayMode)

IMPORT_C void	SetDisplayMode	(	TDisplayMode	aDisplayMode,
			TDisplayMode	aMaskDisplayMode
		)

Parameters

TDisplayMode aDisplayMode
TDisplayMode aMaskDisplayMode

SetEditorPriority(TInt)

IMPORT_C void

SetEditorPriority

(

TInt

aFlag

)

Parameters

TInt aFlag

SetForeground(TBool)

IMPORT_C TBool

SetForeground

(

TBool

aMustConnectFlag

)

Set foreground application session. Only foreground app session can change the pen input UI attribute. Such command from other session will be discarded by server.

Since: S60 V4.0

Parameters

TBool aMustConnectFlag

If ETrue, the set will always success. If EFalse, operation depends on whether current app is the foreground application.

SetGlobalNotes(TBool)

IMPORT_C void

SetGlobalNotes

(

TBool

aFlag

)

Parameters

TBool aFlag

SetInputLanguage(TInt)

IMPORT_C TInt

SetInputLanguage

(

TInt

aLanguage

)

Set Input Language Id

Since: S60 v4.0

Parameters

TInt aLanguage

The input lanuage Id

SetInternalPopUp(TBool)

IMPORT_C void

SetInternalPopUp

(

TBool

aFlag

)

Parameters

TBool aFlag

SetPreferredUiMode(TPluginInputMode)

IMPORT_C void

SetPreferredUiMode

(

TPluginInputMode

aMode

)

Parameters

TPluginInputMode aMode

SetResourceChange(TBool)

IMPORT_C void

SetResourceChange

(

TBool

aFlag

)

Parameters

TBool aFlag

SetUiLayoutId(TUid)

IMPORT_C TInt

SetUiLayoutId

(

TUid

aId

)

Set UI layout id. It will create the UI by the Id

Since: S60 v4.0

Parameters

TUid aId

The layout Id

SetUiLayoutId(TUid, const TDesC8 &)

IMPORT_C TInt	SetUiLayoutId	(	TUid	aId,
			const TDesC8 &	aData
		)

Set UI layout id

Since: S60 v4.0

Parameters

TUid aId	The layout Id
const TDesC8 & aData	The data associated with the layout creation

SetUiLayoutPos(const TPoint &)

IMPORT_C TInt

SetUiLayoutPos

(

const TPoint &

aPos

)

Set UI layout position

Since: S60 v4.0

Parameters

const TPoint & aPos

The layout position

SupportInputMode(TInt)

IMPORT_C TInt

SupportInputMode

(

TInt

aLanguage

)

Get supported input mode

Parameters

TInt aLanguage

UiLayoutPos()

IMPORT_C TPoint

UiLayoutPos

(

)

get UI layout position

Since: S60 v4.0

UiLayoutSize()

IMPORT_C TSize

UiLayoutSize

(

)

get UI layout size

Since: S60 v4.0

UpdateAppInfo(const TDesC &, TPeninputAppInfo)

IMPORT_C void	UpdateAppInfo	(	const TDesC &	aInfo,
			TPeninputAppInfo	aType
		)

Parameters

const TDesC & aInfo
TPeninputAppInfo aType

Version()

IMPORT_C TVersion

Version

(

)

const

Returns the version information of the server.

Since: S60 v4.0

Member Data Documentation

RPeninputServerImpl * iSingletonServer

RPeninputServerImpl *

iSingletonServer

[private]

The singleton client to the input server