RWsSession Class Reference

Sends an event to a window group.

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

Sends a message to all window groups.

In order to receive messages sent using this function you will need to implement the MCoeMessageObserver interface which is defined in the UI Control Framework API.

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

Deprecated

Sends a message to all window groups with the specified priority.

In order to receive messages sent using this function you will need to implement the MCoeMessageObserver interface which is defined in the UI Control Framework API.

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

Deprecated

Sends a message to a window group.

The window group will then receive an event of type EEventMessageReady notifying it that a message has been received. The window group can belong to this or another session.

In order to receive messages sent using this function you will need to implement the MCoeMessageObserver interface which is defined in the UI Control Framework API.

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

See also: MCoeMessageObserver

Sets a session's auto-flush state.

If auto-flush is set to ETrue, the window server buffer is flushed immediately anything is put into it, instead of waiting until it becomes full. This setting is normally used only in a debugging environment.

If the auto-flush state is EFalse, the window server buffer is flushed normally.

See also: RWsSession::Flush() RWsSession::SetBufferSizeL() RWsSession::SetMaxBufferSizeL()

Sets the background colour for the window server.

This background can only be seen in areas of the display that have no windows on them: so for many applications it will never be seen. It affects no other windows.

Sets both the buffer size and maximum buffer size for queuing commands to send to the Windows Server. The value should be at least the size of the largest message that will be sent, otherwise a panic of the client may occur.

The minimum possible buffer size is 640 and the maximum possible size is 16384 bytes. The default size of 640 bytes is sufficient for most uses.

Larger buffers can reduce drawing flicker by allowing more drawing commands to be collected in the buffer before being sent to the server.

Smaller buffers conserve system memory.

Can be used to set a minimum buffer size, sufficient for largest drawing command used, before calling RWsSession::SetMaxBufferSizeL() to set a maximum buffer size for queuing commands.

See also: RWsSession::Flush() RWsSession::SetAutoFlush() RWsSession::SetMaxBufferSizeL()

Sets the current mode for the pointer cursor.

The mode determines which sprite is used for the pointer cursor at any point. See TPointerCursorMode for more information.

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

See also: TPointerCursorMode

Sets Z coordinate threshold values for TPointerEvent::EEnterCloseProximity and TPointerEvent::EExitCloseProximity events. As proximity occupies the negative range of Z coordinates, on most platforms threshold values for these events should be specified as negative.

However, all possible Z coordinate values are accepted by this method regardless of the fact that positive Z coordinate values are interpreted as pressure and only negative Z coordinate values are interpreted as proximity. This means that if a particular platform supports an Up pointer state while a pointer is touching the screen, it is possible to base the firing of EnterCloseProximity/ExitCloseProximity events on pressure readings by specifying positive threshold values.

EnterCloseProximity/ExitCloseProximity event generation can be switched off completely by specifying the following thresholds: aEnterCloseProximityThreshold = KMaxTInt, aExitCloseProximityThreshold = KMinTInt.

This method is supposed to be used only by the UI platform or device's configuration tool.

Modified thresholds will be persisted across system reboots in the following HAL attributes: HALData::EPointer3DEnterCloseProximityThreshold, HALData::EPointer3DExitCloseProximityThreshold.

If this method is never called on a particular device, the default threshold values defined by this device's manufacturer are used.

See also: TPointerEvent::EEnterCloseProximity TPointerEvent::EExitCloseProximity HALData::EPointer3DEnterCloseProximityThreshold HALData::EPointer3DExitCloseProximityThreshold To become released with WSERV NGA APIs

Adds a custom text cursor to the server's list of cursors.

After adding a custom text cursor, it can be selected for use by calling RWindowGroup::SetTextCursor().

Note that once added, custom text cursors cannot be removed.

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

Sets the default fading parameters.

Fading is used to change the colour of windows to be either closer to white or closer to black, so that another window stands out. For example, when displaying a dialogue you could fade all visible windows, then unfade the dialog window. This function sets whether, and the amount by which, faded windows appear closer to white or closer to black.

The white and black mapping values define the range over which colours are re-mapped when a window is faded. If aBlackMap=0 and aWhiteMap=255 then the colours are mapped unchanged. As the two values get closer together, all colours in the faded window becomes more similar - creating the fading effect. When the numbers cross over (so that the black value is greater than the white value) the colours in the faded window start to invert - i.e. colours that were closer to white in the unfaded window are mapped to a darker colour in the faded window.

Changing the default will automatically apply to current graphics contexts but will not have any affect on windows that are already faded.

