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