1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/graphics/windowing/windowserver/inc/advancedpointerevent.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,157 @@
1.4 +// Copyright (c) 1994-2010 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef ADVANCEDPOINTEREVENT_H
1.20 +#define ADVANCEDPOINTEREVENT_H
1.21 +
1.22 +#ifndef __E32STD_H__
1.23 +#include <e32std.h>
1.24 +#endif
1.25 +#ifndef __E32KEYS_H__
1.26 +#include <e32keys.h>
1.27 +#endif
1.28 +#ifndef POINTEREVENT_H
1.29 +#include <pointerevent.h>
1.30 +#endif
1.31 +
1.32 +
1.33 +/** Subclass of TPointerEvent created in order to maintain binary compatibility while
1.34 +extending TPointerEvent with new data:
1.35 +(1) pointer number of the pointer whose state change is described by the event,
1.36 +(2) proximity of the pointer to the screen's surface,
1.37 +(3) pressure applied by the pointer to the screen.
1.38 +
1.39 +These new attributes will be present only on devices that support them, otherwise
1.40 +they will be set to 0.
1.41 +
1.42 +@see TPointerEvent
1.43 +@see TPointerEvent::AdvancedPointerEvent()
1.44 +@see TPointerEvent::IsAdvancedPointerEvent()
1.45 +@see TWsEvent::Pointer()
1.46 +@publishedAll
1.47 +@released */
1.48 +class TAdvancedPointerEvent : public TPointerEvent
1.49 + {
1.50 +public:
1.51 + enum
1.52 + {
1.53 + /**
1.54 + The value used by Symbian OS as the default pointer number for pointer-related
1.55 + event objects which do not contain a pointer number member.
1.56 +
1.57 + WARNING: Enum for internal use ONLY. Compatibility is not guaranteed in future releases.
1.58 + */
1.59 + EDefaultPointerNumber = 0,
1.60 + /**
1.61 + Maximum number of pointers that WServ is able to support. On each particular platform,
1.62 + the number of supported pointers must be less than or equal to this value.
1.63 +
1.64 + WARNING: Enum for internal use ONLY. Compatibility is not guaranteed in future releases.
1.65 + */
1.66 + EMaximumWServNumberOfPointers = 8
1.67 + };
1.68 +
1.69 + // Public API's for WServ Clients
1.70 + inline TAdvancedPointerEvent();
1.71 + inline TInt PointerNumber() const;
1.72 + inline TInt Proximity() const;
1.73 + inline TInt Pressure() const;
1.74 + inline TInt ProximityAndPressure() const;
1.75 + inline TPoint3D Position3D() const;
1.76 + inline TPoint3D Pressure3D() const;
1.77 + inline TPoint3D PositionAndPressure3D() const;
1.78 +
1.79 + IMPORT_C TAdvancedPointerEvent(const TAdvancedPointerEvent& aPointerEvent);
1.80 + IMPORT_C TAdvancedPointerEvent& operator=(const TAdvancedPointerEvent& aPointerEvent);
1.81 +
1.82 +private:
1.83 + // The methods in this section are internalTechnology and intended for use by TWsEvent
1.84 + // and TAdvancedPointerEventHelper (internal WSERV class).
1.85 + friend class TWsEvent;
1.86 + friend class TAdvancedPointerEventHelper;
1.87 +
1.88 + enum
1.89 + {
1.90 + /**
1.91 + Value used as return value from PointerNumber API when the object is a TPointerEvent
1.92 + not a TAdvancedPointerEvent (as indicated by the iModifier flags).
1.93 + */
1.94 + ENonAdvancedPointerPointerNumber = EDefaultPointerNumber,
1.95 + };
1.96 + enum
1.97 + {
1.98 + /**
1.99 + Value used to distinguish between pressure and proximity Z values by Pressure or
1.100 + Proximity Specific APIs.
1.101 + */
1.102 + EPressureProximityCrossover = 0,
1.103 + /**
1.104 + Value used as return Z value from APIs when the object is a TPointerEvent
1.105 + not a TAdvancedPointerEvent (as indicated by the iModifier flags).
1.106 + */
1.107 + ENonAdvancedPointerZCoordinate = EPressureProximityCrossover,
1.108 + };
1.109 +
1.110 + // Private API's for external usage, via inlined accessors
1.111 + IMPORT_C TInt DoGetPointerNumber() const;
1.112 + IMPORT_C TInt DoGetProximity() const;
1.113 + IMPORT_C TInt DoGetPressure() const;
1.114 + IMPORT_C TInt DoGetProximityAndPressure() const;
1.115 +
1.116 + // Private API's for internal WSERV usage. It is impossible to inline them into
1.117 + // client's binaries, thus implementation may be changed in the future.
1.118 + inline void Init();
1.119 + inline void Init(const TPointerEvent::TType aType, const TUint aModifiers, const TPoint3D &aPoint3D, const TUint8 aPointerNumber);
1.120 + inline void SetPointerNumber(TUint8 aPointerNumber);
1.121 + inline void SetPointerZ(TInt aZ);
1.122 + inline void Copy(const TAdvancedPointerEvent& aPointerEvent);
1.123 +
1.124 + /** WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. */
1.125 + union
1.126 + {
1.127 + struct {TInt iSpare1; TInt iSpare2;} ints; // 8 bytes to fill TWsEvent
1.128 + struct {TInt32 iPosZ; TUint8 iPointerNumber;} multiPos3D;
1.129 + } iData;
1.130 + };
1.131 +
1.132 +/** Default Constructor for TAdvancedPointerEvent
1.133 +
1.134 +@publishedAll
1.135 +@released
1.136 +*/
1.137 +inline TAdvancedPointerEvent::TAdvancedPointerEvent() {}
1.138 +
1.139 +inline const TAdvancedPointerEvent* TPointerEvent::AdvancedPointerEvent() const
1.140 +/** Casts this TPointerEvent to TAdvancedPointerEvent in order to provide access
1.141 + to event's pointer number, pressure and proximity (these attributes are accessible
1.142 + through appropriate getters of TAdvancedPointerEvent class).
1.143 +
1.144 + If this is not an instance of TAdvancedPointerEvent, NULL will be returned.
1.145 + Please note that TAdvancedPointerEvents are delivered only to windows for
1.146 + which they have been enabled using RWindowBase::EnableAdvancedPointers() method.
1.147 +
1.148 + @return A pointer to this object as TAdvancedPointerEvent or NULL if this is not
1.149 + an instance of TAdvancedPointerEvent.
1.150 + @see TPointerEvent::IsAdvancedPointerEvent()
1.151 + @see RWindowBase::EnableAdvancedPointers()
1.152 + @publishedAll
1.153 + @released */
1.154 + {
1.155 + return (iModifiers&EModifierAdvancedPointerEvent ? static_cast<const TAdvancedPointerEvent*>(this) : NULL);
1.156 + }
1.157 +
1.158 +#include "advancedpointerevent.inl"
1.159 +
1.160 +#endif /* ADVANCEDPOINTEREVENT_H */