RWindowBase Class Reference

class RWindowBase : public RWindowTreeNode

Client-side handle to a server-side window.

The server-side windows of handles derived from this class can be displayed on the device's screen, and associated with pointer events.

This class is not for user derivation; however derived classes form part of the Window Server API.

Inherits from

Public Member Functions
IMPORT_C TPointAbsPosition()
IMPORT_C voidActivate()
IMPORT_C TIntAddKeyRect(const TRect &, TInt, TBool)
IMPORT_C TIntAllocPointerMoveBuffer(TInt, TUint)
IMPORT_C voidCancelPointerRepeatEventRequest()
IMPORT_C TIntCancelPointerRepeatEventRequest(const TUint8)
IMPORT_C voidClaimPointerGrab(TBool)
IMPORT_C TIntClaimPointerGrab(const TUint8, const TBool)
IMPORT_C voidDisablePointerMoveBuffer()
IMPORT_C voidDiscardPointerMoveBuffer()
IMPORT_C TDisplayModeDisplayMode()
IMPORT_C voidEnableAdvancedPointers()
IMPORT_C voidEnableBackup(TUint)
IMPORT_C voidEnablePointerMoveBuffer()
IMPORT_C voidFadeBehind(TBool)
IMPORT_C voidFreePointerMoveBuffer()
IMPORT_C TIntGetBackgroundSurface(TSurfaceConfiguration &)
IMPORT_C TIntGetPointerCapturePriority()
IMPORT_C TPointInquireOffset(const RWindowTreeNode &)
IMPORT_C TBoolIsFaded()
IMPORT_C TBoolIsNonFading()
IMPORT_C TRgbKeyColor()
IMPORT_C TIntMoveToGroup(TInt)
IMPORT_C TIntPasswordWindow(TPasswordMode)
IMPORT_C voidPointerFilter(TUint32, TUint32)
IMPORT_C TPointPosition()
IMPORT_C voidRemoveAllKeyRects()
IMPORT_C voidRemoveBackgroundSurface(TBool)
IMPORT_C voidRequestPointerRepeatEvent(TTimeIntervalMicroSeconds32, const TRect &)
IMPORT_C TIntRequestPointerRepeatEvent(TTimeIntervalMicroSeconds32, const TRect &, const TUint8)
IMPORT_C TIntRetrievePointerMoveBuffer(TDes8 &)
IMPORT_C TIntSetBackgroundSurface(const TSurfaceId &)
IMPORT_C TIntSetBackgroundSurface(const TSurfaceConfiguration &, TBool)
IMPORT_C TIntSetCornerType(TCornerType, TInt)
IMPORT_C TIntSetExtentErr(const TPoint &, const TSize &)
IMPORT_C voidSetPointerCapture(TInt)
IMPORT_C voidSetPointerCapturePriority(TInt)
IMPORT_C voidSetPointerGrab(TBool)
IMPORT_C voidSetPosition(const TPoint &)
IMPORT_C TIntSetRequiredDisplayMode(TDisplayMode)
IMPORT_C voidSetShadowDisabled(TBool)
IMPORT_C voidSetShadowHeight(TInt)
IMPORT_C TIntSetShape(const TRegion &)
IMPORT_C TIntSetSizeErr(const TSize &)
IMPORT_C voidSetSurfaceTransparency(TBool)
IMPORT_C voidSetVisible(TBool)
IMPORT_C TSizeSize()
Protected Member Functions
RWindowBase()
RWindowBase(RWsSession &)
TInt construct(const RWindowTreeNode &, TUint32, TInt, TDisplayMode)
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
RWindowTreeNode::Child()const
RWindowTreeNode::ClearPointerCursor()
RWindowTreeNode::ClientHandle()const
RWindowTreeNode::Close()
RWindowTreeNode::Destroy()
RWindowTreeNode::DisableErrorMessages()
RWindowTreeNode::DisableFocusChangeEvents()
RWindowTreeNode::DisableGroupChangeEvents()
RWindowTreeNode::DisableGroupListChangeEvents()
RWindowTreeNode::DisableModifierChangedEvents()
RWindowTreeNode::DisableOnEvents()
RWindowTreeNode::DisableVisibilityChangeEvents()
RWindowTreeNode::EnableErrorMessages(TEventControl)
RWindowTreeNode::EnableFocusChangeEvents()
RWindowTreeNode::EnableGroupChangeEvents()
RWindowTreeNode::EnableGroupListChangeEvents()
RWindowTreeNode::EnableModifierChangedEvents(TUint,TEventControl)
RWindowTreeNode::EnableOnEvents(TEventControl)
RWindowTreeNode::EnableVisibilityChangeEvents()
RWindowTreeNode::FullOrdinalPosition()const
RWindowTreeNode::NextSibling()const
RWindowTreeNode::OrdinalPosition()const
RWindowTreeNode::OrdinalPriority()const
RWindowTreeNode::Parent()const
RWindowTreeNode::PrevSibling()const
RWindowTreeNode::RWindowTreeNode()
RWindowTreeNode::RWindowTreeNode(RWsSession &)
RWindowTreeNode::ScreenNumber()const
RWindowTreeNode::Session()const
RWindowTreeNode::SetCustomPointerCursor(const RWsPointerCursor &)
RWindowTreeNode::SetFaded(TBool,TFadeControl)
RWindowTreeNode::SetFaded(TBool,TFadeControl,TUint8,TUint8)
RWindowTreeNode::SetNonFading(TBool)
RWindowTreeNode::SetOrdinalPosition(TInt)
RWindowTreeNode::SetOrdinalPosition(TInt,TInt)
RWindowTreeNode::SetPointerCursor(TInt)
RWindowTreeNode::WindowGroupId()const
Public Member Enumerations
enumTCaptureFlags {
TCaptureFlagEnabled = 0x01, TCaptureFlagDragDrop = 0x02, TCaptureFlagAllGroups = 0x04, TCaptureDisabled = 0, TCaptureEnabled = TCaptureFlagEnabled, TCaptureDragDrop = TCaptureFlagEnabled|TCaptureFlagDragDrop|TCaptureFlagAllGroups
}
Inherited Enumerations
RWindowTreeNode:TFadeControl
Inherited Attributes
MWsClientClass::iBuffer
MWsClientClass::iWsHandle
RWindowTreeNode::__DECLARE_TEST

