Class RWindowGroup

class RWindowGroup : public RWindowTreeNode;

Description

Client-side handle to a server-side window group.

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.

• RWindowGroup - Client-side handle to a server-side window group.

Members

Defined in RWindowGroup:

• AddPriorityKey(TUint,TUint,TUint)Adds a priority key.
• AllowProcessToCreateChildWindowGroups(TUid)Allows a Window Group in the specified process to be be a child of this one
• AutoForeground(TBool)Sets or disables auto-foreground behaviour.
• CancelCaptureKey(TInt32)Cancels a request for key capture.
• CancelCaptureKeyUpAndDowns(TInt32)Cancels a capture request for a key up or key down event.
• CancelCaptureLongKey(TInt32)Cancels a previous long key capture request.
• CancelTextCursor()Removes the text cursor.
• CaptureKey(TUint,TUint,TUint)Requests key capture.
• CaptureKey(TUint,TUint,TUint,TInt)Requests key capture, with a priority.
• CaptureKeyUpAndDowns(TUint,TUint,TUint)Requests the capture of key-up and key-down events on behalf of a window group.
• CaptureKeyUpAndDowns(TUint,TUint,TUint,TInt)Requests the capture of key-up and key-down events on behalf of a window group. ...
• CaptureLongKey(TTimeIntervalMicroSeconds32,TUint,TUint,TUint,TUint,TInt,TUint)Requests capture of long key presses.
• CaptureLongKey(TUint,TUint,TUint,TUint,TInt,TUint)Requests capture of long key presses.
• ClearChildGroup()Clears all children of the current window group.
• Construct(TUint32)Completes construction of a window group.
• Construct(TUint32,TBool)Completes the construction of a window group, setting its initial focus state.
• ConstructChildApp(TInt,TUint32)Completes construction of a window group.
• ConstructChildApp(TInt,TUint32,TBool)Completes construction of a window group.
• DisableKeyClick(TBool)Disables key clicks.
• DisableScreenChangeEvents()Disables screen change event sending.
• EnableReceiptOfFocus(TBool)Enables or disables receipt of keyboard focus.
• EnableScreenChangeEvents()Enables screen change event sending.
• Identifier()constGets the identifier of the window group.
• Name(TDes &)constGets the window group's name, as set by RWindowGroup::SetName(const TDesC &)...
• RWindowGroup()Creates a sessionless, uninitialised window group handle.
• RWindowGroup(RWsSession &)Creates an initialised window group handle within a server session.
• RemovePriorityKey(TUint,TUint,TUint)Removes a priority key.
• SetChildGroup(TInt)Sets a window group chain onto the current window group.
• SetName(const TDesC &)Sets the window group's name.
• SetOrdinalPositionErr(TInt,TInt)Sets the ordinal position and ordinal priority of a window.
• SetOrdinalPriorityAdjust(TInt)Sets the window group's priority adjust value.
• SetOwningWindowGroup(TInt)Sets the owning window group for this window group.
• SetTextCursor(RWindowBase &,const TPoint &,const TTextCursor &)Sets the text cursor.
• SetTextCursor(RWindowBase &,const TPoint &,const TTextCursor &,const TRect &)Sets the text cursor and its clipping rectangle.
• SimulatePointerEvent(TRawEvent)Simulates a pointer event.

Inherited from MWsClientClass:

• WsHandle()constGets the server side handle for the object.

Inherited from RWindowTreeNode:

