sl@0: // Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // e32\include\e32event.h
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __E32EVENT_H__
sl@0: #define __E32EVENT_H__
sl@0: #include <e32cmn.h>
sl@0: #ifdef BTRACE_TRAWEVENT	
sl@0: #include <e32btrace.h>
sl@0: #endif
sl@0: 
sl@0: /**
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: const TInt KUndefinedDeviceNumber = -1;
sl@0: 
sl@0: /**
sl@0: @publishedAll
sl@0: @released
sl@0: 
sl@0: Represents a raw hardware event as generated by hardware drivers of
sl@0: a pointer device, a keyboard etc.
sl@0: 
sl@0: Raw hardware events are added to the kernel's event queue.
sl@0: */
sl@0: class TRawEvent
sl@0: 	{
sl@0: public:
sl@0: 
sl@0:     /**
sl@0:     Defines the event type.
sl@0:     */
sl@0: 	enum TType
sl@0: 		{
sl@0: 		
sl@0: 		/**
sl@0: 		Represents an uninitialised event object.
sl@0: 		*/
sl@0: 		ENone,
sl@0: 		
sl@0: 		/**
sl@0: 		A pointer device (e.g. a pen) has moved. Only changes in Cartesian coordinates are tracked.
sl@0: 		*/
sl@0: 		EPointerMove,
sl@0: 		
sl@0: 		/**
sl@0: 		A switch on event caused by a screen tap using a pointer device. 
sl@0: 		*/
sl@0:         EPointerSwitchOn,
sl@0:         
sl@0:         /**
sl@0:         Represents a keyboard key down event.
sl@0:         */
sl@0: 		EKeyDown,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a keyboard key up event.
sl@0: 		*/
sl@0: 		EKeyUp,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a redraw event.
sl@0: 		
sl@0: 		Typically generated in an emulator environment in response
sl@0: 		to a host OS redraw event.
sl@0: 		*/
sl@0: 		ERedraw,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a device switch on event.
sl@0: 		*/
sl@0: 		ESwitchOn,
sl@0: 		
sl@0: 		/**
sl@0: 		*/
sl@0:         EActive,
sl@0:         
sl@0:   		/**
sl@0: 		*/
sl@0: 		EInactive,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a modifier key being pressed.
sl@0: 		*/
sl@0: 		EUpdateModifiers,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a button down event.
sl@0: 		
sl@0: 		This is typically used to represent a pointing device
sl@0: 		coming into contact with a touch sensitive screen.
sl@0: 		*/
sl@0: 		EButton1Down,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a button up event.
sl@0: 		
sl@0: 		This is typically used to represent a pointing device
sl@0: 		being lifted away from a touch sensitive screen.
sl@0: 		*/
sl@0: 		EButton1Up,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a button down event.
sl@0: 		
sl@0: 		This is typically used to represent a pointing device
sl@0: 		coming into contact with a touch sensitive screen.
sl@0: 		*/
sl@0: 		EButton2Down,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a button up event.
sl@0: 		
sl@0: 		This is typically used to represent a pointing device
sl@0: 		being lifted away from a touch sensitive screen.
sl@0: 		*/
sl@0: 		EButton2Up,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a button down event.
sl@0: 		
sl@0: 		This is typically used to represent a pointing device
sl@0: 		coming into contact with a touch sensitive screen.
sl@0: 		*/
sl@0: 		EButton3Down,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a button up event.
sl@0: 		
sl@0: 		This is typically used to represent a pointing device
sl@0: 		being lifted away from a touch sensitive screen.
sl@0: 		*/
sl@0: 		EButton3Up,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a device switch off event.
sl@0: 		*/
sl@0: 		ESwitchOff,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a key being continually pressed event.
sl@0: 		*/
sl@0: 		EKeyRepeat,
sl@0: 		
sl@0: 		/**
sl@0: 		Represents a case open event.
sl@0: 		
sl@0: 		The meaning of a case is hardware specific.
sl@0: 		*/
sl@0: 		ECaseOpen,
sl@0: 		
sl@0: 		/**
sl@0:         Represents a case close event.
sl@0: 		
sl@0: 		The meaning of a case is hardware specific.
sl@0: 		*/
sl@0: 		ECaseClose,
sl@0: 
sl@0: 		/**
sl@0: 		@prototype
sl@0:         Represents a 3D pointer entering the detection volume event.
sl@0: 		
sl@0: 		This is typically used to represent a pointing device
sl@0: 		coming into detection range of a sensitive screen.
sl@0: 		*/
sl@0: 		EPointer3DInRange,
sl@0: 
sl@0: 		/**
sl@0: 		@prototype
sl@0:         Represents a 3D pointer leaving the detection volume event.
sl@0: 		
sl@0: 		This is typically used to represent a pointing device
sl@0: 		leaving the detection range of a sensitive screen.
sl@0: 		*/
sl@0: 		EPointer3DOutOfRange,
sl@0: 
sl@0: 		/**
sl@0: 		@prototype
sl@0:         Represents a 3D pointer tilt changes only event.
sl@0: 		
sl@0: 		This is typically sent by a 3D pointer driver when it detects
sl@0: 		a change in the pointer's polar coordinates (Theta or Phi).
sl@0: 		*/
sl@0: 		EPointer3DTilt,
sl@0: 
sl@0: 		/**
sl@0: 		@prototype
sl@0:         Represents a 3D pointer rotation only event.
sl@0: 		
sl@0: 		This is typically sent by a 3D pointer driver when it detects
sl@0: 		a rotation of the pointing device (along ist main axis).
sl@0: 		*/
sl@0: 		EPointer3DRotation,
sl@0: 
sl@0: 		/**
sl@0: 		@prototype
sl@0:         Represents a general 3D pointer changes event.
sl@0: 		
sl@0: 		This is typically sent by a 3D pointer driver when it detects
sl@0: 		a change in the pointer's linear and/or polar coordinates and/or rotation.
sl@0: 		*/
sl@0: 		EPointer3DTiltAndMove,
sl@0: 
sl@0: 		/**
sl@0: 		@prototype
sl@0: 		Reserved for a 3D pointing device button down event.
sl@0: 		*/
sl@0: 		EButton4Down,
sl@0: 		
sl@0: 		/**
sl@0: 		@prototype
sl@0: 		Reserved for a 3D pointing device button up event.
sl@0: 		*/
sl@0: 		EButton4Up,
sl@0: 
sl@0: 		/**
sl@0: 		@prototype
sl@0: 		Reserved for a 3D pointing device button down event.
sl@0: 		*/
sl@0: 		EButton5Down,
sl@0: 		
sl@0: 		/**
sl@0: 		@prototype
sl@0: 		Reserved for a 3D pointing device button up event.
sl@0: 		*/
sl@0: 		EButton5Up,
sl@0: 
sl@0: 		/**
sl@0: 		@prototype
sl@0: 		Reserved for a 3D pointing device button down event.
sl@0: 		*/
sl@0: 		EButton6Down,
sl@0: 		
sl@0: 		/**
sl@0: 		@prototype
sl@0: 		Reserved for a 3D pointing device button up event.
sl@0: 		*/
sl@0: 		EButton6Up,
sl@0: 
sl@0: 		/**
sl@0: 		Represents a device restart event.
sl@0: 		*/
sl@0: 		ERestartSystem
sl@0: 		};
sl@0: public:
sl@0: 
sl@0:     /**
sl@0:     Default constructor
sl@0:     */
sl@0: 	inline TRawEvent()
sl@0: 		{ *(TInt*)&iType=0; }
sl@0: 		
sl@0: 	/**
sl@0: 	Gets the event type
sl@0: 	
sl@0: 	@return The event type.
sl@0: 	*/	
sl@0: 	inline TType Type() const
sl@0: 		{return TType(iType);}
sl@0: 
sl@0: 	/**
sl@0: 	Gets the device number (eg. screen number)
sl@0: 
sl@0: 	@return The device number.
sl@0: 	*/
sl@0: 	inline TInt DeviceNumber() const
sl@0: 		{return TInt(iDeviceNumber-1);}
sl@0: 
sl@0: 	/**
sl@0: 	Sets the device number (eg. screen number)
sl@0: 
sl@0: 	@param aDeviceNumber The device number
sl@0: 	*/
sl@0: 	inline void SetDeviceNumber(TInt aDeviceNumber)
sl@0: 		{iDeviceNumber = TUint8(aDeviceNumber+1);}
sl@0: 
sl@0: 	IMPORT_C TPoint Pos() const;
sl@0: 	IMPORT_C TInt ScanCode() const;
sl@0:     IMPORT_C TInt Modifiers() const;
sl@0: 	IMPORT_C TInt Repeats() const;
sl@0:     
sl@0:     /**
sl@0:     Gets the Cartesian coordinates of the 3D pointer end that is closer to the screen.
sl@0:     
sl@0:     @return The Cartesian coordinates of the point defined by the end of the 3D pointing device that is closer to the screen.
sl@0:     */
sl@0: 	IMPORT_C TPoint3D Pos3D() const;
sl@0:     
sl@0: 
sl@0: 	/**
sl@0:     Gets the angular spherical polar coordinates of the 3D pointer end that is closer to the screen.
sl@0:     
sl@0:     @return The angular spherical polar coordinates of the point defined by the end of the 3D pointing device that is closer to the screen.
sl@0: 	@see TAngle3D
sl@0: 	*/
sl@0: 	IMPORT_C TAngle3D Tilt() const;
sl@0: 
sl@0: 	/**
sl@0:     Gets the rotation angle of 3D pointing device.
sl@0: 
sl@0:     Some 3D pointing devices support information regarding the angle formed between the physical and magnetical poles,
sl@0: 	as obtaining when rotating the pen along its main axis.
sl@0: 
sl@0:     @return The rotation angle of the 3D pointing device.
sl@0:     */
sl@0: 	IMPORT_C TInt Rotation() const;
sl@0: 
sl@0:     /**
sl@0:     Gets the tick count value associated with the event.
sl@0:     
sl@0:     Note that the interval between tick counts is
sl@0:     hardware dependent.
sl@0:     
sl@0:     @return The tick count value
sl@0:     */
sl@0: 	inline TUint Ticks() const
sl@0: 		{return iTicks;}
sl@0: 	/**
sl@0: 	Gets the information on which end of the pointing device is closer to the screen
sl@0: 	
sl@0: 	@return A Boolean indicating which end of the pointing device is closer to the screen.
sl@0: 	*/	
sl@0: 	inline TBool IsTip() const
sl@0: 		{return TBool(iTip);}
sl@0: 	
sl@0: 	/**
sl@0: 	Sets the information on which end of the pointing device is closer to the screen
sl@0: 	
sl@0: 	@param aTip A Boolean indicating which end of the pointing device is closer to the screen.
sl@0: 	*/	
sl@0: 	inline void SetTip(TBool aTip)
sl@0: 		{iTip = TUint8(aTip);
sl@0: #ifdef BTRACE_TRAWEVENT	
sl@0: 		BTraceContext4(BTrace::ERawEvent, BTrace::ESetTipEvent,(TUint32)aTip);
sl@0: #endif
sl@0: 		}
sl@0: 
sl@0: 	IMPORT_C void Set(TType aType,TInt aScanCode);
sl@0: 	IMPORT_C void Set(TType aType,TInt aX,TInt aY);
sl@0: 	IMPORT_C void Set(TType aType);
sl@0: 
sl@0: 	IMPORT_C void Set(TType aType,TInt aX,TInt aY,TInt aZ);
sl@0: 	IMPORT_C void Set(TType aType,TInt aX,TInt aY,TInt aZ,TInt aPhi,TInt aTheta,TInt aAlpha);
sl@0: 
sl@0: 	IMPORT_C void SetTilt(TType aType,TInt aPhi,TInt aTheta);
sl@0: 	IMPORT_C void SetRotation(TType aType,TInt aAlpha);
sl@0: 	IMPORT_C void SetRepeat(TType aType,TInt aScanCode,TInt aRepeats);
sl@0: 
sl@0: 	/**
sl@0: 	@return the pointer number of the the event
sl@0: 	*/
sl@0: 	inline TUint8 PointerNumber() const
sl@0: 		{
sl@0: 		return iPointerNumber;
sl@0: 		}
sl@0: 
sl@0: 
sl@0: 	/**
sl@0: 	The pointer number for the event is set
sl@0: 	The pointer  number should be more or equal 0 and should be less than HALData::EPointerMaxPointers,
sl@0: 	otherwise WSERV would ignore the event,ie 	0 <= aPointerNumber < HALData::EPointerMaxPointers 
sl@0: 	@param	aPointerNumber
sl@0: 	Error conditions: None.
sl@0: 	*/
sl@0: 	inline void SetPointerNumber(const TUint8 aPointerNumber)
sl@0: 		{
sl@0: 		iPointerNumber=aPointerNumber;	
sl@0: #ifdef BTRACE_TRAWEVENT	
sl@0: 		BTraceContext4(BTrace::ERawEvent, BTrace::ESetPointerNumberEvent,(TUint32)aPointerNumber);
sl@0: #endif
sl@0: 		}
sl@0: 
sl@0:     /**
sl@0: 	Initialises the event with the supplied information	
sl@0: 	@param	aType	The event type.
sl@0: 	@param	aX		The X position.
sl@0: 	@param	aY		The Y position.
sl@0: 	@param	aZ		The Z position.
sl@0: 	@param  aPointerNumber   The pointer number for the event
sl@0: 	*/
sl@0: 	IMPORT_C void Set (TType aType, TInt aX, TInt aY, TInt aZ, TUint8 aPointerNumber);
sl@0: 	
sl@0: protected:
sl@0: 	TUint8 iType;
sl@0: 	TUint8 iTip;	/**< Indicates whether the tip or head of pointing device is closer to screen.*/
sl@0: 	TUint8 iPointerNumber; //
sl@0: 	TUint8 iDeviceNumber;
sl@0: 	TUint iTicks;
sl@0: 	union
sl@0: 		{
sl@0: 		struct {TInt x;TInt y;} pos;
sl@0: 		struct {TInt x;TInt y;TInt z;TInt phi;TInt theta;TInt alpha;} pos3D;
sl@0: 		struct {TInt scanCode;TInt repeats;} key;
sl@0: 		TInt modifiers;
sl@0: 		} iU;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedAll
sl@0: @released
sl@0: 
sl@0: Encapsulates a hardware event object as a descriptor (package buffer) for
sl@0: the purpose of data transfer.
sl@0: */
sl@0: class TRawEventBuf : public TPckgBuf<TRawEvent>
sl@0: 	{
sl@0: public:
sl@0: 
sl@0:     /**
sl@0:     Gets the hardware event object from the package buffer.
sl@0:     
sl@0:     @return The hardware event object.
sl@0:     */
sl@0: 	inline TRawEvent &Event() const {return(*((TRawEvent *)&iBuf[0]));}
sl@0: 	};
sl@0: 
sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <e32event_private.h>
sl@0: #endif
sl@0: 
sl@0: #endif
sl@0: