RWindow Class Reference

Enables or Disables the storing of redraw operations that do not intersect the viewport for a window.

The window server stores operations required to redraw a window in a redraw store. Calling this function with ETrue causes all such drawing operations to be stored. The EnableRedrawStore(EFalse) call serves as a hint to store only the subset of draw commands which intersect the viewport.

Ends the current redraw.

This function should be called when redrawing is complete.

Gets the invalid region.

Note: if there is not enough memory to create the region, the region's error flag will be set.

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

Window transparency based on the use of a separate window mask bitmap has been deprecated. Calling this method method has no effect. For window transparency see the the support for window alpha channel.

See also: RWindow::SetTransparencyAlphaChannel()

Invalidates the entire window.

This function causes the window to get a redraw message specifying its entire visible area, allowing an application-initiated redraw.

Invalidates an area within the window.

This function invalidates the specified rectangle, which causes the window to get a redraw message. This allows an application-initiated redraw of a specified rectangle.

Returns whether the window uses a redraw store to store drawing commands.

The current WServ implementation always uses a redraw store. Therefore this function always returns ETrue.

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

See also: RWindow::EnableRedrawStore()

Sets the background colour used for clearing in server-initiated redraws.

The window will be cleared to its background colour when a window server-initiated redraw occurs. Background colour can be changed dynamically after a window has been created and activated, however, the new background colour will not be visible until the window has been redrawn.

Sets the background colour used for clearing in server-initiated redraws to none.

The window will not be cleared to its background colour when a window server-initiated redraw occurs.

For a window on which SetTransparencyAlphaChannel() has been called, this function means that the transparent window has no background.

If a client calls this function for an opaque window, it is their responsibility to provide opaque drawing to every pixel in the window (for example, a background bitmap). Otherwise, undefined behaviour will result.

Sets the size and position of a window.

This function may be called at any time after the window's Construct() function: the window's extent will change dynamically.

If the window size is increased, any new area will be cleared to the background colour and a redraw event will be generated for it.

See also: RBackedUpWindow

Window transparency based on the use of a separate window mask bitmap has been deprecated. Calling this method method has no effect. To guarantee a window being opaque; see SetTransparentRegion().

See also: RWindow::SetTransparentRegion()

Sets the size of a window.

This function may be called at any time after the window's Construct() function: the window's size will change dynamically.

If the window size is increased, any new area will be cleared to the background colour and a redraw event will be generated for it.

Enables the use of an alpha channel to control the window's transparency.

Note that the window's invalid area will be cleared using the window's background color before any drawing commence. Thus setting the background color to fully transparent is essential in most use cases.

See also: RWindow::SetBackgroundColor()

Window transparency based on the use of a separate window mask bitmap has been deprecated. Calling this method method has no effect. For window transparency see the the support for window alpha channel.

See also: RWindow::SetTransparencyAlphaChannel()

The support for window transparency factor has been deprecated. Calling this method has no effect. For window transparency see the the support for window alpha channel.

See also: RWindow::SetTransparencyAlphaChannel()

Sets the transparency policy of a window.

No screen content changes will occur immediately as a result of calling this function.

This function applies to transparent window only.

See also: TWsTransparencyPolicy

Window transparency based on the use of a separate window mask bitmap has been deprecated. Calling this method method has no effect. For window transparency see the the support for window alpha channel.

See also: RWindow::SetTransparencyAlphaChannel()

Sets the user-defined transparent region of a window.

This will replace the default transparent region in a transparent window which is normally the full window base area. The area outside of the transparent region will be treated by window server as being opaque. The client is responsible for ensuring that opaque drawing is present in all pixels of this area. If the client fails to do this, undefined behaviour will result. It is possible to make the transparent window completely opaque by passing an empty region. Passing a region equal to the window base area or larger will revert the window to its default behaviour (i.e. full window transparency). No screen content changes will occur immediately as a result of calling this function.

This function applies to transparent window only and always causes a flush of the window server buffer.

See also: RWindow::SetTransparencyAlphaChannel()