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

   1 #ifndef DALI_INTERNAL_EVENT_GESTURE_EVENT_H
   2 #define DALI_INTERNAL_EVENT_GESTURE_EVENT_H
   3
   4 /*
   5  * Copyright (c) 2022 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/integration-api/events/event.h>
  23 #include <dali/internal/event/events/gesture-impl.h>
  24
  25 namespace Dali
  26 {
  27 namespace Internal
  28 {
  29 /**
  30  * This is the abstract base structure for any gestures that the adaptor detects and wishes to send
  31  * to the Core.
  32  */
  33 struct GestureEvent
  34 {
  35   // Destruction
  36
  37   /**
  38    * Virtual destructor.
  39    */
  40   virtual ~GestureEvent();
  41
  42   // Data
  43
  44   /**
  45    * Gesture Type.
  46    */
  47   GestureType::Value gestureType;
  48
  49   /**
  50    * The state of the gesture.
  51    */
  52   GestureState state;
  53
  54   /**
  55    * The time the gesture took place.
  56    */
  57   uint32_t time;
  58
  59   /**
  60    * This is the value of which source the gesture was started with. (ex : mouse)
  61    */
  62   GestureSourceType sourceType;
  63
  64   /**
  65    * The data of the source type.
  66    */
  67   GestureSourceData sourceData;
  68
  69 protected: // Constructors only to be used by derived structures.
  70   /**
  71    * This constructor is only used by derived classes.
  72    * @param[in] gesture       The type of gesture event.
  73    * @param[in] gestureState  The state of the gesture event.
  74    */
  75   GestureEvent(GestureType::Value gesture, GestureState gestureState);
  76 };
  77
  78 } // namespace Internal
  79
  80 } // namespace Dali
  81
  82 #endif // DALI_INTERNAL_EVENT_GESTURE_EVENT_H