Note: RWindowTreeNode::SetFaded(), CWindowGc::SetFaded() and RWsSession::SetSystemFaded() use these fading parameters, and in addition allow the default fading value to be overridden.

See also: RWindowTreeNode::SetFaded() CWindowGc::SetFadingParameters()

Sets the default system pointer cursor.

This function can only be called by the owner of the system pointer cursor list. By default the 0th entry in the pointer cursor list is assigned as the system pointer. The function allows any cursor from the list or even no cursor to be set as the system pointer cursor.

Note: ownership of the system pointer cursor list can be obtained by calling ClaimSystemPointerCursorList() when no-one else has ownership.

Sets the system-wide double click settings.

Double click distance is measured, in pixels, as the sum of the X distance moved and the Y distance moved between clicks. For example: a first click at 10, 20 and a second click at 13,19 gives a distance of (13-10)+(21-20) = 4.

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

See also: GetDoubleClickSettings()

Set focus screen

Sets Z coordinate threshold values for TPointerEvent::EEnterHighPressure and TPointerEvent::EExitHighPressure events. As pressure occupies the positive range of Z coordinates, on most platforms threshold values for these events should be specified as positive values.

However, all possible Z coordinate values are accepted by this method regardless of the fact that only the positive Z coordinate values are interpreted as pressure and the negative Z coordinate values are interpreted as proximity. This means that if a particular platform supports the Down pointer state while a pointer is in proximity to the screen, it is possible to base the firing of EnterHighPressure/ExitHighPressure events on proximity readings by specifying negative threshold values.

EnterHighPressure/ExitHighPressure event generation can be switched off completely by specifying the following thresholds: aEnterHighPressureThreshold = KMaxTInt, aExitHighPressureThreshold = KMinTInt.

This method is supposed to be used only by the UI platform or device's configuration tool.

Modified thresholds will be persisted across system reboots in the following HAL attributes: HALData::EPointer3DEnterHighPressureThreshold, HALData::EPointer3DExitHighPressureThreshold.

If this method is never called on a particular device, the default threshold values defined by this device's manufacturer are used.

See also: TPointerEvent::EEnterHighPressure TPointerEvent::EExitHighPressure HALData::EPointer3DEnterHighPressureThreshold HALData::EPointer3DExitHighPressureThreshold To become released with WSERV NGA APIs

Sets the hot keys.

Hot keys allow standard functions to be performed by application-defined key combinations.

This function maps any key press (with optional modifiers) to one of the hot keys defined in THotKey. More than one key combination may be mapped to each hot key: a new mapping is added each time the function is called.

Modifier key states are defined in TEventModifier. The modifiers that you want to be in a particular state should be specified in aModifierMask and the ones of these you want to be set should be specified in aModifiers. For example, if you want to capture FN-A and you want the SHIFT modifier unset, but you don't care about the state of the other modifiers then set both the flags for SHIFT and FN in aModiferMask and only set FN in aModifiers.

Note: default hotkey settings exist, but this function can be used for customisation. Typically it might be be used by a shell application or other application that controls system-wide settings.

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

Sets the system-wide keyboard repeat rate.

This is the rate at which keyboard events are generated when a key is held down.

The default settings for the keyboard repeat rate are 0.3 seconds for the initial delay, and 0.1 seconds for the interval between subsequent repeats. However, since the settings are system-wide, these will not necessarily be the current settings when an application is launched: the settings may have been over-ridden by another module.

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

See also: GetKeyboardRepeatRate()

Sets the maximum size that the buffer for queuing commands to send to the Windows Server can expand to.

The minimum possible buffer size is 640 and the maximum possible size is 16384 bytes.

If the buffer size is larger than the new maximum it is reduced.

A minimum size is calculated to be one quarter the maximum size, but in any case at least 640 bytes. If the buffer size is smaller than the calculated minimum it is expanded.

RWsSession::SetBufferSizeL() can be used to set a specific minimum size >640 bytes before setting a maximum size. This is useful if you will send very large drawing commands.

After calling this function the buffer size will be between the specified maximum and calculated minimum sizes.

The algorithm for growing the buffer up to the maximum is chosen to balance the cost of expanding the buffer with the waste of an excessively large buffer that is never filled.

If the buffer becomes too full to add a new drawing command, and the buffer size is less than the maximum, the buffer size will be expanded. If the buffer is already at the maximum size, or the expansion fails due to low memory, the buffer will be emptied with RWsSession::Flush(). If there is not enough space now for the new command a panic occurs.

