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

RWindowTreeNode
- MWsClientClass

Public Member Functions
IMPORT_C TUint32	Child()
IMPORT_C void	ClearPointerCursor()
IMPORT_C TUint32	ClientHandle()
IMPORT_C void	Close()
IMPORT_C void	Destroy()
IMPORT_C void	DisableErrorMessages()
IMPORT_C void	DisableFocusChangeEvents()
IMPORT_C void	DisableGroupChangeEvents()
IMPORT_C void	DisableGroupListChangeEvents()
IMPORT_C void	DisableModifierChangedEvents()
IMPORT_C void	DisableOnEvents()
IMPORT_C void	DisableVisibilityChangeEvents()
IMPORT_C TInt	EnableErrorMessages(TEventControl)
IMPORT_C TInt	EnableFocusChangeEvents()
IMPORT_C TInt	EnableGroupChangeEvents()
IMPORT_C TInt	EnableGroupListChangeEvents()
IMPORT_C TInt	EnableModifierChangedEvents(TUint, TEventControl)
IMPORT_C TInt	EnableOnEvents(TEventControl)
IMPORT_C TInt	EnableVisibilityChangeEvents()
IMPORT_C TInt	FullOrdinalPosition()
IMPORT_C TUint32	NextSibling()
IMPORT_C TInt	OrdinalPosition()
IMPORT_C TInt	OrdinalPriority()
IMPORT_C TUint32	Parent()
IMPORT_C TUint32	PrevSibling()
IMPORT_C TInt	ScreenNumber()
IMPORT_C RWsSession *	Session()
IMPORT_C void	SetCustomPointerCursor(const RWsPointerCursor &)
IMPORT_C void	SetFaded(TBool, TFadeControl)
IMPORT_C void	SetFaded(TBool, TFadeControl, TUint8, TUint8)
IMPORT_C void	SetNonFading(TBool)
IMPORT_C void	SetOrdinalPosition(TInt)
IMPORT_C void	SetOrdinalPosition(TInt, TInt)
IMPORT_C TInt	SetPointerCursor(TInt)
IMPORT_C TInt	WindowGroupId()

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
enum	TFadeControl { 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 TUint32

Child

(

)

const

ClearPointerCursor()

IMPORT_C void

ClearPointerCursor

(

)

ClientHandle()

IMPORT_C TUint32

ClientHandle

(

)

const

Close()

IMPORT_C void

(

)

Destroy()

IMPORT_C void

Destroy

(

)

DisableErrorMessages()

IMPORT_C void

DisableErrorMessages

(

)

DisableFocusChangeEvents()

IMPORT_C void

DisableFocusChangeEvents

(

)

DisableGroupChangeEvents()

IMPORT_C void

DisableGroupChangeEvents

(

)

DisableGroupListChangeEvents()

IMPORT_C void

DisableGroupListChangeEvents

(

)

DisableModifierChangedEvents()

IMPORT_C void

DisableModifierChangedEvents

(

)

DisableOnEvents()

IMPORT_C void

DisableOnEvents

(

)

DisableVisibilityChangeEvents()

IMPORT_C void

DisableVisibilityChangeEvents

(

)

EnableErrorMessages(TEventControl)

IMPORT_C TInt

EnableErrorMessages

(

TEventControl

aCircumstances

)

Parameters

TEventControl aCircumstances

EnableFocusChangeEvents()

IMPORT_C TInt

EnableFocusChangeEvents

(

)

EnableGroupChangeEvents()

IMPORT_C TInt

EnableGroupChangeEvents

(

)

EnableGroupListChangeEvents()

IMPORT_C TInt

EnableGroupListChangeEvents

(

)

EnableModifierChangedEvents(TUint, TEventControl)

IMPORT_C TInt	EnableModifierChangedEvents	(	TUint	aModifierMask,
			TEventControl	aCircumstances
		)

Parameters

TUint aModifierMask
TEventControl aCircumstances

EnableOnEvents(TEventControl)

IMPORT_C TInt

EnableOnEvents

(

TEventControl

aCircumstances = EEventControlOnlyWithKeyboardFocus

)

Parameters

TEventControl aCircumstances = EEventControlOnlyWithKeyboardFocus

EnableVisibilityChangeEvents()

IMPORT_C TInt

EnableVisibilityChangeEvents

(

)

FullOrdinalPosition()

IMPORT_C TInt

FullOrdinalPosition

(

)

const

NextSibling()

IMPORT_C TUint32

NextSibling

(

)

const

OrdinalPosition()

IMPORT_C TInt

OrdinalPosition

(

)

const

OrdinalPriority()

IMPORT_C TInt

OrdinalPriority

(

)

const

Parent()

IMPORT_C TUint32

Parent

(

)

const

PrevSibling()

IMPORT_C TUint32

PrevSibling

(

)

const

ScreenNumber()

IMPORT_C TInt

ScreenNumber

(

)

const

Session()

IMPORT_C RWsSession *

Session

(

)

const

SetCustomPointerCursor(const RWsPointerCursor &)

IMPORT_C void

SetCustomPointerCursor

(

const RWsPointerCursor &

aPointerCursor

)

Parameters

const RWsPointerCursor & aPointerCursor

SetFaded(TBool, TFadeControl)

IMPORT_C void	SetFaded	(	TBool	aFaded,
			TFadeControl	aIncludeChildren
		)

Parameters

TBool aFaded
TFadeControl aIncludeChildren

SetFaded(TBool, TFadeControl, TUint8, TUint8)

IMPORT_C void	SetFaded	(	TBool	aFaded,
			TFadeControl	aIncludeChildren,
			TUint8	aBlackMap,
			TUint8	aWhiteMap
		)

Parameters

TBool aFaded
TFadeControl aIncludeChildren
TUint8 aBlackMap
TUint8 aWhiteMap

SetNonFading(TBool)

IMPORT_C void

SetNonFading

(

TBool

aNonFading

)

Parameters

TBool aNonFading

SetOrdinalPosition(TInt)

IMPORT_C void

SetOrdinalPosition

(

TInt

aPos

)

Parameters

TInt aPos

SetOrdinalPosition(TInt, TInt)

IMPORT_C void	SetOrdinalPosition	(	TInt	aPos,
			TInt	aOrdinalPriority
		)

Parameters

TInt aPos
TInt aOrdinalPriority

SetPointerCursor(TInt)

IMPORT_C TInt

SetPointerCursor

(

TInt

aCursorNumber

)

Parameters

TInt aCursorNumber

WindowGroupId()

IMPORT_C TInt

WindowGroupId

(

)

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

[protected]