dali-toolkit/public-api/controls/flex-container/flex-container.h

   1 #ifndef DALI_TOOLKIT_FLEX_CONTAINER_H
   2 #define DALI_TOOLKIT_FLEX_CONTAINER_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 namespace Internal DALI_INTERNAL
  29 {
  30 class FlexContainer;
  31 }
  32
  33 /**
  34  * @addtogroup dali_toolkit_controls_flex_container
  35  * @{
  36  */
  37
  38 /**
  39  * @brief FlexContainer implements a subset of the flexbox spec (defined by W3C):
  40  *
  41  * https://www.w3.org/TR/css3-flexbox/
  42  *
  43  * It aims at providing a more efficient way to lay out, align and distribute space among
  44  * items in the container, even when their size is unknown or dynamic.
  45  *
  46  * FlexContainer has the ability to alter the width and height of its children (i.e. flex
  47  * items) to fill the available space in the best possible way on different screen sizes.
  48  * FlexContainer can expand items to fill available free space, or shrink them to prevent
  49  * overflow.
  50  *
  51  * Below is an illustration of the various directions and terms as applied to a flex
  52  * container with the "flex direction" defined as "row".
  53  *
  54  * @code
  55  *     flex container
  56  *    --------------------------------------------------------------- cross start
  57  *    | ------------------ --------|--------------------------- |
  58  *    | |                | |       |                          | |
  59  *    | |                | |       |                          | |
  60  *    | |  flex item 1   | |       |    flex item 2           | | main axis
  61  *    |-|----------------|-|-------|--------------------------|-|------------>
  62  *    | |                | |       |                          | |
  63  *    | |                | |       |                          | |
  64  *    | |                | |       |                          | |
  65  *    | ------------------ --------|--------------------------- |
  66  *    -----------------------------|--------------------------------- cross end
  67  *    |                            |                            |
  68  *    | main start                 | cross axis                 | main end
  69  *    |                            |                            |
  70  *                                 v
  71  * @endcode
  72  *
  73  * @nosubgrouping
  74  * <h3>Per-child Custom properties for script supporting:</h3>
  75  *
  76  * The following custom properties of the actor are checked to decide how to lay out the
  77  * actor inside the flex container.
  78  *
  79  * These properties are registered dynamically to the child and are non-animatable.
  80  *
  81  * | %Property Name          | Type        |
  82  * |-------------------------|-------------|
  83  * | flex                    | float       |
  84  * | alignSelf               | integer     |
  85  * | flexMargin              | Vector4     |
  86  *
  87  * The available values for alignSelf are: ALIGN_AUTO, ALIGN_FLEX_START, ALIGN_CENTER, ALIGN_FLEX_END, ALIGN_STRETCH
  88  *
  89  * @code
  90  * "name":"icon",
  91  * "type":"ImageView",
  92  * "image":"image.png",
  93  *   "properties": {
  94  *     "flex":1,                        // Property to make the item to receive the specified proportion of the free space in the container.
  95  *     "alignSelf":"flexStart",         // Property to specify how the item will align along the cross axis.
  96  *     "flexMargin":[10, 10, 10, 10]    // Property to specify the space around the item.
  97  *   }
  98  * @endcode
  99  * @SINCE_1_1.35
 100  */
 101
 102 class DALI_TOOLKIT_API FlexContainer : public Control
 103 {
 104 public:
 105   /**
 106    * @brief Enumeration for the direction of the main axis in the flex container. This determines
 107    * the direction that flex items are laid out in the flex container.
 108    * @SINCE_1_1.35
 109    */
 110   enum FlexDirection
 111   {
 112     COLUMN,         ///< The flexible items are displayed vertically as a column @SINCE_1_1.35
 113     COLUMN_REVERSE, ///< The flexible items are displayed vertically as a column, but in reverse order @SINCE_1_1.35
 114     ROW,            ///< The flexible items are displayed horizontally as a row @SINCE_1_1.35
 115     ROW_REVERSE     ///< The flexible items are displayed horizontally as a row, but in reverse order @SINCE_1_1.35
 116   };
 117
 118   /**
 119    * @brief Enumeration for the primary direction in which content is ordered in the flex container
 120    * and on which sides the “start” and “end” are.
 121    * @SINCE_1_1.35
 122    */
 123   enum ContentDirection
 124   {
 125     INHERIT, ///< Inherits the same direction from the parent @SINCE_1_1.35
 126     LTR,     ///< From left to right @SINCE_1_1.35
 127     RTL      ///< From right to left @SINCE_1_1.35
 128   };
 129
 130   /**
 131    * @brief Enumeration for the alignment of the flex items when the items do not use all available
 132    * space on the main-axis.
 133    * @SINCE_1_1.35
 134    */
 135   enum Justification
 136   {
 137     JUSTIFY_FLEX_START,    ///< Items are positioned at the beginning of the container @SINCE_1_1.35
 138     JUSTIFY_CENTER,        ///< Items are positioned at the center of the container @SINCE_1_1.35
 139     JUSTIFY_FLEX_END,      ///< Items are positioned at the end of the container @SINCE_1_1.35
 140     JUSTIFY_SPACE_BETWEEN, ///< Items are positioned with equal space between the lines @SINCE_1_1.35
 141     JUSTIFY_SPACE_AROUND   ///< Items are positioned with equal space before, between, and after the lines @SINCE_1_1.35
 142   };
 143
 144   /**
 145    * @brief Enumeration for the alignment of the flex items or lines when the items or lines do not
 146    * use all the available space on the cross-axis.
 147    * @SINCE_1_1.35
 148    */
 149   enum Alignment
 150   {
 151     ALIGN_AUTO,       ///< Inherits the same alignment from the parent (only valid for "alignSelf" property) @SINCE_1_1.35
 152     ALIGN_FLEX_START, ///< At the beginning of the container @SINCE_1_1.35
 153     ALIGN_CENTER,     ///< At the center of the container @SINCE_1_1.35
 154     ALIGN_FLEX_END,   ///< At the end of the container @SINCE_1_1.35
 155     ALIGN_STRETCH     ///< Stretch to fit the container @SINCE_1_1.35
 156   };
 157
 158   /**
 159    * @brief Enumeration for the wrap type of the flex container when there is no enough room for
 160    * all the items on one flex line.
 161    * @SINCE_1_1.35
 162    */
 163   enum WrapType
 164   {
 165     NO_WRAP, ///< Flex items laid out in single line (shrunk to fit the flex container along the main axis) @SINCE_1_1.35
 166     WRAP     ///< Flex items laid out in multiple lines if needed @SINCE_1_1.35
 167   };
 168
 169 public:
 170   /**
 171    * @brief Enumeration for the start and end property ranges for this control.
 172    * @SINCE_1_1.35
 173    */
 174   enum PropertyRange
 175   {
 176     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.35
 177     PROPERTY_END_INDEX   = PROPERTY_START_INDEX + 1000,             ///< Reserve property indices @SINCE_1_1.35
 178
 179     CHILD_PROPERTY_START_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX,       ///< @SINCE_1_1.35
 180     CHILD_PROPERTY_END_INDEX   = CHILD_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve child property indices @SINCE_1_1.35
 181   };
 182
 183   /**
 184    * @brief Enumeration for the instance of properties belonging to the FlexContainer class.
 185    * @SINCE_1_1.35
 186    */
 187   struct Property
 188   {
 189     /**
 190      * @brief Enumeration for the instance of properties belonging to the FlexContainer class.
 191      * @SINCE_1_1.35
 192      */
 193     enum
 194     {
 195       // Event side properties
 196       CONTENT_DIRECTION = PROPERTY_START_INDEX, ///< name "contentDirection",   The primary direction in which content is ordered,                                                 @see FlexContainer::ContentDirection,  type INTEGER @SINCE_1_1.35
 197       FLEX_DIRECTION,                           ///< name "flexDirection",      The direction of the main-axis which determines the direction that flex items are laid out,        @see FlexContainer::FlexDirection,     type INTEGER @SINCE_1_1.35
 198       FLEX_WRAP,                                ///< name "flexWrap",           Whether the flex items should wrap or not if there is no enough room for them on one flex line,    @see FlexContainer::WrapType,          type INTEGER @SINCE_1_1.35
 199       JUSTIFY_CONTENT,                          ///< name "justifyContent",     The alignment of flex items when the items do not use all available space on the main-axis,        @see FlexContainer::Justification,     type INTEGER @SINCE_1_1.35
 200       ALIGN_ITEMS,                              ///< name "alignItems",         The alignment of flex items when the items do not use all available space on the cross-axis,       @see FlexContainer::Alignment,         type INTEGER @SINCE_1_1.35
 201       ALIGN_CONTENT                             ///< name "alignContent",       Similar to "alignItems", but it aligns flex lines, so only works when there are multiple lines,    @see FlexContainer::Alignment,         type INTEGER @SINCE_1_1.35
 202     };
 203   };
 204
 205   /**
 206    * @brief Enumeration for the instance of child properties belonging to the FlexContainer class.
 207    * @SINCE_1_1.35
 208    */
 209   struct ChildProperty
 210   {
 211     /**
 212      * @brief Enumeration for the instance of child properties belonging to the FlexContainer class.
 213      * @SINCE_1_1.35
 214      */
 215     enum
 216     {
 217       // Event side child properties
 218       FLEX = CHILD_PROPERTY_START_INDEX, ///< name "flex",               The proportion of the free space in the container the flex item will receive. If all items in the container set this property, their sizes will be proportional to the specified flex factor,  type FLOAT @SINCE_1_1.35
 219       ALIGN_SELF,                        ///< name "alignSelf",          The alignment of the flex item along the cross axis, which, if set, overrides the default alignment for all items in the container,                         @see FlexContainer::Alignment,     type INTEGER @SINCE_1_1.35
 220       FLEX_MARGIN                        ///< name "flexMargin",         The space around the flex item,                                                                                                                                                                type VECTOR4 @SINCE_1_1.35
 221     };
 222   };
 223
 224   /**
 225    * @brief Creates a FlexContainer handle; this can be initialized with FlexContainer::New()
 226    * Calling member functions with an uninitialized handle is not allowed.
 227    * @SINCE_1_1.35
 228    */
 229   FlexContainer();
 230
 231   /**
 232    * @brief Copy constructor. Creates another handle that points to the same real object.
 233    * @SINCE_1_1.35
 234    *
 235    * @param[in] handle The handle to copy from
 236    */
 237   FlexContainer(const FlexContainer& handle);
 238
 239   /**
 240    * @brief Move constructor
 241    * @SINCE_1_9.23
 242    *
 243    * @param[in] rhs A reference to the moved handle
 244    */
 245   FlexContainer(FlexContainer&& rhs);
 246
 247   /**
 248    * @brief Assignment operator. Changes this handle to point to another real object.
 249    * @SINCE_1_1.35
 250    * @param[in] handle Handle to an object
 251    * @return A reference to this
 252    */
 253   FlexContainer& operator=(const FlexContainer& handle);
 254
 255   /**
 256    * @brief Move assignment
 257    * @SINCE_1_9.23
 258    *
 259    * @param[in] rhs A reference to the moved handle
 260    * @return A reference to this
 261    */
 262   FlexContainer& operator=(FlexContainer&& rhs);
 263
 264   /**
 265    * @brief Destructor.
 266    *
 267    * @details This is non-virtual since derived Handle types must not contain data or virtual methods.
 268    *
 269    * @SINCE_1_1.35
 270    */
 271   ~FlexContainer();
 272
 273   /**
 274    * @brief Creates the FlexContainer control.
 275    * @SINCE_1_1.35
 276    *
 277    * @return A handle to the FlexContainer control
 278    */
 279   static FlexContainer New();
 280
 281   /**
 282    * @brief Downcasts an Object handle to FlexContainer.
 283    *
 284    * @details If handle points to a FlexContainer, the downcast produces valid handle.
 285    * If not, the returned handle is left uninitialized.
 286    *
 287    * @SINCE_1_1.35
 288    *
 289    * @param[in] handle Handle to an object
 290    * @return Handle to a FlexContainer or an uninitialized handle
 291    */
 292   static FlexContainer DownCast(BaseHandle handle);
 293
 294 public: // Not intended for application developers
 295   /// @cond internal
 296   /**
 297    * @brief Creates a handle using the Toolkit::Internal implementation.
 298    * @SINCE_1_1.35
 299    *
 300    * @param[in] implementation The Control implementation
 301    */
 302   DALI_INTERNAL FlexContainer(Internal::FlexContainer& implementation);
 303
 304   /**
 305    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 306    * @SINCE_1_1.35
 307    *
 308    * @param[in] internal A pointer to the internal CustomActor
 309    */
 310   explicit DALI_INTERNAL FlexContainer(Dali::Internal::CustomActor* internal);
 311   /// @endcond
 312 };
 313
 314 /**
 315  * @}
 316  */
 317 } // namespace Toolkit
 318
 319 } // namespace Dali
 320
 321 #endif // DALI_TOOLKIT_FLEX_CONTAINER_H