See also: RWsSession::Flush() RWsSession::SetAutoFlush() RWsSession::SetBufferSizeL()

Sets the state of the modifier keys.

This function is typically used for permanent modifier states such as Caps Lock or Num Lock, but other possible uses include on-screen function key simulation, or the implementation of a Shift Lock key.

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

See also: GetModifierState()

Sets the area of the screen in which the virtual cursor can be used while in relative mouse mode, for the first screen display mode.

This function sets the area for the first screen mode - the one with index 0, which in most devices will be the only screen mode. The other function overload can be used to set the screen area for other modes. The area is set and stored independently on each screen mode, so that it is not necessary to call this function again when switching back to the first screen mode.

The default area is the full digitiser area. When you set the area it will come into immediate affect, i.e. if necessary the current pointer position will be updated to be within the new area.

Notes:

Relative mouse mode is where the events received from the base by window server are deltas from the last position of the pointer, as opposed to absolute co-ordinates.

This function is honoured even if there is a mouse or pen (e.g. on the emulator), by mapping the co-ordinates of where you click into the area set using this function. However the function does not restrict clicks outside of the 'drawing area' on the Emulator, to allow you to select items on the fascia.

Sets the area of the screen in which the virtual cursor can be used while in relative mouse mode, for a specified screen display mode.

The default area is the full digitiser area for the given mode. When you set the area it will come into immediate affect, i.e. if necessary the current pointer position will be updated to be within the new area.

The area is set and stored independently on each screen mode, so that it is not necessary to call this function again when switching back to a mode.

Notes:

Relative mouse mode is where the events received from the base by window server are deltas from the last position of the pointer, as opposed to absolute co-ordinates.

The previous function overload may be used to set the screen area for only the first mode.

This function is honoured even if there is a mouse or pen (e.g. on the emulator), by mapping the co-ordinates of where you click into the area set using this function. However the function does not restrict clicks outside of the 'drawing area' on the Emulator, to allow you to select items on the fascia.

Sets the current mode for the pointer cursor.

The mode determines which sprite is used for the pointer cursor at any point. The request is ignored unless the calling application is the application that currently has keyboard focus. See TPointerCursorMode for more information.

See also: TPointerCursorMode

Sets the pointer cursor position.

This function allows an application to move the virtual cursor. It works in all modes, not just relative mouse mode.

Note: the function works in screen co-ordinates and honours the pointer cursor area exactly as pen presses do, i.e. only when they are in the drawing area on the Emulator.

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

This method has been deprecated. Shadowing of a window is no longer supported. Calling it has no effect. Deprecated

Sets all windows in the system as faded or unfaded, using the default fading parameters.

This function allows all windows that currently exist, not just those in a single window group, to be faded or unfaded.

Notes: The window server generates a redraw to un-fade a window, because information is lost during fading. Blank (RBlankWindow) and backup (RBackupWindow) windows deal with this themselves. Areas in shadow when the window is faded will also have redraw events generated for them by the window server. While a window is faded, all drawing to that window will be adjusted appropriately by the window server.

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

Sets all windows in the system as faded or unfaded, overriding the default fading parameters (as set by SetDefaultFadingParameters()).

This function allows all windows that currently exist, not just those in the same window group, to be faded or unfaded.

Notes: Fading a window for a second time (that is fading it when it is already faded) will not change the fading map used. The window server generates a redraw to un-fade a window, because information is lost during fading. Blank (RBlankWindow) and backup (RBackupWindow) windows deal with this themselves. Areas in shadow when the window is faded will also have redraw events generated for them by the window server. While a window is faded, all drawing to that window will be adjusted appropriately by the window server.

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

Sets a cursor in the system pointer cursor list.

To gain access to the list, the client must first call ClaimSystemPointerCursorList().

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

Sets the ordinal position of a window group.

This function allows the caller to change the ordinal position of an existing window group. It would typically be used by a shell application.

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

This method has been deprecated. Shadowing of a window is no longer supported. Calling it has no effect. Deprecated

Sends a simulated key event to the window server.

All the fields in TKeyEvent are honoured except iRepeats, which is overridden with zero.

Simulates raw events.

For most purposes, RWsSession::SimulateKeyEvent() should be used instead to simulate key events because low-level scan-code up/down events are not meaningful to anything other than the keyboard to which they apply.

For example, the driver for an external keyboard should do its own conversion from raw scan-codes to higher-level character code key events and pass these to the window server using SimulateKeyEvent().

Sends all pending commands in the buffer to the window server.