RWsSession Class Reference

class RWsSession : public MWsClientClass

Window server session.

The session between the client and the window server can be used to mediate asynchronous events, for client interface control and for system control. A description of each of these capabilities is given below.

Mediating asynchronous events:

Primarily, the session mediates asynchronous events to the user. Three event streams are available: the standard event stream which all applications must use; the redraw event stream which must be used by all applications except those which exclusively use backed-up windows; and the priority key event stream which may be used for abort keys and the like for specialist applications.

All these events are mediated as standard asynchronous services. Typical window server client programs encapsulate each service they require in an active object whose RunL() identifies the event and calls the appropriate member function of a class associated with an application framework, or a window.

Client interface control:

The client's interface with the window server has several aspects, each of which is controlled through the window server session.

Flushing defines how requests to the window server are handled.

System control:

Many system-wide settings may be controlled through the window server session. Typically, these functions are only used by the system shell and its associated sessions/applications. They include: auto-repeat and double-click, querying all window groups in the system, setting the default shadow vector, setting the system pointer cursors, counting resources used by the window server (this is only useful for debugging checks), getting and setting the state of the modifier keys (for instance Shift and Ctrl), setting the window server background colour, getting and setting thresholds for window server generated pointer events.

Inherits from

Public Member Functions
RWsSession()
IMPORT_C TIntClaimSystemPointerCursorList()
IMPORT_C voidClearAllRedrawStores()
IMPORT_C voidClearDefaultSystemPointerCursor()
IMPORT_C TIntClearHotKeys(THotKey)
IMPORT_C voidClearSystemPointerCursor(TInt)
IMPORT_C voidClose()
IMPORT_C voidComputeMode(TComputeMode)
IMPORT_C TIntConnect()
IMPORT_C TIntConnect(RFs &)
IMPORT_C TIntDebugInfo(TInt, TInt)
IMPORT_C TIntDebugInfo(TInt, TDes8 &, TInt)
IMPORT_C voidEnableWindowSizeCacheL()
IMPORT_C voidEventReady(TRequestStatus *)
IMPORT_C voidEventReadyCancel()
IMPORT_C TIntFetchMessage(TUid &, TPtr8 &, const TWsEvent &)
IMPORT_C TIntFindWindowGroupIdentifier(TInt, const TDesC &, TInt)
IMPORT_C TIntFindWindowGroupIdentifier(TInt, TThreadId)
IMPORT_C TIntFinish()
IMPORT_C voidFlush()
IMPORT_C voidFreeSystemPointerCursorList()
IMPORT_C TRgbGetBackgroundColor()
IMPORT_C TIntGetColorModeList(CArrayFixFlat< TInt > *)
IMPORT_C TIntGetColorModeList(TInt, CArrayFixFlat< TInt > *)
IMPORT_C TDisplayModeGetDefModeMaxNumColors(TInt &, TInt &)
IMPORT_C TDisplayModeGetDefModeMaxNumColors(TInt, TInt &, TInt &)
IMPORT_C TIntGetDefaultOwningWindow()
IMPORT_C TIntGetDefaultOwningWindow(TInt)
IMPORT_C voidGetDoubleClickSettings(TTimeIntervalMicroSeconds32 &, TInt &)
IMPORT_C TIntGetEnterCloseProximityThreshold()
IMPORT_C TIntGetEnterHighPressureThreshold()
IMPORT_C voidGetEvent(TWsEvent &)
IMPORT_C TIntGetExitCloseProximityThreshold()
IMPORT_C TIntGetExitHighPressureThreshold()
IMPORT_C TIntGetFocusScreen()
IMPORT_C TIntGetFocusWindowGroup()
IMPORT_C TIntGetFocusWindowGroup(TInt)
voidGetGraphicMessage(TDes8 &)
IMPORT_C voidGetKeyboardRepeatRate(TTimeIntervalMicroSeconds32 &, TTimeIntervalMicroSeconds32 &)
IMPORT_C TIntGetModifierState()
IMPORT_C voidGetPriorityKey(TWsPriorityKeyEvent &)
IMPORT_C voidGetRedraw(TWsRedrawEvent &)
IMPORT_C TIntGetWindowGroupClientThreadId(TInt, TThreadId &)
IMPORT_C TIntGetWindowGroupHandle(TInt)
IMPORT_C TIntGetWindowGroupNameFromIdentifier(TInt, TDes &)
IMPORT_C TIntGetWindowGroupOrdinalPriority(TInt)
voidGraphicAbortMessage(TInt)
TInt GraphicFetchHeaderMessage()
voidGraphicMessageCancel()
voidGraphicMessageReady(TRequestStatus *)
IMPORT_C TIntHeapCount()
IMPORT_C voidHeapSetBurstFail(TInt, TInt, TInt)
IMPORT_C voidHeapSetFail(TInt, TInt)
IMPORT_C voidLogCommand(TLoggingCommand)
IMPORT_C voidLogMessage(const TLogMessageText &)
IMPORT_C TIntNumWindowGroups()
IMPORT_C TIntNumWindowGroups(TInt)
IMPORT_C TIntNumWindowGroups(TInt, TInt)
IMPORT_C TIntNumberOfScreens()
IMPORT_C voidPasswordEntered()
IMPORT_C TRectPointerCursorArea()
IMPORT_C TRectPointerCursorArea(TInt)
IMPORT_C TPointerCursorModePointerCursorMode()
IMPORT_C TPointPointerCursorPosition()
IMPORT_C TIntPreferredSurfaceConfigurationSize()
IMPORT_C voidPrepareForSwitchOff()
IMPORT_C voidPriorityKeyReady(TRequestStatus *)
IMPORT_C voidPriorityKeyReadyCancel()
IMPORT_C voidPurgePointerEvents()
IMPORT_C voidRedrawReady(TRequestStatus *)
IMPORT_C voidRedrawReadyCancel()
IMPORT_C TIntRegisterSurface(TInt, const TSurfaceId &)
IMPORT_C TIntRequestOffEvents(TBool, RWindowTreeNode *)
IMPORT_C TIntResourceCount()
IMPORT_C TIntRestoreDefaultHotKey(THotKey)
IMPORT_C TIntSendEventToAllWindowGroups(const TWsEvent &)
IMPORT_C TIntSendEventToAllWindowGroups(TInt, const TWsEvent &)
IMPORT_C TIntSendEventToOneWindowGroupsPerClient(const TWsEvent &)
IMPORT_C TIntSendEventToWindowGroup(TInt, const TWsEvent &)
IMPORT_C TIntSendMessageToAllWindowGroups(TUid, const TDesC8 &)
IMPORT_C TIntSendMessageToAllWindowGroups(TInt, TUid, const TDesC8 &)
IMPORT_C TIntSendMessageToWindowGroup(TInt, TUid, const TDesC8 &)
IMPORT_C TBoolSetAutoFlush(TBool)
IMPORT_C voidSetBackgroundColor(TRgb)
IMPORT_C voidSetBufferSizeL(TInt)
IMPORT_C TIntSetClientCursorMode(TPointerCursorMode)
IMPORT_C TIntSetCloseProximityThresholds(TInt, TInt)
IMPORT_C TIntSetCustomTextCursor(TInt, const TArray< TSpriteMember > &, TUint, TCustomTextCursorAlignment)
IMPORT_C voidSetDefaultFadingParameters(TUint8, TUint8)
IMPORT_C voidSetDefaultSystemPointerCursor(TInt)
IMPORT_C TIntSetDoubleClick(const TTimeIntervalMicroSeconds32 &, TInt)
IMPORT_C TIntSetFocusScreen(TInt)
IMPORT_C TIntSetHighPressureThresholds(TInt, TInt)
IMPORT_C TIntSetHotKey(THotKey, TUint, TUint, TUint)
IMPORT_C TIntSetKeyboardRepeatRate(const TTimeIntervalMicroSeconds32 &, const TTimeIntervalMicroSeconds32 &)
IMPORT_C voidSetMaxBufferSizeL(TInt)
IMPORT_C TIntSetModifierState(TEventModifier, TModifierState)
IMPORT_C voidSetPointerCursorArea(const TRect &)
IMPORT_C voidSetPointerCursorArea(TInt, const TRect &)
IMPORT_C voidSetPointerCursorMode(TPointerCursorMode)
IMPORT_C TIntSetPointerCursorPosition(const TPoint &)
IMPORT_C voidSetRemoveKeyCode(TBool)
IMPORT_C voidSetShadowVector(const TPoint &)
IMPORT_C TIntSetSystemFaded(TBool)
IMPORT_C TIntSetSystemFaded(TBool, TUint8, TUint8)
IMPORT_C TIntSetSystemPointerCursor(const RWsPointerCursor &, TInt)
IMPORT_C TIntSetWindowGroupOrdinalPosition(TInt, TInt)
IMPORT_C TPointShadowVector()
IMPORT_C voidSimulateKeyEvent(TKeyEvent)
IMPORT_C voidSimulateRawEvent(TRawEvent)
IMPORT_C voidSimulateXyInputType(TInt)
IMPORT_C voidSyncMsgBuf()
IMPORT_C voidSystemInfo(TInt &, SSystemInfo &)
IMPORT_C voidTestWrite(TInt, TInt, const TAny *, TInt)
IMPORT_C voidTestWriteReply(TInt, TInt, const TAny *, TInt)
IMPORT_C TIntTestWriteReplyByProvidingRemoteReadAccess(TInt, TInt, const TDesC8 &, const TDesC8 &)
IMPORT_C TIntTestWriteReplyByProvidingRemoteReadAccess(TInt, TInt, const TDesC8 &, const TDesC16 &)
IMPORT_C voidTestWriteReplyP(TInt, TInt, const TAny *, TInt, TDes8 *)
IMPORT_C voidUnregisterSurface(TInt, const TSurfaceId &)
IMPORT_C TVersionVersion()
IMPORT_C TIntWindowGroupList(CArrayFixFlat< TInt > *)
IMPORT_C TIntWindowGroupList(RArray< TWindowGroupChainInfo > *)
IMPORT_C TIntWindowGroupList(TInt, CArrayFixFlat< TInt > *)
IMPORT_C TIntWindowGroupList(TInt, RArray< TWindowGroupChainInfo > *)
IMPORT_C TIntWindowGroupList(CArrayFixFlat< TInt > *, TInt, TInt)
Private Member Functions
voidDirectAcessActivation(TBool)
TInt DoFlush(const TIpcArgs &)
TInt DoSyncMsgBuf(const TIpcArgs &)
voidconnectL()
voiddoReadEvent(TRequestStatus *, TInt)
TInt doSetHotKey(TInt, TInt, TUint, TUint, TUint)
TInt doWindowGroupList(TInt, RArray< TWindowGroupChainInfo > *, TInt, TInt)
TInt doWindowGroupList(TInt, TInt, CArrayFixFlat< TInt > *, TInt, TInt)
Inherited Functions
MWsClientClass::AddToBitmapArray(const TInt)const
MWsClientClass::AsyncRequest(TRequestStatus &,TUint)const
MWsClientClass::CachedWindowSize(TSize &)const
MWsClientClass::DestroyWindowSizeCacheEntry()
MWsClientClass::MWsClientClass()
MWsClientClass::MWsClientClass(RWsBuffer *)
MWsClientClass::MarkWindowSizeCacheDirty()
MWsClientClass::RefreshWindowSizeCache(const TSize &)const
MWsClientClass::WindowSizeCacheEnabled()const
MWsClientClass::Write(TUint)const
MWsClientClass::Write(const TAny *,TInt,TUint)const
MWsClientClass::Write(const TAny *,TInt,const TAny *,TInt,TUint)const
MWsClientClass::WriteInt(TInt,TUint)const
MWsClientClass::WritePoint(const TPoint &,TUint)const
MWsClientClass::WriteRect(const TRect &,TUint)const
MWsClientClass::WriteReply(TUint,const TIpcArgs *)const
MWsClientClass::WriteReply(const TAny *,TInt,TUint,const TIpcArgs *)const
MWsClientClass::WriteReply(const TAny *,TInt,const TAny *,TInt,TUint,const TIpcArgs *)const
MWsClientClass::WriteReplyByProvidingRemoteReadAccess(const TAny *,TInt,const TReadDescriptorType &,TUint)const
MWsClientClass::WriteReplyInt(TInt,TUint,const TIpcArgs *)const
MWsClientClass::WriteReplyIntP(TInt,const TWriteDescriptorType &,TUint)const
MWsClientClass::WriteReplyP(const TAny *,TInt,const TAny *,TInt,const TWriteDescriptorType &,TUint)const
MWsClientClass::WriteReplyP(const TAny *,TInt,const TWriteDescriptorType &,TUint)const
MWsClientClass::WriteReplyP(const TWriteDescriptorType &,TUint)const
MWsClientClass::WriteSize(const TSize &,TUint)const
MWsClientClass::WsHandle()const
Public Member Enumerations
enumTComputeMode { EPriorityControlDisabled, EPriorityControlComputeOn, EPriorityControlComputeOff }
enumTCustomTextCursorAlignment { ECustomTextCursorAlignTop, ECustomTextCursorAlignBaseline, ECustomTextCursorAlignBottom }
enumTLoggingCommand { ELoggingEnable, ELoggingDisable, ELoggingStatusDump, ELoggingHeapDump }
Inherited Attributes
MWsClientClass::iBuffer
MWsClientClass::iWsHandle