• Child()constGets the first child of the node.
• ClearPointerCursor()Clears pointer cursor settings.
• ClientHandle()constGets the window's client handle
• Close()Closes the node.
• Destroy()Closes and deletes the node.
• DisableErrorMessages()Cancels notification of error message events.
• DisableFocusChangeEvents()Disables delivery of focus changed events.
• DisableGroupChangeEvents()Cancels notification of group changed events.
• DisableGroupListChangeEvents()Disables reporting of window group list change events.
• DisableModifierChangedEvents()Cancels notification of modifier changed events.
• DisableOnEvents()Cancels notification of 'on' events.
• DisableVisibilityChangeEvents()Disables reporting of window visibility change events.
• EFadeIncludeChildrenInclude all child windows when fading/un-fading.
• EFadeWindowOnlyFade only the parent window.
• EnableErrorMessages(TEventControl)Requests notification of error message events.
• EnableFocusChangeEvents()Enables focus changed events.
• EnableGroupChangeEvents()Requests notification of group-change events.
• EnableGroupListChangeEvents()Enables reporting of window group list change events.
• EnableModifierChangedEvents(TUint,TEventControl)Requests notification of modifier changed events.
• EnableOnEvents(TEventControl)Requests notification of 'on' events. 'On' events are of type EEventSwitchOn.
• EnableVisibilityChangeEvents()Enables reporting of window visibility change events.
• FullOrdinalPosition()constGet the current full ordinal position of a window.
• NextSibling()constGets the next window after this one in its sibling list.
• OrdinalPosition()constGets the current ordinal position of the window tree node.
• OrdinalPriority()constGets the ordinal priority of the specified window.
• Parent()constGets the node's parent.
• PrevSibling()constGets the node before this one in the sibling list.
• SetCustomPointerCursor(const RWsPointerCursor &)Sets the pointer cursor to an application-defined cursor.
• SetFaded(TBool,TFadeControl)Sets the window as faded or unfaded.
• SetFaded(TBool,TFadeControl,TUint8,TUint8)Sets one or more windows as faded or unfaded, specifying a fading map.
• SetNonFading(TBool)Sets whether a window is non-fading.
• SetOrdinalPosition(TInt)Sets the ordinal position of a window.
• SetOrdinalPosition(TInt,TInt)Sets the ordinal position and ordinal priority of a window.
• SetPointerCursor(TInt)Sets the pointer cursor from the system pointer cursor list.
• TFadeControlFade control flags.
• WindowGroupId()Returns the window group Id of the parent window group

IMPORT_C RWindowGroup();

Description

Creates a sessionless, uninitialised window group 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 RWindowGroup(RWsSession &aWs);

Description

Creates an initialised window group handle within a server session.

Parameters

IMPORT_C TInt Construct(TUint32 aClientHandle);

Description

Completes construction of a window group.

Construction must be complete before any other window group methods can be called.

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

Parameters

Return value

See also:

• RWindow::Construct(const RWindowTreeNode &,TUint32)Completes the construction of the window handle.

IMPORT_C TInt Construct(TUint32 aClientHandle, TBool aIsFocusable);

Description

Completes the construction of a window group, setting its initial focus state.

Construction must be complete before any other window group methods can be called.

aInitialFocusState can be specified in order to prevent a window group from automatically taking the keyboard focus when it is created. If specified, it sets the initial focus state of the window group. If a window group has a focus state of ETrue (the default), it can receive keyboard focus; if EFalse, it is prevented from receiving keyboard focus until this setting is changed. If a window group is constructed without specifying an initial focus state, keyboard focus will be enabled by default and the window group will receive keyboard focus automatically when it is created. To prevent this, set aInitialFocusState to EFalse.

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

Parameters

Return value

See also:

• RWindowGroup::EnableReceiptOfFocus(TBool)Enables or disables receipt of keyboard focus.
• RWindow::Construct(const RWindowTreeNode &,TUint32)Completes the construction of the window handle.

IMPORT_C TInt ConstructChildApp(TInt aIdOfParentWindowGroup, TUint32 aClientHandle);

Description

Completes construction of a window group.

Construction must be complete before any other window group methods can be called.

The purpose of this Construct function for RWindowGroup is that it allows chains of window groups to be created. When one of the window groups in a chain is moved with SetOrdinalPosition then all window groups in that chain will be moved to be consecutative, with the parent being at the back in the Z-order. The purpose of this feature is to allow embedding of applications.

