Default C++ constructor.

Constructs an uninitialised window server session. Note that it does not establish a connection to the window server - this must be done explicitly by calling the session's Connect() function. Before Connect() is called, no corresponding session object exists in the server, and the RWsSession contains no meaningful handle.

Claims the system pointer cursor list.

You must call this function before you can call SetSystemPointerCursor() or ClearSystemPointerCursor().

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

Clear the redraw store for all windows in the system By default Windows will recorded the drawing commands used during a redraw and use them latter if the window needs to be redrawn. Calling this function will cause all these stores to be thrown away redraw will then be sent to all window, visible windows will recieve them first.

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

Clears the default system pointer cursor.

This sets the pointer to the current default system pointer cursor to NULL.

Clears all mappings for the specified hotkey, including the default mapping.

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

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

Clears a system pointer cursor from the list.

Before calling this function, the client must first gain access to the list by calling ClaimSystemPointerCursorList().

Closes the window server session.

This function cleans up all resources in the RWsSession and disconnects it from the server. Prior to disconnecting from the window server, the client-side window server buffer is destroyed without being flushed. This function should be called when the RWsSession is no longer needed - normally just before it is destroyed.

Sets the mode used to control process priorities.

The default window server behaviour is that the application that owns the window with keyboard focus gets foreground process priority (EPriorityForeground) while all other clients get background priority (EPriorityBackground). This function can be used to over-ride this default behaviour, as discussed in TComputeMode.

Note:

Unlike real Symbian phones, the Emulator runs on a single process. As a result, on the Emulator this function sets the priority of individual threads rather than of processes. The values used for thread priorities are EPriorityLess instead of EPriorityBackground, and EPriorityNormal instead of EPriorityForeground.

Connects the client session to the window server.

Connect() should be the first function called on an RWsSession object after it is created. The function establishes a connection to the window server, creating a corresponding session object in the server. Each session has one and only one connection to the server. Attempting to call Connect() when a connection has already been made will cause a panic.

After a connection has been successfully established, all events are delivered to the client application through the RWsSession object.

Connects the client session to the window server using pre constructed file server session.

Connect() should be the first function called on an RWsSession object after it is created. The function establishes a connection to the window server, creating a corresponding session object in the server. Each session has one and only one connection to the server. Attempting to call Connect() when a connection has already been made will cause a panic.

After a connection has been successfully established, all events are delivered to the client application through the RWsSession object.

Dummy implementation in order to preserve compatibility with WSERV NGA.

Requests standard events from the window server.

Standard events include all events except redraws and priority key events.

The client application will typically handle the completed request using the RunL() function of an active object, and in this case the request status aStat should be the iStatus member of that CActive object.

Notes:

CActive GetEvent()

Cancels a request for standard events from the window server.

This request was made using EventReady().

The client application will typically use an active object to handle standard events, and this function should be called from the active object's DoCancel() function.

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

EventReady()

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

Gets all window groups whose names match a given string, which can contain wildcards.

An example use of this function might be to find all the currently running instances of a particular application, assuming that the window group name contains the application name. An optional argument, aOffset, specifies the number of characters to be ignored at the beginning of the window group name. As several window group names may match the given string, and the function can return only one at a time, there is an argument, aPreviousIdentifier, which gives the identifier for the previous match that was returned. In other words, it means, "get me the next match after this one." The first time the function is called, give 0 as the previous identifier.

Matching is done using TDesC::MatchF(), which does a folded match. Wildcards '*' and '?' can be used to denote one or more characters and exactly one character, respectively. Windows are searched in front to back order.

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

Gets the identifiers of window groups belonging to a client which is owned by a thread with the specified thread ID.

The thread may own more than one window group, so the identifier returned is the one after aPreviousIdentifier. The first time the function is called, use 0 for the previous identifier.

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

Blocks until all outstanding window server rendering has been completed.

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

Delivering a command to the window server requires a context switch, and so it is more efficient to deliver several commands in one go. Hence all client commands are normally first placed into a buffer for delivery to the window server.

The buffer is delivered when it gets full, or when a command that returns a value is called (there are a few exceptions to this), or when this function is called.

Note: this function is called when a prompt response is required from the window server, e.g. after doing some drawing.

