Class RWindow

class RWindow : public RDrawableWindow;

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.

Derivation

• MWsClientClass - Base class for all classes whose objects are clients of the window server.

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

• RWindowBase - Client-side handle to a server-side window.

• RDrawableWindow - Handle to a drawable window.

• RWindow - Handle to a standard window.

Members

Defined in RWindow:

• BeginRedraw()Begins redrawing the window's invalid region.
• BeginRedraw(const TRect &)Begins the redraw of a rectangle within the window's invalid region.
• Construct(const RWindowTreeNode &,TUint32)Completes the construction of the window handle.
• EnableOSB(TBool)Enables/Disables the WSERV to use its OSB
• EnableRedrawStore(TBool)Enables or Disables the redraw store for a window.
• EndRedraw()Ends the current redraw.
• GetInvalidRegion(RRegion &)Gets the invalid region.
• HandleTransparencyUpdate()Notifies the server that the contents of the bitmap that has been registered as ...
• Invalidate()Invalidates the entire window.
• Invalidate(const TRect &)Invalidates an area within the window.
• IsRedrawStoreEnabled()Returns whether the window uses a redraw store to store drawing commands.
• RWindow()Default constructor which creates a sessionless, uninitialised window handle.
• RWindow(RWsSession &)Constructor which creates an initialised window handle within a server session.
• SetBackgroundColor()Sets the background colour used for clearing in server-initiated redraws to none...
• SetBackgroundColor(TRgb)Sets the background colour used for clearing in server-initiated redraws.
• SetExtent(const TPoint &,const TSize &)Sets the size and position of a window.
• SetNonTransparent()Sets the window to not be transparent.
• SetSize(const TSize &)Sets the size of a window.
• SetTransparencyAlphaChannel()Sets the window to be transparent using the alpha channel. Only valid when using...
• SetTransparencyBitmap(const CFbsBitmap &)Sets the tranpsarency bitmap for this window. This will overwrite any other sett...
• SetTransparencyFactor(const TRgb &)Sets the tranpsarency color for this window. This will overwrite any other setti...
• SetTransparencyPolicy(TWsTransparencyPolicy)Sets the transparency policy of a window.
• SetTransparencyWsBitmap(const CWsBitmap &)Sets the tranpsarency bitmap for this window using a CWsBitmap. This will overwr...
• SetTransparentRegion(const TRegion &)Sets the user-defined transparent region of a window.

Inherited from MWsClientClass:

• WsHandle()constGets the server side handle for the object.

Inherited from RDrawableWindow:

• GetDrawRect()Obtains the current rectangle being drawn to this window, during a window redraw...
• Scroll(const TPoint &)Scrolls the window contents by an offset.
• Scroll(const TPoint &,const TRect &)Scrolls a rectangle within a window.
• Scroll(const TRect &,const TPoint &)Scrolls the contents of a clip rectangle, independently of the other contents of...
• Scroll(const TRect &,const TPoint &,const TRect &)Scrolls the contents of a source rectangle within a clipping rectangle.

Inherited from RWindowBase:

• AbsPosition()constGets a window's absolute position - ie the windows position relative to the curr...
• Activate()Displays the window and enables it to receive events.
• AddKeyRect(const TRect &,TInt,TBool)Adds an on-screen key rectangle.
• AllocPointerMoveBuffer(TInt,TUint)Allocates a buffer for storing pointer movements.
• CancelPointerRepeatEventRequest()Cancels a request for a pointer repeat event.
• ClaimPointerGrab(TBool)Claims the pointer grab from another window.
• DisablePointerMoveBuffer()Instructs the window server to stop adding pointer events to the pointer move bu...
• DiscardPointerMoveBuffer()Discards all events in the pointer move buffer.
• DisplayMode()Gets the window's current display mode.
• EnableBackup(TUint)Requests that this window backs up all or part of the screen's contents. There a...
• EnablePointerMoveBuffer()Enables the pointer move buffer for receiving pointer move events.
• FadeBehind(TBool)Sets whether or not all windows behind the current window, in the same window gr...
• FreePointerMoveBuffer()Frees the pointer move buffer.
• GetPointerCapturePriority()constGets the windows's pointer capture priority
• InquireOffset(const RWindowTreeNode &)constEnquires the offset between this and another window.
• IsFaded()Tests whether the current window is faded.
• IsNonFading()Tests whether the current window is non-fading.
• MoveToGroup(TInt)Moves this window to another window group.
• PasswordWindow(TPasswordMode)Makes this window the password window.
• PointerFilter(TUint32,TUint32)Sets the filter which controls which pointer events are sent to the client sessi...
• Position()constGets a window's position relative to its parent.
• RemoveAllKeyRects()Removes all the on-screen keys that have been added to this window.
• RequestPointerRepeatEvent(TTimeIntervalMicroSeconds32,const TRect &)Requests a pointer repeat event.
• RetrievePointerMoveBuffer(TDes8 &)Retrieves events from the pointer move buffer.
• SetCornerType(TCornerType,TInt)Sets the shape of a window's corners.
• SetExtentErr(const TPoint &,const TSize &)Sets a backed-up window's extent, relative to its parent, and returns an error c...
• SetPointerCapture(TInt)Sets the pointer capture state.
• SetPointerCapturePriority(TInt)Sets the window's pointer capture priority.
• SetPointerGrab(TBool)Allows or disallows pointer grabs in a window.
• SetPosition(const TPoint &)Sets the position of a window relative to its parent.
• SetRequiredDisplayMode(TDisplayMode)Sets the window's display mode.
• SetShadowDisabled(TBool)Enables or disables whether a window casts a shadow.
• SetShadowHeight(TInt)Sets a window's shadow height.
• SetShape(const TRegion &)Sets a window's shape arbitrarily, if rectangular windows are not required.
• SetSizeErr(const TSize &)Sets the size of a backed-up window.
• SetVisible(TBool)Sets the window's visibility.
• Size()constGets the window's current size.
• TCaptureDisabledEquivalent to disabling all the above flags.
• TCaptureDragDropEquivalent to the OR of the first three flags.
• TCaptureEnabledEquivalent to TCaptureFlagEnabled.
• TCaptureFlagAllGroupsCapture events from windows belonging to any group, not just the group of the wi...
• TCaptureFlagDragDropIf set, drag-drop events are sent to the window in which the pointer was lifted....
• TCaptureFlagEnabledIf set, capture is enabled, disabled otherwise.
• TCaptureFlagsCapture behaviour flags.

