X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fslider%2Fslider.h;h=83e2b5c815ad9b2ced79c3cac6016d80bc470ec7;hp=d1cffecfb202329bbb0251e903a7154559f2a0ba;hb=c1481543c3334342110f9a4635292d0eff1d15b7;hpb=315b80da193f3ce70ffc07d3502af970ed1146b5 diff --git a/dali-toolkit/public-api/controls/slider/slider.h b/dali-toolkit/public-api/controls/slider/slider.h index d1cffec..83e2b5c 100644 --- a/dali-toolkit/public-api/controls/slider/slider.h +++ b/dali-toolkit/public-api/controls/slider/slider.h @@ -37,7 +37,7 @@ class Slider; */ /** - * @brief Slider is a control to enable sliding an indicator between two values + * @brief Slider is a control to enable sliding an indicator between two values. * * Signals * | %Signal Name | Method | @@ -54,7 +54,7 @@ public: // Properties /** - * @brief The start and end property ranges for this control. + * @brief Enumeration for the start and end property ranges for this control. * @SINCE_1_1.39 */ enum PropertyRange @@ -64,100 +64,104 @@ public: }; /** - * @brief An enumeration of properties belonging to the Slider class. + * @brief Enumeration for the instance of properties belonging to the Slider class. * @SINCE_1_1.39 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the Slider class. + * @SINCE_1_1.39 + */ enum { /** - * @brief name "lowerBound", type float + * @brief name "lowerBound", type float. * @SINCE_1_1.39 */ LOWER_BOUND = PROPERTY_START_INDEX, /** - * @brief name "upperBound", type float + * @brief name "upperBound", type float. * @SINCE_1_1.39 */ UPPER_BOUND, /** - * @brief name "value", type float + * @brief name "value", type float. * @SINCE_1_1.39 */ VALUE, /** - * @brief name "trackVisual", type string if it is a url, map otherwise + * @brief name "trackVisual", type string if it is a url, map otherwise. * @SINCE_1_1.39 */ TRACK_VISUAL, /** - * @brief name "handleVisual", type string if it is a url, map otherwise + * @brief name "handleVisual", type string if it is a url, map otherwise. * @SINCE_1_1.39 */ HANDLE_VISUAL, /** - * @brief name "progressVisual", type string if it is a url, map otherwise + * @brief name "progressVisual", type string if it is a url, map otherwise. * @SINCE_1_1.39 */ PROGRESS_VISUAL, /** - * @brief name "popupVisual", type string if it is a url, map otherwise + * @brief name "popupVisual", type string if it is a url, map otherwise. * @SINCE_1_1.39 */ POPUP_VISUAL, /** - * @brief name "popupArrowVisual", type string if it is a url, map otherwise + * @brief name "popupArrowVisual", type string if it is a url, map otherwise. * @SINCE_1_1.39 */ POPUP_ARROW_VISUAL, /** - * @brief name "disabledColor", type Vector4 + * @brief name "disabledColor", type Vector4. * @SINCE_1_1.39 */ DISABLED_COLOR, /** - * @brief name "valuePrecision", type int + * @brief name "valuePrecision", type int. * @SINCE_1_1.39 */ VALUE_PRECISION, /** - * @brief name "showPopup", type bool + * @brief name "showPopup", type bool. * @SINCE_1_1.39 */ SHOW_POPUP, /** - * @brief name "showValue", type bool + * @brief name "showValue", type bool. * @SINCE_1_1.39 */ SHOW_VALUE, /** - * @brief name "marks", type Property::Array + * @brief name "marks", type Property::Array. * @SINCE_1_1.39 */ MARKS, /** - * @brief name "snapToMarks", type bool + * @brief name "snapToMarks", type bool. * @SINCE_1_1.39 */ SNAP_TO_MARKS, /** - * @brief name "markTolerance", type float + * @brief name "markTolerance", type float. * @SINCE_1_1.39 */ MARK_TOLERANCE, @@ -184,6 +188,7 @@ public: * * Creates another handle that points to the same real object. * @SINCE_1_1.39 + * @param[in] handle Handle to an object */ Slider( const Slider& handle ); @@ -192,6 +197,8 @@ public: * * Changes this handle to point to another real object. * @SINCE_1_1.39 + * @param[in] handle Handle to an object + * @return A reference to this */ Slider& operator=( const Slider& handle ); @@ -204,10 +211,10 @@ public: ~Slider(); /** - * @brief Downcast an Object handle to Slider. + * @brief Downcasts an Object handle to Slider. * - * If handle points to a Slider the - * downcast produces valid handle. If not the returned handle is left uninitialized. + * If handle points to a Slider, the downcast produces valid handle. + * If not, the returned handle is left uninitialized. * @SINCE_1_1.39 * @param[in] handle Handle to an object * @return handle to a Slider or an uninitialized handle @@ -271,7 +278,7 @@ public: // Not intended for application developers * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_1.39 - * @param[in] implementation The Control implementation + * @param[in] implementation The Control implementation */ DALI_INTERNAL Slider(Internal::Slider& implementation); @@ -279,7 +286,7 @@ public: // Not intended for application developers * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_1.39 - * @param[in] internal A pointer to the internal CustomActor + * @param[in] internal A pointer to the internal CustomActor */ explicit DALI_INTERNAL Slider( Dali::Internal::CustomActor* internal ); /// @endcond