dali/public-api/actors/actor-enumerations.h

   1 #ifndef __DALI_ACTOR_ENUMERATIONS_H__
   2 #define __DALI_ACTOR_ENUMERATIONS_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 #include <dali/public-api/common/dali-common.h>
  22
  23 namespace Dali
  24 {
  25
  26 /**
  27  * @brief Actor color mode.
  28  *
  29  */
  30 enum ColorMode
  31 {
  32   USE_OWN_COLOR,                 ///< Actor will use its own color
  33   USE_PARENT_COLOR,              ///< Actor will use its parent color
  34   USE_OWN_MULTIPLY_PARENT_COLOR, ///< Actor will blend its color with its parents color.
  35   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.
  36 };
  37
  38 /**
  39  * @brief Actor position inheritance mode.
  40  */
  41 enum PositionInheritanceMode
  42 {
  43   INHERIT_PARENT_POSITION,                 ///< Actor will inherit its parent position. This is the default
  44   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.
  45   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.
  46   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.
  47 };
  48
  49 /**
  50  * @brief Dimensions for layout
  51  */
  52 namespace Dimension
  53 {
  54 enum Type
  55 {
  56   WIDTH  = 0x1,       ///< Width dimension
  57   HEIGHT = 0x2,       ///< Height dimension
  58
  59   ALL_DIMENSIONS = 0x3  ///< Mask to cover all flags
  60 };
  61
  62 enum Meta
  63 {
  64   DIMENSION_COUNT = 2  ///< Number of dimensions - update this if adding new dimension
  65 };
  66 }
  67
  68 /**
  69  * @brief Size negotiation resize policies
  70  */
  71 namespace ResizePolicy
  72 {
  73 enum Type
  74 {
  75   FIXED,                 ///< Size is fixed as set by SetSize
  76   USE_NATURAL_SIZE,      ///< Size is to use the actor's natural size
  77   FILL_TO_PARENT,        ///< Size is to fill up to the actor's parent's bounds. Aspect ratio not maintained.
  78   SIZE_RELATIVE_TO_PARENT,        ///< The actors size will be ( ParentSize * SizeRelativeToParentFactor ).
  79   SIZE_FIXED_OFFSET_FROM_PARENT,  ///< The actors size will be ( ParentSize + SizeRelativeToParentFactor ).
  80   FIT_TO_CHILDREN,       ///< Size will adjust to wrap around all children
  81   DIMENSION_DEPENDENCY,  ///< One dimension is dependent on the other
  82   USE_ASSIGNED_SIZE      ///< The size will be assigned to the actor
  83 };
  84 }
  85
  86 /**
  87  * @brief Policies to determine how an actor should resize itself when having its size set in size negotiation
  88  */
  89 namespace SizeScalePolicy
  90 {
  91 enum Type
  92 {
  93   USE_SIZE_SET,                ///< Use the size that was set
  94   FIT_WITH_ASPECT_RATIO,       ///< Fit within the size set maintaining natural size aspect ratio
  95   FILL_WITH_ASPECT_RATIO       ///< Fill up the size set maintaining natural size aspect ratio. May exceed size bounds in one dimension.
  96 };
  97 }
  98
  99 /**
 100  * @brief Different types of alignment.
 101  */
 102 namespace HorizontalAlignment
 103 {
 104 enum Type
 105 {
 106   LEFT,         ///< Align horizontally left
 107   CENTER,       ///< Align horizontally center
 108   RIGHT         ///< Align horiztonally right
 109 };
 110 }
 111
 112 namespace VerticalAlignment
 113 {
 114 enum Type
 115 {
 116   TOP,          ///< Align vertically top
 117   CENTER,       ///< Align vertically center
 118   BOTTOM        ///< Align vertically bottom
 119 };
 120 }
 121
 122 } // namespace Dali
 123
 124 #endif // __DALI_ACTOR_ENUMERATIONS_H__