X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fevents%2Fgesture-detector.h;h=b8668185a0e953321a660d9e7885677a8cbf70d9;hb=646f736e77b085c86e982c0d1d4b895c2a431330;hp=5d8cba2ddcd5c9f256ad4ef012f1b569356cb4d6;hpb=423c5be7c4b4f6271f8c23dec6e51b2d3a44e0f6;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/events/gesture-detector.h b/dali/public-api/events/gesture-detector.h index 5d8cba2..b866818 100644 --- a/dali/public-api/events/gesture-detector.h +++ b/dali/public-api/events/gesture-detector.h @@ -2,7 +2,7 @@ #define __DALI_GESTURE_DETECTOR_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. @@ -19,7 +19,6 @@ */ // INTERNAL INCLUDES -#include #include namespace Dali @@ -48,12 +47,12 @@ class Actor; * @SINCE_1_0.0 * @see Gesture */ -class DALI_IMPORT_API GestureDetector : public Handle +class DALI_CORE_API GestureDetector : public Handle { public: // Creation & Destruction /** - * @brief Create an uninitialized GestureDetector. + * @brief Creates an uninitialized GestureDetector. * * This can be initialized with one of the derived gesture detectors' New() methods. For example, PanGestureDetector::New(). * @@ -63,10 +62,10 @@ public: // Creation & Destruction GestureDetector(); /** - * @brief Downcast a handle to GestureDetector handle. + * @brief Downcasts a handle to GestureDetector handle. * - * If handle points to a GestureDetector object the - * downcast produces valid handle. If not the returned handle is left uninitialized. + * If handle points to a GestureDetector object, the downcast produces valid handle. + * If not, the returned handle is left uninitialized. * @SINCE_1_0.0 * @param[in] handle Handle to an object * @return Handle to a GestureDetector object or an uninitialized handle @@ -74,7 +73,7 @@ public: // Creation & Destruction static GestureDetector DownCast( BaseHandle handle ); /** - * @brief Dali::GestureDetector is intended as a base class + * @brief Dali::GestureDetector is intended as a base class. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -85,7 +84,7 @@ public: // Creation & Destruction * @brief This copy constructor is required for (smart) pointer semantics. * * @SINCE_1_0.0 - * @param [in] handle A reference to the copied handle + * @param[in] handle A reference to the copied handle */ GestureDetector(const GestureDetector& handle); @@ -93,7 +92,7 @@ public: // Creation & Destruction * @brief This assignment operator is required for (smart) pointer semantics. * * @SINCE_1_0.0 - * @param [in] rhs A reference to the copied handle + * @param[in] rhs A reference to the copied handle * @return A reference to this */ GestureDetector& operator=(const GestureDetector& rhs); @@ -106,7 +105,7 @@ public: // Actor related * The detected signal will be dispatched when the gesture occurs on * the attached actor. * @SINCE_1_0.0 - * @param[in] actor The actor to attach to the gesture detector + * @param[in] actor The actor to attach to the gesture detector * @pre The gesture detector has been initialized. * @note You can attach several actors to a gesture detector. */ @@ -116,7 +115,7 @@ public: // Actor related * @brief Detaches the attached actor from the gesture detector. * * @SINCE_1_0.0 - * @param[in] actor The actor to detach from the gesture detector. + * @param[in] actor The actor to detach from the gesture detector * @pre The gesture detector has been initialized. * @pre The specified actor has been attached to the gesture detector. */ @@ -145,7 +144,7 @@ public: // Actor related * * @SINCE_1_0.0 * @param[in] index The attached actor's index - * @return The attached actor or an empty handle. + * @return The attached actor or an empty handle * @pre The gesture detector has been initialized. */ Actor GetAttachedActor(size_t index) const; @@ -157,7 +156,7 @@ protected: * @brief This constructor is used by New() methods of derived classes (For example, PanGestureDetector::New()). * * @SINCE_1_0.0 - * @param [in] internal A pointer to a newly allocated Dali resource. + * @param[in] internal A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL GestureDetector(Internal::GestureDetector* internal); /// @endcond