Collapse all Symbian^3 Product Developer Library

TRawEvent Class Reference

class TRawEvent

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.

Public Member Functions
	TRawEvent()
TInt	DeviceNumber()
TBool	IsTip()
IMPORT_C TInt	Modifiers()
TUint8	PointerNumber()
IMPORT_C TPoint	Pos()
IMPORT_C TPoint3D	Pos3D()
IMPORT_C TInt	Repeats()
IMPORT_C TInt	Rotation()
IMPORT_C TInt	ScanCode()
IMPORT_C void	Set(TType, TInt)
IMPORT_C void	Set(TType, TInt, TInt)
IMPORT_C void	Set(TType)
IMPORT_C void	Set(TType, TInt, TInt, TInt)
IMPORT_C void	Set(TType, TInt, TInt, TInt, TInt, TInt, TInt)
IMPORT_C void	Set(TType, TInt, TInt, TInt, TUint8)
void	SetDeviceNumber(TInt)
void	SetPointerNumber(const TUint8)
IMPORT_C void	SetRepeat(TType, TInt, TInt)
IMPORT_C void	SetRotation(TType, TInt)
IMPORT_C void	SetTilt(TType, TInt, TInt)
void	SetTip(TBool)
TUint	Ticks()
IMPORT_C TAngle3D	Tilt()
TType	Type()

Public Member Enumerations
enum	TType { ENone, EPointerMove, EPointerSwitchOn, EKeyDown, EKeyUp, ERedraw, ESwitchOn, EActive, EInactive, EUpdateModifiers, EButton1Down, EButton1Up, EButton2Down, EButton2Up, EButton3Down, EButton3Up, ESwitchOff, EKeyRepeat, ECaseOpen, ECaseClose, EPointer3DInRange, EPointer3DOutOfRange, EPointer3DTilt, EPointer3DRotation, EPointer3DTiltAndMove, EButton4Down, EButton4Up, EButton5Down, EButton5Up, EButton6Down, EButton6Up, ERestartSystem }

Public Member Enumerations

enum

TType {
ENone, EPointerMove, EPointerSwitchOn, EKeyDown, EKeyUp, ERedraw, ESwitchOn, EActive, EInactive, EUpdateModifiers, EButton1Down, EButton1Up, EButton2Down, EButton2Up, EButton3Down, EButton3Up, ESwitchOff, EKeyRepeat, ECaseOpen, ECaseClose, EPointer3DInRange, EPointer3DOutOfRange, EPointer3DTilt, EPointer3DRotation, EPointer3DTiltAndMove, EButton4Down, EButton4Up, EButton5Down, EButton5Up, EButton6Down, EButton6Up, ERestartSystem
}

Public Attributes
TInt	modifiers
TInt	scanCode
TInt	y
TInt	z

Protected Attributes
TUint8	iDeviceNumber
TUint8	iPointerNumber
TUint	iTicks
TUint8	iTip
TUint8	iType
union TRawEvent::@26	iU

Constructor & Destructor Documentation

TRawEvent()

TRawEvent

(

)

[inline]

Default constructor

Member Functions Documentation

DeviceNumber()

TInt

DeviceNumber

(

)

const [inline]

Gets the device number (eg. screen number)

IsTip()

TBool

IsTip

(

)

const [inline]

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

Modifiers()

IMPORT_C TInt

Modifiers

(

)

const

Gets the modifiers.

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

TRawEvent::EUpdateModifiers

PointerNumber()

TUint8

PointerNumber

(

)

const [inline]

Pos()

IMPORT_C TPoint

Pos

(

)

const

Gets the mouse or digitiser X-Y position.

Pos3D()

IMPORT_C TPoint3D

Pos3D

(

)

const

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

Gets the 3D pointing device Cartesian coordinates.

Repeats()

IMPORT_C TInt

Repeats

(

)

const

Gets the repeat count.

Rotation()

IMPORT_C TInt

Rotation

(

)

const

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.

Gets the rotation angle of 3D pointing device.

ScanCode()

IMPORT_C TInt

ScanCode

(

)

const

Gets the scancode.

Set(TType, TInt)

IMPORT_C void	Set	(	TType	aType,
			TInt	aScanCode
		)

Sets the event up as a scancode event.

Parameters

TType aType	The event type.
TInt aScanCode	The scancode.