Constructor & Destructor Documentation

RWsSession()

IMPORT_CRWsSession()

Member Functions Documentation

ClaimSystemPointerCursorList()

IMPORT_C TIntClaimSystemPointerCursorList()

ClearAllRedrawStores()

IMPORT_C voidClearAllRedrawStores()

ClearDefaultSystemPointerCursor()

IMPORT_C voidClearDefaultSystemPointerCursor()

ClearHotKeys(THotKey)

IMPORT_C TIntClearHotKeys(THotKeyaType)

Parameters

THotKey aType

ClearSystemPointerCursor(TInt)

IMPORT_C voidClearSystemPointerCursor(TIntaCursorNumber)

Parameters

TInt aCursorNumber

Close()

IMPORT_C voidClose()

ComputeMode(TComputeMode)

IMPORT_C voidComputeMode(TComputeModeaMode)

Parameters

TComputeMode aMode

Connect()

IMPORT_C TIntConnect()

Connect(RFs &)

IMPORT_C TIntConnect(RFs &aFileServer)

Parameters

RFs & aFileServer

DebugInfo(TInt, TInt)

IMPORT_C TIntDebugInfo(TIntaFunction,
TIntaParam = 0
)const

Parameters

TInt aFunction
TInt aParam = 0

DebugInfo(TInt, TDes8 &, TInt)

