dali/integration-api/events/gesture-event.h

   1 #ifndef __DALI_INTEGRATION_GESTURE_EVENT_H__
   2 #define __DALI_INTEGRATION_GESTURE_EVENT_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  21 #include <dali/public-api/events/gesture.h>
  22 #include <dali/integration-api/events/event.h>
  23
  24 namespace Dali DALI_IMPORT_API
  25 {
  26
  27 namespace Integration
  28 {
  29
  30 /**
  31  * This is the abstract base structure for any gestures that the adaptor detects and wishes to send
  32  * to the Core.
  33  */
  34 struct GestureEvent : public Event
  35 {
  36   // Destruction
  37
  38   /**
  39    * Virtual destructor.
  40    */
  41   virtual ~GestureEvent();
  42
  43   // Data
  44
  45   /**
  46    * Gesture Type.
  47    */
  48   Gesture::Type gestureType;
  49
  50   /**
  51    * The state of the gesture.
  52    */
  53   Gesture::State state;
  54
  55   /**
  56    * The time the gesture took place.
  57    */
  58   unsigned int time;
  59
  60 protected:  // Constructors only to be used by derived structures.
  61
  62   /**
  63    * This constructor is only used by derived classes.
  64    * @param[in] gesture       The type of gesture event.
  65    * @param[in] gestureState  The state of the gesture event.
  66    */
  67   GestureEvent(Gesture::Type gesture, Gesture::State gestureState);
  68 };
  69
  70 } // namespace Integration
  71
  72 } // namespace Dali
  73
  74 #endif // __DALI_INTEGRATION_GESTURE_EVENT_H__