Note: The term parent should not be confused with the paremeter used in the function RWindow::Construct(const RWindowTreeNode &,TUint32). There it means that this window is a child of that window in the tree. Here is just means that the two window groups involved will have an extra association. Note: This window group will be given the same ordinal priority as it's parent window group.

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

Parameters

Return value

See also:

• RWindow::Construct(const RWindowTreeNode &,TUint32)Completes the construction of the window handle.

IMPORT_C TInt ConstructChildApp(TInt aIdOfParentWindowGroup, TUint32 aClientHandle, TBool aIsFocusable);

Description

Completes construction of a window group.

Construction must be complete before any other window group methods can be called.

This Construct function of RWindowGroup allows both the creation of the group window in a chain and for and for it not to recieve focus.

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

Parameters

Return value

See also:

• RWindow::Construct(const RWindowTreeNode &,TUint32)Completes the construction of the window handle.

IMPORT_C void AllowProcessToCreateChildWindowGroups(TUid aProcessSID);

Description

Allows a Window Group in the specified process to be be a child of this one

This function will need to be called to allow another window group to become a child window group of this one.

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

Parameters

IMPORT_C void EnableReceiptOfFocus(TBool aState);

Description

Enables or disables receipt of keyboard focus.

The front most focusable window has keyboard focus. This function sets whether or not the window can receive keyboard focus.

Parameters

IMPORT_C void AutoForeground(TBool aState);

Description

Sets or disables auto-foreground behaviour.

If this behaviour is set for a window, it will automatically be given ordinal position zero whenever a pointer event of type EButton1Down occurs in any of its child windows. This will cause it to be brought to the foreground, unless another window group exists with a higher priority.

A window group that is moved to the foreground will automatically get keyboard focus unless it has explicitly had receipt-of-focus disabled or there is a focusable window group of higher priority. See RWindowGroup::EnableReceiptOfFocus(TBool).

Parameters

IMPORT_C void SetOrdinalPriorityAdjust(TInt aAdjust);

Description

Sets the window group's priority adjust value.

This function is primarily designed for sessions that own multiple window groups. After this function has been called by a window group, that window group's priority will be adjusted by the amount given by aAdjust whenever another window group owned by the same session gains keyboard focus.

When the session loses focus, the priority returns to its original value.

Note: This is ignored for window groups in chains.

Parameters

IMPORT_C TInt SetOrdinalPositionErr(TInt aPos, TInt aOrdinalPriority);

Description

Sets the ordinal position and ordinal priority of a window.

Ordinal priority is a number assigned to a window that determines its position in the z-order. For a description of ordinal priority, see the RWindowTreeNode::SetOrdinalPosition(TInt) function. To set a priority of KPasswordWindowGroupPriority or greater, client will require SwEvent capability. If client does not have SwEvent capability then it will return error code.

Note: If this window is a window group in a chain, then all other window groups in the chain will be moved also. And further they will all have their ordinal priority set to the specified value. When this function is called on Window with aPos set to KOrdinalPositionSwitchToOwningWindow then the function doesn't change the ordinal position of the window, if instead it has focus then the window that would come to the forground if it died will be moved to the foreground.

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

Parameters

Return value

IMPORT_C TInt32 CaptureKey(TUint aKeycode, TUint aModifierMask, TUint aModifier);

Description

Requests key capture.

This function instructs the window server to send key events (of type EEventKey) with the specified key code and modifier state to this window group, regardless of which window group currently has the keyboard focus.

Key events for the key given by aKeyCode are captured only when the modifier keys specified by aModifierMask are in the states specified by aModifier. For example, calling

wsGroup->CaptureKey(EKeyDevice2, EModifierAlt|EModifierCtrl, EModifierCtrl); 

will capture the EKeyDevice2 key only if Ctrl is pressed and Alt is not.