Constructor & Destructor Documentation

RWindowBase()

RWindowBase()[protected]

RWindowBase(RWsSession &)

RWindowBase(RWsSession &aWs)[protected]

Parameters

RWsSession & aWs

Member Functions Documentation

AbsPosition()

IMPORT_C TPointAbsPosition()const

Activate()

IMPORT_C voidActivate()

AddKeyRect(const TRect &, TInt, TBool)

IMPORT_C TIntAddKeyRect(const TRect &aRect,
TIntaScanCode,
TBoolaActivatedByPointerSwitchOn
)

Parameters

const TRect & aRect
TInt aScanCode
TBool aActivatedByPointerSwitchOn

AllocPointerMoveBuffer(TInt, TUint)

IMPORT_C TIntAllocPointerMoveBuffer(TIntaMaxPoints,
TUintaFlags
)

Parameters

TInt aMaxPoints
TUint aFlags

CancelPointerRepeatEventRequest()

IMPORT_C voidCancelPointerRepeatEventRequest()

CancelPointerRepeatEventRequest(const TUint8)

IMPORT_C TIntCancelPointerRepeatEventRequest(const TUint8aPointerNumber)

Parameters

const TUint8 aPointerNumber

ClaimPointerGrab(TBool)

IMPORT_C voidClaimPointerGrab(TBoolaSendUpEvent = ETrue)

Parameters

TBool aSendUpEvent = ETrue

ClaimPointerGrab(const TUint8, const TBool)

IMPORT_C TIntClaimPointerGrab(const TUint8aPointerNumber,
const TBoolaSendUpEvent = ETrue
)

Parameters

const TUint8 aPointerNumber
const TBool aSendUpEvent = ETrue

DisablePointerMoveBuffer()

IMPORT_C voidDisablePointerMoveBuffer()

DiscardPointerMoveBuffer()

IMPORT_C voidDiscardPointerMoveBuffer()

DisplayMode()

IMPORT_C TDisplayModeDisplayMode()const

EnableAdvancedPointers()

IMPORT_C voidEnableAdvancedPointers()

EnableBackup(TUint)

IMPORT_C voidEnableBackup(TUintaBackupType = EWindowBackupAreaBehind)

Parameters

TUint aBackupType = EWindowBackupAreaBehind

EnablePointerMoveBuffer()

IMPORT_C voidEnablePointerMoveBuffer()

FadeBehind(TBool)

IMPORT_C voidFadeBehind(TBoolaFade)

Parameters

TBool aFade

FreePointerMoveBuffer()

IMPORT_C voidFreePointerMoveBuffer()

GetBackgroundSurface(TSurfaceConfiguration &)

IMPORT_C TIntGetBackgroundSurface(TSurfaceConfiguration &aConfiguration)const

Parameters

TSurfaceConfiguration & aConfiguration

GetPointerCapturePriority()

IMPORT_C TIntGetPointerCapturePriority()const

InquireOffset(const RWindowTreeNode &)

IMPORT_C TPointInquireOffset(const RWindowTreeNode &aWindow)const

Parameters

const RWindowTreeNode & aWindow

IsFaded()

IMPORT_C TBoolIsFaded()const

IsNonFading()

IMPORT_C TBoolIsNonFading()const

KeyColor()

IMPORT_C TRgbKeyColor()const

MoveToGroup(TInt)

IMPORT_C TIntMoveToGroup(TIntaIdentifier)

Parameters

TInt aIdentifier

PasswordWindow(TPasswordMode)

IMPORT_C TIntPasswordWindow(TPasswordModeaPasswordMode)

Parameters

TPasswordMode aPasswordMode

PointerFilter(TUint32, TUint32)

IMPORT_C voidPointerFilter(TUint32aFilterMask,
TUint32aFilter
)

Parameters

TUint32 aFilterMask
TUint32 aFilter