IMPORT_C TIntDebugInfo(TIntaFunction,
TDes8 &aReturnBuf,
TIntaParam = 0
)const

Parameters

TInt aFunction
TDes8 & aReturnBuf
TInt aParam = 0

DirectAcessActivation(TBool)

voidDirectAcessActivation(TBoolaIsNowActive)[private]

Parameters

TBool aIsNowActive

DoFlush(const TIpcArgs &)

TInt DoFlush(const TIpcArgs &aIpcArgs)[private]

Parameters

const TIpcArgs & aIpcArgs

DoSyncMsgBuf(const TIpcArgs &)

TInt DoSyncMsgBuf(const TIpcArgs &aIpcArgs)[private]

Parameters

const TIpcArgs & aIpcArgs

EnableWindowSizeCacheL()

IMPORT_C voidEnableWindowSizeCacheL()

EventReady(TRequestStatus *)

IMPORT_C voidEventReady(TRequestStatus *aStat)

Parameters

TRequestStatus * aStat

EventReadyCancel()

IMPORT_C voidEventReadyCancel()

FetchMessage(TUid &, TPtr8 &, const TWsEvent &)

IMPORT_C TIntFetchMessage(TUid &aUid,
TPtr8 &aParams,
const TWsEvent &aMessageEvent
)const