RWsSession::SetAutoFlush() RWsSession::SetBufferSizeL() RWsSession::SetMaxBufferSizeL()

Releases the system pointer cursor list and deletes all the entries in it.

A client should call this function when it no longer needs the system pointer cursor list.

Gets the window server's background colour.

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

Gets the list of available colour modes.

Note that this function should usually be called within User::LeaveIfError(). The only time that an error can be generated is when the array gets resized to the number of display modes. Thus if you make the size of your array equal to the maximum number of display modes over all hardware (this is the number of different values in TDisplayMode) then this function will never leave.

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

Gets the list of available colour modes on a particular screen.

Note that this function should usually be called within User::LeaveIfError(). The only time that an error can be generated is when the array gets resized to the number of display modes. Thus if you make the size of your array equal to the maximum number of display modes over all hardware (this is the number of different values in TDisplayMode) then this function will never leave.

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

Gets the number of colours available in the richest supported colour mode, the number of greys available in the richest grey mode, and returns the default display mode.

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

Gets the number of colours available in the richest supported colour mode, the number of greys available in the richest grey mode, and returns the default display mode, on the specified screen.

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

Gets the identifier of the current default owning window group.

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

Gets the identifier of the current default owning window group on a specified screen.

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

Gets the current system-wide settings for pointer double clicks.

Double click distances are 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.

SetDoubleClick()

Dummy implementation in order to preserve compatibility with WSERV NGA.

Dummy implementation in order to preserve compatibility with WSERV NGA.

Gets a standard event from the session for processing.

The type of event returned by GetEvent() may be any of those listed in TEventCode. To access the data within an event, the event should be converted to the appropriate type, using functions provided by the TWsEvent class. TWsEvent also provides a function to find out the type of the event.

Notes:

It is possible that the returned event is of type EEventNull. Clients should normally ignore these events.

This function should only be called in response to notification that an event has occurred, otherwise the client will be panicked.

This function would normally be called in the RunL() function of an active object which completes with the EventReady() function's request status.

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

TEventCode EventReady()

Dummy implementation in order to preserve compatibility with WSERV NGA.

Dummy implementation in order to preserve compatibility with WSERV NGA.

Get focus screen

Gets the identifier of the window group that currently has the keyboard focus.

Note: this might not necessarily be the front-most window group, as window groups can disable keyboard focus.

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

Gets the identifier of the window group on a specified screen that currently has the keyboard focus.

Note: this might not necessarily be the front-most window group, as window groups can disable keyboard focus.

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

Gets the current system-wide settings for the keyboard repeat rate.

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

SetKeyboardRepeatRate()

Gets the state of the modifier keys.

The state of each modifier key (defined in TEventModifier) is returned in a bitmask.

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

TEventModifier

Gets the completed priority key event from the window server session.

Priority key events are typically used for providing "Abort" or "Escape" keys for an application.

This function is similar to GetEvent(), except that it returns a TWsPriorityKeyEvent instead of a TWsEvent.

Note: this should only be called after notification that a priority key event has occurred.

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

PriorityKeyReady() PriorityKeyReadyCancel()

Gets the redraw event from the session.

This function is similar to GetEvent(), except that the event is returned as a TWsRedrawEvent, and hence there is no need to convert it from a TWsEvent.

The function should only be called after notification that a redraw is waiting.

It always causes a flush of the window server buffer.

RedrawReady() GetEvent() CActive

Gets the thread ID of the client that owns the window group specified by the window group identifier.

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

Gets the handle of the window specified by the window group identifier.

This is the handle that was passed as an argument to RWindowGroup::Construct().

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

Gets the name of a window group from its identifier.

Using the list of identifiers returned by WindowGroupList(), it is possible to get the names of all window groups in the system. Note that window names are a zero length string by default.

Note that the window group name must have been previously set using RWindowGroup::SetName() to contain a meaningful value.

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

Gets a window group's priority.

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

Gets the heap count.

This function calls RHeap::Count() on the window server's heap, after throwing away all the temporary objects allocated for each window.

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

Sets the heap failure burst mode in the window server.

The release version of the base does not support simulated heap failure functionality, and the result of this function is additional error messages. In the debug version the clients are notified of the simulated failure and handle it. See RHeap::__DbgSetBurstAllocFail() for more information.

Note:

It is unlikely, but possible to create a ROM with a mixture of Release and Debug versions of the Base and Window Server DLLs, which results in different behaviour to that described above. If you run a debug Window Server with a release version of the Base, then calling this function will result in neither extra error messages (e.g. EDrawingRegion) nor simulated heap failures. However if you have a release Window Server with a debug Base then you will get both simulated heap failures and the extra error messages.

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

Sets the heap failure mode in the window server.

The release version of the base does not support simulated heap failure functionality, and the result of this function is additional error messages. In the debug version the clients are notified of the simulated failure and handle it. See RHeap::__DbgSetAllocFail() for more information.

Note:

It is unlikely, but possible to create a ROM with a mixture of Release and Debug versions of the Base and Window Server DLLs, which results in different behaviour to that described above. If you run a debug Window Server with a release version of the Base, then calling this function will result in neither extra error messages (e.g. EDrawingRegion) nor simulated heap failures. However if you have a release Window Server with a debug Base then you will get both simulated heap failures and the extra error messages.

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

Allows the window server client to enable or disable logging of window server events.

The type of logging that takes place (e.g. whether to file or to serial port) depends on the settings specified in the wsini.ini file.

Clients can also force a dump of the window tree or information about the window server's heap size and usage.

For logging to work, the wsini.ini file has to specify the type of logging required and the DLLs for that type of logging must have been correctly installed. Otherwise, calling this function will have no effect.

Adds a message to the window server debug log if one is currently in operation.

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

Gets the total number of window groups currently running in the window server.

This includes all the groups running in all sessions.

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

Gets the number of window groups of a given window group priority running in all sessions in the window server.

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

Gets the number of window groups of a given window group priority running on a specified screen

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

Number Of Screens

Disables the window server password mode.

This function must be called by the session which owns the password window when the correct machine password has been entered.

Gets the pointer cursor area for the first screen display mode.

This is the area of the screen in which the virtual cursor can be used while in relative mouse mode. While in pen or mouse mode the event co-ordinates are forced to be within this area unless you click outside the drawable area.

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

SetPointerCursorArea()

Gets the pointer cursor area for the specified screen display mode.

This is the area of the screen in which the virtual cursor can be used while in relative mouse mode. While in pen or mouse mode the event co-ordinates are forced to be within this area unless you click outside the drawable area.

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

SetPointerCursorArea()

Gets the current mode for the pointer cursor.

The mode determines which sprite is used for the pointer cursor at any point.

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

Gets the pointer cursor position.

This function allows an application to determine the position of the virtual cursor.

It always causes a flush of the window server buffer.

Returns the window server's preferred size for the TSurfaceConfiguration object, used for RWindow::SetBackgroundSurface.

Client code is permitted to present any defined version of the TSurfaceConfiguration class, distinguished by its size. If smaller, earlier versions are presented, the server will substitute the stated default values. If later, larger, structures are presented to the server then the additional data will be ignored.

However, by using this method, the client can fine-tune its use of the interface, avoiding generating attribute data that may not be supported, or reduce the options presented to users.

Prepares for switch off.

This stops the window server heart beat timer if running.

Requests priority key events from the window server.

Typically, an client will create an active object for priority key events with a higher priority than the active objects for standard events. The client will then normally handle completed priority key requests in the active object's RunL() function.

As in EventReady(), the request status argument should be the set to the iStatus member of CActive. When priority key events occur, they are obtained using GetPriorityKey().

Notes:

PriorityKeyReadyCancel() GetPriorityKey() CActive

Cancels a priority key event request.

If active objects are used, this function should be called from the active object's DoCancel() function.

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

PriorityKeyReady() CActive

Removes all pointer events waiting to be delivered to this session.

The events are removed from the event queue without being processed. This might occur, for example, at application startup.

Requests redraw events from the window server.

Typically, a client will create an active object for redraw events with a lower priority than the active objects for standard events. The client will then typically handle completed redraw requests in the active object's RunL() function.

As in EventReady(), the request status aStat should be used as the iStatus member of an active object. When a redraw event occurs the active object's RunL() function is called. The redraw event can be obtained by calling GetRedraw() in the RunL().

Notes:

RedrawReadyCancel() GetRedraw() CActive

