1 #ifndef __DALI_HOVER_EVENT_H__
2 #define __DALI_HOVER_EVENT_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/common/dali-common.h>
23 #include <dali/public-api/events/touch-point.h>
28 * @addtogroup dali-core-events
33 * @brief Hover events are a collection of touch points at a specific moment in time.
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.
38 struct DALI_IMPORT_API HoverEvent
40 // Construction & Destruction
43 * @brief Default constructor
49 * @param[in] time The time the event occurred
51 HoverEvent(unsigned long time);
61 * @brief This is a container of points for this hover event.
63 * The first point in the set is always the
64 * primary touch point (i.e. the first point touched in a multi-touch event).
66 TouchPointContainer points;
69 * @brief The time (in ms) that the hover event occurred.
73 // Convenience Methods
76 * @brief Returns the total number of points in this HoverEvent.
78 * @return Total number of Points.
80 unsigned int GetPointCount() const;
83 * @brief Returns a touch point at the index requested.
85 * The first point in the set is always the primary
86 * touch point (i.e. the first point touched in a multi-touch event).
87 * @note "point" should be less than the value returned by GetPointCount().
88 * If out of range, then program asserts.
89 * @param[in] point The index of the required Point.
90 * @return Point requested
92 const TouchPoint& GetPoint(unsigned int point) const;
100 #endif // __DALI_HOVER_EVENT_H__