sl@0: // Copyright (c) 1994-2010 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 "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: // sl@0: sl@0: #ifndef ADVANCEDPOINTEREVENT_H sl@0: #define ADVANCEDPOINTEREVENT_H sl@0: sl@0: #ifndef __E32STD_H__ sl@0: #include sl@0: #endif sl@0: #ifndef __E32KEYS_H__ sl@0: #include sl@0: #endif sl@0: #ifndef POINTEREVENT_H sl@0: #include sl@0: #endif sl@0: sl@0: sl@0: /** Subclass of TPointerEvent created in order to maintain binary compatibility while sl@0: extending TPointerEvent with new data: sl@0: (1) pointer number of the pointer whose state change is described by the event, sl@0: (2) proximity of the pointer to the screen's surface, sl@0: (3) pressure applied by the pointer to the screen. sl@0: sl@0: These new attributes will be present only on devices that support them, otherwise sl@0: they will be set to 0. sl@0: sl@0: @see TPointerEvent sl@0: @see TPointerEvent::AdvancedPointerEvent() sl@0: @see TPointerEvent::IsAdvancedPointerEvent() sl@0: @see TWsEvent::Pointer() sl@0: @publishedAll sl@0: @released */ sl@0: class TAdvancedPointerEvent : public TPointerEvent sl@0: { sl@0: public: sl@0: enum sl@0: { sl@0: /** sl@0: The value used by Symbian OS as the default pointer number for pointer-related sl@0: event objects which do not contain a pointer number member. sl@0: sl@0: WARNING: Enum for internal use ONLY. Compatibility is not guaranteed in future releases. sl@0: */ sl@0: EDefaultPointerNumber = 0, sl@0: /** sl@0: Maximum number of pointers that WServ is able to support. On each particular platform, sl@0: the number of supported pointers must be less than or equal to this value. sl@0: sl@0: WARNING: Enum for internal use ONLY. Compatibility is not guaranteed in future releases. sl@0: */ sl@0: EMaximumWServNumberOfPointers = 8 sl@0: }; sl@0: sl@0: // Public API's for WServ Clients sl@0: inline TAdvancedPointerEvent(); sl@0: inline TInt PointerNumber() const; sl@0: inline TInt Proximity() const; sl@0: inline TInt Pressure() const; sl@0: inline TInt ProximityAndPressure() const; sl@0: inline TPoint3D Position3D() const; sl@0: inline TPoint3D Pressure3D() const; sl@0: inline TPoint3D PositionAndPressure3D() const; sl@0: sl@0: IMPORT_C TAdvancedPointerEvent(const TAdvancedPointerEvent& aPointerEvent); sl@0: IMPORT_C TAdvancedPointerEvent& operator=(const TAdvancedPointerEvent& aPointerEvent); sl@0: sl@0: private: sl@0: // The methods in this section are internalTechnology and intended for use by TWsEvent sl@0: // and TAdvancedPointerEventHelper (internal WSERV class). sl@0: friend class TWsEvent; sl@0: friend class TAdvancedPointerEventHelper; sl@0: sl@0: enum sl@0: { sl@0: /** sl@0: Value used as return value from PointerNumber API when the object is a TPointerEvent sl@0: not a TAdvancedPointerEvent (as indicated by the iModifier flags). sl@0: */ sl@0: ENonAdvancedPointerPointerNumber = EDefaultPointerNumber, sl@0: }; sl@0: enum sl@0: { sl@0: /** sl@0: Value used to distinguish between pressure and proximity Z values by Pressure or sl@0: Proximity Specific APIs. sl@0: */ sl@0: EPressureProximityCrossover = 0, sl@0: /** sl@0: Value used as return Z value from APIs when the object is a TPointerEvent sl@0: not a TAdvancedPointerEvent (as indicated by the iModifier flags). sl@0: */ sl@0: ENonAdvancedPointerZCoordinate = EPressureProximityCrossover, sl@0: }; sl@0: sl@0: // Private API's for external usage, via inlined accessors sl@0: IMPORT_C TInt DoGetPointerNumber() const; sl@0: IMPORT_C TInt DoGetProximity() const; sl@0: IMPORT_C TInt DoGetPressure() const; sl@0: IMPORT_C TInt DoGetProximityAndPressure() const; sl@0: sl@0: // Private API's for internal WSERV usage. It is impossible to inline them into sl@0: // client's binaries, thus implementation may be changed in the future. sl@0: inline void Init(); sl@0: inline void Init(const TPointerEvent::TType aType, const TUint aModifiers, const TPoint3D &aPoint3D, const TUint8 aPointerNumber); sl@0: inline void SetPointerNumber(TUint8 aPointerNumber); sl@0: inline void SetPointerZ(TInt aZ); sl@0: inline void Copy(const TAdvancedPointerEvent& aPointerEvent); sl@0: sl@0: /** WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. */ sl@0: union sl@0: { sl@0: struct {TInt iSpare1; TInt iSpare2;} ints; // 8 bytes to fill TWsEvent sl@0: struct {TInt32 iPosZ; TUint8 iPointerNumber;} multiPos3D; sl@0: } iData; sl@0: }; sl@0: sl@0: /** Default Constructor for TAdvancedPointerEvent sl@0: sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: inline TAdvancedPointerEvent::TAdvancedPointerEvent() {} sl@0: sl@0: inline const TAdvancedPointerEvent* TPointerEvent::AdvancedPointerEvent() const sl@0: /** Casts this TPointerEvent to TAdvancedPointerEvent in order to provide access sl@0: to event's pointer number, pressure and proximity (these attributes are accessible sl@0: through appropriate getters of TAdvancedPointerEvent class). sl@0: sl@0: If this is not an instance of TAdvancedPointerEvent, NULL will be returned. sl@0: Please note that TAdvancedPointerEvents are delivered only to windows for sl@0: which they have been enabled using RWindowBase::EnableAdvancedPointers() method. sl@0: sl@0: @return A pointer to this object as TAdvancedPointerEvent or NULL if this is not sl@0: an instance of TAdvancedPointerEvent. sl@0: @see TPointerEvent::IsAdvancedPointerEvent() sl@0: @see RWindowBase::EnableAdvancedPointers() sl@0: @publishedAll sl@0: @released */ sl@0: { sl@0: return (iModifiers&EModifierAdvancedPointerEvent ? static_cast(this) : NULL); sl@0: } sl@0: sl@0: #include "advancedpointerevent.inl" sl@0: sl@0: #endif /* ADVANCEDPOINTEREVENT_H */