#include <w32std.h>
| class RWsSession : public MWsClientClass |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { ESystemInfoArraySize } |
| enum | TComputeMode { EPriorityControlDisabled, EPriorityControlComputeOn, EPriorityControlComputeOff } |
| enum | TCustomTextCursorAlignment { ECustomTextCursorAlignTop, ECustomTextCursorAlignBaseline, ECustomTextCursorAlignBottom } |
| enum | TLoggingCommand { ELoggingEnable, ELoggingDisable, ELoggingStatusDump, ELoggingHeapDump } |
| Inherited Attributes | |
|---|---|
| MWsClientClass::iBuffer | |
| MWsClientClass::iWsHandle | |
Window server session.
The session between the client and the window server can be used to mediate asynchronous events, for client interface control and for system control. A description of each of these capabilities is given below.
Mediating asynchronous events:
Primarily, the session mediates asynchronous events to the user. Three event streams are available: the standard event stream which all applications must use; the redraw event stream which must be used by all applications except those which exclusively use backed-up windows; and the priority key event stream which may be used for abort keys and the like for specialist applications.
All these events are mediated as standard asynchronous services. Typical window server client programs encapsulate each service they require in an active object whose RunL() identifies the event and calls the appropriate member function of a class associated with an application framework, or a window.
Client interface control:
The client's interface with the window server has several aspects, each of which is controlled through the window server session.
Flushing defines how requests to the window server are handled.
System control:
Many system-wide settings may be controlled through the window server session. Typically, these functions are only used by the system shell and its associated sessions/applications. They include: auto-repeat and double-click, querying all window groups in the system, setting the default shadow vector, setting the system pointer cursors, counting resources used by the window server (this is only useful for debugging checks), getting and setting the state of the modifier keys (for instance Shift and Ctrl), setting the window server background colour, getting and setting thresholds for window server generated pointer events.
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.
See also: ComputeMode()
| Enumerator | Value | Description |
|---|---|---|
| EPriorityControlDisabled |
Client priority is permanently set to its current level. It is not altered or set by the windowing system if the focus changes. Thus if ComputeMode() is called with this flag when a client is in the foreground, it will subsequently have foreground priority even if it is in the background. | |
| EPriorityControlComputeOn |
Client process's priority is always set to EPriorityBackground. | |
| EPriorityControlComputeOff |
Client process's priority is set to EPriorityForeground when the window group takes focus, and set to EPriorityBackground when it loses focus. This is the default behaviour. |
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().
See also: RWsSession::LogCommand()
| IMPORT_C | RWsSession | ( | ) |
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.
| IMPORT_C TInt | ClaimSystemPointerCursorList | ( | ) |
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.
See also: FreeSystemPointerCursorList()
Returns: KErrNone if successful, KErrInUse if another client is already using the system pointer cursor list, otherwise another of the system-wide error codes.
| IMPORT_C void | ClearAllRedrawStores | ( | ) |
Clear the redraw store for all windows in the system. By default Windows will record the drawing commands used during a redraw and re-use them later if the window needs to be redrawn. Calling this function will cause all these server-side stores to be thrown away, redraw requests will then be sent to all client-side windows. Visible windows will receive them first.
In most cases you should be using RWindow::ClearRedrawStore instead of this function.
This function always causes a flush of the window server buffer.
| IMPORT_C void | ClearDefaultSystemPointerCursor | ( | ) |
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.
See also: SetHotKey() RestoreDefaultHotKey()
| Parameter | Description |
|---|---|
| aType | The hot key to be cleared |
Returns: KErrNone if successful, otherwise one of the system-wide error codes.
| IMPORT_C void | ClearSystemPointerCursor | ( | TInt | aCursorNumber | ) |
Clears a system pointer cursor from the list.
Before calling this function, the client must first gain access to the list by calling ClaimSystemPointerCursorList().
| Parameter | Description |
|---|---|
| aCursorNumber | Cursor number to clear |
| IMPORT_C void | Close | ( | ) |
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.
| IMPORT_C void | ComputeMode | ( | TComputeMode | aMode | ) |
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.
| Parameter | Description |
|---|---|
| aMode | The compute mode. |
| IMPORT_C TInt | Connect | ( | ) |
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.
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
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.
| Parameter | Description |
|---|---|
| aFileServer | A fully constructed file server session |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C void | EnableWindowSizeCacheL | ( | ) |
| IMPORT_C void | EventReady | ( | TRequestStatus * | aStat | ) |
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:
The active object runs when an event is waiting. You should call GetEvent() in the RunL() function to get the event.
You should not call this function again until you have either called GetEvent() or EventReadyCancel().
Because this function is asynchronous, there is no guarantee that the Window Server will process the request before the function returns. However, on single core systems it is unusual for this function to return before the Window Server has processed the request, because the client generally runs in a lower priority thread than the Window Server. You should therefore expect the use of this function to give rise to different behaviour between single and multicore systems.
See also: CActive GetEvent()
| Parameter | Description |
|---|---|
| aStat | Request status. On successful completion contains KErrNone, otherwise another of the system-wide error codes. |
| IMPORT_C void | EventReadyCancel | ( | ) |
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.
See also: EventReady()
Called by the client in response to an EEventMessageReady event to receive the message data.
This function always causes a flush of the window server buffer.
| Parameter | Description |
|---|---|
| aUid | A UID which uniquely identifies the session sending the message. |
| aParams | The message data. An unlimited amount of data can be passed in this argument. |
| aMessageEvent | The event sent from the server to the client to identify the message. |
Returns: KErrNone if successful, KErrNoMemory if there is insufficient memory for the message data, otherwise another of the system-wide error codes.
| IMPORT_C TInt | FindWindowGroupIdentifier | ( | TInt | aPreviousIdentifier, |
| const TDesC & | aMatch, | |||
| TInt | aOffset = 0 | |||
| ) | const | |||
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.
| Parameter | Description |
|---|---|
| aPreviousIdentifier | Identifier of the last window group returned. If the value passed is not a valid identifier, the function returns KErrNotFound. |
| aMatch | String to match window group name against: may contain wildcards |
| aOffset | The first aOffset characters of the window group name are ignored when doing the match. |
Returns: The next window group, after the one identified by aPreviousIdentifier, whose name matches aMatch. KErrNotFound if no window group matched or aPreviousIdentifier was not a valid identifier.
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.
| Parameter | Description |
|---|---|
| aPreviousIdentifier | Identifier returned by previous call |
| aThreadId | Thread owning the window group or groups. |
Returns: Next window group identifier after the one identified by aPreviousIdentifier
| IMPORT_C TInt | Finish | ( | ) |
Blocks until all outstanding window server rendering has been completed.
Returns: KErrNone if successful
| IMPORT_C void | Flush | ( | ) |
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.
See also: RWsSession::SetAutoFlush() RWsSession::SetBufferSizeL() RWsSession::SetMaxBufferSizeL()
| IMPORT_C void | FreeSystemPointerCursorList | ( | ) |
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.
| IMPORT_C TRgb | GetBackgroundColor | ( | ) | const |
Gets the window server's background colour.
This function always causes a flush of the window server buffer.
Returns: Background colour
| IMPORT_C TInt | GetColorModeList | ( | CArrayFixFlat< TInt > * | aModeList | ) | const |
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.
| Parameter | Description |
|---|---|
| aModeList | On return, contains a TDisplayMode entry for each of the available display modes. Note that the array's contents are deleted prior to filling with display mode information. |
Returns: The number of color modes if the parameter is passed NULL. Otherwise KErrNone or KErrNoMemory.
| IMPORT_C TInt | GetColorModeList | ( | TInt | aScreenNumber, |
| CArrayFixFlat< TInt > * | aModeList | |||
| ) | const | |||
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.
| Parameter | Description |
|---|---|
| aScreenNumber | specifies the screen. |
| aModeList | On return, contains a TDisplayMode entry for each of the available display modes. Note that the array's contents are deleted prior to filling with display mode information. |
Returns: The number of color modes if the parameter is passed NULL. Otherwise KErrNone or KErrNoMemory.
| IMPORT_C TDisplayMode | GetDefModeMaxNumColors | ( | TInt & | aColor, |
| TInt & | aGray | |||
| ) | const | |||
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.
| Parameter | Description |
|---|---|
| aColor | The number of colours in the richest supported colour mode. |
| aGray | The number of greys in the richest supported grey mode. |
Returns: The default display mode.
| IMPORT_C TDisplayMode | GetDefModeMaxNumColors | ( | TInt | aScreenNumber, |
| TInt & | aColor, | |||
| TInt & | aGray | |||
| ) | const | |||
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.
| Parameter | Description |
|---|---|
| aScreenNumber | specifies the screen. |
| aColor | The number of colours in the richest supported colour mode. |
| aGray | The number of greys in the richest supported grey mode. |
Returns: The default display mode.
| IMPORT_C TInt | GetDefaultOwningWindow | ( | ) | const |
Gets the identifier of the current default owning window group.
This function always causes a flush of the window server buffer.
Returns: Identifier of current default owning window group. Returns 0 if there isn't one.
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.
| Parameter | Description |
|---|---|
| aScreenNumber | specifies the screen. |
Returns: Identifier of current default owning window group on the specified screen. Returns 0 if there isn't one.
| IMPORT_C void | GetDoubleClickSettings | ( | TTimeIntervalMicroSeconds32 & | aInterval, |
| TInt & | aDistance | |||
| ) | const | |||
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.
See also: SetDoubleClick()
| Parameter | Description |
|---|---|
| aInterval | Maximum interval between clicks that constitutes a double click |
| aDistance | Maximum distance between clicks that constitutes a double click |
| IMPORT_C TInt | GetEnterCloseProximityThreshold | ( | ) | const |
See also: TPointerEvent::EEnterCloseProximity To become publishedAll with WSERV NGA APIs To become released with WSERV NGA APIs
Returns: Z coordinate threshold value for TPointerEvent::EEnterCloseProximity events.
| IMPORT_C TInt | GetEnterHighPressureThreshold | ( | ) | const |
See also: TPointerEvent::EEnterHighPressure To become publishedAll with WSERV NGA APIs To become released with WSERV NGA APIs
Returns: Z coordinate threshold value for TPointerEvent::EEnterHighPressure events
| IMPORT_C void | GetEvent | ( | TWsEvent & | aEvent | ) | const |
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.
See also: TEventCode EventReady()
| Parameter | Description |
|---|---|
| aEvent | On return, contains the event that occurred |
| IMPORT_C TInt | GetExitCloseProximityThreshold | ( | ) | const |
See also: TPointerEvent::EExitCloseProximity To become publishedAll with WSERV NGA APIs To become released with WSERV NGA APIs
Returns: Z coordinate threshold value for TPointerEvent::EExitCloseProximity events
| IMPORT_C TInt | GetExitHighPressureThreshold | ( | ) | const |
See also: TPointerEvent::EExitHighPressure To become publishedAll with WSERV NGA APIs To become released with WSERV NGA APIs
Returns: Z coordinate threshold value for TPointerEvent::EExitHighPressure events
| IMPORT_C TInt | GetFocusScreen | ( | ) | const |
Get focus screen
Returns: The screen number of current focus screen
| IMPORT_C TInt | GetFocusWindowGroup | ( | ) | const |
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.
Returns: Identifier of window group with keyboard focus.
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.
| Parameter | Description |
|---|---|
| aScreenNumber | specifies the screen. |
Returns: Identifier of window group with keyboard focus.
| IMPORT_C void | GetKeyboardRepeatRate | ( | TTimeIntervalMicroSeconds32 & | aInitialTime, |
| TTimeIntervalMicroSeconds32 & | aTime | |||
| ) | const | |||
Gets the current system-wide settings for the keyboard repeat rate.
This function always causes a flush of the window server buffer.
See also: SetKeyboardRepeatRate()
| Parameter | Description |
|---|---|
| aInitialTime | Time before first repeat key event |
| aTime | Time between subsequent repeat key events |
| IMPORT_C TInt | GetModifierState | ( | ) | const |
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.
See also: TEventModifier
Returns: Modifier state
| IMPORT_C void | GetPriorityKey | ( | TWsPriorityKeyEvent & | aEvent | ) | const |
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.
See also: PriorityKeyReady() PriorityKeyReadyCancel()
| Parameter | Description |
|---|---|
| aEvent | On return, contains the priority key event that occurred. |
| IMPORT_C void | GetRedraw | ( | TWsRedrawEvent & | aEvent | ) |
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.
See also: RedrawReady() GetEvent() CActive
| Parameter | Description |
|---|---|
| aEvent | On return, contains the redraw event that occurred |
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.
| Parameter | Description |
|---|---|
| aIdentifier | The window group identifier. |
| aThreadId | On return, contains the thread ID. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
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.
| Parameter | Description |
|---|---|
| aIdentifier | The window group identifier. |
Returns: Handle of the window group
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.
| Parameter | Description |
|---|---|
| aIdentifier | The identifier of the window group whose name is to be inquired. |
| aWindowName | On return, contains the window group name. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C TInt | HeapCount | ( | ) | const |
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.
Returns: The window server's heap count.
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.
See also: RHeap::__DbgSetBurstAllocFail()
| Parameter | Description |
|---|---|
| aTAllocFail | A value from the RHeap::TAllocFail enumeration which indicates how to simulate heap allocation failure. |
| aRate | The rate of failure; when aType is RHeap::EDeterministic, heap allocation fails every aRate attempt. |
| aBurst | The number of consecutive allocations that should fail. |
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.
See also: RHeap::__DbgSetAllocFail()
| Parameter | Description |
|---|---|
| aTAllocFail | A value from the RHeap::TAllocFail enumeration which indicates how to simulate heap allocation failure. |
| aValue | The rate of failure; when aType is RHeap::EDeterministic, heap allocation fails every aRate attempt |
| IMPORT_C void | LogCommand | ( | TLoggingCommand | aCommand | ) |
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.
| Parameter | Description |
|---|---|
| aCommand | The logging command. |
| IMPORT_C void | LogMessage | ( | const TLogMessageText & | aMessage | ) |
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.
| Parameter | Description |
|---|---|
| aMessage | The text added to the message log. |
| IMPORT_C TInt | NumWindowGroups | ( | ) | const |
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.
Returns: Total number of window groups running in the server
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.
| Parameter | Description |
|---|---|
| aPriority | Window group priority |
Returns: Number of window groups of priority aPriority
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.
| Parameter | Description |
|---|---|
| aScreenNumber | specifies the screen. |
| aPriority | Window group priority. EAllPriorities is the enum for all priorities |
Returns: Number of window groups of priority aPriority on the specified screen
| IMPORT_C void | PasswordEntered | ( | ) |
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.
| IMPORT_C TRect | PointerCursorArea | ( | ) | const |
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.
See also: SetPointerCursorArea()
Returns: The pointer cursor area for the first screen display mode.
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.
See also: SetPointerCursorArea()
| Parameter | Description |
|---|---|
| aScreenSizeMode | The screen mode for which the pointer cursor area is required. |
Returns: The pointer cursor area for the specified screen display mode.
| IMPORT_C TPointerCursorMode | PointerCursorMode | ( | ) | const |
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.
Returns: The current mode for the pointer cursor.
| IMPORT_C TPoint | PointerCursorPosition | ( | ) | const |
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.
Please note that on devices with multiple pointers (for example with multi-touch screen) the pointer cursor's position will be equal to the last known position of the emulated pointer. More information about the emulated pointer can be found in description of method RWindowBase::EnableAdvancedPointers().
See also: RWindowBase::EnableAdvancedPointers()
Returns: The position of the virtual cursor.
| IMPORT_C TInt | PreferredSurfaceConfigurationSize | ( | ) | const |
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.
Returns: The preferred size in bytesShould match one of the TSurfaceConfiguration classes defined in the client's header file, or be larger than them all, indicating a version newer that the client is compiled for.If the server does not support surface configurationReturn KErrNotSupported.
| IMPORT_C void | PrepareForSwitchOff | ( | ) |
Prepares for switch off.
This stops the window server heart beat timer if running.
| IMPORT_C void | PriorityKeyReady | ( | TRequestStatus * | aStat | ) |
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:
You should not call this function again until you have either called GetPriorityKey() or PriorityKeyReadyCancel().
Because this function is asynchronous, there is no guarantee that the Window Server will process the request before the function returns. However, on single core systems it is unusual for this function to return before the Window Server has processed the request, because the client generally runs in a lower priority thread than the Window Server. You should therefore expect the use of this function to give rise to different behaviour between single and multicore systems.
See also: PriorityKeyReadyCancel() GetPriorityKey() CActive
| Parameter | Description |
|---|---|
| aStat | Request status. On successful completion contains KErrNone, otherwise another of the system-wide error codes. |
| IMPORT_C void | PriorityKeyReadyCancel | ( | ) |
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.
See also: PriorityKeyReady() CActive
| IMPORT_C void | PurgePointerEvents | ( | ) |
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.
| IMPORT_C void | RedrawReady | ( | TRequestStatus * | aStat | ) |
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:
You should not call this function again until you have either called GetRedraw() or RedrawReadyCancel().
Because this function is asynchronous, there is no guarantee that the Window Server will process the request before the function returns. However, on single core systems it is unusual for this function to return before the Window Server has processed the request, because the client generally runs in a lower priority thread than the Window Server. You should therefore expect the use of this function to give rise to different behaviour between single and multicore systems.
See also: RedrawReadyCancel() GetRedraw() CActive
| Parameter | Description |
|---|---|
| aStat | The request status. On successful completion contains KErrNone, otherwise another of the system-wide error codes. |
| IMPORT_C void | RedrawReadyCancel | ( | ) |
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.
See also: RedrawReady()
| IMPORT_C TInt | RegisterSurface | ( | TInt | aScreenNumber, |
| const TSurfaceId & | aSurface | |||
| ) | ||||
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.
aScreenNumber is an acceptable screen number. Otherwise the client thread is panicked with code EWservPanicScreenNumber.
The surface s content is in an undefined state, but the surface remains initialized. This function always causes a flush of the WServ session buffer.
See also: UnregisterSurface
| Parameter | Description |
|---|---|
| aScreenNumber | The screen to which to register. |
| aSurface | The surface to be registered. |
Returns: KErrNone on success or a system-wide error codeKErrNoMemory if registration fails due to low memory.KErrInUse if the surface ID is already registered for this session and screen.
| IMPORT_C TInt | RequestOffEvents | ( | TBool | aOn, |
| RWindowTreeNode * | aWin = NULL | |||
| ) | ||||
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.
| Parameter | Description |
|---|---|
| aOn | ETrue to get the window server to send EEventShellSwitchOff messages to the shell (rather than powering down). EFalse makes the window server switch back to powering down the machine itself. |
| aWin | The handle to the window or window group of the shell to which the message is to be sent. This may be NULL only if aOn=EFalse, in other words, the window server is handling power down itself. If aOn=ETrue then this must not be NULL, or the Window Server will panic the shell. Note that as far as the window server is concerned the handle must exist when this function is called. |
Returns: KErrNone if successful, otherwise one of the system-wide error codes.
| IMPORT_C TInt | ResourceCount | ( | ) | const |
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.
Returns: The number of resources allocated to the client.
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.
See also: ClearHotKeys()
| Parameter | Description |
|---|---|
| aType | The hot key to restore to its default value |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
Sends the specified event to all existing window groups.
This function always causes a flush of the window server buffer.
| Parameter | Description |
|---|---|
| aEvent | The event to be sent to all window groups. |
Returns: KErrNone if successful, KErrPermissionDenied if the client does not have the required capability, KErrNoMemory if there is not enough room to add the event to all the required event queues (although it may have been added to some of them) and otherwise another of the system-wide error codes.
Sends the specified event to all window groups with the specified priority.
This function always causes a flush of the window server buffer.
| Parameter | Description |
|---|---|
| aPriority | The priority which window groups must have to be sent the message. |
| aEvent | The event to be sent to the specified window groups. |
Returns: KErrNone if successful, KErrPermissionDenied if the client does not have the required capability, KErrNoMemory if there is not enough room to add the event to all the required event queues (although it may have been added to some of them) and otherwise another of the system-wide error codes.
Sends an event to a window group.
This function always causes a flush of the window server buffer.
| Parameter | Description |
|---|---|
| aIdentifier | Window group identifier. |
| aEvent | Event to send to the window group. |
Returns: KErrNone if successful, KErrPermissionDenied if the client does not have the required capability, KErrNoMemory if there is not enough room to add the event to the event queue and otherwise another of the system-wide error codes.
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.
| Parameter | Description |
|---|---|
| aUid | A UID which uniquely identifies the session sending the message. |
| aParams | The message data. An unlimited amount of data can be passed in this argument. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
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.
| Parameter | Description |
|---|---|
| aPriority | The priority which window groups must have to be sent the message. |
| aUid | A UID which uniquely identifies the session sending the message. |
| aParams | The message data. An unlimited amount of data can be passed in this argument. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
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
Deprecated| Parameter | Description |
|---|---|
| aIdentifier | The identifier of the window group to receive the message. |
| aUid | A UID which uniquely identifies the session sending the message. |
| aParams | The message data. An unlimited amount of data can be passed in this argument. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
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()
| Parameter | Description |
|---|---|
| aState | ETrue to set auto-flushing on, EFalse to disable auto-flushing. |
Returns: Previous auto-flush state
| IMPORT_C void | SetBackgroundColor | ( | TRgb | aColor | ) |
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.
| Parameter | Description |
|---|---|
| aColor | Background colour |
| IMPORT_C void | SetBufferSizeL | ( | TInt | aBufSize | ) |
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()
| Parameter | Description |
|---|---|
| aBufSize | The desired buffer size in bytes, at least the size of largest message to be sent. |
| IMPORT_C TInt | SetClientCursorMode | ( | TPointerCursorMode | aMode | ) |
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
| Parameter | Description |
|---|---|
| aMode | The new mode for the pointer cursor. |
Returns: KErrNone if successful, otherwise returns system wide errors. Returns KErrPermissionDenied if calling thread lacks WriteDeviceData capability
| IMPORT_C TInt | SetCloseProximityThresholds | ( | TInt | aEnterCloseProximityThreshold, |
| TInt | aExitCloseProximityThreshold | |||
| ) | ||||
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
| Parameter | Description |
|---|---|
| aEnterCloseProximityThreshold | a new threshold for TPointerEvent::EEnterCloseProximity to be set, specified as Z coordinate value |
| aExitCloseProximityThreshold | a new threshold for TPointerEvent::EExitCloseProximity to be set, specified as Z coordinate value |
Returns: KErrNone if successful, KErrNotSupported if the platform doesn't support threshold values for Close Proximity events, KErrArgument if aEnterCloseProximityThreshold is less than aExitCloseProximityThreshold; when this error occurs, threshold values are not changed.
| IMPORT_C TInt | SetCustomTextCursor | ( | TInt | aIdentifier, |
| const TArray< TSpriteMember > & | aSpriteMemberArray, | |||
| TUint | aSpriteFlags, | |||
| TCustomTextCursorAlignment | aAlignment | |||
| ) | ||||
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.
| Parameter | Description |
|---|---|
| aIdentifier | The unique identifier for the cursor. |
| aSpriteMemberArray | An array defining the bitmap(s) that make up the cursor. Typically, this array will contain a single element for a static, non-animated cursor. |
| aSpriteFlags | Flags affecting the sprite behaviour. For possible values see TSpriteFlags. |
| aAlignment | The vertical alignment of the cursor sprite. |
Returns: KErrNone if successful, KErrAlreadyExists if a custom cursor with the specified identifier already exists, or another of the standard system wide error codes.
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()
| Parameter | Description |
|---|---|
| aBlackMap | Black map fading parameter. |
| aWhiteMap | White map fading parameter. |
| IMPORT_C void | SetDefaultSystemPointerCursor | ( | TInt | aCursorNumber | ) |
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.
| Parameter | Description |
|---|---|
| aCursorNumber | The index of the new default system pointer cursor within the system cursor list. |
| IMPORT_C TInt | SetDoubleClick | ( | const TTimeIntervalMicroSeconds32 & | aInterval, |
| TInt | aDistance | |||
| ) | ||||
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()
| Parameter | Description |
|---|---|
| aInterval | Maximum interval between clicks that constitutes a double click |
| aDistance | Maximum distance between clicks that constitutes a double click |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C TInt | SetHighPressureThresholds | ( | TInt | aEnterHighPressureThreshold, |
| TInt | aExitHighPressureThreshold | |||
| ) | ||||
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
| Parameter | Description |
|---|---|
| aEnterHighPressureThreshold | a new threshold for TPointerEvent::EEnterHighPressure to be set, specified as Z coordinate value |
| aExitHighPressureThreshold | a new threshold for TPointerEvent::EExitHighPressure to be set, specified as Z coordinate value |
Returns: KErrNone if successful, KErrNotSupported if the platform doesn't support threshold values for High Pressure events, KErrArgument if aEnterHighPressureThreshold is less than aExitHighPressureThreshold; when this error occurs, threshold values are not changed.
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.
| Parameter | Description |
|---|---|
| aType | The hot key to be mapped |
| aKeyCode | The keycode to be mapped to the hot key |
| aModifierMask | Modifier keys to test for a match |
| aModifier | Modifier keys to be tested for "on" state |
Returns: KErrNone value if successful, otherwise another of the system-wide error codes.
| IMPORT_C TInt | SetKeyboardRepeatRate | ( | const TTimeIntervalMicroSeconds32 & | aInitialTime, |
| const TTimeIntervalMicroSeconds32 & | aTime | |||
| ) | ||||
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()
| Parameter | Description |
|---|---|
| aInitialTime | Time before first repeat key event |
| aTime | Time between subsequent repeat key events |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C void | SetMaxBufferSizeL | ( | TInt | aMaxBufSize | ) |
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()
| Parameter | Description |
|---|---|
| aMaxBufSize | The desired maximum buffer size in bytes. |
| IMPORT_C TInt | SetModifierState | ( | TEventModifier | aModifier, |
| TModifierState | aState | |||
| ) | ||||
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()
| Parameter | Description |
|---|---|
| aModifier | Modifier to set. |
| aState | Modifier state. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C void | SetPointerCursorArea | ( | const TRect & | aArea | ) |
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.
| Parameter | Description |
|---|---|
| aArea | The area of the screen in which the virtual cursor can be used. |
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.
| Parameter | Description |
|---|---|
| aScreenSizeMode | The screen mode to which the new area applies. |
| aArea | The area of the screen, in the aScreenSizeMode screen mode, within which the virtual cursor can be used. |
| IMPORT_C void | SetPointerCursorMode | ( | TPointerCursorMode | aMode | ) |
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
| Parameter | Description |
|---|---|
| aMode | The new mode for the pointer cursor. |
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.
| Parameter | Description |
|---|---|
| aPosition | The new pointer cursor position. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C void | SetShadowVector | ( | const TPoint & | aVector | ) |
This method has been deprecated. Shadowing of a window is no longer supported. Calling it has no effect. Deprecated
| Parameter | Description |
|---|---|
| aVector | Ignored. |
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.
| Parameter | Description |
|---|---|
| aFaded | ETrue to fade all windows, EFalse to un-fade all windows. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
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.
| Parameter | Description |
|---|---|
| aFaded | ETrue to fade all windows, EFalse to un-fade all windows. |
| aBlackMap | Black map fading parameter. |
| aWhiteMap | White map fading parameter. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C TInt | SetSystemPointerCursor | ( | const RWsPointerCursor & | aPointerCursor, |
| TInt | aCursorNumber | |||
| ) | ||||
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.
| Parameter | Description |
|---|---|
| aPointerCursor | Pointer cursor to set in the list |
| aCursorNumber | Cursor number in the list |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
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.
| Parameter | Description |
|---|---|
| aIdentifier | The window group. |
| aPosition | Ordinal position for the window group. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C TPoint | ShadowVector | ( | ) | const |
This method has been deprecated. Shadowing of a window is no longer supported. Calling it has no effect. Deprecated
Returns: TPoint(0, 0)
| IMPORT_C void | SimulateRawEvent | ( | TRawEvent | aEvent | ) |
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().
| Parameter | Description |
|---|---|
| aEvent | The raw event. |
| IMPORT_C void | SyncMsgBuf | ( | ) |
Sends all pending commands in the buffer to the window server.
| IMPORT_C void | SystemInfo | ( | TInt & | aSystemInfoNumber, |
| SSystemInfo & | aSystemInfo | |||
| ) | ||||
| IMPORT_C void | UnregisterSurface | ( | TInt | aScreenNumber, |
| const TSurfaceId & | aSurface | |||
| ) | ||||
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.
aScreenNumber is an acceptable screen number. Otherwise the client thread is panicked with code EWservPanicScreenNumber.
See also: RegisterSurface
| Parameter | Description |
|---|---|
| aScreenNumber | The screen to which to unregister. |
| aSurface | The surface to be unregistered. |
| IMPORT_C TVersion | Version | ( | ) | const |
Gets the window server version.
Returns: Window server version containing major and minor version numbers, and build number.
| IMPORT_C TInt | WindowGroupList | ( | CArrayFixFlat< TInt > * | aWindowList | ) | const |
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.
| Parameter | Description |
|---|---|
| aWindowList | List of identifiers of all window groups in the server. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C TInt | WindowGroupList | ( | RArray< TWindowGroupChainInfo > * | aWindowList | ) | const |
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.
| Parameter | Description |
|---|---|
| aWindowList | List of identifiers of all window groups in the server. |
Returns: KErrNone if successful otherwise KErrNoMemory if there is insufficient memory to create the array, Panics if aWindowList is NULL.
| IMPORT_C TInt | WindowGroupList | ( | TInt | aPriority, |
| CArrayFixFlat< TInt > * | aWindowList | |||
| ) | const | |||
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.
| Parameter | Description |
|---|---|
| aPriority | Window group priority |
| aWindowList | List of identifiers of all window groups in the server of priority aPriority. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C TInt | WindowGroupList | ( | TInt | aPriority, |
| RArray< TWindowGroupChainInfo > * | aWindowList | |||
| ) | const | |||
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.
| Parameter | Description |
|---|---|
| aPriority | Window group priority |
| aWindowList | List of identifiers of all window groups in the server of priority aPriority. |
Returns: KErrNone if successful otherwise KErrNoMemory if there is insufficient memory to create the array, Panics if aWindowList is NULL.
| IMPORT_C TInt | WindowGroupList | ( | CArrayFixFlat< TInt > * | aWindowList, |
| TInt | aScreenNumber, | |||
| TInt | aPriority = EAllPriorities | |||
| ) | const | |||
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.
| Parameter | Description |
|---|---|
| aWindowList | List of identifiers of all window groups on the specified screen with the given priority aPriority. |
| aScreenNumber | specifies the screen |
| aPriority | Window group priority . Enum for all priorities is EAllPriorities |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.