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

   1 #ifndef DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_PARENT_H
   2 #define DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_PARENT_H
   3
   4 /*
   5  * Copyright (c) 2018 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 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  21
  22 namespace Dali
  23 {
  24 namespace Toolkit
  25 {
  26 namespace Internal
  27 {
  28 class LayoutItem;
  29
  30 /**
  31  * Interface that defines a layout Parent. Enables a layout child to access
  32  * methods on its parent, e.g. Remove (during unparenting)
  33  */
  34 class DALI_TOOLKIT_API LayoutParent
  35 {
  36 public:
  37   /**
  38    * @brief Add a child to the parent
  39    * @param[in] item The item to add to this layout parent
  40    */
  41   virtual Toolkit::LayoutGroup::LayoutId Add( LayoutItem& item ) = 0;
  42
  43   /**
  44    * @brief Remove a layout child from this group.
  45    * @param[in] childId The layout child id
  46    */
  47   virtual void Remove( Toolkit::LayoutGroup::LayoutId childId ) = 0;
  48
  49   /**
  50    * @brief Remove a child from this parent
  51    * @param[in] item The item to remove from this layout parent
  52    */
  53   virtual void Remove( LayoutItem& item ) = 0;
  54
  55   /**
  56    * @brief Insert a child to the parent
  57    * @param[in] target The target item
  58    * @param[in] item The item to insert to this layout parent
  59    */
  60   virtual Toolkit::LayoutGroup::LayoutId Insert( LayoutItem& target, LayoutItem& item ) = 0;
  61
  62   /**
  63    * @brief Move a child to another position
  64    * @param[in] target The target item
  65    * @param[in] item The item to move
  66    */
  67   virtual Toolkit::LayoutGroup::LayoutId Move( LayoutItem& target, LayoutItem& item ) = 0;
  68
  69   /**
  70    * @brief Move a child to back
  71    * @param[in] item The item to move
  72    */
  73   virtual Toolkit::LayoutGroup::LayoutId MoveBack( LayoutItem& item ) = 0;
  74
  75 protected:
  76   virtual ~LayoutParent()
  77   {
  78   }
  79 };
  80
  81
  82
  83 } // namespace Internal
  84 } // namespace Toolkit
  85 } // namespace Dali
  86
  87 #endif //DALI_TOOLKIT_INTERNAL_LAYOUTING_LAYOUT_PARENT_H