RWindow Class Reference

Handle to a standard window. More...

#include <w32std.h>

Inheritance diagram for RWindow:

Public Member Functions
IMPORT_C	RWindow ()
	Default constructor which creates a sessionless, uninitialised window handle.
IMPORT_C	RWindow (RWsSession &aWs)
	Constructor which creates an initialised window handle within a server session.
IMPORT_C TInt	Construct (const RWindowTreeNode &parent, TUint32 aHandle)
	Completes the construction of the window handle.
IMPORT_C void	BeginRedraw ()
	Begins redrawing the window's invalid region.
IMPORT_C void	BeginRedraw (const TRect &aRect)
	Begins the redraw of a rectangle within the window's invalid region.
IMPORT_C void	EndRedraw ()
	Ends the current redraw.
IMPORT_C void	Invalidate ()
	Invalidates the entire window.
IMPORT_C void	Invalidate (const TRect &aRect)
	Invalidates an area within the window.
IMPORT_C void	GetInvalidRegion (RRegion &aRegion) const
	Gets the invalid region.
IMPORT_C void	SetBackgroundColor (TRgb aColor)
	Sets the background colour used for clearing in server-initiated redraws.
IMPORT_C void	SetBackgroundColor ()
	Sets the background colour used for clearing in server-initiated redraws to none.
IMPORT_C void	SetSize (const TSize &size)
	Sets the size of a window.
IMPORT_C void	SetExtent (const TPoint &point, const TSize &size)
	Sets the size and position of a window.
IMPORT_C void	HandleTransparencyUpdate ()
	Window transparency based on the use of a separate window mask bitmap has been deprecated.
IMPORT_C TInt	SetTransparencyFactor (const TRgb &aTransparencyFactor)
	The support for window transparency factor has been deprecated.
IMPORT_C TInt	SetTransparencyBitmap (const CFbsBitmap &aTransparencyBitmap)
	Window transparency based on the use of a separate window mask bitmap has been deprecated.
IMPORT_C TInt	SetTransparencyWsBitmap (const CWsBitmap &aTransparencyBitmap)
	Window transparency based on the use of a separate window mask bitmap has been deprecated.
IMPORT_C void	SetNonTransparent ()
	Window transparency based on the use of a separate window mask bitmap has been deprecated.
IMPORT_C void	EnableRedrawStore (TBool aEnabled)
	Enables or Disables the storing of redraw operations that do not intersect the viewport for a window.
IMPORT_C TInt	SetTransparencyAlphaChannel ()
	Enables the use of an alpha channel to control the window's transparency.
IMPORT_C TInt	SetTransparentRegion (const TRegion &aRegion)
	Sets the user-defined transparent region of a window.
IMPORT_C TInt	SetTransparencyPolicy (TWsTransparencyPolicy aPolicy)
	Sets the transparency policy of a window.
IMPORT_C TBool	IsRedrawStoreEnabled () const
	Returns whether the window uses a redraw store to store drawing commands.
IMPORT_C void	EnableOSB (TBool)
	Enables/Disables the WSERV to use its OSB.
IMPORT_C void	ClearRedrawStore ()
	Clears the draw commands that are stored for this window from the redraw store.
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

Handle to a standard window.

An RWindow is a handle to a server-side window which can be displayed and drawn to, and whose redraws are performed by the application.

API status

Published to all clients. Released API.

Definition at line 1901 of file w32std.h.

Constructor & Destructor Documentation

RWindow() [1/2]

IMPORT_C RWindow::RWindow

(

)

Default constructor which creates a sessionless, uninitialised 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)

RWindow() [2/2]

IMPORT_C RWindow::RWindow

(

RWsSession &

aWs

)

Constructor which creates an initialised window handle within a server session.

Parameters

aWs	Window server session to use.

(generated from Symbian Developer Library)

Member Function Documentation

BeginRedraw() [1/2]

IMPORT_C void RWindow::BeginRedraw

(

)

Begins redrawing the window's invalid region.

This method tells the window server that the window is about to respond to the last redraw event by redrawing the entire invalid region. This causes the window server to validate the entire invalid region.

After the redraw is complete the entire region that was previously invalid is validated. The window should then call EndRedraw().

Note: the redraw is clipped to the region that was previously invalid.

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

EndRedraw()

(generated from Symbian Developer Library)

BeginRedraw() [2/2]

IMPORT_C void RWindow::BeginRedraw

(

const TRect &

aRect

)

Begins the redraw of a rectangle within the window's invalid region.

This method tells the window server that the window is about to respond to the last redraw event by redrawing the specified rectangle. This causes the window server to clear the rectangle, and remove it from the invalid region.

After the redraw is complete the window should call EndRedraw().

Note:

