RWindowTreeNode Class Reference

class RWindowTreeNode : public MWsClientClass

A handle to a node in the server-side window tree.

This handle class is used as the base for both window groups and the windows within them; it is not intended for user derivation, and may not be directly constructed: use one of the standard derived classes instead.

Inherits from

Public Member Functions
IMPORT_C TUint32Child()
IMPORT_C voidClearPointerCursor()
IMPORT_C TUint32ClientHandle()
IMPORT_C voidClose()
IMPORT_C voidDestroy()
IMPORT_C voidDisableErrorMessages()
IMPORT_C voidDisableFocusChangeEvents()
IMPORT_C voidDisableGroupChangeEvents()
IMPORT_C voidDisableGroupListChangeEvents()
IMPORT_C voidDisableModifierChangedEvents()
IMPORT_C voidDisableOnEvents()
IMPORT_C voidDisableVisibilityChangeEvents()
IMPORT_C TIntEnableErrorMessages(TEventControl)
IMPORT_C TIntEnableFocusChangeEvents()
IMPORT_C TIntEnableGroupChangeEvents()
IMPORT_C TIntEnableGroupListChangeEvents()
IMPORT_C TIntEnableModifierChangedEvents(TUint, TEventControl)
IMPORT_C TIntEnableOnEvents(TEventControl)
IMPORT_C TIntEnableVisibilityChangeEvents()
IMPORT_C TIntFullOrdinalPosition()
IMPORT_C TUint32NextSibling()
IMPORT_C TIntOrdinalPosition()
IMPORT_C TIntOrdinalPriority()
IMPORT_C TUint32Parent()
IMPORT_C TUint32PrevSibling()
IMPORT_C TIntScreenNumber()
IMPORT_C RWsSession *Session()
IMPORT_C voidSetCustomPointerCursor(const RWsPointerCursor &)
IMPORT_C voidSetFaded(TBool, TFadeControl)
IMPORT_C voidSetFaded(TBool, TFadeControl, TUint8, TUint8)
IMPORT_C voidSetNonFading(TBool)
IMPORT_C voidSetOrdinalPosition(TInt)
IMPORT_C voidSetOrdinalPosition(TInt, TInt)
IMPORT_C TIntSetPointerCursor(TInt)
IMPORT_C TIntWindowGroupId()
Protected Member Functions
RWindowTreeNode()
RWindowTreeNode(RWsSession &)
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
enumTFadeControl { EFadeIncludeChildren = ETrue, EFadeWindowOnly = EFalse }
Protected Attributes
__DECLARE_TEST
Inherited Attributes
MWsClientClass::iBuffer
MWsClientClass::iWsHandle

Constructor & Destructor Documentation

RWindowTreeNode()

RWindowTreeNode()[protected]

RWindowTreeNode(RWsSession &)

RWindowTreeNode(RWsSession &aWs)[protected]

Parameters

RWsSession & aWs

Member Functions Documentation

Child()

IMPORT_C TUint32Child()const

ClearPointerCursor()

IMPORT_C voidClearPointerCursor()

ClientHandle()

IMPORT_C TUint32ClientHandle()const

Close()

IMPORT_C voidClose()

Destroy()

IMPORT_C voidDestroy()

DisableErrorMessages()

IMPORT_C voidDisableErrorMessages()

DisableFocusChangeEvents()

IMPORT_C voidDisableFocusChangeEvents()

DisableGroupChangeEvents()

IMPORT_C voidDisableGroupChangeEvents()

DisableGroupListChangeEvents()

IMPORT_C voidDisableGroupListChangeEvents()

DisableModifierChangedEvents()

IMPORT_C voidDisableModifierChangedEvents()

DisableOnEvents()

IMPORT_C voidDisableOnEvents()

DisableVisibilityChangeEvents()

IMPORT_C voidDisableVisibilityChangeEvents()

EnableErrorMessages(TEventControl)

IMPORT_C TIntEnableErrorMessages(TEventControlaCircumstances)

Parameters

TEventControl aCircumstances

EnableFocusChangeEvents()

IMPORT_C TIntEnableFocusChangeEvents()

EnableGroupChangeEvents()

IMPORT_C TIntEnableGroupChangeEvents()

EnableGroupListChangeEvents()

IMPORT_C TIntEnableGroupListChangeEvents()

EnableModifierChangedEvents(TUint, TEventControl)

IMPORT_C TIntEnableModifierChangedEvents(TUintaModifierMask,
TEventControlaCircumstances
)

Parameters

TUint aModifierMask
TEventControl aCircumstances

EnableOnEvents(TEventControl)

IMPORT_C TIntEnableOnEvents(TEventControlaCircumstances = EEventControlOnlyWithKeyboardFocus)

Parameters

TEventControl aCircumstances = EEventControlOnlyWithKeyboardFocus

EnableVisibilityChangeEvents()

IMPORT_C TIntEnableVisibilityChangeEvents()

FullOrdinalPosition()

IMPORT_C TIntFullOrdinalPosition()const

NextSibling()

IMPORT_C TUint32NextSibling()const

OrdinalPosition()

IMPORT_C TIntOrdinalPosition()const

OrdinalPriority()

IMPORT_C TIntOrdinalPriority()const

Parent()

IMPORT_C TUint32Parent()const

PrevSibling()

IMPORT_C TUint32PrevSibling()const

ScreenNumber()

IMPORT_C TIntScreenNumber()const

Session()

IMPORT_C RWsSession *Session()const

SetCustomPointerCursor(const RWsPointerCursor &)

IMPORT_C voidSetCustomPointerCursor(const RWsPointerCursor &aPointerCursor)

Parameters

const RWsPointerCursor & aPointerCursor

SetFaded(TBool, TFadeControl)

IMPORT_C voidSetFaded(TBoolaFaded,
TFadeControlaIncludeChildren
)

Parameters

TBool aFaded
TFadeControl aIncludeChildren

SetFaded(TBool, TFadeControl, TUint8, TUint8)

IMPORT_C voidSetFaded(TBoolaFaded,
TFadeControlaIncludeChildren,
TUint8aBlackMap,
TUint8aWhiteMap
)

Parameters

TBool aFaded
TFadeControl aIncludeChildren
TUint8 aBlackMap
TUint8 aWhiteMap

SetNonFading(TBool)

IMPORT_C voidSetNonFading(TBoolaNonFading)

Parameters

TBool aNonFading

SetOrdinalPosition(TInt)

IMPORT_C voidSetOrdinalPosition(TIntaPos)

Parameters

TInt aPos

SetOrdinalPosition(TInt, TInt)

IMPORT_C voidSetOrdinalPosition(TIntaPos,
TIntaOrdinalPriority
)

Parameters

TInt aPos
TInt aOrdinalPriority

SetPointerCursor(TInt)

IMPORT_C TIntSetPointerCursor(TIntaCursorNumber)

Parameters

TInt aCursorNumber

WindowGroupId()

IMPORT_C TIntWindowGroupId()const

Member Enumerations Documentation

Enum TFadeControl

Fade control flags.

These flags define whether fading is applied to all child windows when SetFaded() is called on a window.

Enumerators

EFadeIncludeChildren = ETrue

Include all child windows when fading/un-fading.

EFadeWindowOnly = EFalse

Fade only the parent window.

Note that a panic will occur if this value is used when SetFaded() is called on a window group.

Member Data Documentation

__DECLARE_TEST

__DECLARE_TEST[protected]