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.
39 struct DALI_IMPORT_API HoverEvent
41 // Construction & Destruction
44 * @brief Default constructor.
52 * @param[in] time The time the event occurred
54 HoverEvent(unsigned long time);
65 * @brief This is a container of points for this hover event.
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).
70 TouchPointContainer points;
73 * @brief The time (in ms) that the hover event occurred.
77 // Convenience Methods
80 * @brief Returns the total number of points in this HoverEvent.
83 * @return Total number of Points
85 unsigned int GetPointCount() const;
88 * @brief Returns a touch point at the index requested.
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).
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.
98 const TouchPoint& GetPoint(unsigned int point) const;
106 #endif // __DALI_HOVER_EVENT_H__