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>
38 using LayoutId = unsigned int;
42 * Base class for layouts. It is used to layout a control (or visual).
43 * It can be laid out by a LayoutGroup.
45 class DALI_IMPORT_API LayoutItem : public BaseHandle
51 CHILD_PROPERTY_START_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by child properties
52 CHILD_PROPERTY_END_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX+1000 ///< Reserving 1000 property indices
59 WIDTH_SPECIFICATION = ///< Child property to specify desired width (May use MATCH_PARENT/WRAP_CONTENT)
60 CHILD_PROPERTY_START_INDEX,
61 HEIGHT_SPECIFICATION ///< Child property to specify desired height (May use MATCH_PARENT/WRAP_CONTENT)
66 * @brief Default constructor which provides an uninitialized Dali::LayoutItem.
71 * @brief Default destructor
73 ~LayoutItem()=default;
76 * @brief Create an initialized LayoutItem
78 * @param[in] handle A handle to the object that this layout for, e.g. a Control or a Visual::Base
79 * @warning This is an interim function, and will be deleted when all controls have layouts
80 * @todo Ensure that this warning is implemented
82 static LayoutItem New( Handle& handle );
85 * @brief Copy constructor
86 * @param[in] copy The LayoutItem to copy.
88 LayoutItem(const LayoutItem& copy) = default;
91 * @brief Assignment operator
92 * @param[in] rhs The LayoutItem to copy
94 LayoutItem& operator=( const LayoutItem& rhs ) = default;
97 * @brief Get a handle to the control or visual this layout represents.
101 Handle GetOwner() const;
104 * @brief Set whether this layout should be animated or not
106 * @param[in] animateLayout True if the layout should be animated when applied
108 void SetAnimateLayout( bool animateLayout );
111 * @brief Predicate to determine whether this layout should be animated when applied
113 * @return True if the layout should be animated when applied
115 bool IsLayoutAnimated() const;
120 * @brief This constructor is used by LayoutItem::New() methods.
122 * @param[in] actor A pointer to a newly allocated Dali resource
124 explicit DALI_INTERNAL LayoutItem( Internal::LayoutItem* LayoutItem );
132 #endif // DALI_TOOLKIT_LAYOUTING_LAYOUT_ITEM_H