1 #ifndef DALI_TOOLKIT_LAYOUTING_FLEX_NODE_H
2 #define DALI_TOOLKIT_LAYOUTING_FLEX_NODE_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.
21 #include <dali/public-api/actors/actor.h>
22 #include <dali/public-api/common/dali-common.h>
26 #include <dali-toolkit/public-api/dali-toolkit-common.h>
37 * @brief Enumeration for the direction of the main axis in the flex container. This determines
38 * the direction that flex items are laid out in the flex container.
40 enum class FlexDirection
42 COLUMN, ///< The flexible items are displayed vertically as a column
43 COLUMN_REVERSE, ///< The flexible items are displayed vertically as a column, but in reverse order
44 ROW, ///< The flexible items are displayed horizontally as a row
45 ROW_REVERSE ///< The flexible items are displayed horizontally as a row, but in reverse order
49 * @brief Enumeration for the alignment of the flex items when the items do not use all available
50 * space on the main-axis.
52 enum class Justification
54 FLEX_START, ///< Items are positioned at the beginning of the container
55 CENTER, ///< Items are positioned at the center of the container
56 FLEX_END, ///< Items are positioned at the end of the container
57 SPACE_BETWEEN, ///< Items are positioned with equal space between the items
58 SPACE_AROUND ///< Items are positioned with equal space before, between, and after the items
62 * @brief Enumeration for the wrap type of the flex container when there is not enough room for
63 * all the items on one flex line.
67 NO_WRAP, ///< Flex items laid out in single line (shrunk to fit the flex container along the main axis)
68 WRAP ///< Flex items laid out in multiple lines if needed
72 * @brief Enumeration for the alignment of the flex items or lines when the items or lines do not
73 * use all the available space on the cross-axis.
77 AUTO, ///< Currently unsupported, placeholder for inheritance of parent alignment.
79 FLEX_START, ///< At the beginning of the container
80 CENTER, ///< At the center of the container
81 FLEX_END, ///< At the end of the container
82 STRETCH ///< Stretch to fit the container
86 * @brief Enumeration for the position type of the flex item how it is positioned within its parent.
88 enum class PositionType
90 RELATIVE, ///< Flex items laid out relatively
91 ABSOLUTE ///< Flex items laid out absolutely
95 * Struct used for MeasureCallback
99 SizeTuple(float x, float y)
110 * @brief Callback signature for child Actor measure callback.
111 * @note Actor, child Actor to measure
112 * @note float, available width for child
113 * @note int, width measure specifcation mode
114 * @note float, available height for child
115 * @note int, height measure specification mode
117 using MeasureCallback = SizeTuple (*)(Dali::Actor, float, int, float, int);
120 * This class provides the API for calling into the Flex layout implementation.
122 class DALI_TOOLKIT_API Node
126 * @brief Constructor.
135 Node& operator=(Node&&) = default;
136 Node(Node&&) = default;
137 Node(const Node&) = delete;
138 Node& operator=(const Node&) = delete;
141 * @brief Insert child into the FlexLayout at the given index.
142 * @param[in] child Actor to insert.
143 * @param[in] margin of child Actor.
144 * @param[in] measureFunction for the child.
145 * @param[in] index to insert at.
146 * @return child node pointer
148 Node* AddChild(Actor child, Extents margin, MeasureCallback measureFunction, int index);
151 * @brief Remove child from the FlexLayout at the given index.
152 * @param[in] child child to be removed.
154 void RemoveChild(Actor child);
157 * @brief Return the dimensions of the node.
158 * @param[in] width width specification
159 * @param[in] widthMode width specification mode
160 * @param[in] height height specification
161 * @param[in] heightMode height specification mode
162 * @return Size tuple representing the width and height of the node
164 SizeTuple MeasureNode(float width, int widthMode, float height, int heightMode);
167 * @brief Perform the layout measure calculations.
168 * @param[in] availableWidth Amount of space available for layout, width.
169 * @param[in] availableHeight Amount of space available for layout, height.
170 * @param[in] isRTL Is the direction of the layout right to left.
172 void CalculateLayout(float availableWidth, float availableHeight, bool isRTL);
175 * @brief Get the calculated width of the given node.
176 * @return the width of the node
178 float GetFlexWidth() const;
181 * @brief Get the calculated height of the given node.
182 * @return the height of the node
184 float GetFlexHeight() const;
187 * @brief Get frame coordinates of the node at the given index.
188 * @param[in] index of the child
189 * @return Frame structure left x, top y, right z, bottom w
191 Vector4 GetNodeFrame(int index) const;
194 * @brief Set the flex direction in the layout.
195 * The direction of the main-axis which determines the direction that flex items are laid out.
196 * @param[in] flexDirection The flex direction.
198 void SetFlexDirection(FlexDirection flexDirection);
201 * @brief Get the flex direction in the layout.
202 * @return The flex direction.
204 FlexDirection GetFlexDirection() const;
207 * @brief Set the justification in the layout.
208 * @param[in] flexJustification The flex justification.
210 void SetFlexJustification(Justification flexJustification);
213 * @brief Get the flex justification in the layout.
214 * @return The flex justification.
216 Justification GetFlexJustification() const;
219 * @brief Set the wrap in the layout.
220 * @param[in] flexWrap The flex wrap.
222 void SetFlexWrap(WrapType flexWrap);
225 * @brief Get the flex wrap in the layout.
226 * @return The flex wrap.
228 WrapType GetFlexWrap() const;
231 * @brief Set the alignment of the layout content.
232 * @param[in] flexAlignment The alignment of the content.
234 void SetFlexAlignment(Alignment flexAlignment);
237 * @brief Get the alignment of the layout content.
238 * @return The flex content alignment.
240 Alignment GetFlexAlignment() const;
243 * @brief Set the alignment of the layout items.
244 * @param[in] flexAlignment The alignment of the items.
246 void SetFlexItemsAlignment(Alignment flexAlignment);
249 * @brief Get the alignment of the layout items.
250 * @return The flex items alignment.
252 Alignment GetFlexItemsAlignment() const;
255 * @brief Set the alignment self of the layout items.
256 * @param[in] flexAlignmentSelf The alignment self of the items.
258 void SetFlexAlignmentSelf(Alignment flexAlignmentSelf);
261 * @brief Get the alignment self of the layout items.
262 * @return The flex items alignment self.
264 Alignment GetFlexAlignmentSelf() const;
267 * @brief Set the position type of the layout items.
268 * @param[in] flexPositionType The position type of the items.
270 void SetFlexPositionType(PositionType flexPositionType);
273 * @brief Get the position type of the layout items.
274 * @return The flex position type.
276 PositionType GetFlexPositionType() const;
279 * @brief Set the aspect ratio of the layout items.
280 * @param[in] flexAspectRatio The aspect ratio of the items.
282 void SetFlexAspectRatio(float flexAspectRatio);
285 * @brief Get the aspect ratio of the layout items.
286 * @return The flex aspect ratio.
288 float GetFlexAspectRatio() const;
291 * @brief Set the basis of the layout items.
292 * @param[in] flexBasis The basis of the items.
294 void SetFlexBasis(float flexBasis);
297 * @brief Get the basis of the layout items.
298 * @return The flex basis.
300 float GetFlexBasis() const;
303 * @brief Set the shrink of the layout items.
304 * @param[in] flexShrink The shrink of the items.
306 void SetFlexShrink(float flexShrink);
309 * @brief Get the shrink of the layout items.
310 * @return The flex shrink.
312 float GetFlexShrink() const;
315 * @brief Set the grow of the layout items.
316 * @param[in] flexGrow The grow of the items.
318 void SetFlexGrow(float flexGrow);
321 * @brief Get the grow of the layout items.
322 * @return The flex grow.
324 float GetFlexGrow() const;
327 * @brief Set the margin.
328 * @param[in] margin The margin value.
330 void SetMargin(Extents margin);
333 * @brief Set the padding.
334 * @param[in] padding The padding value.
336 void SetPadding(Extents padding);
340 std::unique_ptr<Impl> mImpl;
345 } // namespace Toolkit
348 #endif // DALI_TOOLKIT_LAYOUTING_FLEX_NODE_H