- Change @deprecrated 1.x.x to @DEPRECATED_1_x.x to follow the new doxygen tagging rule.
Change-Id: I2054064fda1d0737560d187a9d2cf8e7c865ab9a
// Deprecated API
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the label with an actor.
*
void SetLabel( Actor label );
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the button image.
*
void SetButtonImage( Image image );
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the selected image.
*
void SetSelectedImage( Image image );
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Gets the button image.
*
Actor GetButtonImage() const;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Gets the selected image.
*
using Button::SetButtonImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the unselected image with an Actor.
*
using Button::SetBackgroundImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the background image with an Actor.
*
using Button::SetSelectedImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the selected image with an Actor.
*
using Button::SetSelectedBackgroundImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the selected background image with an Actor.
*
using Button::SetDisabledBackgroundImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the disabled background image with an Actor.
*
using Button::SetDisabledImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the disabled image with an Actor.
*
using Button::SetDisabledSelectedImage;
/**
- * @deprecated DALi 1.0.50
+ * @DEPRECATED_1_0.50
*
* @brief Sets the disabled selected image with an Actor.
*
*/
/**
- * @deprecated DALi 1.1.16
+ * @DEPRECATED_1_1.16
*
* @brief These depth indices should not be used.
* @SINCE_1_0.0
*/
enum DepthIndexRanges
{
- BACKGROUND_DEPTH_INDEX = static_cast<int>( -Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ), ///< @deprecated DALi 1.1.16 @SINCE_1_0.0
- CONTENT_DEPTH_INDEX = 0, ///< @deprecated DALi 1.1.16 @SINCE_1_0.0
- DECORATION_DEPTH_INDEX = static_cast<int>( Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ) ///< @deprecated DALi 1.1.16 @SINCE_1_0.0
+ BACKGROUND_DEPTH_INDEX = static_cast<int>( -Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ), ///< @DEPRECATED_1_1.16 @SINCE_1_0.0
+ CONTENT_DEPTH_INDEX = 0, ///< @DEPRECATED_1_1.16 @SINCE_1_0.0
+ DECORATION_DEPTH_INDEX = static_cast<int>( Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ) ///< @DEPRECATED_1_1.16 @SINCE_1_0.0
};
/**
{
enum
{
- STYLE_NAME = PROPERTY_START_INDEX, ///< name "styleName", @see SetStyleName, type std::string @SINCE_1_0.0
- BACKGROUND_COLOR, ///< name "background-color", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4 @SINCE_1_0.0
- BACKGROUND_IMAGE, ///< name "background-image", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map @SINCE_1_0.0
- KEY_INPUT_FOCUS, ///< name "keyInputFocus", @see SetKeyInputFocus, type bool @SINCE_1_0.0
- BACKGROUND, ///< name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map @SINCE_1_1.3
+ /**
+ * @brief name "styleName", type std::string
+ * @SINCE_1_0.0
+ * @see SetStyleName
+ */
+ STYLE_NAME = PROPERTY_START_INDEX,
+ /**
+ * @DEPRECATED_1_1.3
+ * @brief name "background-color", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4
+ * @SINCE_1_0.0
+ * @see SetStyleName
+ */
+ BACKGROUND_COLOR,
+ /**
+ * @DEPRECATED_1_1.3
+ * @brief name "background-image", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map
+ * @SINCE_1_0.0
+ */
+ BACKGROUND_IMAGE,
+ /**
+ * @brief name "keyInputFocus", type bool
+ * @SINCE_1_0.0
+ * @see SetKeyInputFocus
+ */
+ KEY_INPUT_FOCUS,
+ /**
+ * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map
+ * @SINCE_1_1.3
+ */
+ BACKGROUND,
};
};
/**
* @brief Retrieves the name of the style to be applied to the control (if any).
- *
* @SINCE_1_0.0
* @return A string matching a style or an empty string.
*/
void SetBackgroundColor( const Vector4& color );
/**
- * @deprecated DALi 1.1.3 API removed.
+ * @DEPRECATED_1_1.3
*
* @brief Retrieves the background color of the control.
*
enum
{
// Event side properties
- RESOURCE_URL = PROPERTY_START_INDEX, ///< name "resourceUrl", @deprecated DALi 1.1.16 Use IMAGE instead. type string @SINCE_1_0.0
- IMAGE, ///< name "image", @see SetImage(), type string if it is a url, map otherwise @SINCE_1_0.0
- PRE_MULTIPLIED_ALPHA, ///< name "preMultipliedAlpha", type Boolean @pre image must be initialized. @SINCE_1_1.18
+
+ /**
+ * @DEPRECATED_1_1.16. Use IMAGE instead.
+ * @brief name "resourceUrl", type string
+ * @SINCE_1_0.0
+ */
+ RESOURCE_URL = PROPERTY_START_INDEX,
+ /**
+ * @brief name "image", type string if it is a url, map otherwise
+ * @SINCE_1_0.0
+ */
+ IMAGE,
+ /**
+ * @brief name "preMultipliedAlpha", type Boolean
+ * @SINCE_1_1.18
+ * @pre image must be initialized.
+ */
+ PRE_MULTIPLIED_ALPHA,
// Animatable properties
- PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX, ///< name "pixelArea", type Vector4, Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0]. @SINCE_1_1.18
+
+
+ /**
+ * @brief name "pixelArea", type Vector4
+ * @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
+ * @SINCE_1_0.18
+ */
+ PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX,
};
};
void SetImage( const std::string& url, ImageDimensions size );
/**
- * @deprecated Gets the Image
+ * @DEPRECATED_1_1.4
+ * @brief Gets the Image
*
* @SINCE_1_0.0
* @return The Image currently set to this ImageView