Cancels a redraw event request.

If active objects are used, this function should be called from the active object's DoCancel() function.

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

RedrawReady()

This function registers a surface for use in composition on the screen associated with this device within this session.

A surface may be registered as a separate step before it is added as a background surface for a window created in the same session and that is displayed on this screen. This then allows content to be provisioned before the surface is displayed for the first time, and to be kept "live" while not assigned to any window.

A surface can be successfully registered in multiple sessions and on multiple screens, but only once for a given combination of session and screen.

The client should call UnregisterSurface when finished with the surface registered using this method. The surface will be automatically unregistered if necessary when the session closes.

Requests the window server to send OFF events to a window.

After calling this function, the window server sends OFF events to the window when an event occurs which requires power down, rather than handling powering down itself.

Notes:

Any client can ask for OFF events, but only one window in the system can be set to receive them. If this function is called when another window is set to receive OFF events then the client will be panicked. The exception is the shell, which is allowed to take receipt of OFF events from other clients.

The window server identifies the shell client by comparing the process name of the client with the process name of the shell. Only the first client created by the shell is guaranteed to have the extra shell client privileges.

If the shell dies or terminates just before the action requiring power down happens then the window server will handle it rather than passing it on to the shell.

The window server has a queue of messages that it is waiting to send to clients. If the shell's client's queue is full and the window server cannot make room for the OFF message then it will power down the machine itself.

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

Gets the number of objects that the server has allocated for that client.

This function can be used to check that the client has correctly cleaned up all of its objects.

It always causes a flush of the window server buffer.

Restores the default mapping for a hot key.

The function clears current mappings for a hot key and restores the default mapping. See THotKey for the default.

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

ClearHotKeys()

Sends the specified event to all existing window groups.

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

Sends the specified event to all window groups with the specified priority.

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

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.

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.

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.

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.

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.

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.

Dummy implementation in order to preserve compatibility with WSERV NGA.

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.

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.

Set focus screen

Dummy implementation in order to preserve compatibility with WSERV NGA.

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.

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.

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.

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.

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.

Sets the shadow vector.

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.

Gets the current value of the shadow vector.

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

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.

This function removes the surface from the session's register of surfaces that are used in composition on the screen associated with this device.

Calling this function with a surface that is not currently explicitly registered on this screen in this session by RegisterSurface() will have no effect.

Calling this function while the surface is still assigned to a window will have no immediate effect. However, when the surface is unassigned from the window, and is not held by another session it will then be automatically unregistered.

An unregistered surface can be re-registered again, if necessary.

This function does not explicitly force a flush of the WServ session buffer. Internal reference counting will keep the Surface ID "live" until the client code has released any handles and provisioners, and WServ processes the buffered remove command, and the final frame containing this surface has finished being displayed.

Gets the window server version.

Gets a list of identifiers of all window groups in all window server sessions.

An array buffer must be created to store the resultant list.

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

Gets a list of identifier of window group and parent identifier of window group of all window groups in all window server sessions.

An array buffer must be created to store the resultant list.

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

Lists the number of window groups of a given window group priority running in all window server sessions.

This function is the same as WindowGroupList() described above, but allows the application to restrict the list of window groups to those of a particular window group priority.

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

Lists the number of window groups of a given window group priority running in all window server sessions.

This function is the same as WindowGroupList() described above, but allows the application to restrict the list of window groups to those of a particular window group priority.

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

Lists the number of window groups of a given window group priority running on a specified screen.

This function is the same as WindowGroupList() described above, but allows the application to restrict the list of window groups to those of a particular window group priority.

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

Gets the id of window groups and id of its parent window group of specified priority running in all sessions in the window server.

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

Gets the id of window groups of specified priority running on a specified screen.

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

Compute mode flags.

When a window group takes focus or loses it, the window server can boost its client's thread or process priority to provide a better response to the user. How it alters the priority is determined by the current compute mode of the client.

ComputeMode()

The vertical alignment of a custom text cursor sprite.

One of these values must be set, see SetCustomTextCursor(). This value also determines which part of each sprite member bitmap is clipped when the cursor's TTextCursor::EFlagClipVertical flag is set.

Window server logging commands passed to LogCommand().

RWsSession::LogCommand()