Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: 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(), EActive, EButton1Down, EButton1Up, EButton2Down, EButton2Up, EButton3Down, EButton3Up, ECaseClose, ECaseOpen, EInactive, EKeyDown, EKeyRepeat, EKeyUp, ENone, EPointerMove, EPointerSwitchOn, ERedraw, ESwitchOff, ESwitchOn, EUpdateModifiers, IsTip(), Modifiers(), Pos(), Pos3D(), Rotation(), ScanCode(), Set(), Set(), Set(), Set(), Set(), SetDeviceNumber(), SetRotation(), SetTilt(), SetTip(), TRawEvent(), TType, Ticks(), Tilt(), Type(), alpha, iDeviceNumber, iSpare2, iTicks, iTip, iType, iU, modifiers, phi, pos, pos3D, scanCode, theta, x, y, z


Construction and destruction


TRawEvent()

inline TRawEvent();

Description

Default constructor

[Top]


Member functions


Type()

inline TType Type() const;

Description

Gets the event type

Return value

TType

The event type.


DeviceNumber()

inline TInt DeviceNumber() const;

Description

Gets the device number (eg. screen number)

Return value

TInt

The device number.


SetDeviceNumber()

inline void SetDeviceNumber(TInt aDeviceNumber);

Description

Sets the device number (eg. screen number)

Parameters

TInt aDeviceNumber

The device number


Pos()

IMPORT_C TPoint Pos() const;

Description

Gets the mouse or digitiser X-Y position.

Return value

TPoint

The position.


ScanCode()

IMPORT_C TInt ScanCode() const;

Description

Gets the scancode.

Return value

TInt

The scancode.


Modifiers()

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

See also:


Pos3D()

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

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

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

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

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

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

IMPORT_C void Set(TType aType, TInt aScanCode);

Description

Sets the event up as a scancode event.

Parameters

TType aType

The event type.

TInt aScanCode

The scancode.


Set()

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

Description

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

IMPORT_C void Set(TType aType);

Description

Sets up an event without specific parameters.

Parameters

TType aType

The event type.


Set()

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

TType aType

The event type.

TInt aX

The X position.

TInt aY

The Y position.

TInt aZ

The Z position (defaulst to 0 on 2D detection devices).


Set()

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

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

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

Description

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.


SetRotation()

IMPORT_C void SetRotation(TType aType, TInt aAlpha);

Description

Sets the event up as 3D pointer rotation event.

Parameters

TType aType

The event type.

TInt aAlpha

The rotation angle.

[Top]


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.

[Top]


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;

Description