Parameters

TUid & aUid
TPtr8 & aParams
const TWsEvent & aMessageEvent

FindWindowGroupIdentifier(TInt, const TDesC &, TInt)

IMPORT_C TIntFindWindowGroupIdentifier(TIntaPreviousIdentifier,
const TDesC &aMatch,
TIntaOffset = 0
)const

Parameters

TInt aPreviousIdentifier
const TDesC & aMatch
TInt aOffset = 0

FindWindowGroupIdentifier(TInt, TThreadId)

IMPORT_C TIntFindWindowGroupIdentifier(TIntaPreviousIdentifier,
TThreadIdaThreadId
)const

Parameters

TInt aPreviousIdentifier
TThreadId aThreadId

Finish()

IMPORT_C TIntFinish()

Flush()

IMPORT_C voidFlush()

FreeSystemPointerCursorList()

IMPORT_C voidFreeSystemPointerCursorList()

GetBackgroundColor()

IMPORT_C TRgbGetBackgroundColor()const

GetColorModeList(CArrayFixFlat< TInt > *)

IMPORT_C TIntGetColorModeList(CArrayFixFlat< TInt > *aModeList)const

Parameters

CArrayFixFlat< TInt > * aModeList

GetColorModeList(TInt, CArrayFixFlat< TInt > *)

IMPORT_C TIntGetColorModeList(TIntaScreenNumber,
CArrayFixFlat< TInt > *aModeList
)const

Parameters

TInt aScreenNumber
CArrayFixFlat< TInt > * aModeList

GetDefModeMaxNumColors(TInt &, TInt &)

IMPORT_C TDisplayModeGetDefModeMaxNumColors(TInt &aColor,
TInt &aGray
)const

Parameters

TInt & aColor
TInt & aGray

GetDefModeMaxNumColors(TInt, TInt &, TInt &)

IMPORT_C TDisplayModeGetDefModeMaxNumColors(TIntaScreenNumber,
TInt &aColor,
TInt &aGray
)const

Parameters

TInt aScreenNumber
TInt & aColor
TInt & aGray

GetDefaultOwningWindow()

IMPORT_C TIntGetDefaultOwningWindow()const

GetDefaultOwningWindow(TInt)

IMPORT_C TIntGetDefaultOwningWindow(TIntaScreenNumber)const

Parameters

TInt aScreenNumber

GetDoubleClickSettings(TTimeIntervalMicroSeconds32 &, TInt &)

IMPORT_C voidGetDoubleClickSettings(TTimeIntervalMicroSeconds32 &aInterval,
TInt &aDistance
)const

Parameters

TTimeIntervalMicroSeconds32 & aInterval
TInt & aDistance

GetEnterCloseProximityThreshold()

IMPORT_C TIntGetEnterCloseProximityThreshold()const

GetEnterHighPressureThreshold()

IMPORT_C TIntGetEnterHighPressureThreshold()const

GetEvent(TWsEvent &)

IMPORT_C voidGetEvent(TWsEvent &aEvent)const

Parameters

TWsEvent & aEvent

GetExitCloseProximityThreshold()

IMPORT_C TIntGetExitCloseProximityThreshold()const

GetExitHighPressureThreshold()

IMPORT_C TIntGetExitHighPressureThreshold()const

GetFocusScreen()

IMPORT_C TIntGetFocusScreen()const

GetFocusWindowGroup()

IMPORT_C TIntGetFocusWindowGroup()const

GetFocusWindowGroup(TInt)

IMPORT_C TIntGetFocusWindowGroup(TIntaScreenNumber)const

Parameters

TInt aScreenNumber

GetGraphicMessage(TDes8 &)

voidGetGraphicMessage(TDes8 &aData)const

Parameters

TDes8 & aData

GetKeyboardRepeatRate(TTimeIntervalMicroSeconds32 &, TTimeIntervalMicroSeconds32 &)

IMPORT_C voidGetKeyboardRepeatRate(TTimeIntervalMicroSeconds32 &aInitialTime,
TTimeIntervalMicroSeconds32 &aTime
)const

GetModifierState()

IMPORT_C TIntGetModifierState()const

GetPriorityKey(TWsPriorityKeyEvent &)

IMPORT_C voidGetPriorityKey(TWsPriorityKeyEvent &aEvent)const