Set(TType, TInt, TInt)

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

Sets the event up as a mouse/pen event.

Parameters

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

Set(TType)

IMPORT_C void

Set

(

TType

aType

)

Sets up an event without specific parameters.

Parameters

TType aType

The event type.

Set(TType, TInt, TInt, TInt)

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

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

Parameters

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
		)

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

Parameters

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.

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

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

Initialises the event with the supplied information Sets the event up as a 3D pointer linear move event with pointer number

Parameters

TType aType	The event type.
TInt aX	The X position.
TInt aY	The Y position.
TInt aZ	The Z position .
TUint8 aPointerNumber	The pointer number for the event

SetDeviceNumber(TInt)

void

SetDeviceNumber

(

TInt

aDeviceNumber

)

[inline]

Sets the device number (eg. screen number)

Parameters

TInt aDeviceNumber

The device number

SetPointerNumber(const TUint8)

void

SetPointerNumber

(

const TUint8

aPointerNumber

)

[inline]

The pointer number for the event is set The pointer number should be more or equal 0 and should be less than HALData::EPointerMaxPointers, otherwise WSERV would ignore the event,ie 0 <= aPointerNumber < HALData::EPointerMaxPointers

Parameters

const TUint8 aPointerNumber

Error conditions: None.

SetRepeat(TType, TInt, TInt)

IMPORT_C void	SetRepeat	(	TType	aType,
			TInt	aScanCode,
			TInt	aRepeats
		)

Sets the event up as a repeating scancode event.

Parameters

TType aType	The event type.
TInt aScanCode	The scancode.
TInt aRepeats	The repeat count.

SetRotation(TType, TInt)

IMPORT_C void	SetRotation	(	TType	aType,
			TInt	aAlpha
		)

Sets the event up as 3D pointer rotation event.

Parameters

TType aType	The event type.
TInt aAlpha	The rotation angle.

SetTilt(TType, TInt, TInt)

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

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

Parameters

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

SetTip(TBool)

void

SetTip

(

TBool

aTip

)

[inline]

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.

Ticks()

TUint

Ticks

(

)

const [inline]

Gets the tick count value associated with the event.

Note that the interval between tick counts is hardware dependent.

Tilt()

IMPORT_C TAngle3D

Tilt

(

)

const

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

TAngle3DGets the 3D pointing device polar coordinates and rotation.

Type()

TType

Type

(

)

const [inline]

Gets the event type

Member Enumerations Documentation

Enum TType

Defines the event type.

Enumerators

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.
EPointer3DInRange	Represents a 3D pointer entering the detection volume event. This is typically used to represent a pointing device coming into detection range of a sensitive screen.
EPointer3DOutOfRange	Represents a 3D pointer leaving the detection volume event. This is typically used to represent a pointing device leaving the detection range of a sensitive screen.
EPointer3DTilt	Represents a 3D pointer tilt changes only event. This is typically sent by a 3D pointer driver when it detects a change in the pointer's polar coordinates (Theta or Phi).
EPointer3DRotation	Represents a 3D pointer rotation only event. This is typically sent by a 3D pointer driver when it detects a rotation of the pointing device (along ist main axis).
EPointer3DTiltAndMove	Represents a general 3D pointer changes event. This is typically sent by a 3D pointer driver when it detects a change in the pointer's linear and/or polar coordinates and/or rotation.
EButton4Down	Reserved for a 3D pointing device button down event.
EButton4Up	Reserved for a 3D pointing device button up event.
EButton5Down	Reserved for a 3D pointing device button down event.
EButton5Up	Reserved for a 3D pointing device button up event.
EButton6Down	Reserved for a 3D pointing device button down event.
EButton6Up	Reserved for a 3D pointing device button up event.
ERestartSystem	Represents a device restart event.

Member Data Documentation

TUint8 iDeviceNumber

TUint8

iDeviceNumber

[protected]

TUint8 iPointerNumber

TUint8

iPointerNumber

[protected]

TUint iTicks

TUint

iTicks

[protected]

TUint8 iTip

TUint8

iTip

[protected]

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

TUint8 iType

TUint8

iType

[protected]

union TRawEvent::@26 iU

union TRawEvent::@26

[protected]

TInt modifiers

TInt

modifiers

TInt scanCode

TInt

scanCode

TInt y

TInt

TInt z

TInt