dali-toolkit/devel-api/layouting/linear-layout.h

   1 #ifndef DALI_TOOLKIT_LAYOUTING_LINEAR_LAYOUT_H
   2 #define DALI_TOOLKIT_LAYOUTING_LINEAR_LAYOUT_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/public-api/common/dali-common.h>
  21 #include <dali/public-api/object/base-handle.h>
  22 #include <dali-toolkit/devel-api/layouting/layout-group.h>
  23 #include <dali-toolkit/devel-api/layouting/layout-size.h>
  24 #include <dali-toolkit/public-api/toolkit-property-index-ranges.h>
  25
  26 namespace Dali
  27 {
  28 namespace Toolkit
  29 {
  30
  31 namespace Internal DALI_INTERNAL
  32 {
  33 class LinearLayout;
  34 }
  35
  36 /**
  37  * This class implements a linear box layout, automatically handling
  38  * right to left or left to right direction change.
  39  */
  40 class DALI_TOOLKIT_API LinearLayout : public LayoutGroup
  41 {
  42 public:
  43
  44   enum PropertyRange
  45   {
  46     CHILD_PROPERTY_START_INDEX = LINEAR_LAYOUT_CHILD_PROPERTY_START_INDEX,
  47     CHILD_PROPERTY_END_INDEX   = LINEAR_LAYOUT_CHILD_PROPERTY_END_INDEX
  48   };
  49
  50   /**
  51    * @brief Enumeration for the direction in which the content is laid out
  52    */
  53   enum class Orientation
  54   {
  55     HORIZONTAL,                 ///< Horizontal (row)
  56     VERTICAL                    ///< Vertical (column)
  57   };
  58
  59   /**
  60    * @brief Enumeration for the alignment of the linear layout items.
  61    */
  62   struct Alignment
  63   {
  64     enum Type
  65     {
  66       BEGIN                     = 0x1,  ///< At the left/right edge of the container (maps to LTR/RTL direction for horizontal orientation)
  67       END                       = 0x2,  ///< At the right/left edge of the container (maps to LTR/RTL direction for horizontal orientation)
  68       CENTER_HORIZONTAL         = 0x4,  ///< At the horizontal center of the container
  69       TOP                       = 0x8,  ///< At the top edge of the container
  70       BOTTOM                    = 0x10, ///< At the bottom edge of the container
  71       CENTER_VERTICAL           = 0x20  ///< At the vertical center of the container
  72     };
  73   };
  74
  75   /**
  76    * @brief Creates an uninitialized LinearLayout handle.
  77    *
  78    * Initialize it using LinearLayout::New().
  79    * Calling member functions with an uninitialized handle is not allowed.
  80    */
  81   LinearLayout();
  82
  83   /**
  84    * @brief Creates a LinearLayout object.
  85    */
  86   static LinearLayout New();
  87
  88   /**
  89    * @brief Downcasts a handle to a LinearLayout handle.
  90    *
  91    * If handle points to a LinearLayout, the downcast produces a valid handle.
  92    * If not, the returned handle is left uninitialized.
  93
  94    * @param[in] handle to an object
  95    * @return Handle to a LinearLayout or an uninitialized handle
  96    */
  97   static LinearLayout DownCast( BaseHandle handle );
  98
  99   /**
 100    * @brief Copy constructor
 101    */
 102   LinearLayout( const LinearLayout& other );
 103
 104   /**
 105    * @brief Assigment operator
 106    */
 107   LinearLayout& operator=( const LinearLayout& other );
 108
 109   /**
 110    * @brief Default destructor.
 111    *
 112    * This is non-virtual, since derived Handle types must not contain data or virtual methods
 113    */
 114   ~LinearLayout()=default;
 115
 116   /**
 117    * @brief Set the padding between cells in the layout
 118    *
 119    * @param[in] size The padding between cells.
 120    */
 121   void SetCellPadding( LayoutSize size );
 122
 123   /**
 124    * @brief Get the padding between cells in the layout
 125    *
 126    * @return The padding between cells.
 127    */
 128   LayoutSize GetCellPadding() const;
 129
 130   /**
 131    * @brief Set the orientation in the layout
 132    *
 133    * @param[in] orientation The orientation.
 134    */
 135   void SetOrientation( Orientation orientation );
 136
 137   /**
 138    * @brief Get the orientation in the layout
 139    *
 140    * @return The orientation.
 141    */
 142   Orientation GetOrientation() const;
 143
 144   /**
 145    * @brief Set the alignment in the layout
 146    *
 147    * @param[in] alignment The alignment.
 148    */
 149   void SetAlignment( unsigned int alignment );
 150
 151   /**
 152    * @brief Get the alignment in the layout
 153    *
 154    * @return The alignment.
 155    */
 156   unsigned int GetAlignment() const;
 157
 158 public: // Not intended for application developers
 159
 160   /// @cond internal
 161   /**
 162    * @brief This constructor is used by LinearLayout::New() methods.
 163    *
 164    * @param[in] actor A pointer to a newly allocated Dali resource
 165    */
 166   explicit DALI_INTERNAL LinearLayout( Internal::LinearLayout* body );
 167   /// @endcond
 168 };
 169
 170 } // namespace Toolkit
 171 } // namespace Dali
 172
 173 #endif // DALI_TOOLKIT_LAYOUTING_LINEAR_LAYOUT_H