Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: W32STD.H

Enum TEventCode

TEventCode

Description

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.

See also:

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, or uses the pointer to switch on the device. If the current input type (see TXYInputType) is "mouse" or "relative mouse", i.e. it generates pointer move events as well as drag events, then this event type is also generated whenever the pointer is moved.

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().

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.

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.