Tizen 2.4.0 rev3 SDK Public Release
[framework/graphics/dali.git] / dali / public-api / actors / actor-enumerations.h
index 23aa9d2..0fdf60c 100644 (file)
@@ -34,10 +34,10 @@ namespace Dali
  */
 enum ColorMode
 {
-  USE_OWN_COLOR,                 ///< Actor will use its own color
-  USE_PARENT_COLOR,              ///< Actor will use its parent color
-  USE_OWN_MULTIPLY_PARENT_COLOR, ///< Actor will blend its color with its parents color.
-  USE_OWN_MULTIPLY_PARENT_ALPHA  ///< Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default.
+  USE_OWN_COLOR,                 ///< Actor will use its own color @since_tizen 2.4
+  USE_PARENT_COLOR,              ///< Actor will use its parent color @since_tizen 2.4
+  USE_OWN_MULTIPLY_PARENT_COLOR, ///< Actor will blend its color with its parents color. @since_tizen 2.4
+  USE_OWN_MULTIPLY_PARENT_ALPHA  ///< Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default. @since_tizen 2.4
 };
 
 /**
@@ -46,10 +46,10 @@ enum ColorMode
  */
 enum PositionInheritanceMode
 {
-  INHERIT_PARENT_POSITION,                 ///< Actor will inherit its parent position. This is the default
-  USE_PARENT_POSITION,                     ///< Actor will copy its parent position. This is useful if many actors are stacked together in the same place. This option ignores parent origin and anchor point.
-  USE_PARENT_POSITION_PLUS_LOCAL_POSITION, ///< Actor will copy its parent position and add local position. This is useful if many actors are stacked together in the same place with an offset.  This option ignores parent origin and anchor point.
-  DONT_INHERIT_POSITION                    ///< Actor will not inherit position. Local position is treated as world position. This is useful if a constraint is used to override local position or if an actor is positioned globally. This option ignores parent origin, anchor point and local position.
+  INHERIT_PARENT_POSITION,                 ///< Actor will inherit its parent position. This is the default @since_tizen 2.4
+  USE_PARENT_POSITION,                     ///< Actor will copy its parent position. This is useful if many actors are stacked together in the same place. This option ignores parent origin and anchor point. @since_tizen 2.4
+  USE_PARENT_POSITION_PLUS_LOCAL_POSITION, ///< Actor will copy its parent position and add local position. This is useful if many actors are stacked together in the same place with an offset.  This option ignores parent origin and anchor point. @since_tizen 2.4
+  DONT_INHERIT_POSITION                    ///< Actor will not inherit position. Local position is treated as world position. This is useful if a constraint is used to override local position or if an actor is positioned globally. This option ignores parent origin, anchor point and local position. @since_tizen 2.4
 };
 
 /**
@@ -60,15 +60,15 @@ namespace Dimension
 {
 enum Type
 {
-  WIDTH  = 0x1,       ///< Width dimension
-  HEIGHT = 0x2,       ///< Height dimension
+  WIDTH  = 0x1,       ///< Width dimension @since_tizen 2.4
+  HEIGHT = 0x2,       ///< Height dimension @since_tizen 2.4
 
-  ALL_DIMENSIONS = 0x3  ///< Mask to cover all flags
+  ALL_DIMENSIONS = 0x3  ///< Mask to cover all flags @since_tizen 2.4
 };
 
 enum Meta
 {
-  DIMENSION_COUNT = 2  ///< Number of dimensions - update this if adding new dimension
+  DIMENSION_COUNT = 2  ///< Number of dimensions - update this if adding new dimension @since_tizen 2.4
 };
 }
 
@@ -80,14 +80,14 @@ namespace ResizePolicy
 {
 enum Type
 {
-  FIXED,                 ///< Size is fixed as set by SetSize
-  USE_NATURAL_SIZE,      ///< Size is to use the actor's natural size
-  FILL_TO_PARENT,        ///< Size is to fill up to the actor's parent's bounds. Aspect ratio not maintained.
-  SIZE_RELATIVE_TO_PARENT,        ///< The actors size will be ( ParentSize * SizeRelativeToParentFactor ).
-  SIZE_FIXED_OFFSET_FROM_PARENT,  ///< The actors size will be ( ParentSize + SizeRelativeToParentFactor ).
-  FIT_TO_CHILDREN,       ///< Size will adjust to wrap around all children
-  DIMENSION_DEPENDENCY,  ///< One dimension is dependent on the other
-  USE_ASSIGNED_SIZE      ///< The size will be assigned to the actor
+  FIXED,                 ///< Size is fixed as set by SetSize @since_tizen 2.4
+  USE_NATURAL_SIZE,      ///< Size is to use the actor's natural size @since_tizen 2.4
+  FILL_TO_PARENT,        ///< Size is to fill up to the actor's parent's bounds. Aspect ratio not maintained. @since_tizen 2.4
+  SIZE_RELATIVE_TO_PARENT,        ///< The actors size will be ( ParentSize * SizeRelativeToParentFactor ). @since_tizen 2.4
+  SIZE_FIXED_OFFSET_FROM_PARENT,  ///< The actors size will be ( ParentSize + SizeRelativeToParentFactor ). @since_tizen 2.4
+  FIT_TO_CHILDREN,       ///< Size will adjust to wrap around all children @since_tizen 2.4
+  DIMENSION_DEPENDENCY,  ///< One dimension is dependent on the other @since_tizen 2.4
+  USE_ASSIGNED_SIZE      ///< The size will be assigned to the actor @since_tizen 2.4
 };
 const Type DEFAULT = USE_NATURAL_SIZE; ///< Default resize policy
 }
@@ -100,33 +100,37 @@ namespace SizeScalePolicy
 {
 enum Type
 {
-  USE_SIZE_SET,                ///< Use the size that was set
-  FIT_WITH_ASPECT_RATIO,       ///< Fit within the size set maintaining natural size aspect ratio
-  FILL_WITH_ASPECT_RATIO       ///< Fill up the size set maintaining natural size aspect ratio. May exceed size bounds in one dimension.
+  USE_SIZE_SET,                ///< Use the size that was set @since_tizen 2.4
+  FIT_WITH_ASPECT_RATIO,       ///< Fit within the size set maintaining natural size aspect ratio @since_tizen 2.4
+  FILL_WITH_ASPECT_RATIO       ///< Fill up the size set maintaining natural size aspect ratio. May exceed size bounds in one dimension. @since_tizen 2.4
 };
 }
 
 /**
- * @brief Different types of alignment.
+ * @brief Horizontal alignment types.
  * @since_tizen 2.4
  */
 namespace HorizontalAlignment
 {
 enum Type
 {
-  LEFT,         ///< Align horizontally left
-  CENTER,       ///< Align horizontally center
-  RIGHT         ///< Align horiztonally right
+  LEFT,         ///< Align horizontally left @since_tizen 2.4
+  CENTER,       ///< Align horizontally center @since_tizen 2.4
+  RIGHT         ///< Align horiztonally right @since_tizen 2.4
 };
 }
 
+/**
+ * @brief Vertical alignment types.
+ * @since_tizen 2.4
+ */
 namespace VerticalAlignment
 {
 enum Type
 {
-  TOP,          ///< Align vertically top
-  CENTER,       ///< Align vertically center
-  BOTTOM        ///< Align vertically bottom
+  TOP,          ///< Align vertically top @since_tizen 2.4
+  CENTER,       ///< Align vertically center @since_tizen 2.4
+  BOTTOM        ///< Align vertically bottom @since_tizen 2.4
 };
 }