Position()

IMPORT_C TPointPosition()const

RemoveAllKeyRects()

IMPORT_C voidRemoveAllKeyRects()

RemoveBackgroundSurface(TBool)

IMPORT_C voidRemoveBackgroundSurface(TBoolaTriggerRedraw)

Parameters

TBool aTriggerRedraw

RequestPointerRepeatEvent(TTimeIntervalMicroSeconds32, const TRect &)

IMPORT_C voidRequestPointerRepeatEvent(TTimeIntervalMicroSeconds32aTime,
const TRect &aRect
)

Parameters

TTimeIntervalMicroSeconds32 aTime
const TRect & aRect

RequestPointerRepeatEvent(TTimeIntervalMicroSeconds32, const TRect &, const TUint8)

IMPORT_C TIntRequestPointerRepeatEvent(TTimeIntervalMicroSeconds32aTime,
const TRect &aRect,
const TUint8aPointerNumber
)

Parameters

TTimeIntervalMicroSeconds32 aTime
const TRect & aRect
const TUint8 aPointerNumber

RetrievePointerMoveBuffer(TDes8 &)

IMPORT_C TIntRetrievePointerMoveBuffer(TDes8 &aBuf)const

Parameters

TDes8 & aBuf

SetBackgroundSurface(const TSurfaceId &)

IMPORT_C TIntSetBackgroundSurface(const TSurfaceId &aSurface)

Parameters

const TSurfaceId & aSurface

SetBackgroundSurface(const TSurfaceConfiguration &, TBool)

IMPORT_C TIntSetBackgroundSurface(const TSurfaceConfiguration &aConfiguration,
TBoolaTriggerRedraw
)

Parameters

const TSurfaceConfiguration & aConfiguration
TBool aTriggerRedraw

SetCornerType(TCornerType, TInt)

IMPORT_C TIntSetCornerType(TCornerTypeaCornerType,
TIntaCornerFlags = 0
)

Parameters

TCornerType aCornerType
TInt aCornerFlags = 0

SetExtentErr(const TPoint &, const TSize &)

IMPORT_C TIntSetExtentErr(const TPoint &point,
const TSize &size
)

Parameters

const TPoint & point
const TSize & size

SetPointerCapture(TInt)

IMPORT_C voidSetPointerCapture(TIntaFlags)

Parameters

TInt aFlags

SetPointerCapturePriority(TInt)

IMPORT_C voidSetPointerCapturePriority(TIntaPriority)

Parameters

TInt aPriority

SetPointerGrab(TBool)

IMPORT_C voidSetPointerGrab(TBoolaState)

Parameters

TBool aState

SetPosition(const TPoint &)

IMPORT_C voidSetPosition(const TPoint &point)

Parameters

const TPoint & point

SetRequiredDisplayMode(TDisplayMode)

IMPORT_C TIntSetRequiredDisplayMode(TDisplayModeaMode)

Parameters

TDisplayMode aMode

SetShadowDisabled(TBool)

IMPORT_C voidSetShadowDisabled(TBoolaState)

Parameters

TBool aState

SetShadowHeight(TInt)

IMPORT_C voidSetShadowHeight(TIntaHeight)

Parameters

TInt aHeight

SetShape(const TRegion &)

IMPORT_C TIntSetShape(const TRegion &aRegion)

Parameters

const TRegion & aRegion

SetSizeErr(const TSize &)

IMPORT_C TIntSetSizeErr(const TSize &size)

Parameters

const TSize & size

SetSurfaceTransparency(TBool)

IMPORT_C voidSetSurfaceTransparency(TBoolaSurfaceTransparency)

Parameters

TBool aSurfaceTransparency

SetVisible(TBool)

IMPORT_C voidSetVisible(TBoolaState)

Parameters

TBool aState

Size()

IMPORT_C TSizeSize()const

construct(const RWindowTreeNode &, TUint32, TInt, TDisplayMode)

TInt construct(const RWindowTreeNode &parent,
TUint32aHandle,
TIntaType,
TDisplayModeaDisplayMode
)[protected]

Parameters

const RWindowTreeNode & parent
TUint32 aHandle
TInt aType
TDisplayMode aDisplayMode

Member Enumerations Documentation

Enum TCaptureFlags

Capture behaviour flags.

SetPointerCapture()

EEventDragDrop

Enumerators

TCaptureFlagEnabled = 0x01

If set, capture is enabled, disabled otherwise.

TCaptureFlagDragDrop = 0x02

If set, drag-drop events are sent to the window in which the pointer was lifted. Drag-drop is a tap-drag-lift sequence.

TCaptureFlagAllGroups = 0x04

Capture events from windows belonging to any group, not just the group of the window on which the flag was set

TCaptureDisabled = 0

Equivalent to disabling all the above flags.

TCaptureEnabled = TCaptureFlagEnabled

Equivalent to TCaptureFlagEnabled.

TCaptureDragDrop = TCaptureFlagEnabled|TCaptureFlagDragDrop|TCaptureFlagAllGroups

Equivalent to the OR of the first three flags.

© Nokia 2010.