#include <w32std.h>
| class RBlankWindow : public RWindowBase |
| Public Member Functions | |
|---|---|
| RBlankWindow() | |
| RBlankWindow(RWsSession &) | |
| IMPORT_C TInt | Construct(const RWindowTreeNode &, TUint32) |
| IMPORT_C void | SetColor(TRgb) |
| IMPORT_C void | SetColor() |
| IMPORT_C void | SetExtent(const TPoint &, const TSize &) |
| IMPORT_C void | SetSize(const TSize &) |
| Inherited Attributes | |
|---|---|
| MWsClientClass::iBuffer | |
| MWsClientClass::iWsHandle | |
| RWindowTreeNode::__DECLARE_TEST | |
| Inherited Enumerations | |
|---|---|
| RWindowBase:TCaptureFlags | |
| RWindowTreeNode:TFadeControl | |
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.
| IMPORT_C | RBlankWindow | ( | ) |
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 | ) |
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.
| Parameter | Description |
|---|---|
| aWs | The window server session that owns the window. |
| IMPORT_C TInt | Construct | ( | const RWindowTreeNode & | parent, |
| TUint32 | aHandle | |||
| ) | ||||
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.
See also: TWsEvent::Handle() TWsPriorityKeyEvent::Handle() RWindow::Construct()
| Parameter | Description |
|---|---|
| parent | The window's parent. |
| aHandle | Client handle for the window. See RWindow::Construct() for a description of the client handle. |
Returns: KErrNone if successful, otherwise one of the system-wide error codes, the most likely of which is KErrNoMemory.
| IMPORT_C void | SetColor | ( | TRgb | aColor | ) |
Sets the colour of the blank window.
| Parameter | Description |
|---|---|
| aColor | Colour for the window. |
| IMPORT_C void | SetColor | ( | ) |
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 | ) |
Sets the size of the blank window.
| Parameter | Description |
|---|---|
| size | Size. |