RBackedUpWindow Class Reference

Client-side handle to a drawable window with a backup bitmap. More...

#include <w32std.h>

Inheritance diagram for RBackedUpWindow:

Public Member Functions
IMPORT_C	RBackedUpWindow ()
	Default C++ constructor which creates a sessionless backed-up window handle.
IMPORT_C	RBackedUpWindow (RWsSession &aWs)
	Constructor which creates an uninitialised backed-up window handle within a session.
IMPORT_C TInt	Construct (const RWindowTreeNode &parent, TDisplayMode aDisplayMode, TUint32 aHandle)
	Completes the construction of a backed up window.
IMPORT_C TInt	BitmapHandle () const
	Gets a handle to the backup bitmap.
IMPORT_C void	UpdateScreen ()
	Copies the backup bitmap's image to the on-screen bitmap.
IMPORT_C void	UpdateScreen (const TRegion &aRegion)
	Copies a part of the backup bitmap to the on-screen bitmap.
IMPORT_C void	UpdateBackupBitmap ()
	Copies to the backup bitmap any areas of the window which are not currently stored in the bitmap.
IMPORT_C void	MaintainBackup ()
	Tells the window server to start maintaining a backup bitmap with the entire window contents.
Public Member Functions inherited from RDrawableWindow
IMPORT_C void	Scroll (const TPoint &aOffset)
	Scrolls the window contents by an offset.
IMPORT_C void	Scroll (const TRect &aClipRect, const TPoint &aOffset)
	Scrolls the contents of a clip rectangle, independently of the other contents of the window.
IMPORT_C void	Scroll (const TPoint &aOffset, const TRect &aRect)
	Scrolls a rectangle within a window.
IMPORT_C void	Scroll (const TRect &aClipRect, const TPoint &aOffset, const TRect &aRect)
	Scrolls the contents of a source rectangle within a clipping rectangle.
IMPORT_C TRect	GetDrawRect () const
	Obtains the current rectangle being drawn to this window, during a window redraw cycle.
Public Member Functions inherited from RWindowBase
IMPORT_C void	Activate ()
	Displays the window and enables it to receive events.
IMPORT_C void	SetPosition (const TPoint &point)
	Sets the position of a window relative to its parent.
IMPORT_C TInt	SetSizeErr (const TSize &size)
	Sets the size of a backed-up window.
IMPORT_C TInt	SetExtentErr (const TPoint &point, const TSize &size)
	Sets a backed-up window's extent, relative to its parent, and returns an error code from the server.
IMPORT_C TSize	Size () const
	Gets the window's current size.
IMPORT_C TPoint	InquireOffset (const RWindowTreeNode &aWindow) const
	Enquires the offset between this and another window.
IMPORT_C void	PointerFilter (TUint32 aFilterMask, TUint32 aFilter)
	Sets the filter which controls which pointer events are sent to the client session.
IMPORT_C void	SetPointerGrab (TBool aState)
	Allows or disallows pointer grabs in a window.
IMPORT_C void	ClaimPointerGrab (TBool aSendUpEvent=ETrue)
	Claims the pointer grab from another window.
IMPORT_C TInt	ClaimPointerGrab (const TUint8 aPointerNumber, const TBool aSendUpEvent=ETrue)
	Dummy implementation in order to preserve compatibility with WSERV NGA.
IMPORT_C void	SetPointerCapture (TInt aFlags)
	Sets the pointer capture state.
IMPORT_C void	SetPointerCapturePriority (TInt aPriority)
	Sets the window's pointer capture priority.
IMPORT_C TInt	GetPointerCapturePriority () const
	Gets the windows's pointer capture priority.
IMPORT_C void	SetVisible (TBool aState)
	Sets the window's visibility.
IMPORT_C void	SetShadowHeight (TInt aHeight)
	Sets a window's shadow height.
IMPORT_C void	SetShadowDisabled (TBool aState)
	Enables or disables whether a window casts a shadow.
IMPORT_C TPoint	Position () const
	Gets a window's position relative to its parent.
IMPORT_C TPoint	AbsPosition () const
	Gets a window's absolute position - ie the windows position relative to the current screen size mode.
IMPORT_C TInt	SetCornerType (TCornerType aCornerType, TInt aCornerFlags=0)
	Sets the shape of a window's corners.
