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) 2019 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   /**
  44    * @brief Default constructor.
  45    *
  46    * @SINCE_1_0.0
  47    */
  48   RelayoutContainer() {}
  49
  50   /**
  51    * @brief Virtual destructor.
  52    * @SINCE_1_0.0
  53    */
  54   virtual ~RelayoutContainer() {}
  55
  56   /**
  57    * @brief Adds relayout information to the container if it doesn't already exist.
  58    *
  59    * @SINCE_1_0.0
  60    * @param actor The actor to relayout
  61    * @param size The size to relayout
  62    */
  63   virtual void Add( const Actor& actor, const Vector2& size ) = 0;
  64
  65 };
  66
  67 /**
  68  * @}
  69  */
  70 } // namespace Dali
  71
  72 #endif // DALI_RELAYOUT_CONTAINER_H