Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <W32STD.H>

Typedef TLogMessageText

typedef TBuf<KLogMessageLength> TLogMessageText;

Description

Log message text buffer.

This is used in RWsSession::LogMessage(const TLogMessageText &).

[Top]


Enum TScreenModeEnforcement

TScreenModeEnforcement

Description

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.

See also:

ESizeEnforcementNone

No enforcement.

All windows that are the children of window groups will be displayed, irrespective of the screen mode.

This is not properly supported and is provided for testing purposes.

ESizeEnforcementPixelsAndRotation

Pixels and rotation enforcement.

Group windows must be set up for the correct rotation and be working in the correct size in pixels to be displayed.

ESizeEnforcementPixelsTwipsAndRotation

Pixels and Twips enforcement.

Group windows must have the correct rotation and be working in the correct size in pixels and twips to be displayed.

This setting might be used if the display pixels are not square, and would distort fonts when rotated.

[Top]


Enum TCornerType

TCornerType

Description

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.

See also:

EWindowCornerSquare

Square corner.

EWindowCorner1

Corner pixel removed.

EWindowCorner2

Two pixel step.

3 pixels are removed: the corner pixel and a single pixel from each side.

EWindowCorner3

Three pixel step.

5 pixels are removed: the corner pixel, the two pixels next to it and the 2 pixels above or below it.

EWindowCorner5

Five pixel step.

12 pixels are removed: the corner pixel, the four pixels next to it, the four pixels above or below it, the pixel which was diagonal to the corner pixel, and the pixels to both sides of that pixel.

EWindowCornerRegion

ECornerTypeMask

Corner type mask.

This value is used by the window server, and may be used by developers, to separate TCornerType and TCornerFlags values from a TInt which contains both types.

[Top]


Enum TCornerFlags

TCornerFlags

Description

Corner flags.

These are used by RWindowBase::SetCornerType(TCornerType,TInt) to set which corners of a window are not to have corner types applied to them.

See also:

EWindowCornerNotTL

Do not apply corner shape to top left corner.

EWindowCornerNotTR

Do not apply corner shape to top right corner.

EWindowCornerNotBL

Do not apply corner shape to bottom left corner.

EWindowCornerNotBR

Do not apply corner shape to bottom right corner.

[Top]


Enum TWindowBackupType

TWindowBackupType

Description

Window backup type flags.

See also:

EWindowBackupAreaBehind

Backup the area behind the current window only.

This is the default behaviour for the RWindowBase::EnableBackup(TUint) 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.

[Top]


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(TInt,TUid,const TDesC8 &).

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 RWsSessionRWsSession: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.

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

UserUser 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.

[Top]


Enum THotKey

THotKey

Description

Window server hot keys.

See also:

EHotKeyEnableLogging

Enables logging of all messages to and from the window server.

Note that the required type of logging must have been specified in the wsini.ini file (using the LOG keyword), and the appropriate logging DLL must be available.

Default key mapping: <Ctrl><Alt><Shift>E

EHotKeyDisableLogging

Always disables window server logging, if active. Does nothing otherwise.

Default key mapping: <Ctrl><Alt><Shift>D

EHotKeyStateDump

Dumps a list of all windows to the log. (If logging is disabled, it is temporarily enabled in order to do this.)

Default key mapping: <Ctrl><Alt><Shift>W

EHotKeyOfDeath

Kills the foreground application.

Default key mapping: <Ctrl><Alt><Shift>K

EHotKeyShutDown

Shuts down the window server.

Be cautious! This may mean resetting the machine to re-start the window server.

Default key mapping: release (not available), debug (<Ctrl><Alt><Shift>X).

EHotKeyHeapDump

Dumps a list of cells allocated on the window server's heap to the log. (If logging is disabled, it is temporarily enabled in order to do this.)

Note that logging requires that the type of logging has been set up in the wsini.ini file, and that the appropriate logging DLL is available.

Default key mapping: <Ctrl><Alt><Shift>H

EHotKeyIncContrast

Increases the LCD contrast.

Default key mapping: EKeyIncContrast. Note that this value is from an enum in e32keys.h. The contrast wraps around when it reaches the maximum.

EHotKeyDecContrast

Decreases the LCD contrast.

Default key mapping: EKeyDecContrast. Note that this value is from an enum in e32keys.h. The contrast wraps around when it reaches the minimum.

EHotKeyOff

Switches the machine off.

Default key mapping: EKeyOff. Note that this value is from an enum in e32keys.h.

EHotKeyBacklightOn

Switches the backlight on.

Default key mapping: EKeyBacklightOn. Note that this value is from an enum in e32keys.h.

EHotKeyBacklightOff

Switches the backlight off.

Default key mapping: EKeyBacklightOff. Note that this value is from an enum in e32keys.h.

EHotKeyBacklightToggle

Toggles the backlight.

Default key mapping: EKeyBacklightToggle. Note that this value is from an enum in e32keys.h.

EHotKeyScreenDimension0

Switches to screen size 0.

This, and the following 3 keys are used to switch screen sizes on real hardware, for instance when the cover is closed on a phone that supports screen flipping.

EHotKeyScreenDimension1

Switches to screen size 1.

This might be generated when the cover is opened on a phone that supports screen flipping.

EHotKeyScreenDimension2

Switches to screen size 2.

EHotKeyScreenDimension3

Switches to screen size 3.

EHotKeyCycleDisplaySize

Cycles the display though its possible sizes.

This is used only for debugging.

