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