When handling a redraw event, this rectangle would typically be the rectangle returned by TWsRedrawEvent::Rect().

The redraw is clipped to the area that is validated, i.e. the intersection of the rectangle with the previously invalid region.

If you only validate part of the rectangle given in the redraw event then, after EndRedraw() is called, drawing will be clipped to the visible area which is not invalid. This is because drawing (that is non-redrawing) is always clipped to the visible region less the invalid region. You will get another message telling you to redraw the area that is still invalid.

EndRedraw()

Parameters

aRect

The rectangle to be redrawn.

(generated from Symbian Developer Library)

ClearRedrawStore()

IMPORT_C void RWindow::ClearRedrawStore

(

)

Clears the draw commands that are stored for this window from the redraw store.

Windows that have had their redraw store cleared are not ready to draw again until a new set of draw commands enclosed by BeginRedraw/EndRedraw have been issued.

(generated from Symbian Developer Library)

Construct()

IMPORT_C TInt RWindow::Construct	(	const RWindowTreeNode &	parent,
		TUint32	aHandle
	)

Completes the construction of the window handle.

This method should be called after the RWindow() constructor, before any other functions are performed on the window. It creates a window in the window server corresponding to the RWindow object. The window is initialised to inherit the size and extent of its parent window, given by the first parameter. If its parent is a group window then it will be full screen.

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

Parameters

parent

The window's parent.

aHandle

Client handle for the window. This is an integer value chosen by the client that must be unique within the current server session. The usual way of doing this is to cast the address of the object that owns the window to a TUint32; this allows event handlers which are given a window handle to obtain a reference to the window an event is intended for. For example, CCoeControl uses this technique when it constructs a window. Note that in GUI applications, every window is created and owned by a control. Therefore it is rare for 3rd party code to ever need to call a window's Construct() function directly.

(generated from Symbian Developer Library)

EnableOSB()

IMPORT_C void RWindow::EnableOSB

(

TBool

)

Enables/Disables the WSERV to use its OSB.

(generated from Symbian Developer Library)

EnableRedrawStore()

IMPORT_C void RWindow::EnableRedrawStore

(

TBool

aEnabled

)

Enables or Disables the storing of redraw operations that do not intersect the viewport for a window.

The window server stores operations required to redraw a window in a redraw store. Calling this function with ETrue causes all such drawing operations to be stored. The EnableRedrawStore(EFalse) call serves as a hint to store only the subset of draw commands which intersect the viewport.

Parameters

aEnabled

Indicates whether the redraw store should be enabled or disabled.

(generated from Symbian Developer Library)

EndRedraw()

IMPORT_C void RWindow::EndRedraw

(

)

Ends the current redraw.

This function should be called when redrawing is complete.

(generated from Symbian Developer Library)

GetInvalidRegion()

IMPORT_C void RWindow::GetInvalidRegion

(

RRegion &

aRegion

)

const

Gets the invalid region.

Note: if there is not enough memory to create the region, the region's error flag will be set.

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

Parameters

aRegion

On return, contains the invalid region.

(generated from Symbian Developer Library)

HandleTransparencyUpdate()

IMPORT_C void RWindow::HandleTransparencyUpdate

(

)

Window transparency based on the use of a separate window mask bitmap has been deprecated.

Calling this method method has no effect. For window transparency see the the support for window alpha channel.

RWindow::SetTransparencyAlphaChannel()

(generated from Symbian Developer Library)

Invalidate() [1/2]

IMPORT_C void RWindow::Invalidate

(

)

Invalidates the entire window.

This function causes the window to get a redraw message specifying its entire visible area, allowing an application-initiated redraw.

(generated from Symbian Developer Library)

Invalidate() [2/2]

IMPORT_C void RWindow::Invalidate

(

const TRect &

aRect

)

Invalidates an area within the window.

This function invalidates the specified rectangle, which causes the window to get a redraw message. This allows an application-initiated redraw of a specified rectangle.

Parameters

aRect

Area to invalidate.

(generated from Symbian Developer Library)

IsRedrawStoreEnabled()

IMPORT_C TBool RWindow::IsRedrawStoreEnabled

(

)

const

Returns whether the window uses a redraw store to store drawing commands.

The current WServ implementation always uses a redraw store. Therefore this function always returns ETrue.

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

RWindow::EnableRedrawStore()

(generated from Symbian Developer Library)

SetBackgroundColor() [1/2]

IMPORT_C void RWindow::SetBackgroundColor

(

)

Sets the background colour used for clearing in server-initiated redraws to none.

The window will not be cleared to its background colour when a window server-initiated redraw occurs.

For a window on which SetTransparencyAlphaChannel() has been called, this function means that the transparent window has no background.

