qstmgesturelib/qstmgesture_if.h
changeset 0 1450b09d0cfd
child 3 0954f5dd2cd0
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/qstmgesturelib/qstmgesture_if.h	Tue May 04 12:39:35 2010 +0300
@@ -0,0 +1,155 @@
+/*
+* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: 
+*
+*/
+
+
+#ifndef QSTMGESTURE_IF_H_
+#define QSTMGESTURE_IF_H_
+
+#include <QtCore>
+namespace qstmGesture
+{
+
+enum QStm_GestureUid
+{
+    EGestureUidUnknown     = 0,
+    EGestureUidTouch,
+    EGestureUidTap,
+    EGestureUidDoubleTap   = EGestureUidTap,
+    EGestureUidLongPress,
+    EGestureUidHover,
+    EGestureUidPan,
+    EGestureUidRelease,
+    EGestureUidLeftRight,
+    EGestureUidUpDown,
+    EGestureUidFlick,
+    EGestureUidEdgeScroll,
+    EGestureUidPinch,
+    EGestureUidCornerZoom,
+    //
+    EStmGestureUid_Count
+};
+
+enum QStm_GestureAreaSettings
+{
+    ETouchTimeArea,
+    ETouchArea,
+    EHoldArea,
+    //
+    EGestureAreaSettingsCount
+};
+
+enum QStm_GestureSettings
+{
+    //ETouchTimeout,
+    EDoubleTapTimeout,
+    ESuppressTimeout,
+    EMoveSuppressTimeout,
+    EHoverSpeed,
+    EPanSpeedLow,
+    EPanSpeedHigh,
+    EFlickSpeed, 
+    EPinchSpeed,
+    EZoomCornerSize,
+    EEdgeScrollRange,
+    ECapacitiveUpUsed,
+    EPanDisabledWhileHovering,
+    EHoverDisabledWhilePanning,
+    EAdjustYPos,
+    EEnableFiltering,
+    EWServMessageInterception, // TBool
+    EMoveTolerance,
+    //
+    EGestureSettingsCount
+};
+
+struct QStm_GestureArea
+{
+public:
+    enum QStm_Shape
+    {
+        // Use GestureArea settings from globally defined default
+        EDefaultSettings = -1,
+        ERectangle  = 1, // == stmUiEventEngine::ERectangle,
+        ECircle     = 2, // == stmUiEventEngine::ECircle,
+        EEllipse    = 3  // == stmUiEventEngine::EEllipse
+    };
+
+    QStm_Shape m_shape;
+    int        m_timeout;
+    QSize      m_size;
+};
+
+enum QStm_EdgeScroll
+{
+    EEdgeScrollUp = 1,
+    EEdgeScrollDown,
+    EEdgeScrollLeft,
+    EEdgeScrollRight,
+    EEdgeScrollUnknown
+};
+
+enum QStm_TapType
+{
+    ETapTypeSingle = 1,
+    ETapTypeDouble
+};
+
+enum QStm_ZoomType
+{
+    EZoomUndefined  = 0,
+    EZoomIn         = 1,
+    EZoomOut        = 2
+};
+
+enum QStm_GestureDirection
+{
+    ENoDirection = 0,
+    //
+    ENorth = 1,
+    ENorthEast,
+    EEast,
+    ESouthEast,
+    ESouth,
+    ESouthWest,
+    EWest,
+    ENorthWest,
+};
+
+/*!
+ * Generic gesture interface.  The gestures
+ * contain a generic part and a gesture specific part
+ * is obtained using the getDetails() method.
+ *
+ */
+class QStm_GestureIf
+{
+public:
+    virtual QStm_GestureUid gestureUid() const = 0; // Identifier of recognizer type that issues the gesture
+    virtual QPoint getLocation() const = 0 ;    // Location where the gesture happened (if applicable)
+    virtual int getType() const = 0 ;           // If the gesture can have different types (like tap or double tap)
+    virtual float getSpeed() const = 0 ;  // px/msec, as calculated in the UI state machine, not valid in all cases
+    virtual void* getDetails() const = 0 ;        // Other possible details.... (can be a pointer to a larger struct)
+    virtual QString getGestureName() = 0 ;       // String name for gesture, makes possible to use single callback for gestures
+    virtual QPoint getLengthAndDirection() const { return QPoint(0,0); }  // very simple vector
+    virtual QStm_GestureDirection getDirection() const { return qstmGesture::ENoDirection; }
+    virtual QPointF getSpeedVec() const = 0;
+    virtual void* target() = 0;
+};
+
+} // namespace
+
+#endif /* QSTMGESTURE_IF_H_ */