1 #ifndef DALI_TOOLKIT_LAYOUTING_LINEAR_LAYOUT_H
2 #define DALI_TOOLKIT_LAYOUTING_LINEAR_LAYOUT_H
5 * Copyright (c) 2018 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.
20 #include <dali/public-api/common/dali-common.h>
21 #include <dali/public-api/object/base-handle.h>
22 #include <dali-toolkit/devel-api/layouting/layout-group.h>
23 #include <dali-toolkit/devel-api/layouting/layout-size.h>
24 #include <dali-toolkit/public-api/toolkit-property-index-ranges.h>
31 namespace Internal DALI_INTERNAL
37 * This class implements a linear box layout, automatically handling
38 * right to left or left to right direction change.
40 class DALI_TOOLKIT_API LinearLayout : public LayoutGroup
46 CHILD_PROPERTY_START_INDEX = LINEAR_LAYOUT_CHILD_PROPERTY_START_INDEX,
47 CHILD_PROPERTY_END_INDEX = LINEAR_LAYOUT_CHILD_PROPERTY_END_INDEX
51 * @brief Enumeration for the direction in which the content is laid out
53 enum class Orientation
55 HORIZONTAL, ///< Horizontal (row)
56 VERTICAL ///< Vertical (column)
60 * @brief Enumeration for the alignment of the linear layout items.
66 BEGIN = 0x1, ///< At the left/right edge of the container (maps to LTR/RTL direction for horizontal orientation)
67 END = 0x2, ///< At the right/left edge of the container (maps to LTR/RTL direction for horizontal orientation)
68 CENTER_HORIZONTAL = 0x4, ///< At the horizontal center of the container
69 TOP = 0x8, ///< At the top edge of the container
70 BOTTOM = 0x10, ///< At the bottom edge of the container
71 CENTER_VERTICAL = 0x20 ///< At the vertical center of the container
79 WEIGHT = CHILD_PROPERTY_START_INDEX, ///< name "weight", The proportion of the free space in the container the linear item will receive after all other non weighted items measured and all items specification width & height added. Type FLOAT
84 * @brief Creates an uninitialized LinearLayout handle.
86 * Initialize it using LinearLayout::New().
87 * Calling member functions with an uninitialized handle is not allowed.
92 * @brief Creates a LinearLayout object.
94 static LinearLayout New();
97 * @brief Downcasts a handle to a LinearLayout handle.
99 * If handle points to a LinearLayout, the downcast produces a valid handle.
100 * If not, the returned handle is left uninitialized.
102 * @param[in] handle to an object
103 * @return Handle to a LinearLayout or an uninitialized handle
105 static LinearLayout DownCast( BaseHandle handle );
108 * @brief Copy constructor
110 LinearLayout( const LinearLayout& other );
113 * @brief Assigment operator
115 LinearLayout& operator=( const LinearLayout& other );
118 * @brief Default destructor.
120 * This is non-virtual, since derived Handle types must not contain data or virtual methods
122 ~LinearLayout()=default;
125 * @brief Set the padding between cells in the layout
127 * @param[in] size The padding between cells.
129 void SetCellPadding( LayoutSize size );
132 * @brief Get the padding between cells in the layout
134 * @return The padding between cells.
136 LayoutSize GetCellPadding() const;
139 * @brief Set the orientation in the layout
141 * @param[in] orientation The orientation.
143 void SetOrientation( Orientation orientation );
146 * @brief Get the orientation in the layout
148 * @return The orientation.
150 Orientation GetOrientation() const;
153 * @brief Set the alignment in the layout
155 * @param[in] alignment The alignment.
157 void SetAlignment( unsigned int alignment );
160 * @brief Get the alignment in the layout
162 * @return The alignment.
164 unsigned int GetAlignment() const;
166 public: // Not intended for application developers
170 * @brief This constructor is used by LinearLayout::New() methods.
172 * @param[in] actor A pointer to a newly allocated Dali resource
174 explicit DALI_INTERNAL LinearLayout( Internal::LinearLayout* body );
178 } // namespace Toolkit
181 #endif // DALI_TOOLKIT_LAYOUTING_LINEAR_LAYOUT_H