If a client calls this function for an opaque window, it is their responsibility to provide opaque drawing to every pixel in the window (for example, a background bitmap). Otherwise, undefined behaviour will result.

(generated from Symbian Developer Library)

SetBackgroundColor() [2/2]

IMPORT_C void RWindow::SetBackgroundColor

(

TRgb

aColor

)

Sets the background colour used for clearing in server-initiated redraws.

The window will be cleared to its background colour when a window server-initiated redraw occurs. Background colour can be changed dynamically after a window has been created and activated, however, the new background colour will not be visible until the window has been redrawn.

Parameters

aColor

Background colour to be used during redraws.

(generated from Symbian Developer Library)

SetExtent()

IMPORT_C void RWindow::SetExtent	(	const TPoint &	point,
		const TSize &	size
	)

Sets the size and position of a window.

This function may be called at any time after the window's Construct() function: the window's extent will change dynamically.

If the window size is increased, any new area will be cleared to the background colour and a redraw event will be generated for it.

RBackedUpWindow

Parameters

point	The position of the window's origin, relative to its parent.
size	The window size.

(generated from Symbian Developer Library)

SetNonTransparent()

IMPORT_C void RWindow::SetNonTransparent

(

)

Window transparency based on the use of a separate window mask bitmap has been deprecated.

Calling this method method has no effect. To guarantee a window being opaque; see SetTransparentRegion().

RWindow::SetTransparentRegion()

(generated from Symbian Developer Library)

SetSize()

IMPORT_C void RWindow::SetSize

(

const TSize &

size

)

Sets the size of a window.

This function may be called at any time after the window's Construct() function: the window's size will change dynamically.

If the window size is increased, any new area will be cleared to the background colour and a redraw event will be generated for it.

Parameters

size	The window size.

(generated from Symbian Developer Library)

SetTransparencyAlphaChannel()

IMPORT_C TInt RWindow::SetTransparencyAlphaChannel

(

)

Enables the use of an alpha channel to control the window's transparency.

Note that the window's invalid area will be cleared using the window's background color before any drawing commence. Thus setting the background color to fully transparent is essential in most use cases.

RWindow::SetBackgroundColor()

(generated from Symbian Developer Library)

SetTransparencyBitmap()

IMPORT_C TInt RWindow::SetTransparencyBitmap

(

const CFbsBitmap &

aTransparencyBitmap

)

Window transparency based on the use of a separate window mask bitmap has been deprecated.

Calling this method method has no effect. For window transparency see the the support for window alpha channel.

RWindow::SetTransparencyAlphaChannel()

Parameters

aTransparencyBitmap

Ignored.

(generated from Symbian Developer Library)

SetTransparencyFactor()

IMPORT_C TInt RWindow::SetTransparencyFactor

(

const TRgb &

aTransparencyFactor

)

The support for window transparency factor has been deprecated.

Calling this method has no effect. For window transparency see the the support for window alpha channel.

RWindow::SetTransparencyAlphaChannel()

Parameters

aTransparencyFactor

Ignored.

(generated from Symbian Developer Library)

SetTransparencyPolicy()

IMPORT_C TInt RWindow::SetTransparencyPolicy

(

TWsTransparencyPolicy

aPolicy

)

Sets the transparency policy of a window.

No screen content changes will occur immediately as a result of calling this function.

This function applies to transparent window only.

TWsTransparencyPolicy

Parameters

aPolicy

Transparent window policy.

(generated from Symbian Developer Library)

SetTransparencyWsBitmap()

IMPORT_C TInt RWindow::SetTransparencyWsBitmap

(

const CWsBitmap &

aTransparencyBitmap

)

Window transparency based on the use of a separate window mask bitmap has been deprecated.

Calling this method method has no effect. For window transparency see the the support for window alpha channel.

RWindow::SetTransparencyAlphaChannel()

Parameters

aTransparencyBitmap

Ignored.

(generated from Symbian Developer Library)

SetTransparentRegion()

IMPORT_C TInt RWindow::SetTransparentRegion

(

const TRegion &

aRegion

)

Sets the user-defined transparent region of a window.

This will replace the default transparent region in a transparent window which is normally the full window base area. The area outside of the transparent region will be treated by window server as being opaque. The client is responsible for ensuring that opaque drawing is present in all pixels of this area. If the client fails to do this, undefined behaviour will result. It is possible to make the transparent window completely opaque by passing an empty region. Passing a region equal to the window base area or larger will revert the window to its default behaviour (i.e. full window transparency). No screen content changes will occur immediately as a result of calling this function.

This function applies to transparent window only and always causes a flush of the window server buffer.

RWindow::SetTransparencyAlphaChannel()

Parameters

aRegion

User defined windows's transparent region.

(generated from Symbian Developer Library)

---

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

• w32std.h
• w32std.h.dox