1 #ifndef __DALI_TOOLKIT_FLEX_CONTAINER_H__
2 #define __DALI_TOOLKIT_FLEX_CONTAINER_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.
22 #include <dali-toolkit/public-api/controls/control.h>
30 namespace Internal DALI_INTERNAL
36 * @addtogroup dali_toolkit_controls_flex_container
41 * @brief FlexContainer implements a subset of the flexbox spec (defined by W3C):
43 * https://www.w3.org/TR/css3-flexbox/
45 * It aims at providing a more efficient way to lay out, align and distribute space among
46 * items in the container, even when their size is unknown or dynamic.
48 * FlexContainer has the ability to alter the width and height of its children (i.e. flex
49 * items) to fill the available space in the best possible way on different screen sizes.
50 * FlexContainer can expand items to fill available free space, or shrink them to prevent
53 * Below is an illustration of the various directions and terms as applied to a flex
54 * container with the "flex direction" defined as "row".
58 * --------------------------------------------------------------- cross start
59 * | ------------------ --------|--------------------------- |
62 * | | flex item 1 | | | flex item 2 | | main axis
63 * |-|----------------|-|-------|--------------------------|-|------------>
67 * | ------------------ --------|--------------------------- |
68 * -----------------------------|--------------------------------- cross end
70 * | main start | cross axis | main end
76 * <h3>Per-child Custom properties for script supporting:</h3>
78 * The following custom properties of the actor are checked to decide how to lay out the
79 * actor inside the flex container.
81 * These properties are registered dynamically to the child and are non-animatable.
83 * | %Property Name | Type |
84 * |-------------------------|-------------|
86 * | alignSelf | integer |
87 * | flexPadding | Vector4 |
88 * | flexBorder | Vector4 |
89 * | flexMargin | Vector4 |
91 * The available values for alignSelf are: ALIGN_AUTO, ALIGN_FLEX_START, ALIGN_CENTER, ALIGN_FLEX_END, ALIGN_STRETCH
96 * "image":"image.png",
97 * "customProperties": {
98 * "flex":1, // property to make the item to receive the specified proportion of the free space in the container. If all items in the container use this pattern, their sizes will be proportional to the specified flex factor.
99 * "alignSelf":"flexStart", // property to specify how the item will align along the cross axis, if set, this overides the default alignment for all items in the container
100 * "flexPadding":[10, 10, 10, 10], // property to specify the space around the content (inside the flex border) of the item, if not set, default value is [0, 0, 0, 0]
101 * "flexBorder":[5, 5, 5, 5], // property to specify the border that goes around the flex padding and the content of the item, if not set, default value is [0, 0, 0, 0]
102 * "flexMargin":[10, 10, 10, 10] // property to specify the space outside the flex border, if not set, default value is [0, 0, 0, 0]
107 class DALI_IMPORT_API FlexContainer : public Control
112 * @brief The direction of the main axis in the flex container. This determines
113 * the direction that flex items are laid out in the flex container.
117 COLUMN, ///< The flexible items are displayed vertically as a column
118 COLUMN_REVERSE, ///< The flexible items are displayed vertically as a column, but in reverse order
119 ROW, ///< The flexible items are displayed horizontally as a row
120 ROW_REVERSE ///< The flexible items are displayed horizontally as a row, but in reverse order
124 * @brief The primary direction in which content is ordered in the flex container
125 * and on which sides the “start” and “end” are.
127 enum ContentDirection
129 INHERIT, ///< Inherits the same direction from the parent
130 LTR, ///< From left to right
131 RTL ///< From right to left
135 * @brief Alignment of the flex items when the items do not use all available
136 * space on the main-axis.
140 JUSTIFY_FLEX_START, ///< Items are positioned at the beginning of the container
141 JUSTIFY_CENTER, ///< Items are positioned at the center of the container
142 JUSTIFY_FLEX_END, ///< Items are positioned at the end of the container
143 JUSTIFY_SPACE_BETWEEN, ///< Items are positioned with equal space between the lines
144 JUSTIFY_SPACE_AROUND ///< Items are positioned with equal space before, between, and after the lines
148 * @brief Alignment of the flex items or lines when the items or lines do not
149 * use all available space on the cross-axis.
153 ALIGN_AUTO, ///< Inherits the same alignment from the parent (only valid for "alignSelf" property)
154 ALIGN_FLEX_START, ///< At the beginning of the container
155 ALIGN_CENTER, ///< At the center of the container
156 ALIGN_FLEX_END, ///< At the end of the container
157 ALIGN_STRETCH ///< Stretch to fit the container
161 * @brief The wrap type of the flex container when there is no enough room for
162 * all the items on one flex line.
166 NO_WRAP, ///< Flex items laid out in single line (shrunk to fit the flex container along the main axis)
167 WRAP ///< Flex items laid out in multiple lines if needed
173 * @brief The start and end property ranges for this control.
177 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
178 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
182 * @brief An enumeration of properties belonging to the FlexContainer class.
188 CONTENT_DIRECTION = PROPERTY_START_INDEX, ///< name "contentDirection", The primary direction in which content is ordered, @see FlexContainer::ContentDirection, type INTEGER
189 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
190 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
191 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
192 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
193 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
198 * Create a FlexContainer handle; this can be initialised with FlexContainer::New()
199 * Calling member functions with an uninitialised handle is not allowed.
204 * Copy constructor. Creates another handle that points to the same real object
205 * @param handle to copy from
207 FlexContainer( const FlexContainer& handle );
210 * Assignment operator. Changes this handle to point to another real object
212 FlexContainer& operator=( const FlexContainer& handle );
217 * This is non-virtual since derived Handle types must not contain data or virtual methods.
222 * Create the FlexContainer control.
223 * @return A handle to the FlexContainer control.
225 static FlexContainer New();
228 * Downcast an Object handle to FlexContainer. If handle points to a FlexContainer the
229 * downcast produces valid handle. If not the returned handle is left uninitialized.
230 * @param[in] handle Handle to an object
231 * @return handle to a FlexContainer or an uninitialized handle
233 static FlexContainer DownCast( BaseHandle handle );
236 public: // Not intended for application developers
239 * @brief Creates a handle using the Toolkit::Internal implementation.
241 * @param[in] implementation The Control implementation.
243 DALI_INTERNAL FlexContainer( Internal::FlexContainer& implementation );
246 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
248 * @param[in] internal A pointer to the internal CustomActor.
250 explicit DALI_INTERNAL FlexContainer( Dali::Internal::CustomActor* internal );
256 } // namespace Toolkit
260 #endif // __DALI_TOOLKIT_FLEX_CONTAINER_H__