Parameters

TWsPriorityKeyEvent & aEvent

GetRedraw(TWsRedrawEvent &)

IMPORT_C voidGetRedraw(TWsRedrawEvent &aEvent)

Parameters

TWsRedrawEvent & aEvent

GetWindowGroupClientThreadId(TInt, TThreadId &)

IMPORT_C TIntGetWindowGroupClientThreadId(TIntaIdentifier,
TThreadId &aThreadId
)const

Parameters

TInt aIdentifier
TThreadId & aThreadId

GetWindowGroupHandle(TInt)

IMPORT_C TIntGetWindowGroupHandle(TIntaIdentifier)const

Parameters

TInt aIdentifier

GetWindowGroupNameFromIdentifier(TInt, TDes &)

IMPORT_C TIntGetWindowGroupNameFromIdentifier(TIntaIdentifier,
TDes &aWindowName
)const

Parameters

TInt aIdentifier
TDes & aWindowName

GetWindowGroupOrdinalPriority(TInt)

IMPORT_C TIntGetWindowGroupOrdinalPriority(TIntaIdentifier)const

Parameters

TInt aIdentifier

GraphicAbortMessage(TInt)

voidGraphicAbortMessage(TIntaError)

Parameters

TInt aError

GraphicFetchHeaderMessage()

TInt GraphicFetchHeaderMessage()

GraphicMessageCancel()

voidGraphicMessageCancel()

GraphicMessageReady(TRequestStatus *)

voidGraphicMessageReady(TRequestStatus *aStat)

Parameters

TRequestStatus * aStat

HeapCount()

IMPORT_C TIntHeapCount()const

HeapSetBurstFail(TInt, TInt, TInt)

IMPORT_C voidHeapSetBurstFail(TIntaTAllocFail,
TIntaRate,
TIntaBurst
)

Parameters

TInt aTAllocFail
TInt aRate
TInt aBurst

HeapSetFail(TInt, TInt)

IMPORT_C voidHeapSetFail(TIntaTAllocFail,
TIntaValue
)

Parameters

TInt aTAllocFail
TInt aValue

LogCommand(TLoggingCommand)

IMPORT_C voidLogCommand(TLoggingCommandaCommand)

Parameters

TLoggingCommand aCommand

LogMessage(const TLogMessageText &)

IMPORT_C voidLogMessage(const TLogMessageText &aMessage)

Parameters

const TLogMessageText & aMessage

NumWindowGroups()

IMPORT_C TIntNumWindowGroups()const

NumWindowGroups(TInt)

IMPORT_C TIntNumWindowGroups(TIntaPriority)const

Parameters

TInt aPriority

NumWindowGroups(TInt, TInt)

IMPORT_C TIntNumWindowGroups(TIntaScreenNumber,
TIntaPriority
)const

Parameters

TInt aScreenNumber
TInt aPriority

NumberOfScreens()

IMPORT_C TIntNumberOfScreens()const

PasswordEntered()

IMPORT_C voidPasswordEntered()

PointerCursorArea()

IMPORT_C TRectPointerCursorArea()const

PointerCursorArea(TInt)

IMPORT_C TRectPointerCursorArea(TIntaScreenSizeMode)const

Parameters

TInt aScreenSizeMode

PointerCursorMode()

IMPORT_C TPointerCursorModePointerCursorMode()const

PointerCursorPosition()

IMPORT_C TPointPointerCursorPosition()const

PreferredSurfaceConfigurationSize()

IMPORT_C TIntPreferredSurfaceConfigurationSize()const

PrepareForSwitchOff()

IMPORT_C voidPrepareForSwitchOff()

PriorityKeyReady(TRequestStatus *)

IMPORT_C voidPriorityKeyReady(TRequestStatus *aStat)

Parameters

TRequestStatus * aStat

PriorityKeyReadyCancel()

IMPORT_C voidPriorityKeyReadyCancel()

PurgePointerEvents()

IMPORT_C voidPurgePointerEvents()

RedrawReady(TRequestStatus *)

IMPORT_C voidRedrawReady(TRequestStatus *aStat)

Parameters

TRequestStatus * aStat

RedrawReadyCancel()

IMPORT_C voidRedrawReadyCancel()

RegisterSurface(TInt, const TSurfaceId &)

IMPORT_C TIntRegisterSurface(TIntaScreenNumber,
const TSurfaceId &aSurface
)

Parameters

TInt aScreenNumber
const TSurfaceId & aSurface

RequestOffEvents(TBool, RWindowTreeNode *)

IMPORT_C TIntRequestOffEvents(TBoolaOn,
RWindowTreeNode *aWin = NULL
)

Parameters

TBool aOn
RWindowTreeNode * aWin = NULL

ResourceCount()

IMPORT_C TIntResourceCount()const

RestoreDefaultHotKey(THotKey)

IMPORT_C TIntRestoreDefaultHotKey(THotKeyaType)

Parameters

THotKey aType

SendEventToAllWindowGroups(const TWsEvent &)

IMPORT_C TIntSendEventToAllWindowGroups(const TWsEvent &aEvent)

Parameters