Inherited from RWindowTreeNode:

• Child()constGets the first child of the node.
• ClearPointerCursor()Clears pointer cursor settings.
• ClientHandle()constGets the window's client handle
• Close()Closes the node.
• Destroy()Closes and deletes the node.
• DisableErrorMessages()Cancels notification of error message events.
• DisableFocusChangeEvents()Disables delivery of focus changed events.
• DisableGroupChangeEvents()Cancels notification of group changed events.
• DisableGroupListChangeEvents()Disables reporting of window group list change events.
• DisableModifierChangedEvents()Cancels notification of modifier changed events.
• DisableOnEvents()Cancels notification of 'on' events.
• DisableVisibilityChangeEvents()Disables reporting of window visibility change events.
• EFadeIncludeChildrenInclude all child windows when fading/un-fading.
• EFadeWindowOnlyFade only the parent window.
• EnableErrorMessages(TEventControl)Requests notification of error message events.
• EnableFocusChangeEvents()Enables focus changed events.
• EnableGroupChangeEvents()Requests notification of group-change events.
• EnableGroupListChangeEvents()Enables reporting of window group list change events.
• EnableModifierChangedEvents(TUint,TEventControl)Requests notification of modifier changed events.
• EnableOnEvents(TEventControl)Requests notification of 'on' events. 'On' events are of type EEventSwitchOn.
• EnableVisibilityChangeEvents()Enables reporting of window visibility change events.
• FullOrdinalPosition()constGet the current full ordinal position of a window.
• NextSibling()constGets the next window after this one in its sibling list.
• OrdinalPosition()constGets the current ordinal position of the window tree node.
• OrdinalPriority()constGets the ordinal priority of the specified window.
• Parent()constGets the node's parent.
• PrevSibling()constGets the node before this one in the sibling list.
• SetCustomPointerCursor(const RWsPointerCursor &)Sets the pointer cursor to an application-defined cursor.
• SetFaded(TBool,TFadeControl)Sets the window as faded or unfaded.
• SetFaded(TBool,TFadeControl,TUint8,TUint8)Sets one or more windows as faded or unfaded, specifying a fading map.
• SetNonFading(TBool)Sets whether a window is non-fading.
• SetOrdinalPosition(TInt)Sets the ordinal position of a window.
• SetOrdinalPosition(TInt,TInt)Sets the ordinal position and ordinal priority of a window.
• SetPointerCursor(TInt)Sets the pointer cursor from the system pointer cursor list.
• TFadeControlFade control flags.
• WindowGroupId()Returns the window group Id of the parent window group

IMPORT_C RWindow();

Description

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.

IMPORT_C RWindow(RWsSession &aWs);

Description

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

Parameters

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

Description

Completes the construction of the window handle.

This method should be called after the RWindow::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

Return value

IMPORT_C void BeginRedraw();

Description

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 RWindow::EndRedraw().

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

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

See also:

• RWindow::EndRedraw()Ends the current redraw.

IMPORT_C void BeginRedraw(const TRect &aRect);

Description

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 RWindow::EndRedraw().

Note:

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

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 RWindow::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.

Parameters

See also:

• RWindow::EndRedraw()Ends the current redraw.

IMPORT_C void EndRedraw();

Description

Ends the current redraw.

This function should be called when redrawing is complete.

IMPORT_C void Invalidate();

Description

Invalidates the entire window.

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

IMPORT_C void Invalidate(const TRect &aRect);

Description

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

IMPORT_C void GetInvalidRegion(RRegion &aRegion);

Description

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

IMPORT_C void SetBackgroundColor(TRgb aColor);

Description

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

IMPORT_C void SetBackgroundColor();

Description

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.

IMPORT_C void SetSize(const TSize &size);

Description

Sets the size of a window.

This function may be called at any time after the window's RWindow::Construct(const RWindowTreeNode &,TUint32) 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

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

Description

Sets the size and position of a window.

This function may be called at any time after the window's RWindow::Construct(const RWindowTreeNode &,TUint32) 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.

Parameters

See also:

• RBackedUpWindowClient-side handle to a drawable window with a backup bitmap.

IMPORT_C void HandleTransparencyUpdate();

Description

Notifies the server that the contents of the bitmap that has been registered as the transparency bitmap has been changed

IMPORT_C TInt SetTransparencyFactor(const TRgb &aTransparencyFactor);

Description

Sets the tranpsarency color for this window. This will overwrite any other settings.

Note when inherited transparency is supported all children of this window will automatically inherit the transparency set by this function. If this window's children should not inherit transparecy then call the funciton RWindow::SetNonTransparent() now so that in future releases they will still not be transparent.

Transparent windows require redraw storing to be turned on, if it is not already it will be turned on for this window by calling this function.

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

Parameters

Return value

IMPORT_C TInt SetTransparencyBitmap(const CFbsBitmap &aTransparencyBitmap);

Description

Sets the tranpsarency bitmap for this window. This will overwrite any other settings.

Note when inherited transparency is supported all children of this window will automatically inherit the transparency set by this function. If this window's children should not inherit transparecy then call the funciton RWindow::SetNonTransparent() now so that in future releases they will still not be transparent.

Transparent windows require redraw storing to be turned on, if it is not already it will be turned on for this window by calling this function.

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

Parameters

Return value

IMPORT_C TInt SetTransparencyWsBitmap(const CWsBitmap &aTransparencyBitmap);

Description

Sets the tranpsarency bitmap for this window using a CWsBitmap. This will overwrite any other settings.

Note when inherited transparency is supported all children of this window will automatically inherit the transparency set by this function. If this window's children should not inherit transparecy then call the funciton RWindow::SetNonTransparent() now so that in future releases they will still not be transparent.

Transparent windows require redraw storing to be turned on, if it is not already it will be turned on for this window by calling this function.

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

Parameters

Return value

IMPORT_C void SetNonTransparent();

Description

Sets the window to not be transparent.

This function only needs to be called if the parent window is set to be transparent. In which case it should be called to stop this window inheriting the transparency from the parent.

Note that although inherited transparency is not supported at the moment when it is implemented in future releases the children will automatically become transparent so call this funciton now to stop this window becomming transparent in the future (but you only need to if it's parent is set transparent).

IMPORT_C void EnableRedrawStore(TBool aEnabled);

Description

Enables or Disables the redraw store for a window.

The window server can store the operations needed to redraw a window. This is the default behaviour, and is desired in most cases. Under certain circumstances, however, client side redrawing is essential, and then this function should be called to disable the redraw store.

Windows which do not use the redraw store will not display correctly when visible through a transparent window.

Parameters

IMPORT_C TInt SetTransparencyAlphaChannel();

Description

Sets the window to be transparent using the alpha channel. Only valid when using a display mode which supports alpha blending

Transparent windows require redraw storing to be turned on, if it is not already it will be turned on for this window by calling this function.

Return value

IMPORT_C TInt SetTransparentRegion(const TRegion &aRegion);

Description

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. 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.

Parameters

Return value

See also:

• RWindow::SetTransparencyFactor(const TRgb &)Sets the tranpsarency color for this window. This will overwrite any other setti...
• RWindow::SetTransparencyBitmap(const CFbsBitmap &)Sets the tranpsarency bitmap for this window. This will overwrite any other sett...
• RWindow::SetTransparencyAlphaChannel()Sets the window to be transparent using the alpha channel. Only valid when using...

IMPORT_C TInt SetTransparencyPolicy(TWsTransparencyPolicy aPolicy);

Description

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.

Parameters

Return value

See also:

• TWsTransparencyPolicyTransparency policies

IMPORT_C TBool IsRedrawStoreEnabled();

Description

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

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

Return value

See also:

• RWindow::EnableRedrawStore(TBool)Enables or Disables the redraw store for a window.

IMPORT_C void EnableOSB(TBool);

Description

Enables/Disables the WSERV to use its OSB

Parameters