Normally, keyboard key presses result in three events being delivered to the client: EEventKeyDown, EEventKey and EEventKeyUp. However, RWindowGroup::CaptureKey(TUint,TUint,TUint) results in only the EEventKey being delivered to the window group that called it: the EEventKeyUp and EEventKeyDown events are sent to the window group that has focus. If a window group wishes to capture the EEventKeyUp and EEventKeyDown events as well as the EEventKey, it should call RWindowGroup::CaptureKeyUpAndDowns(TUint,TUint,TUint).

Note that a window group can call this function more than once (to request capture for more than one key), and more than one window group may have requested key capture. If multiple window groups have requested to capture the same key using this function, the key is sent to the window group that most recently requested the key capture.

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

Parameters

Return value

IMPORT_C TInt32 CaptureKey(TUint aKeycode, TUint aModifierMask, TUint aModifier, TInt aPriority);

Description

Requests key capture, with a priority.

This function instructs the window server to send key events (of type EEventKey) with the specified key code and modifier state to this window group, regardless of which window group currently has the keyboard focus.

Key events for the key given by aKeyCode are captured only when the modifier keys specified by aModifierMask are in the states specified by aModifier. For example, calling

wsGroup->CaptureKey(EKeyDevice2, EModifierAlt|EModifierCtrl, EModifierCtrl, priority); 

will capture the EKeyDevice2 key only if Ctrl is pressed and Alt is not.

Normally, keyboard key presses result in three events being delivered to the client: EEventKeyDown, EEventKey and EEventKeyUp. However, RWindowGroup::CaptureKey(TUint,TUint,TUint) results in only the EEventKey being delivered to the window group that called it: the EEventKeyUp and EEventKeyDown events are sent to the window group that has focus. If a window group wishes to capture the EEventKeyUp and EEventKeyDown events as well as the EEventKey, it should call RWindowGroup::CaptureKeyUpAndDowns(TUint,TUint,TUint).

Note that a window group can call this function more than once (to request capture for more than one key), and more than one window group may have requested key capture. If multiple window groups have requested to capture the same key at the same priority, the key is sent to the window group that most recently requested the key capture.

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

Parameters

Return value

IMPORT_C void CancelCaptureKey(TInt32 aCaptureKey);

Description

Cancels a request for key capture.

Use this function to cancel a request to capture a key previously made with RWindowGroup::CaptureKey(TUint,TUint,TUint). If the value passed in aHotKey is not a valid capture key handle, this function will cause a panic.

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

Parameters

IMPORT_C TInt32 CaptureKeyUpAndDowns(TUint aScanCode, TUint aModifierMask, TUint aModifier);

Description

Requests the capture of key-up and key-down events on behalf of a window group.

This function requests the window server to send EEventKeyUp and EEventKeyDown key events from the specified key to this window group, regardless of which window group currently has the keyboard focus. This contrasts with RWindowGroup::CaptureKey(TUint,TUint,TUint), which causes the window server to send the EEventKey event.

Key events for the key given by aScanCode are captured only when the modifier keys specified by aModifierMask are in the states specified by aModifiers. See RWsSession::SetHotKey(THotKey,TUint,TUint,TUint) for examples of how to set aModifierMask and aModifiers.

Note: in general, keyboard key presses result in three events being delivered to the client: EEventKeyDown, EEventKey and EEventKeyUp.

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

Parameters

Return value

IMPORT_C TInt32 CaptureKeyUpAndDowns(TUint aScanCode, TUint aModifierMask, TUint aModifier, TInt aPriority);

Description

Requests the capture of key-up and key-down events on behalf of a window group. This function is identical to the other overload, except that it allows a priority to be specified. This function always causes a flush of the window server buffer.

Parameters

Return value

IMPORT_C void CancelCaptureKeyUpAndDowns(TInt32 aCaptureKey);

Description

Cancels a capture request for a key up or key down event.

Use this function to cancel a request to capture a key, previously made with RWindowGroup::CaptureKeyUpAndDowns(TUint,TUint,TUint). If the value passed in aHotKey is not a valid capture key handle, this function will cause a panic.

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