const TWsEvent & aEvent

SendEventToAllWindowGroups(TInt, const TWsEvent &)

IMPORT_C TIntSendEventToAllWindowGroups(TIntaPriority,
const TWsEvent &aEvent
)

Parameters

TInt aPriority
const TWsEvent & aEvent

SendEventToOneWindowGroupsPerClient(const TWsEvent &)

IMPORT_C TIntSendEventToOneWindowGroupsPerClient(const TWsEvent &aEvent)

Parameters

const TWsEvent & aEvent

SendEventToWindowGroup(TInt, const TWsEvent &)

IMPORT_C TIntSendEventToWindowGroup(TIntaIdentifier,
const TWsEvent &aEvent
)

Parameters

TInt aIdentifier
const TWsEvent & aEvent

SendMessageToAllWindowGroups(TUid, const TDesC8 &)

IMPORT_C TIntSendMessageToAllWindowGroups(TUidaUid,
const TDesC8 &aParams
)

Parameters

TUid aUid
const TDesC8 & aParams

SendMessageToAllWindowGroups(TInt, TUid, const TDesC8 &)

IMPORT_C TIntSendMessageToAllWindowGroups(TIntaPriority,
TUidaUid,
const TDesC8 &aParams
)

Parameters

TInt aPriority
TUid aUid
const TDesC8 & aParams

SendMessageToWindowGroup(TInt, TUid, const TDesC8 &)

IMPORT_C TIntSendMessageToWindowGroup(TIntaIdentifier,
TUidaUid,
const TDesC8 &aParams
)

Parameters

TInt aIdentifier
TUid aUid
const TDesC8 & aParams

SetAutoFlush(TBool)

IMPORT_C TBoolSetAutoFlush(TBoolaState)

Parameters

TBool aState

SetBackgroundColor(TRgb)

IMPORT_C voidSetBackgroundColor(TRgbaColor)

Parameters

TRgb aColor

SetBufferSizeL(TInt)

IMPORT_C voidSetBufferSizeL(TIntaBufSize)

Parameters

TInt aBufSize

SetClientCursorMode(TPointerCursorMode)

IMPORT_C TIntSetClientCursorMode(TPointerCursorModeaMode)

Parameters

TPointerCursorMode aMode

SetCloseProximityThresholds(TInt, TInt)

IMPORT_C TIntSetCloseProximityThresholds(TIntaEnterCloseProximityThreshold,
TIntaExitCloseProximityThreshold
)

Parameters

TInt aEnterCloseProximityThreshold
TInt aExitCloseProximityThreshold

SetCustomTextCursor(TInt, const TArray< TSpriteMember > &, TUint, TCustomTextCursorAlignment)

IMPORT_C TIntSetCustomTextCursor(TIntaIdentifier,
const TArray< TSpriteMember > &aSpriteMemberArray,
TUintaSpriteFlags,
TCustomTextCursorAlignmentaAlignment
)

Parameters

TInt aIdentifier
const TArray< TSpriteMember > & aSpriteMemberArray
TUint aSpriteFlags
TCustomTextCursorAlignment aAlignment

SetDefaultFadingParameters(TUint8, TUint8)

IMPORT_C voidSetDefaultFadingParameters(TUint8aBlackMap,
TUint8aWhiteMap
)

Parameters

TUint8 aBlackMap
TUint8 aWhiteMap

SetDefaultSystemPointerCursor(TInt)

IMPORT_C voidSetDefaultSystemPointerCursor(TIntaCursorNumber)

Parameters

TInt aCursorNumber

SetDoubleClick(const TTimeIntervalMicroSeconds32 &, TInt)

IMPORT_C TIntSetDoubleClick(const TTimeIntervalMicroSeconds32 &aInterval,
TIntaDistance
)

Parameters

const TTimeIntervalMicroSeconds32 & aInterval
TInt aDistance

SetFocusScreen(TInt)

IMPORT_C TIntSetFocusScreen(TIntaScreenNumber)

Parameters

TInt aScreenNumber

SetHighPressureThresholds(TInt, TInt)

IMPORT_C TIntSetHighPressureThresholds(TIntaEnterHighPressureThreshold,
TIntaExitHighPressureThreshold
)

Parameters

TInt aEnterHighPressureThreshold
TInt aExitHighPressureThreshold

SetHotKey(THotKey, TUint, TUint, TUint)

IMPORT_C TIntSetHotKey(THotKeyaType,
TUintaKeyCode,
TUintaModifierMask,
TUintaModifier
)

Parameters

THotKey aType
TUint aKeyCode
TUint aModifierMask
TUint aModifier

SetKeyboardRepeatRate(const TTimeIntervalMicroSeconds32 &, const TTimeIntervalMicroSeconds32 &)

IMPORT_C TIntSetKeyboardRepeatRate(const TTimeIntervalMicroSeconds32 &aInitialTime,
const TTimeIntervalMicroSeconds32 &aTime
)

Parameters

const TTimeIntervalMicroSeconds32 & aInitialTime
const TTimeIntervalMicroSeconds32 & aTime

SetMaxBufferSizeL(TInt)