A device may have several screen sizes, each with a default orientation. For example a phone that supports screen flipping will have different display sizes when the cover is opened and closed.

Default key mapping: debug : <Ctrl><Alt><Shift> U. Release : none.

EHotKeyCycleOrientation

Cycles the screen orientation through the specified rotations for the particular size mode you are in.

For example, phones that support screen flipping may use this feature for changing between right and left handed use.

For rectangular display modes you can only specify 2 orientations, 180 degrees apart. For square modes you can specify 4 rotations (90 degrees) or however many you want.

Specification of the list of rotations takes place in the WSINI.INI file.

Default key mapping: debug : <Ctrl><Alt><Shift> O. Release : none.

EHotKeyIncBrightness

Increases the screen's brightness.

The brightness wraps around to the minimum value after it has reached the maximum.

EHotKeyDecBrightness

Decreases the screen's brightness.

The brightness wraps around to the maximum value after it has reached the minimum.

EHotKeyCycleFocusScreen

Cycle focus screen from one to another in multiple screen environment. Start from current focused screen, switch to next the screen, and wraps around when it reaches the last screen.

Default key mapping: <Ctrl><Alt><Shift> I.

EHotKeyFirstKeyType

Value for first hot key.

Used with EHotKeyLastKeyType to make it easy to write a for loop that steps through all the different key values.

EHotKeyLastKeyType

Value for last hot key.

Used with EHotKeyFirstKeyType to make it easy to write a for loop that steps through all the different key values.

[Top]


Enum TPasswordMode

Interface status: deprecated

TPasswordMode

Description

Password mode flags.

EPasswordCancel

Releases ownership of password handling.

This allows another window to become the password window. A client will be panicked with code 46 if it sets this mode when it is not the current password window.

EPasswordNone

No password handling is performed by this window, but no other window can become the password window.

EPasswordOnceADay

Password mode is enabled only once a day.

When enabled, password mode requires the user to enter a password before any further actions can be performed.

EPasswordAlways

Password mode is enabled every time the machine is switched on.

EPasswordAlwaysTriggerNow

Equivalent to setting the password mode to EPasswordAlways and triggering an instant password check.

EPasswordOnceADayTriggerNow

Equivalent to setting the password mode to EPasswordOnceADay and triggering an instant password check.

[Top]


Enum TSpriteFlags

TSpriteFlags

Description

Sprite flags.

These can be combined using a bit-wise OR operation.

See also:

ESpriteFlash

Flash sprite on and off.

All flashing is done on the same timer, including the text cursor.

ESpriteNoChildClip

With this flag set, the sprite is displayed over the window and all its children.

Without the flag, the sprite is only displayed over the window's visible area.

This is particularly useful when the sprite is owned by a window group, as it means the sprite will be displayed over the whole screen.

Notes:

By default a sprite is clipped to the visible region of the window that owns it.

Sprites with this flag set are displayed in front of sprites without this flag.

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

[Top]


Enum TEventControl

TEventControl

Description

Event reporting control.

This enumeration defines flags which can be used to control how events are reported.

See also:

EEventControlAlways

Requested events are sent in all circumstances.

EEventControlOnlyWithKeyboardFocus

Events are delivered only when the requesting window's window group has keyboard focus.

EEventControlOnlyWhenVisible

Events are delivered only when the requesting window or any of its children are visible on the screen.

[Top]


Enum TPointerFilter

TPointerFilter

Description

Pointer event filter types.

These flags are used by RWindowBase::PointerFilter(TUint32,TUint32) 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.

See also:

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)

[Top]


Enum TPointerCursorMode

TPointerCursorMode

Description

Pointer cursor mode flags.

These flags define the current cursor mode, and hence which sprite to use for the pointer cursor.

See also:

EPointerCursorNone

Don't have a pointer cursor.

EPointerCursorFixed

The default system pointer cursor is used whenever there is a pointer cursor.

EPointerCursorNormal

The default system pointer cursor is used unless the window the pointer cursor is above specifies one, in which case that cursor is used.

EPointerCursorWindow

There is no pointer cursor unless the pointer is above a window that has specified one.

EPointerCursorFirstMode

First pointer cursor mode.

This is used in test code for iterating though available modes.

EPointerCursorLastMode

The final pointer cursor mode.

This is used in test code for iterating though available modes. It will be updated if more modes are added.

[Top]


Enum TLongCaptureFlags

TLongCaptureFlags

Description

Flags which customise a long key press capture request made by a window group.

These flags are passed to RWindowGroup::CaptureLongKey(TUint,TUint,TUint,TUint,TInt,TUint).

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.

See also:

ELongCaptureShortEventImmediately

If specified, the normal ("short") key event is sent immediately (on key down) to the application with keyboard focus. If not specified, the normal key event is sent when the key is released (if the key is not held down long enough to generate a long key event).

ELongCaptureRepeatEvents

If specified, causes the long key press to automatically repeat. If not specified, the long key press will generate a single key event only.

ELongCaptureNormal

Equivalent to ELongCaptureShortEventImmediately being set and the other flags unset.

ELongCaptureWaitShort

Equivalent to the first two values being unset.

[Top]


Enum TWsTransparencyPolicy

TWsTransparencyPolicy

Description

Transparency policies

These policies are to control the behaviour of a transparent window.

See also:

ETransparencyDefault

Default behaviour.

ETransparencyFreezeUnder

Freeze the content of underneath the transparent window to prevent redraw everytime the overlying window changes.


W32STD.H Global variables