1 #ifndef DALI_TOOLKIT_FLEX_CONTAINER_H
2 #define DALI_TOOLKIT_FLEX_CONTAINER_H
5 * Copyright (c) 2020 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.
22 #include <dali-toolkit/public-api/controls/control.h>
28 namespace Internal DALI_INTERNAL
34 * @addtogroup dali_toolkit_controls_flex_container
39 * @brief FlexContainer implements a subset of the flexbox spec (defined by W3C):
41 * https://www.w3.org/TR/css3-flexbox/
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.
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
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".
56 * --------------------------------------------------------------- cross start
57 * | ------------------ --------|--------------------------- |
60 * | | flex item 1 | | | flex item 2 | | main axis
61 * |-|----------------|-|-------|--------------------------|-|------------>
65 * | ------------------ --------|--------------------------- |
66 * -----------------------------|--------------------------------- cross end
68 * | main start | cross axis | main end
74 * <h3>Per-child Custom properties for script supporting:</h3>
76 * The following custom properties of the actor are checked to decide how to lay out the
77 * actor inside the flex container.
79 * These properties are registered dynamically to the child and are non-animatable.
81 * | %Property Name | Type |
82 * |-------------------------|-------------|
84 * | alignSelf | integer |
85 * | flexMargin | Vector4 |
87 * The available values for alignSelf are: ALIGN_AUTO, ALIGN_FLEX_START, ALIGN_CENTER, ALIGN_FLEX_END, ALIGN_STRETCH
92 * "image":"image.png",
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.
102 class DALI_TOOLKIT_API FlexContainer : public Control
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.
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
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.
123 enum ContentDirection
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
131 * @brief Enumeration for the alignment of the flex items when the items do not use all available
132 * space on the main-axis.
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
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.
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
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.
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
171 * @brief Enumeration for the start and end property ranges for this control.
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
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
184 * @brief Enumeration for the instance of properties belonging to the FlexContainer class.
190 * @brief Enumeration for the instance of properties belonging to the FlexContainer class.
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
206 * @brief Enumeration for the instance of child properties belonging to the FlexContainer class.
212 * @brief Enumeration for the instance of child properties belonging to the FlexContainer class.
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
225 * @brief Creates a FlexContainer handle; this can be initialized with FlexContainer::New()
226 * Calling member functions with an uninitialized handle is not allowed.
232 * @brief Copy constructor. Creates another handle that points to the same real object.
235 * @param[in] handle The handle to copy from
237 FlexContainer(const FlexContainer& handle);
240 * @brief Move constructor
243 * @param[in] rhs A reference to the moved handle
245 FlexContainer(FlexContainer&& rhs);
248 * @brief Assignment operator. Changes this handle to point to another real object.
250 * @param[in] handle Handle to an object
251 * @return A reference to this
253 FlexContainer& operator=(const FlexContainer& handle);
256 * @brief Move assignment
259 * @param[in] rhs A reference to the moved handle
260 * @return A reference to this
262 FlexContainer& operator=(FlexContainer&& rhs);
267 * @details This is non-virtual since derived Handle types must not contain data or virtual methods.
274 * @brief Creates the FlexContainer control.
277 * @return A handle to the FlexContainer control
279 static FlexContainer New();
282 * @brief Downcasts an Object handle to FlexContainer.
284 * @details If handle points to a FlexContainer, the downcast produces valid handle.
285 * If not, the returned handle is left uninitialized.
289 * @param[in] handle Handle to an object
290 * @return Handle to a FlexContainer or an uninitialized handle
292 static FlexContainer DownCast(BaseHandle handle);
294 public: // Not intended for application developers
297 * @brief Creates a handle using the Toolkit::Internal implementation.
300 * @param[in] implementation The Control implementation
302 DALI_INTERNAL FlexContainer(Internal::FlexContainer& implementation);
305 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
308 * @param[in] internal A pointer to the internal CustomActor
310 explicit DALI_INTERNAL FlexContainer(Dali::Internal::CustomActor* internal);
317 } // namespace Toolkit
321 #endif // DALI_TOOLKIT_FLEX_CONTAINER_H