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