dali/internal/event/events/long-press-gesture/long-press-gesture-event.h

   1 #ifndef DALI_INTERNAL_EVENT_LONG_PRESS_GESTURE_H
   2 #define DALI_INTERNAL_EVENT_LONG_PRESS_GESTURE_H
   3
   4 /*
   5  * Copyright (c) 2019 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 // INTERNAL INCLUDES
  22 #include <dali/internal/event/events/gesture-event.h>
  23 #include <dali/public-api/math/vector2.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal
  29 {
  30
  31 /**
  32  * If the adaptor detects a long press gesture, then it should create an instance of this structure and
  33  * send it to the Core.
  34  *
  35  * This gesture can be in four states:
  36  * - POSSIBLE:  When the user first puts their finger down - Core needs to hit test the down point.
  37  * - STARTED:   When the long-press gesture is actually detected.
  38  * - FINISHED:  When the user finally lifts all touches.
  39  * - CANCELLED: If, after a down event, no long press is detected, or a system interruption.
  40  */
  41 struct LongPressGestureEvent : public GestureEvent
  42 {
  43   // Construction & Destruction
  44
  45   /**
  46    * Default Constructor
  47    * @param[in]  state  STARTED, when we detect a long press.
  48    *                    FINISHED, when all touches are finished.
  49    */
  50   LongPressGestureEvent( GestureState state );
  51
  52   /**
  53    * Virtual destructor
  54    */
  55   virtual ~LongPressGestureEvent();
  56
  57   // Data
  58
  59   /**
  60    * @copydoc Dali::LongPressGesture::numberOfTouches
  61    */
  62   unsigned int numberOfTouches;
  63
  64   /**
  65    * This is the point, in screen coordinates, where the long press occurred.
  66    * If a multi-touch tap, then this should be the centroid of all the touch points.
  67    */
  68   Vector2 point;
  69 };
  70
  71 } // namespace Internal
  72
  73 } // namespace Dali
  74
  75 #endif // DALI_INTERNAL_EVENT_LONG_PRESS_GESTURE_H