IMPORT_C TInt	SetShape (const TRegion &aRegion)
	Sets a window's shape arbitrarily, if rectangular windows are not required.
IMPORT_C TInt	SetRequiredDisplayMode (TDisplayMode aMode)
	Sets the window's display mode.
IMPORT_C TDisplayMode	DisplayMode () const
	Gets the window's current display mode.
IMPORT_C void	EnableBackup (TUint aBackupType=EWindowBackupAreaBehind)
	Requests that this window backs up all or part of the screen's contents.
IMPORT_C void	RequestPointerRepeatEvent (TTimeIntervalMicroSeconds32 aTime, const TRect &aRect)
	Requests a pointer repeat event.
IMPORT_C void	CancelPointerRepeatEventRequest ()
	Cancels a request for a pointer repeat event.
IMPORT_C TInt	RequestPointerRepeatEvent (TTimeIntervalMicroSeconds32 aTime, const TRect &aRect, const TUint8 aPointerNumber)
	Dummy implementation in order to preserve compatibility with WSERV NGA.
IMPORT_C TInt	CancelPointerRepeatEventRequest (const TUint8 aPointerNumber)
	Dummy implementation in order to preserve compatibility with WSERV NGA.
IMPORT_C TInt	AllocPointerMoveBuffer (TInt aMaxPoints, TUint aFlags)
	Allocates a buffer for storing pointer movements.
IMPORT_C void	FreePointerMoveBuffer ()
	Frees the pointer move buffer.
IMPORT_C void	EnablePointerMoveBuffer ()
	Enables the pointer move buffer for receiving pointer move events.
IMPORT_C void	DisablePointerMoveBuffer ()
	Instructs the window server to stop adding pointer events to the pointer move buffer.
IMPORT_C TInt	RetrievePointerMoveBuffer (TDes8 &aBuf) const
	Retrieves events from the pointer move buffer.
IMPORT_C void	DiscardPointerMoveBuffer ()
	Discards all events in the pointer move buffer.
IMPORT_C TInt	AddKeyRect (const TRect &aRect, TInt aScanCode, TBool aActivatedByPointerSwitchOn)
	Adds an on-screen key rectangle.
IMPORT_C void	RemoveAllKeyRects ()
	Removes all the on-screen keys that have been added to this window.
IMPORT_C TInt	PasswordWindow (TPasswordMode aPasswordMode)
	Makes this window the password window.
IMPORT_C void	FadeBehind (TBool aFade)
	Sets whether or not all windows behind the current window, in the same window group, should be faded or unfaded.
IMPORT_C TBool	IsFaded () const
	Tests whether the current window is faded.
IMPORT_C TBool	IsNonFading () const
	Tests whether the current window is non-fading.
IMPORT_C TInt	MoveToGroup (TInt aIdentifier)
	Moves this window to another window group.
IMPORT_C TInt	SetBackgroundSurface (const TSurfaceId &aSurface)
	This sets the background of the window to be the given surface.
IMPORT_C TInt	SetBackgroundSurface (const TSurfaceConfiguration &aConfiguration, TBool aTriggerRedraw)
	This sets a surface to appear in front of the window's background within a given area of that window.
IMPORT_C void	RemoveBackgroundSurface (TBool aTriggerRedraw)
	This removes any background surface that has been set to the window.
IMPORT_C TInt	GetBackgroundSurface (TSurfaceConfiguration &aConfiguration) const
	Retrieves a copy of the current configuration for background surface attached to the window.
IMPORT_C void	SetSurfaceTransparency (TBool aSurfaceTransparency)
	Not supported in non-NGA.
IMPORT_C TRgb	KeyColor () const
	This function returns the key color for the window, if used.
IMPORT_C void	EnableAdvancedPointers ()
	Dummy implementation in order to preserve compatibility with WSERV NGA.
IMPORT_C void	SetPurpose (TInt aPurpose)
IMPORT_C void	SendEffectCommand (TInt aTfxCmd, const TDesC8 &aTfxCmdData=KNullDesC8)
IMPORT_C void	OverrideEffects (TInt aAction, const TFileName &aResourceDir, const TFileName &aFilenameOutgoing, const TFileName &aFilenameIncoming, TBitFlags aFlags=0)
IMPORT_C TInt	FixNativeOrientation ()
	Dummy implementation in order to preserve compatibility with WSERV NGA.
