dali/public-api/events/hover-event.h

   1 #ifndef __DALI_HOVER_EVENT_H__
   2 #define __DALI_HOVER_EVENT_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/common/dali-common.h>
  23 #include <dali/public-api/events/touch-point.h>
  24
  25 namespace Dali
  26 {
  27 /**
  28  * @addtogroup dali_core_events
  29  * @{
  30  */
  31
  32 /**
  33  * @brief Hover events are a collection of touch points at a specific moment in time.
  34  *
  35  * When a multi-touch event occurs, each touch point represents the points that are currently being
  36  * hovered or the points where a hover has stopped.
  37  * @SINCE_1_0.0
  38  */
  39 struct DALI_IMPORT_API HoverEvent
  40 {
  41   // Construction & Destruction
  42
  43   /**
  44    * @brief Default constructor.
  45    * @SINCE_1_0.0
  46    */
  47   HoverEvent();
  48
  49   /**
  50    * @brief Constructor.
  51    * @SINCE_1_0.0
  52    * @param[in] time The time the event occurred
  53    */
  54   HoverEvent(unsigned long time);
  55
  56   /**
  57    * @brief Destructor.
  58    * @SINCE_1_0.0
  59    */
  60   ~HoverEvent();
  61
  62   // Data
  63
  64   /**
  65    * @brief This is a container of points for this hover event.
  66    *
  67    * The first point in the set is always the
  68    * primary touch point (i.e. the first point touched in a multi-touch event).
  69    */
  70   TouchPointContainer points;
  71
  72   /**
  73    * @brief The time (in ms) that the hover event occurred.
  74    */
  75   unsigned long time;
  76
  77   // Convenience Methods
  78
  79   /**
  80    * @brief Returns the total number of points in this HoverEvent.
  81    *
  82    * @SINCE_1_0.0
  83    * @return Total number of Points
  84    */
  85   unsigned int GetPointCount() const;
  86
  87   /**
  88    * @brief Returns a touch point at the index requested.
  89    *
  90    * The first point in the set is always the primary
  91    * touch point (i.e. the first point touched in a multi-touch event).
  92    * @SINCE_1_0.0
  93    * @param[in] point The index of the required Point
  94    * @return Point requested
  95    * @note "point" should be less than the value returned by GetPointCount().
  96    *       If out of range, then program asserts.
  97    */
  98   const TouchPoint& GetPoint(unsigned int point) const;
  99 };
 100
 101 /**
 102  * @}
 103  */
 104 } // namespace Dali
 105
 106 #endif // __DALI_HOVER_EVENT_H__