#include <e32event.h>
Link against: euser.lib

Class `TRawEvent`

class TRawEvent;

Description

Represents a raw hardware event as generated by hardware drivers of a pointer device, a keyboard etc.

Raw hardware events are added to the kernel's event queue.

Members

Defined in TRawEvent:

DeviceNumber()constGets the device number (eg. screen number)
EActive
EButton1DownRepresents a button down event.
EButton1UpRepresents a button up event.
EButton2DownRepresents a button down event.
EButton2UpRepresents a button up event.
EButton3DownRepresents a button down event.
EButton3UpRepresents a button up event.
ECaseCloseRepresents a case close event.
ECaseOpenRepresents a case open event.
EInactive
EKeyDownRepresents a keyboard key down event.
EKeyRepeatRepresents a key being continually pressed event.
EKeyUpRepresents a keyboard key up event.
ENoneRepresents an uninitialised event object.
EPointerMoveA pointer device (e.g. a pen) has moved. Only changes in Cartesian coordinates a...
EPointerSwitchOnA switch on event caused by a screen tap using a pointer device.
ERedrawRepresents a redraw event.
ERestartSystemRepresents a device restart event.
ESwitchOffRepresents a device switch off event.
ESwitchOnRepresents a device switch on event.
EUpdateModifiersRepresents a modifier key being pressed.
IsTip()constGets the information on which end of the pointing device is closer to the screen
Modifiers()constGets the modifiers.
Pos()constGets the mouse or digitiser X-Y position.
Pos3D()constGets the Cartesian coordinates of the 3D pointer end that is closer to the scree...
Rotation()constGets the rotation angle of 3D pointing device.
ScanCode()constGets the scancode.
Set(TType)Sets up an event without specific parameters.
Set(TType,TInt)Sets the event up as a scancode event.
Set(TType,TInt,TInt)Sets the event up as a mouse/pen event.
Set(TType,TInt,TInt,TInt)Sets the event up as a 3D pointer linear move event.
Set(TType,TInt,TInt,TInt,TInt,TInt,TInt)Sets the event up as a 3D pointer linear move and tilt and rotation change event...
SetDeviceNumber(TInt)Sets the device number (eg. screen number)
SetRotation(TType,TInt)Sets the event up as 3D pointer rotation event.
SetTilt(TType,TInt,TInt)Sets the event up as 3D pointer tilt change event.
SetTip(TBool)Sets the information on which end of the pointing device is closer to the screen
TRawEvent()Default constructor
TTypeDefines the event type.
Ticks()constGets the tick count value associated with the event.
Tilt()constGets the angular spherical polar coordinates of the 3D pointer end that is close...
Type()constGets the event type
alpha
iDeviceNumber
iSpare2
iTicks
iTipIndicates whether the tip or head of pointing device is closer to screen.
iType
iU
modifiers
phi
pos
pos3D
scanCode
theta
x
y
z

Construction and destruction

`TRawEvent()`

inline TRawEvent();

Description

Default constructor

Member functions

`Type()const`

inline TType Type() const;

Description

Gets the event type

Return value


                                 						TRawEvent::TType

The event type.

`DeviceNumber()const`

inline TInt DeviceNumber() const;

Description

Gets the device number (eg. screen number)

Return value


                                 						TInt

The device number.

`SetDeviceNumber(TInt)`

inline void SetDeviceNumber(TInt aDeviceNumber);

Description

Sets the device number (eg. screen number)

Parameters


                                 						TInt aDeviceNumber

The device number

`Pos()const`

IMPORT_C TPoint Pos() const;

Description

Gets the mouse or digitiser X-Y position.

Return value

TPoint

The position.

`ScanCode()const`

IMPORT_C TInt ScanCode() const;

Description

Gets the scancode.

Return value

TInt

The scancode.

`Modifiers()const`

IMPORT_C TInt Modifiers() const;

Description

Gets the modifiers.

Return value

TInt

The modifiers.

Panic codes

EUSER

34 If the event does not represent a modifier key being pressed, i.e. if the event type is not TRawEvent::EUpdateModifiers

`Pos3D()const`

IMPORT_C TPoint3D Pos3D() const;

Description

Gets the Cartesian coordinates of the 3D pointer end that is closer to the screen.

Return value

TPoint3D

