- Generated by
1.9.8
|
Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
|
#include <fntstore.h>#include <bitdev.h>#include <bitstd.h>#include <e32keys.h>#include <textcursor.h>#include <pointerevent.h>#include <advancedpointerevent.h>#include <sizemode.h>#include <babitflags.h>#include <wspublishandsubscribedata.h>#include <graphics/windowserverconstants.h>#include <graphics/pointereventdata.h>Go to the source code of this file.
Classes | |
| struct | TPixelsAndRotation |
| Pixels and rotation struct. More... | |
| struct | TPixelsTwipsAndRotation |
| Pixels, twips and rotation struct. More... | |
| struct | TSpriteMember |
| Sprite member. More... | |
| struct | TKeyEvent |
| Key event details. More... | |
| struct | TModifiersChangedEvent |
| Details of changed modifier keys. More... | |
| struct | TWsVisibilityChangedEvent |
| Visibility changed events. More... | |
| struct | TWsDisplayChangedEvent |
| Display changed events. More... | |
| struct | TWsErrorMessage |
| Error event details. More... | |
| class | TWsRedrawEvent |
| Window server redraw event. More... | |
| class | TWsPriorityKeyEvent |
| Priority key events. More... | |
| class | TWsEvent |
| Window server event. More... | |
| class | TWsGraphicId |
| Identifies an abstract artwork. More... | |
| class | CWsGraphic |
| Client representation of a window-server-side piece of artwork owned by this Client. More... | |
| class | MWsClientClass |
| Base class for all classes whose objects are clients of the window server. More... | |
| class | RWsSession |
| Window server session. More... | |
| struct | RWsSession::TWindowGroupChainInfo |
| struct | RWsSession::SSystemInfo |
| WARNING: Struct for internal use ONLY. More... | |
| class | RWindowTreeNode |
| A handle to a node in the server-side window tree. More... | |
| class | RWindowBase |
| Client-side handle to a server-side window. More... | |
| class | RBlankWindow |
| Blank window. More... | |
| class | RDrawableWindow |
| Handle to a drawable window. More... | |
| class | RWindow |
| Handle to a standard window. More... | |
| class | RBackedUpWindow |
| Client-side handle to a drawable window with a backup bitmap. More... | |
| class | RWindowGroup |
| Client-side handle to a server-side window group. More... | |
| class | CWsBitmap |
| Window server bitmap. More... | |
| class | TWsGraphicMsgFixedBase |
| Base class for fixed-size messages to be attached to CWindowGc::DrawWsGraphic commands. More... | |
| class | RWsGraphicMsgBuf |
| Utility class for building data buffers to be attached to CWindowGc::DrawWsGraphic commands Useful when there is more than one piece of data to be attached to the draw command. More... | |
| class | CWindowGc |
| Window graphics context. More... | |
| class | CWsScreenDevice |
| Software device screen. More... | |
| class | RWsSpriteBase |
| Sprite base class. More... | |
| class | RWsSprite |
| Sprite. More... | |
| class | RWsPointerCursor |
| Pointer cursor. More... | |
| class | RAnimDll |
| Client-side interface to the server-side animation DLL. More... | |
| class | RAnim |
| Client-side handle to a server-side animation class. More... | |
| class | RDirectScreenAccess |
| The interface between an application that directly accesses the screen and the window server. More... | |
| class | MAbortDirectScreenAccess |
| The interface for terminating direct screen access. More... | |
| class | MDirectScreenAccess |
| The interface for restarting direct screen access. More... | |
| class | CDirectScreenAccess |
| An active object used to start direct screen access. More... | |
| class | RSoundPlugIn |
| Client interface to the key or pointer click plug-in DLL. More... | |
Typedefs | |
| typedef TBuf< KLogMessageLength > | TLogMessageText |
| Log message text buffer. | |
Functions | |
| _LIT (KWSERVThreadName,"Wserv") | |
| typedef TBuf<KLogMessageLength> TLogMessageText |
Log message text buffer.
This is used in RWsSession::LogMessage().
| anonymous enum |
Log message text length.
This defines the length of the log text message buffer TLogMessageText, which is used in RWsSession::LogMessage().
| Enumerator | |
|---|---|
| KLogMessageLength | The length of the log message text buffer in characters. |
| anonymous enum |
Password window group priority.
This priority is assigned to the password window group when the window server is displaying the password window. This is the highest priority, which ensures that the machine password window is in front of all other windows - hence password tests cannot be bypassed.
| Enumerator | |
|---|---|
| KPasswordWindowGroupPriority | Password window group priority. |
| anonymous enum |
Switch ordinal position to owning window.
This enum can be specified as the 2nd parameter to RWsSession::SetWindowGroupOrdinalPosition() or as the 1st parameter to RWindowTreeNode::SetOrdinalPosition() (if this is being called on an RWindowGroup).
When called with this value, the functions don't change the ordinal position of the group window in question, but rather bring to the front the window that would come to the front if that group window were to die with keyboard focus.
| Enumerator | |
|---|---|
| KOrdinalPositionSwitchToOwningWindow | Switch ordinal position to owning window. |
| enum TCornerFlags |
Corner flags.
These are used by RWindowBase::SetCornerType() to set which corners of a window are not to have corner types applied to them.
| enum TCornerType |
Window corner types.
Corners may be specified square or stepped, with varying numbers of pixels removed to make the stepping. Picturing a corner as the top left corner of a window, the numbers denote the number of pixels removed from the top row to give corners.
| enum TEventCode |
Types of standard events.
These are events that the window server passes to its clients, as opposed to events that the base passes to the window server.
| Enumerator | |
|---|---|
| EEventNull | Null event. This can be sent, but should be ignored by clients. |
| EEventKey | Key event. This is the event that is sent when a character has been received from the keyboard. If an EEventKey event is associated with an EEventKeyDown or EEventKeyUp event (typically EEventKeyDown), the EEventKey event occurs after the EEventKeyDown/EEventKeyUp event. In practice, the only keys potentially likely to have their EEventKey event generated on the up rather than the down are modifier keys. |
| EEventKeyUp | Key up event. If an EEventKey event is associated with an EEventKeyUp event (which is rarely the case), the EEventKey event occurs after the EEventKeyUp event. |
| EEventKeyDown | Key down event. If an EEventKey event is associated with an EEventKeyDown event (which is typically the case), the EEventKey event occurs after the EEventKeyDown event. |
| EEventModifiersChanged | Modifier changed event. This is an event generated by the window server when the state of one of the modifier keys changes. It is not reported unless explicitly requested by a window. |
| EEventPointer | Pointer event. This event is sent when the user presses or releases a pointer button (or the equivalent action, depending on the type of pointing device), drags the pointer, moves it or uses the pointer to switch on the device. |
| EEventPointerEnter | Pointer enter event. This occurs when the user moves the pointer into a window with a pointer button pressed (or equivalent action depending on the type of pointing device). If move events are being generated, this event also occurs when the user moves the pointer into the window. |
| EEventPointerExit | Pointer exit event. Occurs when the user moves the pointer out of a window with a pointer button pressed (or equivalent action depending on the type of pointing device). If move events are being generated, this event also occurs when the user moves the pointer out of the window. |
| EEventPointerBufferReady | Pointer move buffer ready event. Occurs when the pointer move buffer is ready to be retrieved by the client. |
| EEventDragDrop | Occurs as a duplicate of each pointer event if a window sets pointer capture with the TCaptureFlagDragDrop flag set. |
| EEventFocusLost | Focus lost event. Occurs when a window group loses keyboard focus. |
| EEventFocusGained | Focus gained event. Occurs when a window group gains keyboard focus. |
| EEventSwitchOn | On event. This event type is not reported unless explicitly requested by a window.
|
| EEventPassword | Password event. Occurs when the window server enters password mode. It is sent to the group window of the currently active password window. This is the window server mode where the user is required to enter a password before any further actions can be performed. |
| EEventWindowGroupsChanged | Window group changed event. This occurs whenever a window group is destroyed, and whenever a window group's name changes This event type is not reported unless explicitly requested by a window. |
| EEventErrorMessage | Error event. Occurs when an error occurs. See TWsErrorMessage::TErrorCategory for the types of errors. This event type is not reported unless explicitly requested by a window. |
| EEventMessageReady | Message ready event. Occurs when a session sends a message to this window group using RWsSession::SendMessageToWindowGroup(). |
| EEventMarkInvalid | |
| EEventSwitchOff | Off event. This is issued when an off event is received by the window server from the base. If for some reason the event can't be delivered, or there is no-one to deliver it to, then a call to the base is made to power down the processor. This event is only delivered if explicitly requested using RWsSession:RequestOffEvent(). |
| EEventKeySwitchOff | Event issued to off-event requesting windows when the off key is pressed. |
| EEventScreenDeviceChanged | Screen size mode change event. This is issued when the screen size mode has changed, for instance when the cover on a phone that supports screen flipping is opened or closed. |
| EEventFocusGroupChanged | Event sent whenever the window group with focus changes. Requested by RWindowTreeNode::EnableFocusChangeEvents(). |
| EEventCaseOpened | Case opened event. This event is sent to those windows that have requested EEventSwitchOn events. Unlike with EEventSwitchOn events, the screen will not be switched on first. |
| EEventCaseClosed | Case closed event. This event is sent to those windows that have requested EEventSwitchOff events. Unlike EEventSwitchOff events, which make a call to the base to power down the processor if for some reason the event can't be delivered (or there is no-one to deliver it to), failure to deliver case closed events has no repercussions. |
| EEventWindowGroupListChanged | Window group list change event. The window group list is a list of all window groups and their z-order. This event indicates any change in the window group list: additions, removals and reorderings. Notification of this event is requested by calling RWindowTreeNode::EnableGroupListChangeEvents(). |
| EEventWindowVisibilityChanged | The visibility of a window has changed. This is sent to windows when they change from visible to invisible, or visa versa, usually due to another window obscuring them. Notification of this event is requested by calling RWindowTreeNode::EnableVisibilityChangeEvents(). |
| EEventDisplayChanged | The display state or configuration has changed. Either change of the current resolution list (state change) or current resolution/background (mode change) will trigger this event. Notification of this event is requested by calling MDisplayControl::EnableDisplayChangeEvents() |
| EEventKeyRepeat | Repeating key event. This is only sent to a key click plug-in DLL (if one is present) to indicate a repeating key event.
|
| EEventGroupWindowOpen | |
| EEventGroupWindowClose | |
| EEventWindowClose | |
| EEventDirectScreenAccessBegin | Direct screen access begin This is only sent to anim dlls (if they register to be notified). It indicates that the number of direct screen access sessions has increased from zero to one. |
| EEventDirectScreenAccessEnd | Direct screen access end This is only sent to anim dlls (if they register to be notified). It indicates that the number of direct screen access sessions has decreased from one to zero. |
| EEventHeartbeatTimerStateChange | Event to signal the starting or stopping of the wserv heartbeat timer This is only sent to anim dlls (if they register to be notified). |
| EEventPowerMgmt | 900-909 WSERV protects with PowerMgmt |
| EEventReserved | |
| EEventUser | User defined event. The client can use this and all higher values to define their own events. These events can be sent between windows of the same client or windows of different clients.
|
| enum TEventControl |
Event reporting control.
This enumeration defines flags which can be used to control how events are reported.
| enum THotKey |
Window server hot keys.
| enum TLongCaptureFlags |
Flags which customise a long key press capture request made by a window group.
These flags are passed to RWindowGroup::CaptureLongKey().
Two things can be configured using this enum: the normal key event that is generated immediately, and the long key event that is generated after a short time interval. The normal key event can be sent immediately (on key down) to the application with keyboard focus, or, if the key is not held down long enough to generate a long key event, when the key is released. The long key event can be customised to generate a single key event only, or to auto repeat.
| enum TPasswordMode |
Password mode flags.
| enum TPointerCursorMode |
Pointer cursor mode flags.
These flags define the current cursor mode, and hence which sprite to use for the pointer cursor.
| enum TPointerFilter |
Pointer event filter types.
These flags are used by RWindowBase::PointerFilter() to define which pointer events are filtered out by the window server and not sent to the client session. They also allow the window server to simulate a move event prior to each pen down event.
| Enumerator | |
|---|---|
| EPointerFilterEnterExit | Filters out both pointer enter and pointer exit events for this window. |
| EPointerFilterMove | Filters out pointer-move events for this window. |
| EPointerFilterDrag | Filters out pointer-drag events for this window. |
| EPointerGenerateSimulatedMove | Simulates a pointer move event before each pen down event. This makes the pen appear more like a mouse, with simulated movement between two pointer events. You can only get these events while you are in pen mode. |
| EPointerMoveEvents | Filters move and drag-pointer events from the event stream and simulates the move event before each pen down event. This enum is useful when you want to get simulated move events. Use it as shown below to turn on simulated moves: win->PointerFilter(EPointerMoveEvents, EPointerGenerateSimulateMoves)
|
| enum TPriorities |
Screen mode enforcement flags.
Screen mode enforcement ensures that windows must meet certain requirements if they are to be displayed. When the screen mode changes, window groups that are incorrectly set up, according to these requirements, are locked out. The windows are notified of the change, and will be displayed if they are updated (according to the current enforcement requirement) to match the new screen mode.
| enum TSpriteFlags |
Sprite flags.
These can be combined using a bit-wise OR operation.
| Enumerator | |
|---|---|
| ESpriteFlash | Flash sprite on and off. All flashing is done on the same timer, including the text cursor. |
| ESpriteNoChildClip | This flag no longer has any effect. If you want a sprite to appear on top of all windows, you can create a floating sprite by specifying a RWindowGroup as parent to the sprite. |
| ESpriteNoShadows | The sprite's appearance will not change when it is on a shadowed part of the screen. (Typically this is used for sprites attached to window groups so that they are perceived to be floating above the windows). |
| enum TWindowBackupType |
Window backup type flags.
| Enumerator | |
|---|---|
| EWindowBackupAreaBehind | Backup the area behind the current window only. This is the default behaviour for the RWindowBase::EnableBackup() function. |
| EWindowBackupFullScreen | Backup the entire screen. This is provided for windows that require the rest of the screen to fade when they are displayed. When the rest of the screen should become unfaded, the window server redraws the whole screen from the backed up bitmap. |
Transparency policies.
These policies are to control the behaviour of a transparent window.
| Enumerator | |
|---|---|
| ETransparencyDefault | Default behaviour. |
| ETransparencyFreezeUnder | Freeze the content of underneath the transparent window to prevent redraw everytime the overlying window changes. |
| _LIT | ( | KWSERVThreadName | , |
| "Wserv" | |||
| ) |
1.9.8