dali/public-api/size-negotiation/relayout-container.h

   1 #ifndef DALI_RELAYOUT_CONTAINER_H
   2 #define DALI_RELAYOUT_CONTAINER_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/actors/actor.h>
  23 #include <dali/public-api/math/vector2.h>
  24
  25 namespace Dali
  26 {
  27 /**
  28  * @addtogroup dali_core_size_negotiation
  29  * @{
  30  */
  31
  32 class RelayoutContainer;
  33 using RelayoutContainerPtr = RelayoutContainer*;
  34
  35 /**
  36  * @brief Interface to encapsulate information required for relayout.
  37  * @SINCE_1_0.0
  38  */
  39 class RelayoutContainer
  40 {
  41 public:
  42   /**
  43    * @brief Default constructor.
  44    *
  45    * @SINCE_1_0.0
  46    */
  47   RelayoutContainer() = default;
  48
  49   /**
  50    * @brief Virtual destructor.
  51    * @SINCE_1_0.0
  52    */
  53   virtual ~RelayoutContainer() = default;
  54
  55   /**
  56    * @brief Adds relayout information to the container if it doesn't already exist.
  57    *
  58    * @SINCE_1_0.0
  59    * @param actor The actor to relayout
  60    * @param size The size to relayout
  61    */
  62   virtual void Add(const Actor& actor, const Vector2& size) = 0;
  63 };
  64
  65 /**
  66  * @}
  67  */
  68 } // namespace Dali
  69
  70 #endif // DALI_RELAYOUT_CONTAINER_H