IMPORT_C voidSetMaxBufferSizeL(TIntaMaxBufSize)

Parameters

TInt aMaxBufSize

SetModifierState(TEventModifier, TModifierState)

IMPORT_C TIntSetModifierState(TEventModifieraModifier,
TModifierStateaState
)

Parameters

TEventModifier aModifier
TModifierState aState

SetPointerCursorArea(const TRect &)

IMPORT_C voidSetPointerCursorArea(const TRect &aArea)

Parameters

const TRect & aArea

SetPointerCursorArea(TInt, const TRect &)

IMPORT_C voidSetPointerCursorArea(TIntaScreenSizeMode,
const TRect &aArea
)

Parameters

TInt aScreenSizeMode
const TRect & aArea

SetPointerCursorMode(TPointerCursorMode)

IMPORT_C voidSetPointerCursorMode(TPointerCursorModeaMode)

Parameters

TPointerCursorMode aMode

SetPointerCursorPosition(const TPoint &)

IMPORT_C TIntSetPointerCursorPosition(const TPoint &aPosition)

Parameters

const TPoint & aPosition

SetRemoveKeyCode(TBool)

IMPORT_C voidSetRemoveKeyCode(TBoolaRemove)

Parameters

TBool aRemove

SetShadowVector(const TPoint &)

IMPORT_C voidSetShadowVector(const TPoint &aVector)

Parameters

const TPoint & aVector

SetSystemFaded(TBool)

IMPORT_C TIntSetSystemFaded(TBoolaFaded)

Parameters

TBool aFaded

SetSystemFaded(TBool, TUint8, TUint8)

IMPORT_C TIntSetSystemFaded(TBoolaFaded,
TUint8aBlackMap,
TUint8aWhiteMap
)

Parameters

TBool aFaded
TUint8 aBlackMap
TUint8 aWhiteMap

SetSystemPointerCursor(const RWsPointerCursor &, TInt)

IMPORT_C TIntSetSystemPointerCursor(const RWsPointerCursor &aPointerCursor,
TIntaCursorNumber
)

Parameters

const RWsPointerCursor & aPointerCursor
TInt aCursorNumber

SetWindowGroupOrdinalPosition(TInt, TInt)

IMPORT_C TIntSetWindowGroupOrdinalPosition(TIntaIdentifier,
TIntaPosition
)

Parameters

TInt aIdentifier
TInt aPosition

ShadowVector()

IMPORT_C TPointShadowVector()const

SimulateKeyEvent(TKeyEvent)

IMPORT_C voidSimulateKeyEvent(TKeyEventaEvent)

Parameters

TKeyEvent aEvent

SimulateRawEvent(TRawEvent)

IMPORT_C voidSimulateRawEvent(TRawEventaEvent)

Parameters

TRawEvent aEvent

SimulateXyInputType(TInt)

IMPORT_C voidSimulateXyInputType(TIntaInputType)

Parameters

TInt aInputType

SyncMsgBuf()

IMPORT_C voidSyncMsgBuf()

SystemInfo(TInt &, SSystemInfo &)

IMPORT_C voidSystemInfo(TInt &aSystemInfoNumber,
SSystemInfo &aSystemInfo
)

Parameters

TInt & aSystemInfoNumber
SSystemInfo & aSystemInfo

TestWrite(TInt, TInt, const TAny *, TInt)

IMPORT_C voidTestWrite(TIntaHandle,
TIntaOpcode,
const TAny *aData,
TIntaLength
)

Parameters

TInt aHandle
TInt aOpcode
const TAny * aData
TInt aLength

TestWriteReply(TInt, TInt, const TAny *, TInt)

IMPORT_C voidTestWriteReply(TIntaHandle,
TIntaOpcode,
const TAny *aData,
TIntaLength
)

Parameters

TInt aHandle
TInt aOpcode
const TAny * aData
TInt aLength

TestWriteReplyByProvidingRemoteReadAccess(TInt, TInt, const TDesC8 &, const TDesC8 &)

IMPORT_C TIntTestWriteReplyByProvidingRemoteReadAccess(TIntaHandle,
TIntaOpcode,
const TDesC8 &aData,
const TDesC8 &aRemoteReadBuffer
)

Parameters

TInt aHandle
TInt aOpcode
const TDesC8 & aData
const TDesC8 & aRemoteReadBuffer

TestWriteReplyByProvidingRemoteReadAccess(TInt, TInt, const TDesC8 &, const TDesC16 &)

IMPORT_C TIntTestWriteReplyByProvidingRemoteReadAccess(TIntaHandle,
TIntaOpcode,
const TDesC8 &aData,
const TDesC16 &aRemoteReadBuffer
)

Parameters

TInt aHandle
TInt aOpcode
const TDesC8 & aData
const TDesC16 & aRemoteReadBuffer

TestWriteReplyP(TInt, TInt, const TAny *, TInt, TDes8 *)

IMPORT_C voidTestWriteReplyP(TIntaHandle,
TIntaOpcode,
const TAny *aData,
TIntaLength,
TDes8 *aReplyPackage
)

Parameters

TInt aHandle
TInt aOpcode
const TAny * aData
TInt aLength
TDes8 * aReplyPackage