IMPORT_C TSize	SizeForEgl () const
	Dummy implementation in order to preserve compatibility with WSERV NGA.
Public Member Functions inherited from RWindowTreeNode
IMPORT_C void	Close ()
	Closes the node.
IMPORT_C void	Destroy ()
	Closes and deletes the node.
IMPORT_C TUint32	ClientHandle () const
	Gets the window's client handle.
IMPORT_C TUint32	Parent () const
	Gets the node's parent.
IMPORT_C TUint32	PrevSibling () const
	Gets the node before this one in the sibling list.
IMPORT_C TUint32	NextSibling () const
	Gets the next window after this one in its sibling list.
IMPORT_C TUint32	Child () const
	Gets the first child of the node.
IMPORT_C TInt	OrdinalPriority () const
	Gets the ordinal priority of the specified window.
IMPORT_C TInt	OrdinalPosition () const
	Gets the current ordinal position of the window tree node.
IMPORT_C TInt	FullOrdinalPosition () const
	Get the current full ordinal position of a window.
IMPORT_C void	SetOrdinalPosition (TInt aPos)
	Sets the ordinal position of a window.
IMPORT_C void	SetOrdinalPosition (TInt aPos, TInt aOrdinalPriority)
	Sets the ordinal position and ordinal priority of a window.
IMPORT_C TInt	ScreenNumber () const
	Get the screen number that a window is located on.
IMPORT_C TInt	WindowGroupId () const
	Returns the window group Id of the parent window group.
IMPORT_C TInt	SetPointerCursor (TInt aCursorNumber)
	Sets the pointer cursor from the system pointer cursor list.
IMPORT_C void	SetCustomPointerCursor (const RWsPointerCursor &aPointerCursor)
	Sets the pointer cursor to an application-defined cursor.
IMPORT_C TInt	EnableOnEvents (TEventControl aCircumstances=EEventControlOnlyWithKeyboardFocus)
	Requests notification of 'on' events.
IMPORT_C void	DisableOnEvents ()
	Cancels notification of 'on' events.
IMPORT_C TInt	EnableGroupChangeEvents ()
	Requests notification of group-change events.
IMPORT_C void	DisableGroupChangeEvents ()
	Cancels notification of group changed events.
IMPORT_C TInt	EnableFocusChangeEvents ()
	Enables focus changed events.
IMPORT_C void	DisableFocusChangeEvents ()
	Disables delivery of focus changed events.
IMPORT_C TInt	EnableGroupListChangeEvents ()
	Enables reporting of window group list change events.
IMPORT_C void	DisableGroupListChangeEvents ()
	Disables reporting of window group list change events.
IMPORT_C TInt	EnableVisibilityChangeEvents ()
	Enables reporting of window visibility change events.
IMPORT_C void	DisableVisibilityChangeEvents ()
	Disables reporting of window visibility change events.
IMPORT_C TInt	EnableErrorMessages (TEventControl aCircumstances)
	Requests notification of error message events.
IMPORT_C void	DisableErrorMessages ()
	Cancels notification of error message events.
IMPORT_C TInt	EnableModifierChangedEvents (TUint aModifierMask, TEventControl aCircumstances)
	Requests notification of modifier changed events.
IMPORT_C void	DisableModifierChangedEvents ()
	Cancels notification of modifier changed events.
IMPORT_C void	SetNonFading (TBool aNonFading)
	Sets whether a window is non-fading.
IMPORT_C void	SetFaded (TBool aFaded, TFadeControl aIncludeChildren)
	Sets the window as faded or unfaded.
IMPORT_C void	SetFaded (TBool aFaded, TFadeControl aIncludeChildren, TUint8 aBlackMap, TUint8 aWhiteMap)
	Sets one or more windows as faded or unfaded, specifying a fading map.
IMPORT_C void	ClearPointerCursor ()
	Clears pointer cursor settings.
IMPORT_C RWsSession *	Session () const
	Returns the window server session that is used to create this window handle.
Public Member Functions inherited from MWsClientClass
	MWsClientClass ()
	MWsClientClass (RWsBuffer *aBuffer)
