capi/dali/public-api/events/long-press-gesture.h

   1 #ifndef __DALI_LONG_PRESS_GESTURE_H__
   2 #define __DALI_LONG_PRESS_GESTURE_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 /**
  22  * @addtogroup CAPI_DALI_EVENTS_MODULE
  23  * @{
  24  */
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/public-api/events/gesture.h>
  28 #include <dali/public-api/math/vector2.h>
  29
  30 namespace Dali DALI_IMPORT_API
  31 {
  32
  33 /**
  34  * @brief A LongPressGesture is emitted when the user touches and holds the screen with the stated number of fingers.
  35  *
  36  * This gesture can be in one of two states, when the long-press gesture is first detected: "Started";
  37  * and when the long-press gesture ends: "Finished".
  38  *
  39  * Long press gesture finishes when all touches have been released.
  40  *
  41  * @see LongPressGestureDetector
  42  */
  43 struct LongPressGesture : public Gesture
  44 {
  45   // Construction & Destruction
  46
  47   /**
  48    * @brief Constructor
  49    *
  50    * @param[in] state  The state of the gesture
  51    */
  52   LongPressGesture(Gesture::State state);
  53
  54   /**
  55    * @brief Copy constructor
  56    */
  57   LongPressGesture( const LongPressGesture& rhs );
  58
  59   /**
  60    * @brief Assignment operator
  61    */
  62   LongPressGesture& operator=( const LongPressGesture& rhs );
  63
  64   /**
  65    * @brief Virtual destructor
  66    */
  67   virtual ~LongPressGesture();
  68
  69   // Data
  70
  71   /**
  72    * @brief The number of touch points in this long press gesture, i.e. the number of fingers the user had
  73    * on the screen to generate the long press gesture.
  74    */
  75   unsigned int numberOfTouches;
  76
  77   /**
  78    * @brief This is the point, in screen coordinates, where the long press occurred.
  79    *
  80    * If a multi-touch long press, then this is the centroid of all the touch points.
  81    */
  82   Vector2 screenPoint;
  83
  84   /**
  85    * @brief This is the point, in local actor coordinates, where the long press occurred.
  86    *
  87    * If a multi-touch long press, then this is the centroid of all the touch points.
  88    * @return The point where tap has occurred (in local actor coordinates).
  89    */
  90   Vector2 localPoint;
  91 };
  92
  93 } // namespace Dali
  94
  95 /**
  96  * @}
  97  */
  98 #endif // __DALI_LONG_PRESS_GESTURE_H__