The Cartesian coordinates of the point defined by the end of the 3D pointing device that is closer to the screen.

`Tilt()const`

IMPORT_C TAngle3D Tilt() const;

Description

Gets the angular spherical polar coordinates of the 3D pointer end that is closer to the screen.

Return value

TAngle3D

The angular spherical polar coordinates of the point defined by the end of the 3D pointing device that is closer to the screen.

`Rotation()const`

IMPORT_C TInt Rotation() const;

Description

Gets the rotation angle of 3D pointing device.

Some 3D pointing devices support information regarding the angle formed between the physical and magnetical poles, as obtaining when rotating the pen along its main axis.

Return value

TInt

The rotation angle of the 3D pointing device.

`Ticks()const`

inline TUint Ticks() const;

Description

Gets the tick count value associated with the event.

Note that the interval between tick counts is hardware dependent.

Return value


                                 						TUint

The tick count value

`IsTip()const`

inline TBool IsTip() const;

Description

Gets the information on which end of the pointing device is closer to the screen

Return value


                                 						TBool

A Boolean indicating which end of the pointing device is closer to the screen.

`SetTip(TBool)`

inline void SetTip(TBool aTip);

Description

Sets the information on which end of the pointing device is closer to the screen

Parameters


                                 						TBool aTip

A Boolean indicating which end of the pointing device is closer to the screen.

`Set(TType,TInt)`

IMPORT_C void Set(TType aType, TInt aScanCode);

Description

Sets the event up as a scancode event.

Parameters

`TRawEvent::TType aType`	The event type.
`TInt aScanCode`	The scancode.

`Set(TType,TInt,TInt)`

IMPORT_C void Set(TType aType, TInt aX, TInt aY);

Description

Sets the event up as a mouse/pen event.

Parameters

`TRawEvent::TType aType`	The event type.
`TInt aX`	The X position.
`TInt aY`	The Y position.

`Set(TType)`

IMPORT_C void Set(TType aType);

Description

Sets up an event without specific parameters.

Parameters


                                 						TRawEvent::TType aType

The event type.

`Set(TType,TInt,TInt,TInt)`

IMPORT_C void Set(TType aType, TInt aX, TInt aY, TInt aZ);

Description

Sets the event up as a 3D pointer linear move event.

Parameters

`TRawEvent::TType aType`	The event type.
`TInt aX`	The X position.
`TInt aY`	The Y position.
`TInt aZ`	The Z position (defaults to 0 on 2D detection devices).

`Set(TType,TInt,TInt,TInt,TInt,TInt,TInt)`

IMPORT_C void Set(TType aType, TInt aX, TInt aY, TInt aZ, TInt aPhi, TInt aTheta, TInt aAlpha);

Description

Sets the event up as a 3D pointer linear move and tilt and rotation change event.

Parameters

`TRawEvent::TType aType`	The event type.
`TInt aX`	The X position (or TPhi polar coordinate).
`TInt aY`	The Y position (or Theta polar coordinate).
`TInt aZ`	The Z position (or rotation).
`TInt aPhi`	The Phi polar coordinate.
`TInt aTheta`	The Theta polar coordinate.
`TInt aAlpha`	The rotation angle.

`SetTilt(TType,TInt,TInt)`

IMPORT_C void SetTilt(TType aType, TInt aPhi, TInt aTheta);

Description

Sets the event up as 3D pointer tilt change event.

Parameters

`TRawEvent::TType aType`	The event type.
`TInt aPhi`	The Phi coordinate.
`TInt aTheta`	The Theta coordinate.

`SetRotation(TType,TInt)`

IMPORT_C void SetRotation(TType aType, TInt aAlpha);

Description

Sets the event up as 3D pointer rotation event.

Parameters

`TRawEvent::TType aType`	The event type.
`TInt aAlpha`	The rotation angle.

Member enumerations

Enum `TType`

TType

Description

Defines the event type.