TInt	WsHandle () const
	Gets the server side handle for the object.

Additional Inherited Members
Public Types inherited from RWindowBase
enum	TCaptureFlags {   TCaptureFlagEnabled =0x01 , TCaptureFlagDragDrop =0x02 , TCaptureFlagAllGroups =0x04 , TCaptureDisabled =0 ,   TCaptureEnabled =TCaptureFlagEnabled , TCaptureDragDrop =TCaptureFlagEnabled|TCaptureFlagDragDrop|TCaptureFlagAllGroups }
	Capture behaviour flags. More...
Public Types inherited from RWindowTreeNode
enum	TFadeControl { EFadeIncludeChildren =ETrue , EFadeWindowOnly =EFalse }
	Fade control flags. More...
Protected Member Functions inherited from RDrawableWindow
	RDrawableWindow ()
	Protected default constructor which creates a sessionless, uninitialised drawable-window handle.
	RDrawableWindow (RWsSession &aWs)
	Protected default constructor which creates an initialised drawable-window handle within a server session.
void	SetDrawRect (const TRect &aRect)
	Protected system function.
Protected Member Functions inherited from RWindowBase
	RWindowBase ()
	Protected default constructor; creates an uninitialised, sessionless window handle.
	RWindowBase (RWsSession &aWs)
	Protected constructor; creates an uninitialised window handle within a session.
TInt	construct (const RWindowTreeNode &parent, TUint32 aHandle, TInt aType, TDisplayMode aDisplayMode)
	Panic condition: TW32Panic 17 in debug builds if called on an already constructed object.
Protected Member Functions inherited from RWindowTreeNode
	RWindowTreeNode ()
	Protected default constructor.
	RWindowTreeNode (RWsSession &aWs)
	Protected constructor which creates an uninitialised window tree node handle within a server session.
