dali-toolkit/devel-api/layouting/layout-item-impl.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_ITEM_H
   2 #define DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_ITEM_H
   3 /*
   4  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   5  *
   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
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  */
  18
  19 #include <memory>
  20
  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-item.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>
  32
  33 namespace Dali
  34 {
  35 namespace Toolkit
  36 {
  37 namespace Internal
  38 {
  39
  40 class LayoutItem;
  41 using LayoutItemPtr = IntrusivePtr<LayoutItem>;
  42
  43
  44 /**
  45  * Base class for layouts.
  46  */
  47 class DALI_IMPORT_API LayoutItem : public BaseObject,
  48                                    public LayoutParent
  49 {
  50 public:
  51   /**
  52    * Constructor.
  53    */
  54   LayoutItem();
  55
  56 protected:
  57   /**
  58    * A reference counted object may only be deleted by calling Unreference()
  59    */
  60   virtual ~LayoutItem();
  61
  62 public:
  63
  64 /**
  65    * @brief Construct
  66    *
  67    * @param[in] owner The owner (container view / child view / visual ) of this layout
  68    * @return a new LayoutItem object
  69    */
  70   static LayoutItemPtr New( Handle& owner );
  71
  72   /**
  73    * @brief Remove the default copy constructor
  74    */
  75   LayoutItem(const LayoutItem& copy)=delete;
  76
  77   /**
  78    * @brief Remove the default assignment operator
  79    */
  80   LayoutItem& operator=(const LayoutItem& rhs)=delete;
  81
  82   /**
  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
  86    */
  87   void Initialize( Handle& owner, const std::string& containerType );
  88
  89   /**
  90    * @brief Get a handle to the owner of this layout
  91    *
  92    * @return a handle to the owner of this layout
  93    */
  94   Handle GetOwner() const;
  95
  96   /**
  97    * @brief Unparent this layout from it's owner, and remove any layout children in derived types
  98    */
  99   void Unparent();
 100
 101   /**
 102    * @brief Set whether this layout should be animated or not
 103    *
 104    * @param[in] animateLayout True if the layout should be animated when applied
 105    */
 106   void SetAnimateLayout( bool animateLayout );
 107
 108   /**
 109    * @brief Get whether this layout should be animated or not
 110    *
 111    * @return True if the layout should be animated when applied
 112    */
 113   bool IsLayoutAnimated() const;
 114
 115   /**
 116    * @brief Register child properties of layout with owner type.
 117    *
 118    * The Actor hierarchy uses these registered properties in the type
 119    * system to ensure child custom properties are properly initialized.
 120    *
 121    * @param[in] containerType The type of the containing view (owner)
 122    */
 123   void RegisterChildProperties( const std::string& containerType );
 124
 125   /**
 126    * @brief  This is called to find out how big a layout should be.
 127    *
 128    * The parent supplies constraint information in the width and height parameters.
 129    *
 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.
 133    *
 134    * @param[in] widthMeasureSpec Horizontal space requirements as imposed by the parent
 135    * @param[in] heightMeasureSpec Vertical space requirements as imposed by the parent
 136    *
 137    * @see #OnMeasure(MeasureSpec, MeasureSpec)
 138    */
 139   void Measure( MeasureSpec widthMeasureSpec, MeasureSpec heightMeasureSpec );
 140
 141   /**
 142    * @brief Assign a size and position to a layout and all of its descendants.
 143    *
 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.
 147    *
 148    * Derived classes with children should override OnLayout. In that method, they should call Layout on each
 149    * of their children.
 150    *
 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
 155    */
 156   void Layout( LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom );
 157
 158   /**
 159    * @brief Utility to return a default size.
 160    *
 161    * Uses the supplied size if the MeasureSpec imposed no constraints. Will get larger if allowed by the
 162    * MeasureSpec.
 163    *
 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.
 167    */
 168   static LayoutLength GetDefaultSize( LayoutLength size, MeasureSpec measureSpec );
 169
 170   /**
 171    * @copydoc LayoutParent::GetParent
 172    */
 173   virtual LayoutParent* GetParent() override;
 174
 175   /**
 176    * @brief Request that this layout is re-laid out.
 177    *
 178    * This will make this layout and all it's parent layouts dirty.
 179    */
 180   void RequestLayout();
 181
 182   /**
 183    * @brief Predicate to determine if this layout has been requested to re-layout
 184    *
 185    * @return True if a layout request has occured on this layout
 186    */
 187   bool IsLayoutRequested() const;
 188
 189   /**
 190    * @brief Get the measured width (without any measurement flags).
 191    *
 192    * This method should be used only during measurement and layout calculations.
 193    *
 194    * Use {@link Dali::Actor::GetTargetSize()} to see how wide a control is after layout
 195    */
 196   LayoutLength GetMeasuredWidth() const;
 197
 198   /**
 199    * @brief Get the measured height (without any measurement flags).
 200    *
 201    * This method should be used only during measurement and layout calculations.
 202    *
 203    * Use {@link Dali::Actor::GetTargetSize()} to see how high a control is after layout
 204    */
 205   LayoutLength GetMeasuredHeight() const;
 206
 207   /**
 208    * @brief Get the measured width and state.
 209    *
 210    * This method should be used only during measurement and layout calculations.
 211    *
 212    * Use {@link Dali::Actor::GetTargetSize()} to see how wide a view is after layout
 213    */
 214   MeasuredSize GetMeasuredWidthAndState() const;
 215
 216   /**
 217    * @brief Get the measured height and state.
 218    *
 219    * This method should be used only during measurement and layout calculations.
 220    *
 221    * Use {@link Dali::Actor::GetTargetSize()} to see how high a view is after layout
 222    */
 223   MeasuredSize GetMeasuredHeightAndState() const;
 224
 225   /**
 226    * @brief Returns the suggested minimum width that the layout should use.
 227    *
 228    * This returns the maximum of the layout's minimum width and the background's minimum width
 229    *
 230    * When being used in {@link #OnMeasure()}, the caller should still
 231    * ensure the returned width is within the requirements of the parent.
 232    *
 233    * @return The suggested minimum width of the layout.
 234    */
 235   LayoutLength GetSuggestedMinimumWidth() const;
 236
 237   /**
 238    * @brief Returns the suggested minimum height that the layout should use.
 239    *
 240    * This returns the maximum of the layout's minimum height and the background's minimum height
 241    *
 242    * When being used in {@link #OnMeasure()}, the caller should still
 243    * ensure the returned height is within the requirements of the parent.
 244    *
 245    * @return The suggested minimum height of the layout.
 246    */
 247   LayoutLength GetSuggestedMinimumHeight() const;
 248
 249   /**
 250    * @brief Sets the minimum width of the layout.
 251    *
 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).
 254    *
 255    * @param[in] minWidth The minimum width the layout will try to be, in pixels
 256    *
 257    * @see #GetMinimumWidth()
 258    */
 259   void SetMinimumWidth( LayoutLength minWidth );
 260
 261   /**
 262    * @brief Sets the minimum height of the layout.
 263    *
 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).
 266    *
 267    * @param[in] minHeight The minimum height the layout will try to be, in pixels
 268    *
 269    * @see #GetMinimumHeight()
 270    */
 271   void SetMinimumHeight( LayoutLength minHeight );
 272
 273   /**
 274    * @brief Returns the minimum width of the layout.
 275    *
 276    * @return the minimum width the layout will try to be, in pixels
 277    *
 278    * @see #SetMinimumWidth(LayoutLength)
 279    */
 280   LayoutLength GetMinimumWidth() const;
 281
 282   /**
 283    * @brief Returns the minimum height of the layout.
 284    *
 285    * @return the minimum height the layout will try to be, in pixels
 286    *
 287    * @see #SetMinimumHeight(LayoutLength)
 288    */
 289   LayoutLength GetMinimumHeight() const;
 290
 291   /**
 292    * Get the padding information.
 293    * @return The padding information
 294    */
 295   Extents GetPadding() const;
 296
 297   /**
 298    * Get the margin information.
 299    * @return The margin information
 300    */
 301   Extents GetMargin() const;
 302
 303 protected:
 304   /**
 305    * @brief Allow directly deriving classes to remove layout children when unparented
 306    */
 307   virtual void OnUnparent(){};
 308
 309   /**
 310    * @brief Ensure direct derived types register their child properties with the owner
 311    *
 312    * @param[in] containerType The type name of the owner container
 313    */
 314   virtual void OnRegisterChildProperties( const std::string& containerType );
 315
 316   /**
 317    * @brief Measure the layout and its content to determine the measured width and the
 318    * measured height.
 319    *
 320    * This method is invoked by {@link #Measure(MeasureSpec, MeasureSpec)} and
 321    * should be overridden by subclasses to provide accurate and efficient
 322    * measurement of their contents.
 323    *
 324    * <strong>CONTRACT:</strong> When overriding this method, you
 325    * <em>must</em> call {@link #SetMeasuredDimensions(MeasuredSize,MeasuredSize)} to store the
 326    * measured width and height of this layout. Failure to do so will trigger an
 327    * <code>IllegalStateException</code>, thrown by
 328    * {@link #Measure(MeasureSpec,MeasureSpec)}. Calling the superclass'
 329    * {@link #OnMeasure(MeasureSpec,MeasureSpec)} is a valid use.
 330    *
 331    * The base class implementation of measure defaults to the background size,
 332    * unless a larger size is allowed by the MeasureSpec. Subclasses should
 333    * override {@link #OnMeasure(MeasureSpec,MeasureSpec)} to provide better measurements of
 334    * their content.
 335    *
 336    * If this method is overridden, it is the subclass's responsibility to make
 337    * sure the measured height and width are at least the layout's minimum height
 338    * and width ({@link #GetSuggestedMinimumHeight()} and
 339    * {@link #GetSuggestedMinimumWidth()}).
 340    *
 341    * @param[in] widthMeasureSpec horizontal space requirements as imposed by the parent.
 342    *                             The requirements are encoded with
 343    *                             {@link MeasureSpec}.
 344    * @param[in] heightMeasureSpec vertical space requirements as imposed by the parent.
 345    *                              The requirements are encoded with
 346    *                              {@link MeasureSpec}.
 347    *
 348    * @see #GetMeasuredWidth()
 349    * @see #GetMeasuredHeight()
 350    * @see #GetSuggestedMinimumHeight()
 351    * @see #GetSuggestedMinimumWidth()
 352    * @see MeasureSpec#GetMode(int)
 353    * @see MeasureSpec#GetSize(int)
 354    */
 355   virtual void OnMeasure( MeasureSpec widthMeasureSpec, MeasureSpec heightMeasureSpec );
 356
 357   /**
 358    * @brief Called from Layout() when this layout should assign a size and position to each of its children.
 359    *
 360    * Derived classes with children should override this method and call Layout() on each of their children.
 361    *
 362    * @param[in] changed This is a new size or position for this layout
 363    * @param[in] left Left position, relative to parent
 364    * @param[in] top Top position, relative to parent
 365    * @param[in] right Right position, relative to parent
 366    * @param[in] bottom Bottom position, relative to parent
 367    */
 368   virtual void OnLayout( bool changed, LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom );
 369
 370
 371   /**
 372    * @brief This method must be called by {@link #OnMeasure(MeasureSpec,MeasureSpec)} to store the
 373    * measured width and measured height.
 374    *
 375    * Failing to do so will trigger an exception at measurement time.
 376    *
 377    * @param[in] measuredWidth The measured width of this layout. This may have a state of
 378    * {@link MeasuredSize::MEASURED_SIZE_TOO_SMALL}
 379    *
 380    * @param[in] measuredHeight The measured height of this layout. This may have a state of
 381    * {@link MeasuredSize::MEASURED_SIZE_TOO_SMALL}
 382    */
 383   void SetMeasuredDimensions( MeasuredSize measuredWidth, MeasuredSize measuredHeight );
 384
 385   /**
 386    * @brief Utility to reconcile a desired size and state, with constraints imposed by a MeasureSpec.
 387    *
 388    * @param[in] size How big the layout wants to be.
 389    * @param[in] measureSpec Constraints imposed by the parent.
 390    * @param[in] childMeasuredState Size information bit mask for the layout's children.
 391    *
 392    * @return A measured size, which may indicate that it is too small.
 393    */
 394   static MeasuredSize ResolveSizeAndState( LayoutLength size, MeasureSpec measureSpec,
 395                                            MeasuredSize::State childMeasuredState );
 396
 397   /**
 398    * @brief Sets the frame (the size and position) of the layout onto it's owner
 399    *
 400    * @todo Consider instead, collating properties into LayoutCollector in order to set/animate them all
 401    * in one block.
 402    * @param[in] left The horizontal position of the left edge of this frame within the parent layout
 403    * @param[in] top The vertical position of the top edge of this frame within the parent layout
 404    * @param[in] right The horizontal position of the right edge of this frame within the parent layout
 405    * @param[in] bottom The vertical position of the bottom edge of this frame within the parent layout
 406    */
 407   bool SetFrame( LayoutLength left, LayoutLength top, LayoutLength right, LayoutLength bottom );
 408
 409   /**
 410    * Virtual method to inform derived classes when the layout size changed
 411    * @param[in] newSize The new size of the layout
 412    * @param[in] oldSize The old size of the layout
 413    */
 414   virtual void OnSizeChanged( LayoutSize newSize, LayoutSize oldSize );
 415
 416
 417   /**
 418    * @brief Initialization method for LayoutGroup to override
 419    */
 420   virtual void OnInitialize();
 421
 422 private:
 423   /**
 424    * @brief Called to change the size of the layout.
 425    *
 426    * @param[in] newSize The new size of the layout
 427    * @param[in] oldSize The old size of the layout
 428    */
 429   void SizeChange( LayoutSize newSize, LayoutSize oldSize );
 430
 431   /**
 432    * @brief Triggered when a layout animation finished.
 433    *
 434    * @param[in] animation  A handle to the layout animation
 435    */
 436   void OnLayoutAnimationFinished( Animation& animation );
 437
 438 public:
 439   class Impl; // Class declaration is public so we can add devel API's in the future
 440
 441
 442 private:
 443   std::unique_ptr<Impl> mImpl; ///< Implementation class holds all the data
 444   SlotDelegate<LayoutItem> mSlotDelegate;
 445 };
 446
 447 } //namespace Internal
 448
 449 inline Internal::LayoutItem& GetImplementation( Dali::Toolkit::LayoutItem& handle )
 450 {
 451   DALI_ASSERT_ALWAYS( handle && "LayoutItem handle is empty" );
 452   BaseObject& object = handle.GetBaseObject();
 453   return static_cast< Internal::LayoutItem& >( object );
 454 }
 455
 456 inline const Internal::LayoutItem& GetImplementation( const Dali::Toolkit::LayoutItem& handle )
 457 {
 458   DALI_ASSERT_ALWAYS( handle && "LayoutItem handle is empty" );
 459   const BaseObject& object = handle.GetBaseObject();
 460   return static_cast< const Internal::LayoutItem& >( object );
 461 }
 462
 463 } //namespace Toolkit
 464 } //namespace Dali
 465
 466 #endif // DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_ITEM_H