1 #ifndef DALI_ACTOR_ENUMERATIONS_H
2 #define DALI_ACTOR_ENUMERATIONS_H
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali/public-api/common/dali-common.h>
26 * @addtogroup dali_core_actors
31 * @brief Actor color mode.
37 USE_OWN_COLOR, ///< Actor will use its own color @SINCE_1_0.0
38 USE_PARENT_COLOR, ///< Actor will use its parent color @SINCE_1_0.0
39 USE_OWN_MULTIPLY_PARENT_COLOR, ///< Actor will blend its color with its parents color. @SINCE_1_0.0
40 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_1_0.0
44 * @DEPRECATED_1_1.24 Use SetInheritPosition instead
45 * @brief Actor position inheritance mode.
48 enum PositionInheritanceMode
50 INHERIT_PARENT_POSITION, ///< Actor will inherit its parent position. This is the default @SINCE_1_0.0
51 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_1_0.0
52 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_1_0.0
53 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_1_0.0
57 * @brief Dimensions for layout
63 * @brief The type of Dimension
68 WIDTH = 0x1, ///< Width dimension @SINCE_1_0.0
69 HEIGHT = 0x2, ///< Height dimension @SINCE_1_0.0
71 ALL_DIMENSIONS = 0x3 ///< Mask to cover all flags @SINCE_1_0.0
75 * @brief The number of dimensions
80 DIMENSION_COUNT = 2 ///< Number of dimensions - update this if adding new dimension @SINCE_1_0.0
85 * @brief Size negotiation resize policies
88 namespace ResizePolicy
91 * @brief The type of ResizePolicy
96 FIXED, ///< Size is fixed as set by SetSize @SINCE_1_0.0
97 USE_NATURAL_SIZE, ///< Size is to use the actor's natural size @SINCE_1_0.0 @see Actor::GetNaturalSize()
98 FILL_TO_PARENT, ///< Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. @SINCE_1_0.0
99 SIZE_RELATIVE_TO_PARENT, ///< The actors size will be ( ParentSize * SizeRelativeToParentFactor ). @SINCE_1_0.0
100 SIZE_FIXED_OFFSET_FROM_PARENT, ///< The actors size will be ( ParentSize + SizeRelativeToParentFactor ). @SINCE_1_0.0
101 FIT_TO_CHILDREN, ///< Size will adjust to wrap around all children @SINCE_1_0.0
102 DIMENSION_DEPENDENCY, ///< One dimension is dependent on the other @SINCE_1_0.0
103 USE_ASSIGNED_SIZE ///< The size will be assigned to the actor @SINCE_1_0.0
105 const Type DEFAULT = USE_NATURAL_SIZE; ///< Default resize policy
109 * @brief Policies to determine how an actor should resize itself when having its size set in size negotiation
112 namespace SizeScalePolicy
115 * @brief The type of SizeScalePolicy
120 USE_SIZE_SET, ///< Use the size that was set @SINCE_1_0.0
121 FIT_WITH_ASPECT_RATIO, ///< Fit within the size set maintaining natural size aspect ratio @SINCE_1_0.0
122 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
127 * @brief Horizontal alignment types.
130 namespace HorizontalAlignment
133 * @brief The type of HorizontalAlignment
138 LEFT, ///< Align horizontally left @SINCE_1_0.0
139 CENTER, ///< Align horizontally center @SINCE_1_0.0
140 RIGHT ///< Align horizontally right @SINCE_1_0.0
145 * @brief Vertical alignment types.
148 namespace VerticalAlignment
151 * @brief The type of VerticalAlignment
156 TOP, ///< Align vertically top @SINCE_1_0.0
157 CENTER, ///< Align vertically center @SINCE_1_0.0
158 BOTTOM ///< Align vertically bottom @SINCE_1_0.0
163 * @brief The ClippingMode describes how this Actors children will be clipped against it.
166 namespace ClippingMode
169 * @brief The type of ClippingMode
174 DISABLED, ///< This Actor will not clip its children. @SINCE_1_2_5
175 CLIP_CHILDREN, ///< This Actor will clip all children to within its boundaries (the actor will also be visible itself). @SINCE_1_2_5
185 #endif // DALI_ACTOR_ENUMERATIONS_H