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(), RBlankWindow(), RBlankWindow(), SetColor(), SetColor(), SetExtent(), SetSize()

Inherited from MWsClientClass:
WsHandle()

Inherited from RWindowBase:
AbsPosition(), Activate(), AddKeyRect(), AllocPointerMoveBuffer(), CancelPointerRepeatEventRequest(), ClaimPointerGrab(), DisablePointerMoveBuffer(), DiscardPointerMoveBuffer(), DisplayMode(), EnableBackup(), EnablePointerMoveBuffer(), FadeBehind(), FreePointerMoveBuffer(), GetPointerCapturePriority(), InquireOffset(), IsFaded(), IsNonFading(), MoveToGroup(), PasswordWindow(), PointerFilter(), Position(), RemoveAllKeyRects(), RequestPointerRepeatEvent(), RetrievePointerMoveBuffer(), SetCornerType(), SetExtentErr(), SetPointerCapture(), SetPointerCapturePriority(), 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(), DisableGroupListChangeEvents(), DisableModifierChangedEvents(), DisableOnEvents(), DisableVisibilityChangeEvents(), EFadeIncludeChildren, EFadeWindowOnly, EnableErrorMessages(), EnableFocusChangeEvents(), EnableGroupChangeEvents(), EnableGroupListChangeEvents(), EnableModifierChangedEvents(), EnableOnEvents(), EnableVisibilityChangeEvents(), FullOrdinalPosition(), NextSibling(), OrdinalPosition(), OrdinalPriority(), Parent(), PrevSibling(), SetCustomPointerCursor(), SetFaded(), SetNonFading(), SetOrdinalPosition(), SetPointerCursor(), TFadeControl, WindowGroupId()

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() 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(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() 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()
• TWsPriorityKeyEvent::Handle()
• RWindow::Construct()

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.