1 #ifndef DALI_TOOLKIT_LAYOUTING_HBOX_LAYOUT_H
2 #define DALI_TOOLKIT_LAYOUTING_HBOX_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 horizontal box layout, automatically handling
38 * right to left or left to right direction change.
40 class DALI_IMPORT_API HboxLayout : public LayoutGroup
46 CHILD_PROPERTY_START_INDEX = LINEAR_LAYOUT_CHILD_PROPERTY_START_INDEX,
47 CHILD_PROPERTY_END_INDEX = LINEAR_LAYOUT_CHILD_PROPERTY_END_INDEX
52 // @todo When we can have event-only properties for BaseObject, this will be useful.
55 CELL_PADDING = PROPERTY_REGISTRATION_START_INDEX + 2000
63 WEIGHT = CHILD_PROPERTY_START_INDEX
68 * @brief Creates an uninitialized HboxLayout handle.
70 * Initialize it using HboxLayout::New().
71 * Calling member functions with an uninitialized handle is not allowed.
76 * @brief Creates a HboxLayout object.
78 static HboxLayout New();
81 * @brief Downcasts a handle to a HboxLayout handle.
83 * If handle points to a HboxLayout, the downcast produces a valid handle.
84 * If not, the returned handle is left uninitialized.
86 * @param[in] handle to an object
87 * @return Handle to a HboxLayout or an uninitialized handle
89 static HboxLayout DownCast( BaseHandle handle );
92 * @brief Copy constructor
94 HboxLayout( const HboxLayout& other );
97 * @brief Assigment operator
99 HboxLayout& operator=( const HboxLayout& other );
102 * @brief Default destructor.
104 * This is non-virtual, since derived Handle types must not contain data or virtual methods
106 ~HboxLayout()=default;
109 * @brief Set the padding between cells in the layout
111 * @param[in] size The padding between cells.
113 void SetCellPadding( LayoutSize size );
116 * @brief Get the padding between cells in the layout
118 * @return The padding between cells.
120 LayoutSize GetCellPadding();
122 public: // Not intended for application developers
126 * @brief This constructor is used by HboxLayout::New() methods.
128 * @param[in] actor A pointer to a newly allocated Dali resource
130 explicit DALI_INTERNAL HboxLayout( Internal::HboxLayout* body );
134 } // namespace Toolkit
137 #endif // DALI_TOOLKIT_LAYOUTING_HBOX_LAYOUT_H