1 #ifndef DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_BASE_H
2 #define DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_BASE_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/intrusive-ptr.h>
22 #include <dali/public-api/object/base-object.h>
23 #include <dali/public-api/object/type-registry.h>
24 #include <dali/public-api/actors/actor-enumerations.h>
25 #include <dali-toolkit/devel-api/layouting/child-layout-data.h>
26 #include <dali-toolkit/devel-api/layouting/layout-base.h>
27 #include <dali-toolkit/devel-api/layouting/layout-parent-impl.h>
28 #include <dali-toolkit/devel-api/layouting/layout-controller.h>
29 #include <dali-toolkit/devel-api/layouting/layout-size.h>
30 #include <dali-toolkit/devel-api/layouting/measure-spec.h>
31 #include <dali-toolkit/devel-api/layouting/measured-size.h>
41 using LayoutBasePtr = IntrusivePtr<LayoutBase>;
45 * Base class for layouts.
47 class DALI_IMPORT_API LayoutBase : public BaseObject,
58 * A reference counted object may only be deleted by calling Unreference()
60 ~LayoutBase() = default;
67 * @param[in] owner The owner (container view / child view / visual ) of this layout
68 * @return a new LayoutBase object
70 static LayoutBasePtr New( Handle& owner );
73 * @brief Remove the default copy constructor
75 LayoutBase(const LayoutBase& copy)=delete;
78 * @brief Remove the default assignment operator
80 LayoutBase& operator=(const LayoutBase& rhs)=delete;
83 * @brief Initialize the layout with it's owner and owner's type name
84 * @param[in] owner a handle to the owner container
85 * @param[in] containerType the type name of the owner container
87 void Initialize( Handle& owner, const std::string& containerType );
90 * @brief Get a handle to the owner of this layout
92 * @return a handle to the owner of this layout
94 Handle GetOwner() const;
97 * @brief Unparent this layout from it's owner, and remove any layout children in derived types
102 * @brief Set whether this layout should be animated or not
104 * @param[in] animateLayout True if the layout should be animated when applied
106 void SetAnimateLayout( bool animateLayout );
109 * @brief Get whether this layout should be animated or not
111 * @return True if the layout should be animated when applied
113 bool IsLayoutAnimated() const;
116 * @brief Register child properties of layout with owner type.
118 * The Actor hierarchy uses these registered properties in the type
119 * system to ensure child custom properties are properly initialized.
121 * @param[in] containerType The type of the containing view (owner)
123 void RegisterChildProperties( const std::string& containerType );
126 * @brief This is called to find out how big a layout should be.
128 * The parent supplies constraint information in the width and height parameters.
130 * The actual measurement work of a layout is performed in
131 * {@link #OnMeasure(MeasureSpec, MeasureSpec)}, called by this method. Therefore, only
132 * {@link #OnMeasure(MeasureSpec, MeasureSpec)} can and must be overridden by subclasses.
134 * @param[in] widthMeasureSpec Horizontal space requirements as imposed by the parent
135 * @param[in] heightMeasureSpec Vertical space requirements as imposed by the parent
137 * @see #OnMeasure(MeasureSpec, MeasureSpec)
139 void Measure( MeasureSpec widthMeasureSpec, MeasureSpec heightMeasureSpec );
142 * @brief Assign a size and position to a layout and all of its descendants.
144 * This is the second phase of the layout mechanism. (The first is measuring). In this phase, each parent
145 * calls layout on all of its children to position them. This is typically done using the child
146 * measurements that were stored in the measure pass.
148 * Derived classes with children should override OnLayout. In that method, they should call Layout on each
151 * @param[in] left position, relative to parent
152 * @param[in] top position, relative to parent
153 * @param[in] right position, relative to parent
154 * @param[in] bottom position, relative to parent
156 void Layout( LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom );
159 * @brief Utility to return a default size.
161 * Uses the supplied size if the MeasureSpec imposed no constraints. Will get larger if allowed by the
164 * @param[in] size Default size for this layout
165 * @param[in] measureSpec Constraints imposed by the parent
166 * @return The size this layout should be.
168 static LayoutLength GetDefaultSize( LayoutLength size, MeasureSpec measureSpec );
171 * @copydoc LayoutParent::GetParent
173 virtual LayoutParent* GetParent() override;
176 * @brief Request that this layout is re-laid out.
178 * This will make this layout and all it's parent layouts dirty.
180 void RequestLayout();
183 * @brief Predicate to determine if this layout has been requested to re-layout
185 * @return True if a layout request has occured on this layout
187 bool IsLayoutRequested() const;
190 * @brief Get the measured width (without any measurement flags).
192 * This method should be used only during measurement and layout calculations.
194 * Use {@link Dali::Actor::GetTargetSize()} to see how wide a control is after layout
196 LayoutLength GetMeasuredWidth() const;
199 * @brief Get the measured height (without any measurement flags).
201 * This method should be used only during measurement and layout calculations.
203 * Use {@link Dali::Actor::GetTargetSize()} to see how high a control is after layout
205 LayoutLength GetMeasuredHeight() const;
208 * @brief Get the measured width and state.
210 * This method should be used only during measurement and layout calculations.
212 * Use {@link Dali::Actor::GetTargetSize()} to see how wide a view is after layout
214 MeasuredSize GetMeasuredWidthAndState() const;
217 * @brief Get the measured height and state.
219 * This method should be used only during measurement and layout calculations.
221 * Use {@link Dali::Actor::GetTargetSize()} to see how high a view is after layout
223 MeasuredSize GetMeasuredHeightAndState() const;
226 * @brief Returns the suggested minimum width that the layout should use.
228 * This returns the maximum of the layout's minimum width and the background's minimum width
230 * When being used in {@link #OnMeasure()}, the caller should still
231 * ensure the returned width is within the requirements of the parent.
233 * @return The suggested minimum width of the layout.
235 LayoutLength GetSuggestedMinimumWidth() const;
238 * @brief Returns the suggested minimum height that the layout should use.
240 * This returns the maximum of the layout's minimum height and the background's minimum height
242 * When being used in {@link #OnMeasure()}, the caller should still
243 * ensure the returned height is within the requirements of the parent.
245 * @return The suggested minimum height of the layout.
247 LayoutLength GetSuggestedMinimumHeight() const;
250 * @brief Sets the minimum width of the layout.
252 * It is not guaranteed the layout will be able to achieve this minimum width (for example, if its parent
253 * layout constrains it with less available width).
255 * @param[in] minWidth The minimum width the layout will try to be, in pixels
257 * @see #GetMinimumWidth()
259 void SetMinimumWidth( LayoutLength minWidth );
262 * @brief Sets the minimum height of the layout.
264 * It is not guaranteed the layout will be able to achieve this minimum height (for example, if its parent
265 * layout constrains it with less available height).
267 * @param[in] minHeight The minimum height the layout will try to be, in pixels
269 * @see #GetMinimumHeight()
271 void SetMinimumHeight( LayoutLength minHeight );
274 * @brief Returns the minimum width of the layout.
276 * @return the minimum width the layout will try to be, in pixels
278 * @see #SetMinimumWidth(LayoutLength)
280 LayoutLength GetMinimumWidth() const;
283 * @brief Returns the minimum height of the layout.
285 * @return the minimum height the layout will try to be, in pixels
287 * @see #SetMinimumHeight(LayoutLength)
289 LayoutLength GetMinimumHeight() const;
292 * Get the padding information
293 * @return The padding information
295 Extents GetPadding() const;
299 * @brief Allow directly deriving classes to remove layout children when unparented
301 virtual void OnUnparent(){};
304 * @brief Ensure direct derived types register their child properties with the owner
306 * @param[in] containerType The type name of the owner container
308 virtual void OnRegisterChildProperties( const std::string& containerType );
312 * @brief Measure the layout and its content to determine the measured width and the
315 * This method is invoked by {@link #Measure(MeasureSpec, MeasureSpec)} and
316 * should be overridden by subclasses to provide accurate and efficient
317 * measurement of their contents.
319 * <strong>CONTRACT:</strong> When overriding this method, you
320 * <em>must</em> call {@link #SetMeasuredDimensions(MeasuredSize,MeasuredSize)} to store the
321 * measured width and height of this layout. Failure to do so will trigger an
322 * <code>IllegalStateException</code>, thrown by
323 * {@link #Measure(MeasureSpec,MeasureSpec)}. Calling the superclass'
324 * {@link #OnMeasure(MeasureSpec,MeasureSpec)} is a valid use.
326 * The base class implementation of measure defaults to the background size,
327 * unless a larger size is allowed by the MeasureSpec. Subclasses should
328 * override {@link #OnMeasure(MeasureSpec,MeasureSpec)} to provide better measurements of
331 * If this method is overridden, it is the subclass's responsibility to make
332 * sure the measured height and width are at least the layout's minimum height
333 * and width ({@link #GetSuggestedMinimumHeight()} and
334 * {@link #GetSuggestedMinimumWidth()}).
336 * @param[in] widthMeasureSpec horizontal space requirements as imposed by the parent.
337 * The requirements are encoded with
338 * {@link MeasureSpec}.
339 * @param[in] heightMeasureSpec vertical space requirements as imposed by the parent.
340 * The requirements are encoded with
341 * {@link MeasureSpec}.
343 * @see #GetMeasuredWidth()
344 * @see #GetMeasuredHeight()
345 * @see #GetSuggestedMinimumHeight()
346 * @see #GetSuggestedMinimumWidth()
347 * @see MeasureSpec#GetMode(int)
348 * @see MeasureSpec#GetSize(int)
350 virtual void OnMeasure( MeasureSpec widthMeasureSpec, MeasureSpec heightMeasureSpec );
353 * @brief Called from Layout() when this layout should assign a size and position to each of its children.
355 * Derived classes with children should override this method and call Layout() on each of their children.
357 * @param[in] changed This is a new size or position for this layout
358 * @param[in] left Left position, relative to parent
359 * @param[in] top Top position, relative to parent
360 * @param[in] right Right position, relative to parent
361 * @param[in] bottom Bottom position, relative to parent
363 virtual void OnLayout( bool changed, LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom );
367 * @brief This method must be called by {@link #OnMeasure(MeasureSpec,MeasureSpec)} to store the
368 * measured width and measured height.
370 * Failing to do so will trigger an exception at measurement time.
372 * @param[in] measuredWidth The measured width of this layout. This may have a state of
373 * {@link MeasuredSize::MEASURED_SIZE_TOO_SMALL}
375 * @param[in] measuredHeight The measured height of this layout. This may have a state of
376 * {@link MeasuredSize::MEASURED_SIZE_TOO_SMALL}
378 void SetMeasuredDimensions( MeasuredSize measuredWidth, MeasuredSize measuredHeight );
381 * @brief Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec.
383 * @param[in] size How big the layout wants to be.
384 * @param[in] measureSpec Constraints imposed by the parent.
385 * @param[in] childMeasuredState Size information bit mask for the layout's children.
387 * @return A measured size, which may indicate that it is too small.
389 static MeasuredSize ResolveSizeAndState( LayoutLength size, MeasureSpec measureSpec,
390 MeasuredSize::State childMeasuredState );
393 * @brief Sets the frame (the size and position) of the layout onto it's owner
395 * @todo Consider instead, collating properties into LayoutCollector in order to set/animate them all
397 * @param[in] left The horizontal position of the left edge of this frame within the parent layout
398 * @param[in] top The vertical position of the top edge of this frame within the parent layout
399 * @param[in] right The horizontal position of the right edge of this frame within the parent layout
400 * @param[in] bottom The vertical position of the bottom edge of this frame within the parent layout
402 bool SetFrame( LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom );
405 * Virtual method to inform derived classes when the layout size changed
406 * @param[in] newSize The new size of the layout
407 * @param[in] oldSize The old size of the layout
409 virtual void OnSizeChanged( LayoutSize newSize, LayoutSize oldSize );
413 * @brief Initialization method for LayoutGroup to override
415 virtual void OnInitialize();
419 * @brief Called to change the size of the layout.
421 * @param[in] newSize The new size of the layout
422 * @param[in] oldSize The old size of the layout
424 void SizeChange( LayoutSize newSize, LayoutSize oldSize );
427 * @brief Triggered when a layout animation finished.
429 * @param[in] animation A handle to the layout animation
431 void OnLayoutAnimationFinished( Animation& animation );
434 class Impl; // Class declaration is public so we can add devel API's in the future
438 std::unique_ptr<Impl> mImpl; ///< Implementation class holds all the data
439 SlotDelegate<LayoutBase> mSlotDelegate;
442 } //namespace Internal
444 inline Internal::LayoutBase& GetImplementation( Dali::Toolkit::LayoutBase& handle )
446 DALI_ASSERT_ALWAYS( handle && "LayoutBase handle is empty" );
447 BaseObject& object = handle.GetBaseObject();
448 return static_cast< Internal::LayoutBase& >( object );
451 inline const Internal::LayoutBase& GetImplementation( const Dali::Toolkit::LayoutBase& handle )
453 DALI_ASSERT_ALWAYS( handle && "LayoutBase handle is empty" );
454 const BaseObject& object = handle.GetBaseObject();
455 return static_cast< const Internal::LayoutBase& >( object );
458 } //namespace Toolkit
461 #endif // DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_BASE_H