![[Index]](../../../../a_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../a_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../a_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../a_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Location:
W32STD.H
Link against: ws32.lib
class RWindow : public RDrawableWindow;
Handle to a standard window.
An RWindow is a handle to a server-side window which can be displayed and drawn to, and whose redraws are performed by the application.
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
RDrawableWindow - Handle to a drawable window
RWindow - Handle to a standard window
Defined in RWindow:
BeginRedraw(), BeginRedraw(), Construct(), EnableOSB(), EnableRedrawStore(), EndRedraw(), GetInvalidRegion(), HandleTransparencyUpdate(), Invalidate(), Invalidate(), IsRedrawStoreEnabled(), RWindow(), RWindow(), SetBackgroundColor(), SetBackgroundColor(), SetExtent(), SetNonTransparent(), SetSize(), SetTransparencyAlphaChannel(), SetTransparencyBitmap(), SetTransparencyFactor(), SetTransparencyPolicy(), SetTransparencyWsBitmap(), SetTransparentRegion()
Inherited from MWsClientClass:
WsHandle()
Inherited from RDrawableWindow:
GetDrawRect(),
Scroll()
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 RWindow();
Default constructor which creates a sessionless, uninitialised window handle.
Handles to server-side objects must be created in a session in order to be operational; this constructor is merely a convenience
to allow the handle to be stored as a data member. 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 RWindow(RWsSession &aWs);
Constructor which creates an initialised window handle within a server session.
|
|
|
IMPORT_C TInt Construct(const RWindowTreeNode &parent, TUint32 aHandle);
Completes the construction of the window handle.
This method should be called after the RWindow() constructor, before any other functions are performed on the window. It creates a window in the window server corresponding
to the RWindow object. The window is initialised to inherit the size and extent of its parent window, given by the first parameter.
If its parent is a group window then it will be full screen.
This function always causes a flush of the window server buffer.
|
|
IMPORT_C void BeginRedraw();
Begins redrawing the window's invalid region.
This method tells the window server that the window is about to respond to the last redraw event by redrawing the entire invalid region. This causes the window server to validate the entire invalid region.
After the redraw is complete the entire region that was previously invalid is validated. The window should then call EndRedraw().
Note: the redraw is clipped to the region that was previously invalid.
This function always causes a flush of the window server buffer.
IMPORT_C void BeginRedraw(const TRect &aRect);
Begins the redraw of a rectangle within the window's invalid region.
This method tells the window server that the window is about to respond to the last redraw event by redrawing the specified rectangle. This causes the window server to clear the rectangle, and remove it from the invalid region.
After the redraw is complete the window should call EndRedraw().
Note:
When handling a redraw event, this rectangle would typically be the rectangle returned by TWsRedrawEvent::Rect().
The redraw is clipped to the area that is validated, i.e. the intersection of the rectangle with the previously invalid region.
If you only validate part of the rectangle given in the redraw event then, after EndRedraw() is called, drawing will be clipped to the visible area which is not invalid. This is because drawing (that is non-redrawing)
is always clipped to the visible region less the invalid region. You will get another message telling you to redraw the area
that is still invalid.
|
IMPORT_C void EndRedraw();
Ends the current redraw.
This function should be called when redrawing is complete.
IMPORT_C void Invalidate();
Invalidates the entire window.
This function causes the window to get a redraw message specifying its entire visible area, allowing an application-initiated redraw.
IMPORT_C void Invalidate(const TRect &aRect);
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.
|
IMPORT_C void GetInvalidRegion(RRegion &aRegion);
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.
|
IMPORT_C void SetBackgroundColor(TRgb aColor);
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.
|
IMPORT_C void SetBackgroundColor();
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.
IMPORT_C void SetSize(const TSize &size);
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.
|
IMPORT_C void SetExtent(const TPoint &point, const TSize &size);
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.
|
IMPORT_C void HandleTransparencyUpdate();
Notifies the server that the contents of the bitmap that has been registered as the transparency bitmap has been changed
IMPORT_C TInt SetTransparencyFactor(const TRgb &aTransparencyFactor);
Sets the tranpsarency color for this window. This will overwrite any other settings.
Note when inherited transparency is supported all children of this window will automatically inherit the transparency set
by this function. If this window's children should not inherit transparecy then call the funciton RWindow::SetNonTransparent() now so that in future releases they will still not be transparent.
Transparent windows require redraw storing to be turned on, if it is not already it will be turned on for this window by calling this function.
This function always causes a flush of the window server buffer.
|
|
IMPORT_C TInt SetTransparencyBitmap(const CFbsBitmap &aTransparencyBitmap);
Sets the tranpsarency bitmap for this window. This will overwrite any other settings.
Note when inherited transparency is supported all children of this window will automatically inherit the transparency set
by this function. If this window's children should not inherit transparecy then call the funciton RWindow::SetNonTransparent() now so that in future releases they will still not be transparent.
Transparent windows require redraw storing to be turned on, if it is not already it will be turned on for this window by calling this function.
This function always causes a flush of the window server buffer.
|
|
IMPORT_C TInt SetTransparencyWsBitmap(const CWsBitmap &aTransparencyBitmap);
Sets the tranpsarency bitmap for this window using a CWsBitmap. This will overwrite any other settings.
Note when inherited transparency is supported all children of this window will automatically inherit the transparency set
by this function. If this window's children should not inherit transparecy then call the funciton RWindow::SetNonTransparent() now so that in future releases they will still not be transparent.
Transparent windows require redraw storing to be turned on, if it is not already it will be turned on for this window by calling this function.
This function always causes a flush of the window server buffer.
|
|
IMPORT_C void SetNonTransparent();
Sets the window to not be transparent.
This function only needs to be called if the parent window is set to be transparent. In which case it should be called to stop this window inheriting the transparency from the parent.
Note that although inherited transparency is not supported at the moment when it is implemented in future releases the children will automatically become transparent so call this funciton now to stop this window becomming transparent in the future (but you only need to if it's parent is set transparent).
IMPORT_C void EnableRedrawStore(TBool aEnabled);
Enables or Disables the redraw store for a window.
The window server can store the operations needed to redraw a window. This is the default behaviour, and is desired in most cases. Under certain circumstances, however, client side redrawing is essential, and then this function should be called to disable the redraw store.
Windows which do not use the redraw store will not display correctly when visible through a transparent window.
|
IMPORT_C TInt SetTransparencyAlphaChannel();
Sets the window to be transparent using the alpha channel. Only valid when using a display mode which supports alpha blending
Transparent windows require redraw storing to be turned on, if it is not already it will be turned on for this window by calling this function.
|
IMPORT_C TInt SetTransparentRegion(const TRegion &aRegion);
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. 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.
|
|
![[Top]](../../../../a_stock/arrow_up_2.gif){kind=icon}
RWindow::SetTransparencyFactor()RWindow::SetTransparencyBitmap()RWindow::SetTransparencyAlphaChannel()IMPORT_C TInt SetTransparencyPolicy(TWsTransparencyPolicy aPolicy);
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.
|
|
IMPORT_C TBool IsRedrawStoreEnabled();
Returns whether the window uses a redraw store to store drawing commands.
This function always causes a flush of the window server buffer.
|
IMPORT_C void EnableOSB(TBool);
Enables/Disables the WSERV to use its OSB
|
|
Copyright ©2008 Symbian Software Ltd. |
|
![[Previous]](../../../../a_stock/btn_prev.gif){kind=small}
![[Top]](../../../../a_stock/btn_top.gif)
![[Next]](../../../../a_stock/btn_next.gif){kind=small}