1 #ifndef DALI_TOOLKIT_LAYOUTING_LAYOUT_ITEM_H
2 #define DALI_TOOLKIT_LAYOUTING_LAYOUT_ITEM_H
4 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 #include <dali/public-api/common/dali-common.h>
22 #include <dali/public-api/actors/actor-enumerations.h>
23 #include <dali/public-api/object/base-handle.h>
24 #include <dali/public-api/object/property-index-ranges.h>
25 #include <dali-toolkit/devel-api/layouting/child-layout-data.h>
26 #include <dali-toolkit/devel-api/layouting/measure-spec.h>
27 #include <dali-toolkit/public-api/dali-toolkit-common.h>
39 using LayoutId = unsigned int;
43 * Base class for layouts. It is used to layout a control (or visual).
44 * It can be laid out by a LayoutGroup.
46 class DALI_TOOLKIT_API LayoutItem : public BaseHandle
52 CHILD_PROPERTY_START_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by child properties
53 CHILD_PROPERTY_END_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX+1000 ///< Reserving 1000 property indices
60 WIDTH_SPECIFICATION = ///< Child property to specify desired width (May use MATCH_PARENT/WRAP_CONTENT)
61 CHILD_PROPERTY_START_INDEX,
62 HEIGHT_SPECIFICATION ///< Child property to specify desired height (May use MATCH_PARENT/WRAP_CONTENT)
67 * @brief Default constructor which provides an uninitialized Dali::LayoutItem.
72 * @brief Default destructor
74 ~LayoutItem()=default;
77 * @brief Create an initialized LayoutItem
79 * @param[in] handle A handle to the object that this layout for, e.g. a Control or a Visual::Base
80 * @warning This is an interim function, and will be deleted when all controls have layouts
81 * @todo Ensure that this warning is implemented
83 static LayoutItem New( Handle& handle );
86 * @brief Copy constructor
87 * @param[in] copy The LayoutItem to copy.
89 LayoutItem(const LayoutItem& copy) = default;
92 * @brief Assignment operator
93 * @param[in] rhs The LayoutItem to copy
95 LayoutItem& operator=( const LayoutItem& rhs ) = default;
98 * @brief Get a handle to the control or visual this layout represents.
102 Handle GetOwner() const;
105 * @brief Set whether this layout should be animated or not
107 * @param[in] animateLayout True if the layout should be animated when applied
109 void SetAnimateLayout( bool animateLayout );
112 * @brief Predicate to determine whether this layout should be animated when applied
114 * @return True if the layout should be animated when applied
116 bool IsLayoutAnimated() const;
121 * @brief This constructor is used by LayoutItem::New() methods.
123 * @param[in] actor A pointer to a newly allocated Dali resource
125 explicit DALI_INTERNAL LayoutItem( Internal::LayoutItem* LayoutItem );
133 #endif // DALI_TOOLKIT_LAYOUTING_LAYOUT_ITEM_H