Protected Member Functions inherited from MWsClientClass
void	Write (const TAny *aData1, TInt aLength1, TInt aLength2, TUint aOpcode) const
void	Write (const TAny *aData, TInt aLength, const TAny *aData2, TInt aLength2, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const
void	Write (const TAny *aBuf, TInt aBufLen, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const
void	Write (TUint aOpcode) const
void	WriteInt (TInt aInt, TUint aOpcode) const
void	WriteRect (const TRect &aRect, TUint aOpcode) const
void	WritePoint (const TPoint &aPoint, TUint aOpcode) const
void	WriteSize (const TSize &aSize, TUint aOpcode) const
TInt	WriteReply (TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const
TInt	WriteReplyInt (TInt aInt, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const
TInt	WriteReply (const TAny *aBuf, TInt aBufLen, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const
TInt	WriteReply (const TAny *aBuf, TInt aBufLen, const TAny *aBuf2, TInt aBuflen2, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const
TInt	WriteReplyP (const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const
TInt	WriteReplyIntP (TInt aInt, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const
TInt	WriteReplyP (const TAny *aBuf, TInt aBufLen, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const
TInt	WriteReplyP (const TAny *aBuf, TInt aBufLen, const TAny *aBuf2, TInt aBuflen2, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const
TInt	WriteReplyByProvidingRemoteReadAccess (const TAny *aBuf, TInt aBufLen, const TReadDescriptorType &aRemoteReadBuffer, TUint aOpcode) const
void	AddToBitmapArray (const TInt aBitmapHandle) const
void	AsyncRequest (TRequestStatus &aStatus, TUint aOpcode) const
TBool	WindowSizeCacheEnabled () const
void	MarkWindowSizeCacheDirty ()
void	RefreshWindowSizeCache (const TSize &aNewSize) const
TInt	CachedWindowSize (TSize &aSize) const
void	DestroyWindowSizeCacheEntry ()
Protected Attributes inherited from RWindowTreeNode
	__DECLARE_TEST
Protected Attributes inherited from MWsClientClass
TInt32	iWsHandle
	WARNING: Member variable for internal use ONLY.
RWsBuffer *	iBuffer
	WARNING: Member variable for internal use ONLY.

Detailed Description

Client-side handle to a drawable window with a backup bitmap.

A backed-up window is associated with a backup bitmap which retains the contents of the window. When an area of the window is invalidated, the window server uses the bitmap directly to update the window without requiring an application redraw. The backup bitmap is owned by the font and bitmap server and resides on the font and bitmap server's shared heap, which is accessible to all client programs: functions are provided to allow the client application to access this bitmap directly and perform updates to the window under application control.

Deprecated:

API status

Published to all clients.

Definition at line 1941 of file w32std.h.

Constructor & Destructor Documentation

RBackedUpWindow() [1/2]

IMPORT_C RBackedUpWindow::RBackedUpWindow

(

)

Default C++ constructor which creates a sessionless backed-up window handle.

Handles to server-side objects must be created in a session in order to be operational; this constructor is merely a convenience to allow the handle to be stored as a data member. See RWindowTreeNode::RWindowTreeNode() for details of how the complete setup of a handle field may be deferred until the window server session is known.

(generated from Symbian Developer Library)

RBackedUpWindow() [2/2]

IMPORT_C RBackedUpWindow::RBackedUpWindow

(

RWsSession &

aWs

)

Constructor which creates an uninitialised backed-up window handle within a session.

Parameters

aWs	The window server session that owns the window.

(generated from Symbian Developer Library)

Member Function Documentation

BitmapHandle()

IMPORT_C TInt RBackedUpWindow::BitmapHandle

(

)

const

Gets a handle to the backup bitmap.

This handle can then be passed to CFbsBitmap::Duplicate() to gain access to the bitmap. Once the bitmap has been obtained, it can be drawn to or read from by the application.

Notes: in most circumstances this function should be used only after MaintainBackup() has been called. Otherwise, the content of the backup bitmap will be unpredictable.

This function always causes a flush of the window server buffer.

(generated from Symbian Developer Library)

Construct()

IMPORT_C TInt RBackedUpWindow::Construct	(	const RWindowTreeNode &	parent,
		TDisplayMode	aDisplayMode,
		TUint32	aHandle
	)

Completes the construction of a backed up window.

This method should be called after the RBackedUpWindow(RWsSession&) constructor, and before any other functions are performed on the window. It creates a window in the window server corresponding to the RBackedUpWindow object, and allocates a bitmap with which to perform the window backup.

Unlike non backed up windows, the size of a backed up window is not inherited from its parent. The window will be created with an initial size of zero, but this can be altered. The display mode must be specified because it determines the amount of memory required to store the backup bitmap.

This function always causes a flush of the window server buffer.

RWindowBase::SetSizeErr() RWindowBase::SetExtentErr() RWindow::Construct()

Parameters

parent	The window's parent.
aDisplayMode	The display mode for the window.
aHandle	The client's handle for the window. See RWindow::Construct() for a description of the client handle.

(generated from Symbian Developer Library)

MaintainBackup()

IMPORT_C void RBackedUpWindow::MaintainBackup

(

)

Tells the window server to start maintaining a backup bitmap with the entire window contents.

By default, the window only backs up the non-visible and shadowed part of the window. Calling this function makes drawing to the window much faster.

Once this function has been called, it cannot be reversed.

(generated from Symbian Developer Library)

UpdateBackupBitmap()

IMPORT_C void RBackedUpWindow::UpdateBackupBitmap

(

)

Copies to the backup bitmap any areas of the window which are not currently stored in the bitmap.

This method does not need to be called if the server has not been instructed to maintain the backup buffer constantly

MaintainBackup()

(generated from Symbian Developer Library)

UpdateScreen() [1/2]

IMPORT_C void RBackedUpWindow::UpdateScreen

(

)

Copies the backup bitmap's image to the on-screen bitmap.

This function should be used if the application draws directly to the backup bitmap. Any changes made to the backup bitmap will not be reflected on the screen until this function is called.

(generated from Symbian Developer Library)

UpdateScreen() [2/2]

IMPORT_C void RBackedUpWindow::UpdateScreen

(

const TRegion &

aRegion

)

Copies a part of the backup bitmap to the on-screen bitmap.

This function behaves in the same way as UpdateScreen(), but copies only the specified region of the backup bitmap to the window on screen.

This function always causes a flush of the window server buffer.

Parameters

aRegion

Area of the backup bitmap to copy.

(generated from Symbian Developer Library)

---

The documentation for this class was generated from the following files:

• w32std.h
• w32std.h.dox