Class RDrawableWindow

class RDrawableWindow : public RWindowBase;

Description

Handle to a drawable window.

This class cannot be constructed directly. The two concrete derived classes, RWindow and RBackedUpWindow, allow drawing but use different protocols because RWindow relies on the client to redraw invalid areas.

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.

Members

Defined in 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 MWsClientClass:

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

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 void Scroll(const TPoint &aOffset);

Description

Scrolls the window contents by an offset.

All parts of an RWindow are either drawn with content copied from another part of the window or are invalidated. Areas are invalidated when the source content of the scroll would be outside the window or obscured behind another window. The areas that are invalidated are not blanked off.

For example, if the window is scrolled towards the right, then there is no content (from outside the window) to move into area on the left hand side. This area is invalidated. Similarly, no content can be scrolled out from under an obscuring window, so the area from beneath the obscuring window is also invalidated.

Note that for an RBackedUpWindow, the contents of areas obscured by other windows are stored. In this case the window contents are scrolled out from "underneath" the obscuring window. In the example above the area on the left was invalidated but for this type of window the area simply contains its old pre-scroll contents.

Parameters

const TPoint &aOffset Scroll offset, in pixels. Positive values cause the window contents to move downwards/right. Negative values cause contents to move upwards/left.

IMPORT_C void Scroll(const TRect &aClipRect, const TPoint &aOffset);

Description

Scrolls the contents of a clip rectangle, independently of the other contents of the window.

This function behaves in exactly the same way as the single parameter overload, except that the scroll region is a clipping rectangle rather than the whole window. All parts of the clipping rectangle are either drawn with content copied from another part of the rectangle or are invalidated.

The RBackedUpWindow behaviour is also similar to the behaviour in the function above.

Parameters

const TRect &aClipRect Rectangle to which scrolling is to be clipped const TPoint &aOffset Scroll offset, in pixels. Positive values cause the window contents to move downwards and right. Negative values cause contents to move upwards and left.

IMPORT_C void Scroll(const TPoint &aOffset, const TRect &aRect);

Description

Scrolls a rectangle within a window.

This function effectively moves the specified rectangle by the given offset with respect to the window. The destination rectangle may overlap and cover the old rectangle.

Note that if the source of this rectangle is an invalid area, ie it is obscured or lies outside the window, then this area in the destination rectangle will be invalidated.

Parameters

const TPoint &aOffset Scroll offset, in pixels. Positive values cause the window contents to move downwards and right. Negative values cause contents to move upwards and left. const TRect &aRect The source rectangle for the scroll.

IMPORT_C void Scroll(const TRect &aClipRect, const TPoint &aOffset, const TRect &aRect);

Description

Scrolls the contents of a source rectangle within a clipping rectangle.

The source rectangle is effectively copied from one position to another, with both the source and destination clipped to the clipping rectangle. Hence if the source and destination rectangles are inside the clipping region then this function behaves exactly like the RDrawableWindow::Scroll(const TPoint &,const TRect &) overload. However if the source or destination for the scrolled rectangle intersect the clipping rectangle then the function behaves similarly to the RDrawableWindow::Scroll(const TRect &,const TPoint &) overload, with regards to invalidated regions etc.

Parameters

const TRect &aClipRect Rectangle to which scrolling is to be clipped. const TPoint &aOffset Scroll offset, in pixels. Positive values cause the window contents to move downwards and right. Negative values cause contents to move upwards and left. const TRect &aRect Source rectangle for the scroll.

IMPORT_C TRect GetDrawRect();

Description

Obtains the current rectangle being drawn to this window, during a window redraw cycle.

This function can be called between a BeginRedraw() / EndRedraw() pair to obtain the current window redraw reference rectangle.

Return value

TRect The current reference rectangle that is being redrawn