[3.0] Clipping API feature in Actor

[platform/core/uifw/dali-core.git] / dali / public-api / actors / actor-enumerations.h

diff --git a/dali/public-api/actors/actor-enumerations.h b/dali/public-api/actors/actor-enumerations.h
index bed10d2..78b861d 100644 (file)
--- a/dali/public-api/actors/actor-enumerations.h
+++ b/dali/public-api/actors/actor-enumerations.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_ACTOR_ENUMERATIONS_H__
-#define __DALI_ACTOR_ENUMERATIONS_H__
+#ifndef DALI_ACTOR_ENUMERATIONS_H
+#define DALI_ACTOR_ENUMERATIONS_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 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.
@@ -59,18 +59,18 @@ enum PositionInheritanceMode
  */
 namespace Dimension
 {
-enum Type
-{
-  WIDTH  = 0x1,       ///< Width dimension @SINCE_1_0.0
-  HEIGHT = 0x2,       ///< Height dimension @SINCE_1_0.0
+  enum Type
+  {
+    WIDTH  = 0x1,       ///< Width dimension @SINCE_1_0.0
+    HEIGHT = 0x2,       ///< Height dimension @SINCE_1_0.0
 
-  ALL_DIMENSIONS = 0x3  ///< Mask to cover all flags @SINCE_1_0.0
-};
+    ALL_DIMENSIONS = 0x3  ///< Mask to cover all flags @SINCE_1_0.0
+  };
 
-enum Meta
-{
-  DIMENSION_COUNT = 2  ///< Number of dimensions - update this if adding new dimension @SINCE_1_0.0
-};
+  enum Meta
+  {
+    DIMENSION_COUNT = 2  ///< Number of dimensions - update this if adding new dimension @SINCE_1_0.0
+  };
 }
 
 /**
@@ -79,18 +79,18 @@ enum Meta
  */
 namespace ResizePolicy
 {
-enum Type
-{
-  FIXED,                 ///< Size is fixed as set by SetSize @SINCE_1_0.0
-  USE_NATURAL_SIZE,      ///< Size is to use the actor's natural size @SINCE_1_0.0 @see Actor::GetNaturalSize()
-  FILL_TO_PARENT,        ///< Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. @SINCE_1_0.0
-  SIZE_RELATIVE_TO_PARENT,        ///< The actors size will be ( ParentSize * SizeRelativeToParentFactor ). @SINCE_1_0.0
-  SIZE_FIXED_OFFSET_FROM_PARENT,  ///< The actors size will be ( ParentSize + SizeRelativeToParentFactor ). @SINCE_1_0.0
-  FIT_TO_CHILDREN,       ///< Size will adjust to wrap around all children @SINCE_1_0.0
-  DIMENSION_DEPENDENCY,  ///< One dimension is dependent on the other @SINCE_1_0.0
-  USE_ASSIGNED_SIZE      ///< The size will be assigned to the actor @SINCE_1_0.0
-};
-const Type DEFAULT = USE_NATURAL_SIZE; ///< Default resize policy
+  enum Type
+  {
+    FIXED,                 ///< Size is fixed as set by SetSize @SINCE_1_0.0
+    USE_NATURAL_SIZE,      ///< Size is to use the actor's natural size @SINCE_1_0.0 @see Actor::GetNaturalSize()
+    FILL_TO_PARENT,        ///< Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. @SINCE_1_0.0
+    SIZE_RELATIVE_TO_PARENT,        ///< The actors size will be ( ParentSize * SizeRelativeToParentFactor ). @SINCE_1_0.0
+    SIZE_FIXED_OFFSET_FROM_PARENT,  ///< The actors size will be ( ParentSize + SizeRelativeToParentFactor ). @SINCE_1_0.0
+    FIT_TO_CHILDREN,       ///< Size will adjust to wrap around all children @SINCE_1_0.0
+    DIMENSION_DEPENDENCY,  ///< One dimension is dependent on the other @SINCE_1_0.0
+    USE_ASSIGNED_SIZE      ///< The size will be assigned to the actor @SINCE_1_0.0
+  };
+  const Type DEFAULT = USE_NATURAL_SIZE; ///< Default resize policy
 }
 
 /**
@@ -99,12 +99,12 @@ const Type DEFAULT = USE_NATURAL_SIZE; ///< Default resize policy
  */
 namespace SizeScalePolicy
 {
-enum Type
-{
-  USE_SIZE_SET,                ///< Use the size that was set @SINCE_1_0.0
-  FIT_WITH_ASPECT_RATIO,       ///< Fit within the size set maintaining natural size aspect ratio @SINCE_1_0.0
-  FILL_WITH_ASPECT_RATIO       ///< Fill up the size set maintaining natural size aspect ratio. May exceed size bounds in one dimension. @SINCE_1_0.0
-};
+  enum Type
+  {
+    USE_SIZE_SET,                ///< Use the size that was set @SINCE_1_0.0
+    FIT_WITH_ASPECT_RATIO,       ///< Fit within the size set maintaining natural size aspect ratio @SINCE_1_0.0
+    FILL_WITH_ASPECT_RATIO       ///< Fill up the size set maintaining natural size aspect ratio. May exceed size bounds in one dimension. @SINCE_1_0.0
+  };
 }
 
 /**
@@ -113,12 +113,12 @@ enum Type
  */
 namespace HorizontalAlignment
 {
-enum Type
-{
-  LEFT,         ///< Align horizontally left @SINCE_1_0.0
-  CENTER,       ///< Align horizontally center @SINCE_1_0.0
-  RIGHT         ///< Align horiztonally right @SINCE_1_0.0
-};
+  enum Type
+  {
+    LEFT,         ///< Align horizontally left @SINCE_1_0.0
+    CENTER,       ///< Align horizontally center @SINCE_1_0.0
+    RIGHT         ///< Align horizontally right @SINCE_1_0.0
+  };
 }
 
 /**
@@ -127,17 +127,31 @@ enum Type
  */
 namespace VerticalAlignment
 {
-enum Type
+  enum Type
+  {
+    TOP,          ///< Align vertically top @SINCE_1_0.0
+    CENTER,       ///< Align vertically center @SINCE_1_0.0
+    BOTTOM        ///< Align vertically bottom @SINCE_1_0.0
+  };
+}
+
+/**
+ * @brief The ClippingMode describes how this Actors children will be clipped against it.
+ * @SINCE_1_2.5
+ */
+namespace ClippingMode
 {
-  TOP,          ///< Align vertically top @SINCE_1_0.0
-  CENTER,       ///< Align vertically center @SINCE_1_0.0
-  BOTTOM        ///< Align vertically bottom @SINCE_1_0.0
-};
+  enum Type
+  {
+    DISABLED,                     ///< This Actor will not clip its children. @SINCE_1_2.5
+    CLIP_CHILDREN,                ///< This Actor will clip all children to within its boundaries (the actor will also be visible itself). @SINCE_1_2.5
+  };
 }
 
+
 /**
  * @}
  */
 } // namespace Dali
 
-#endif // __DALI_ACTOR_ENUMERATIONS_H__
+#endif // DALI_ACTOR_ENUMERATIONS_H