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