UnregisterSurface(TInt, const TSurfaceId &)

IMPORT_C voidUnregisterSurface(TIntaScreenNumber,
const TSurfaceId &aSurface
)

Parameters

TInt aScreenNumber
const TSurfaceId & aSurface

Version()

IMPORT_C TVersionVersion()const

WindowGroupList(CArrayFixFlat< TInt > *)

IMPORT_C TIntWindowGroupList(CArrayFixFlat< TInt > *aWindowList)const

Parameters

CArrayFixFlat< TInt > * aWindowList

WindowGroupList(RArray< TWindowGroupChainInfo > *)

IMPORT_C TIntWindowGroupList(RArray< TWindowGroupChainInfo > *aWindowList)const

Parameters

RArray< TWindowGroupChainInfo > * aWindowList

WindowGroupList(TInt, CArrayFixFlat< TInt > *)

IMPORT_C TIntWindowGroupList(TIntaPriority,
CArrayFixFlat< TInt > *aWindowList
)const

Parameters

TInt aPriority
CArrayFixFlat< TInt > * aWindowList

WindowGroupList(TInt, RArray< TWindowGroupChainInfo > *)

IMPORT_C TIntWindowGroupList(TIntaPriority,
RArray< TWindowGroupChainInfo > *aWindowList
)const

Parameters

TInt aPriority
RArray< TWindowGroupChainInfo > * aWindowList

WindowGroupList(CArrayFixFlat< TInt > *, TInt, TInt)

IMPORT_C TIntWindowGroupList(CArrayFixFlat< TInt > *aWindowList,
TIntaScreenNumber,
TIntaPriority = EAllPriorities
)const

Parameters

CArrayFixFlat< TInt > * aWindowList
TInt aScreenNumber
TInt aPriority = EAllPriorities

connectL()

voidconnectL()[private]

doReadEvent(TRequestStatus *, TInt)

voiddoReadEvent(TRequestStatus *aStat,
TIntaOpcode
)[private]

Parameters

TRequestStatus * aStat
TInt aOpcode

doSetHotKey(TInt, TInt, TUint, TUint, TUint)

TInt doSetHotKey(TIntaOpcode,
TIntaType,
TUintaKeycode,
TUintaModifierMask,
TUintaModifiers
)[private]

Parameters

TInt aOpcode
TInt aType
TUint aKeycode
TUint aModifierMask
TUint aModifiers

doWindowGroupList(TInt, RArray< TWindowGroupChainInfo > *, TInt, TInt)

TInt doWindowGroupList(TIntaPriority,
RArray< TWindowGroupChainInfo > *aWindowListCh,
TIntaNumOpcode,
TIntaListOpcode
)const [private]

Parameters

TInt aPriority
RArray< TWindowGroupChainInfo > * aWindowListCh
TInt aNumOpcode
TInt aListOpcode

doWindowGroupList(TInt, TInt, CArrayFixFlat< TInt > *, TInt, TInt)

TInt doWindowGroupList(TIntaScreenNumber,
TIntaPriority,
CArrayFixFlat< TInt > *aWindowListId,
TIntaNumOpcode,
TIntaListOpcode
)const [private]

Parameters

TInt aScreenNumber
TInt aPriority
CArrayFixFlat< TInt > * aWindowListId
TInt aNumOpcode
TInt aListOpcode

Member Enumerations Documentation

Enum TComputeMode

Compute mode flags.

When a window group takes focus or loses it, the window server can boost its client's thread or process priority to provide a better response to the user. How it alters the priority is determined by the current compute mode of the client.

ComputeMode()

Enumerators

EPriorityControlDisabled

Client priority is permanently set to its current level. It is not altered or set by the windowing system if the focus changes.

Thus if ComputeMode() is called with this flag when a client is in the foreground, it will subsequently have foreground priority even if it is in the background.

EPriorityControlComputeOn

Client process's priority is always set to EPriorityBackground.

EPriorityControlComputeOff

Client process's priority is set to EPriorityForeground when the window group takes focus, and set to EPriorityBackground when it loses focus.

This is the default behaviour.

Enum TCustomTextCursorAlignment

The vertical alignment of a custom text cursor sprite.

One of these values must be set, see SetCustomTextCursor(). This value also determines which part of each sprite member bitmap is clipped when the cursor's TTextCursor::EFlagClipVertical flag is set.

Enumerators

ECustomTextCursorAlignTop

The y-origin of each sprite member bitmap is aligned with the top of the line.

ECustomTextCursorAlignBaseline

The y-origin of each sprite member bitmap is aligned with the baseline of the line.

ECustomTextCursorAlignBottom

The y-origin of each sprite member bitmap is aligned with the bottom of the line.

Enum TLoggingCommand

Window server logging commands passed to LogCommand().

RWsSession::LogCommand()

Enumerators

ELoggingEnable

Enables logging.

ELoggingDisable

Disables logging.

ELoggingStatusDump

Logs the current status of all the windows in the tree, even if logging is not currently enabled.

ELoggingHeapDump

Logs information about the window server's heap size and usage, even if logging is not currently enabled.