Class RBlankWindow

class RBlankWindow : public RWindowBase;

Description

Blank window.

A blank window may have its extent and colour changed, but nothing else may be drawn to it. Blank windows provide no functionality that is not provided by the RWindow class. However, they are useful when the application requires a window that cannot be drawn to, for example a container window.

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.

• RBlankWindow - Blank window.

Members

Defined in RBlankWindow:

• Construct(const RWindowTreeNode &,TUint32)Completes the construction of a valid blank-window handle.
• RBlankWindow()Default C++ constructor which creates an invalid blank-window handle.
• RBlankWindow(RWsSession &)Default C++ constructor which creates a valid but uninitialised blank-window han...
• SetColor()Sets the background colour used for clearing when the window becomes uncovered o...
• SetColor(TRgb)Sets the colour of the blank window.
• SetExtent(const TPoint &,const TSize &)Sets the extent of the blank window.
• SetSize(const TSize &)Sets the size of the blank window.

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 RBlankWindow();

Description

Default C++ constructor which creates an invalid blank-window handle.

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 RBlankWindow(RWsSession &aWs);

Description

Default C++ constructor which creates a valid but uninitialised blank-window handle.

This constructor does not create a window in the window server: client programs must do this by calling RBlankWindow::Construct(const RWindowTreeNode &,TUint32) before any operations can be carried out on the window.

Parameters

RWsSession &aWs The window server session that owns the window.

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

Description

Completes the construction of a valid blank-window handle.

This function should be called after the RBlankWindow::RBlankWindow(RWsSession &) constructor, and before any other functions are performed on the window. It creates a window in the window server corresponding to the RBlankWindow object. The window is initialised to inherit the size and extent of its parent window, or to be full screen if its parent is a group window.

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

Parameters

const RWindowTreeNode &parent The window's parent. TUint32 aHandle Client handle for the window. See RWindow::Construct(const RWindowTreeNode &,TUint32) for a description of the client handle.

Return value

TInt KErrNone if successful, otherwise one of the system-wide error codes, the most likely of which is KErrNoMemory.

See also:

• TWsEvent::Handle()constGets the window handle.
• TWsPriorityKeyEvent::Handle()constGets the handle for the window group which added the priority key.
• RWindow::Construct(const RWindowTreeNode &,TUint32)Completes the construction of the window handle.

IMPORT_C void SetColor(TRgb aColor);

Description

Sets the colour of the blank window.

Parameters

TRgb aColor Colour for the window.

IMPORT_C void SetColor();

Description

Sets the background colour used for clearing when the window becomes uncovered or visible to none.

The window content will be left with whatever happened to be on the screen at the time.

IMPORT_C void SetSize(const TSize &size);

Description

Sets the size of the blank window.

Parameters

const TSize &size Size.

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

Description

Sets the extent of the blank window.

Parameters

const TPoint &point The position of the window's origin, relative to its parent. const TSize &size Size for the window.