X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fevents%2Ftouch-event.h;h=3fc4463f27ef00336fb5dbf3c07895e2a0370137;hb=3ebd19dd0b1e9beec0b01da6ac6c812dc6f6b95c;hp=e61c5ff1c0fbebd44310f536a83e8e7a13a0fb60;hpb=d43cb862080fe2f4271980d3d666865b6e616b0d;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/events/touch-event.h b/dali/public-api/events/touch-event.h index e61c5ff..3fc4463 100644 --- a/dali/public-api/events/touch-event.h +++ b/dali/public-api/events/touch-event.h @@ -25,10 +25,16 @@ namespace Dali { /** + * @addtogroup dali_core_events + * @{ + */ + +/** * @brief Touch 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 * touched or the points where a touch has stopped. + * @SINCE_1_0.0 */ struct DALI_IMPORT_API TouchEvent { @@ -36,17 +42,20 @@ struct DALI_IMPORT_API TouchEvent /** * @brief Default constructor + * @SINCE_1_0.0 */ TouchEvent(); /** * @brief Constructor - * @param[in] time The time the event occurred + * @SINCE_1_0.0 + * @param[in] time The time the event occurred */ TouchEvent(unsigned long time); /** * @brief Destructor + * @SINCE_1_0.0 */ ~TouchEvent(); @@ -70,6 +79,7 @@ struct DALI_IMPORT_API TouchEvent /** * @brief Returns the total number of points in this TouchEvent. * + * @SINCE_1_0.0 * @return Total number of Points. */ unsigned int GetPointCount() const; @@ -79,14 +89,18 @@ struct DALI_IMPORT_API TouchEvent * * The first point in the set is always the primary * touch point (i.e. the first point touched in a multi-touch event). - * @note "point" should be less than the value returned by GetPointCount(). - * If out of range, then program asserts. + * @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. */ const TouchPoint& GetPoint(unsigned int point) const; }; +/** + * @} + */ } // namespace Dali #endif // __DALI_TOUCH_EVENT_H__