`ENone`	Represents an uninitialised event object.
`EPointerMove`	A pointer device (e.g. a pen) has moved. Only changes in Cartesian coordinates are tracked.
`EPointerSwitchOn`	A switch on event caused by a screen tap using a pointer device.
`EKeyDown`	Represents a keyboard key down event.
`EKeyUp`	Represents a keyboard key up event.
`ERedraw`	Represents a redraw event. Typically generated in an emulator environment in response to a host OS redraw event.
`ESwitchOn`	Represents a device switch on event.
`EActive`
`EInactive`
`EUpdateModifiers`	Represents a modifier key being pressed.
`EButton1Down`	Represents a button down event. This is typically used to represent a pointing device coming into contact with a touch sensitive screen.
`EButton1Up`	Represents a button up event. This is typically used to represent a pointing device being lifted away from a touch sensitive screen.
`EButton2Down`	Represents a button down event. This is typically used to represent a pointing device coming into contact with a touch sensitive screen.
`EButton2Up`	Represents a button up event. This is typically used to represent a pointing device being lifted away from a touch sensitive screen.
`EButton3Down`	Represents a button down event. This is typically used to represent a pointing device coming into contact with a touch sensitive screen.
`EButton3Up`	Represents a button up event. This is typically used to represent a pointing device being lifted away from a touch sensitive screen.
`ESwitchOff`	Represents a device switch off event.
`EKeyRepeat`	Represents a key being continually pressed event.
`ECaseOpen`	Represents a case open event. The meaning of a case is hardware specific.
`ECaseClose`	Represents a case close event. The meaning of a case is hardware specific.
`ERestartSystem`	Represents a device restart event.

Member data

`iType`

protected: TUint8 iType;

Description

`iTip`

protected: TUint8 iTip;

Description

Indicates whether the tip or head of pointing device is closer to screen.

`iSpare2`

protected: TUint8 iSpare2;

Description

`iDeviceNumber`

protected: TUint8 iDeviceNumber;

Description

`iTicks`

protected: TUint iTicks;

Description

`x`

protected: TInt x;

Description

`y`

protected: TInt y;

Description

`pos`

protected: TRawEvent::@52::@53 pos;

Description

`z`

protected: TInt z;

Description

`phi`

protected: TInt phi;

Description

`theta`

protected: TInt theta;

Description

`alpha`

protected: TInt alpha;

Description

`pos3D`

protected: TRawEvent::@52::@54 pos3D;

Description

`scanCode`

protected: TInt scanCode;

Description

`modifiers`

protected: TInt modifiers;

Description

`iU`

protected: TRawEvent::@52 iU;

Class TRawEvent

Description

Members

Construction and destruction

TRawEvent()

Description

Member functions

Type()const

Description

Return value

DeviceNumber()const

Description

Return value

SetDeviceNumber(TInt)

Description

Parameters

Pos()const

Description

Return value

ScanCode()const

Description

Return value

Modifiers()const

Description

Return value

Panic codes

See also:

Pos3D()const

Description

Return value

Tilt()const

Description

Return value

Rotation()const

Description

Return value

Ticks()const

Description

Return value

IsTip()const

Description

Return value

SetTip(TBool)

Description

Parameters

Set(TType,TInt)

Description

Parameters

Set(TType,TInt,TInt)

Description

Parameters

Set(TType)

Description

Parameters

Set(TType,TInt,TInt,TInt)

Description

Parameters

Set(TType,TInt,TInt,TInt,TInt,TInt,TInt)

Description

Parameters

SetTilt(TType,TInt,TInt)

Description

Parameters

SetRotation(TType,TInt)

Description

Parameters

Member enumerations

Enum TType

Description

Member data

iType

Description

iTip

Description

iSpare2

Description

iDeviceNumber

Description

iTicks

Description

Class `TRawEvent`

`TRawEvent()`

`Type()const`

`DeviceNumber()const`

`SetDeviceNumber(TInt)`

`Pos()const`

`ScanCode()const`

`Modifiers()const`

`Pos3D()const`

`Tilt()const`

`Rotation()const`

`Ticks()const`

`IsTip()const`

`SetTip(TBool)`

`Set(TType,TInt)`

`Set(TType,TInt,TInt)`

`Set(TType)`

`Set(TType,TInt,TInt,TInt)`

`Set(TType,TInt,TInt,TInt,TInt,TInt,TInt)`

`SetTilt(TType,TInt,TInt)`

`SetRotation(TType,TInt)`

Enum `TType`

`iType`

`iTip`

`iSpare2`

`iDeviceNumber`

`iTicks`

`x`

`y`

`pos`

`z`

`phi`

`theta`

`alpha`

`pos3D`

`scanCode`

`modifiers`

`iU`