X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fevents%2Fhover-event.h;h=e5c9f48adbe7fa4c7fd018f3e7fb14437d108f94;hb=646f736e77b085c86e982c0d1d4b895c2a431330;hp=fde089a00e20e0a160b1326cb8c61670be276292;hpb=368e910834eeb8d9bcd57293b26b49415f932d2b;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/events/hover-event.h b/dali/public-api/events/hover-event.h index fde089a..e5c9f48 100644 --- a/dali/public-api/events/hover-event.h +++ b/dali/public-api/events/hover-event.h @@ -2,7 +2,7 @@ #define __DALI_HOVER_EVENT_H__ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,36 +18,47 @@ * */ +// EXTERNAL INCLUDES +#include // uint32_t + // INTERNAL INCLUDES #include #include namespace Dali { +/** + * @addtogroup dali_core_events + * @{ + */ /** * @brief Hover events are a collection of touch points at a specific moment in time. * * When a multi-touch event occurs, each touch point represents the points that are currently being * hovered or the points where a hover has stopped. + * @SINCE_1_0.0 */ -struct DALI_IMPORT_API HoverEvent +struct DALI_CORE_API HoverEvent { // Construction & Destruction /** - * @brief Default constructor + * @brief Default constructor. + * @SINCE_1_0.0 */ HoverEvent(); /** - * @brief Constructor - * @param[in] time The time the event occurred + * @brief Constructor. + * @SINCE_1_0.0 + * @param[in] time The time the event occurred */ HoverEvent(unsigned long time); /** - * @brief Destructor + * @brief Destructor. + * @SINCE_1_0.0 */ ~HoverEvent(); @@ -71,23 +82,28 @@ struct DALI_IMPORT_API HoverEvent /** * @brief Returns the total number of points in this HoverEvent. * - * @return Total number of Points. + * @SINCE_1_0.0 + * @return Total number of Points */ - unsigned int GetPointCount() const; + uint32_t GetPointCount() const; /** * @brief Returns a touch point at the index requested. * * The first point in the set is always the primary * touch point (i.e. the first point touched in a multi-touch event). + * @SINCE_1_0.0 + * @param[in] point The index of the required Point + * @return Point requested * @note "point" should be less than the value returned by GetPointCount(). * If out of range, then program asserts. - * @param[in] point The index of the required Point. - * @return Point requested */ - const TouchPoint& GetPoint(unsigned int point) const; + const TouchPoint& GetPoint( uint32_t point) const; }; +/** + * @} + */ } // namespace Dali #endif // __DALI_HOVER_EVENT_H__