Class RBlankWindow

RBlankWindow

Support

Supported from 5.0

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 engine RBlankWindow Blank window RWindowBase Client-side handle to a server-side window RWindowTreeNode Handle to a node in the server-side window tree

Defined in RBlankWindow:
Construct(), RBlankWindow(), SetColor(), SetExtent(), SetSize()

Inherited from MWsClientClass:
WsHandle()

Inherited from RWindowBase:
Activate(), AddKeyRect(), AllocPointerMoveBuffer(), CancelPointerRepeatEventRequest(), ClaimPointerGrab(), DisablePointerMoveBuffer(), DiscardPointerMoveBuffer(), DisplayMode(), EnableBackup(), EnablePointerMoveBuffer(), FadeBehind(), FreePointerMoveBuffer(), InquireOffset(), IsFaded(), IsNonFading(), MoveToGroup(), PasswordWindow(), PointerFilter(), Position(), RemoveAllKeyRects(), RequestPointerRepeatEvent(), RetrievePointerMoveBuffer(), SetCornerType(), SetExtentErr(), SetPointerCapture(), SetPointerGrab(), SetPosition(), SetRequiredDisplayMode(), SetShadowDisabled(), SetShadowHeight(), SetShape(), SetSizeErr(), SetVisible(), Size(), TCaptureDisabled, TCaptureDragDrop, TCaptureEnabled, TCaptureFlagAllGroups, TCaptureFlagDragDrop, TCaptureFlagEnabled, TCaptureFlags

Inherited from RWindowTreeNode:
Child(), ClearPointerCursor(), Close(), Destroy(), DisableErrorMessages(), DisableFocusChangeEvents(), DisableGroupChangeEvents(), DisableModifierChangedEvents(), DisableOnEvents(), EFadeIncludeChildren, EFadeWindowOnly, EnableErrorMessages(), EnableFocusChangeEvents(), EnableGroupChangeEvents(), EnableModifierChangedEvents(), EnableOnEvents(), FullOrdinalPosition(), NextSibling(), OrdinalPosition(), OrdinalPriority(), Parent(), PrevSibling(), SetCustomPointerCursor(), SetFaded(), SetNonFading(), SetOrdinalPosition(), SetPointerCursor(), TFadeControl

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.

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() before any operations can be carried out on the window.

Parameters

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

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

Integer handles must be values that are unique within the current server session (see RBackedUpWindow()). 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.

Parameters

const RWindowTreeNode &parent The window's parent. TUint32 aHandle Window server handle number for the window (must be unique: see above).

Return value

TInt KErrNone if successful, otherwise one of the system-wide error codes.

See also:

• TWsEvent::Handle()
• TWsPriorityKeyEvent::Handle()

void SetColor(TRgb aColor);

Description

Sets the colour of the blank window.

Parameters

TRgb aColor Colour for the window.

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.

void SetSize(const TSize& size);

Description

Sets the size of the blank window.

Parameters

const TSize& size Size.