Parameters

IMPORT_C TInt32 CaptureLongKey(TUint aInputKeyCode, TUint aOutputKeyCode, TUint aModifierMask, TUint aModifier,TInt aPriority, TUint aFlags);

Description

Requests capture of long key presses.

This function causes the window server to send a long key event (which is generated when the key has been held down for the initial keyboard repeat time), to this window group, regardless of whether it currently has keyboard focus. The key that is output can have a different key code to the key that was captured.

Key events for the key given by aInputKeyCode are captured only when the modifier keys specified by aModifierMask are in the states specified by aModifiers.

A priority can be specified to resolve any conflicts that arise when multiple window groups attempt to capture the same long key event.

Normal key press behaviour (where no long key press capture requests have been made) is as follows. When a key is pressed, a key down event occurs, followed by one or more standard (short) key events, followed by a key up event. All of these key events are sent to the application in the foreground.

Key press behaviour when an application has made a long key press capture request is as follows. When the key is pressed and held down, a long key event is generated in addition to the events described above (although if a long key event occurs, then there will never be more than one standard key event) and this is sent to the application that made the request, even if it is not in the foreground.

If that application also wants to capture the up and down key events then it needs to call RWindowGroup::CaptureKeyUpAndDowns(TUint,TUint,TUint). If it wants to capture the standard key event, then it needs to call RWindowGroup::CaptureKey(TUint,TUint,TUint). Depending on flags (enumerated in TLongCaptureFlags) specified when making the long key capture request, the standard key event can either be generated when the key is pressed, as it would be if no long key capture request had been made, or it can be generated when the key is released. In the latter case, the standard key event is only generated if the key was not held down long enough to generate a long key event.

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

Parameters

Return value

See also:

• TLongCaptureFlagsFlags which customise a long key press capture request made by a window group.

IMPORT_C TInt32 CaptureLongKey(TTimeIntervalMicroSeconds32 aRepeatTime, TUint aInputKeyCode, TUint aOutputKeyCode,TUint aModifierMask, TUint aModifier, TInt aPriority, TUint aFlags);

Description

Requests capture of long key presses.

This function causes the window server to send a long key event (which is generated when the key has been held down for the specified time), to this window group, regardless of whether it currently has keyboard focus.

For more information on this function, see the other RWindowGroup::CaptureLongKey(TUint,TUint,TUint,TUint,TInt,TUint) overload.

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

Parameters

Return value

See also:

• TLongCaptureFlagsFlags which customise a long key press capture request made by a window group.

IMPORT_C void CancelCaptureLongKey(TInt32 aCaptureKey);

Description

Cancels a previous long key capture request.

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

Parameters

IMPORT_C TInt AddPriorityKey(TUint aKeycode, TUint aModifierMask, TUint aModifier);

Description

Adds a priority key.

Priority key events are typically used for providing "Abort" or "Escape" keys for an application. For priority key events to occur they must first be configured using this function. Functions provided by RWsSession can then be used to get priority key events. Note that unlike other events, the Control Framework does not get priority key events for you.

Priority key events for the key given by aKeyCode are only delivered when the modifier keys specified by aModifierMask are in the states specified by aModifiers. See RWsSession::SetHotKey(THotKey,TUint,TUint,TUint) for examples of how to use aModifierMask and aModifiers.

More than one priority key can be added for each keycode, each having a different set of modifier requirements.

Note: if you press a priority key while another is waiting to be sent to the client then the first key is lost.

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

Parameters

Return value

IMPORT_C void RemovePriorityKey(TUint aKeycode, TUint aModifierMask, TUint aModifier);

Description

Removes a priority key.

Use this function to remove a priority key that was added using RWindowGroup::AddPriorityKey(TUint,TUint,TUint). If the specified priority key does not exist, this function does nothing.

Note: all 3 parameters must match exactly for a successful removal.

Parameters

IMPORT_C void SetTextCursor(RWindowBase &aWin, const TPoint &aPos, const TTextCursor &aCursor);

Description

Sets the text cursor.

Use this function to set a text cursor for this window group, or to change the existing text cursor's position or appearance.

Parameters

IMPORT_C void SetTextCursor(RWindowBase &aWin, const TPoint &aPos, const TTextCursor &aCursor, const TRect &aClipRect);

Description

Sets the text cursor and its clipping rectangle.

Use this function to set a text cursor for this window group, or to change the existing text cursor's position or appearance.

The cursor is clipped to aClipRect. This allows, for example, the window to have a border region in which the cursor is not displayed.

Parameters

IMPORT_C void CancelTextCursor();

Description

Removes the text cursor.

Use this function to remove the current text cursor from this window group. This function does nothing if the cursor is currently in another window group.

IMPORT_C void SetOwningWindowGroup(TInt aIdentifier);

Description

Sets the owning window group for this window group.

The owning window group is the group that is brought to the foreground when the window group which has keyboard focus (the foreground application) dies.

If the owning window group is not set, then the window group brought to the foreground when the application dies will be the default owning window group.

Parameters

IMPORT_C TInt SetName(const TDesC &aName);

Description

Sets the window group's name.

Use this function to set the name of a window group. Window group names are arbitrary and can contain any data that can be stored in a descriptor of type TDesC.

Note: if this function is successful, a window group change event is sent to everything that is set up to receive these events.

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

Parameters

Return value

IMPORT_C TInt Name(TDes &aWindowName) const;

Description

Gets the window group's name, as set by RWindowGroup::SetName(const TDesC &).

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

Parameters

Return value

IMPORT_C TInt Identifier() const;

Description

Gets the identifier of the window group.

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

Return value

IMPORT_C void DisableKeyClick(TBool aState);

Description

Disables key clicks.

If a window group calls this function with aState=ETrue, key clicks (i.e. the sound generated when keys are pressed) will be disabled whenever this window group has the keyboard focus. Key clicks for this window group can be re-enabled by calling this function with aState=EFalse.

Note that this function doesn't do anything in v6.0 and v6.1.

Parameters

IMPORT_C TInt EnableScreenChangeEvents();

Description

Enables screen change event sending.

This function ensures that window groups are sent screen change events, which are sent, for example, when the cover on a phone that supports screen flipping is opened or closed.

Note that not getting screen change events is the default behaviour.

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

Return value

See also:

• RWindowGroup::DisableScreenChangeEvents()Disables screen change event sending.

IMPORT_C void DisableScreenChangeEvents();

Description

Disables screen change event sending.

This function prevents window groups from getting screen change events, which are sent, for example, when the cover on a phone that supports screen flipping is opened or closed.

Note that not getting screen change events is the default behaviour.

See RWindowGroup::EnableScreenChangeEvents().

IMPORT_C void SimulatePointerEvent(TRawEvent aEvent);

Description

Simulates a pointer event.

This function sends a pointer event to the window as if it had come from the kernel, except that it will be sent to a window which is a child of the window group it is called on.

Notes:

The function can be used to send a pointer event to an application when it is in the background.

The function is supported for testing purposes only.

Parameters

IMPORT_C TInt ClearChildGroup();

Description

Clears all children of the current window group.

The window group chain is broken directly after the current window group. In the general case (consider clearing the child group of a window group in the middle of a long chain), this results in two distinct chains. In the special cases where either the parent window group or the child window group ends up as the only member of a resultant chain, it is removed from that chain.

Return value

See also:

• RWindowGroup::SetChildGroup(TInt)Sets a window group chain onto the current window group.

IMPORT_C TInt SetChildGroup(TInt aId);

Description

Sets a window group chain onto the current window group.

Appends all the window groups chained to the child window group onto the chain containing the current window group.

Parameters

Return value

See also:

• RWindowGroup::ClearChildGroup()Clears all children of the current window group.