dali-toolkit/public-api/controls/scrollable/item-view/default-item-layout.h

   1 #ifndef DALI_TOOLKIT_DEFAULT_ITEM_LAYOUT_H
   2 #define DALI_TOOLKIT_DEFAULT_ITEM_LAYOUT_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-toolkit/public-api/controls/scrollable/item-view/item-layout.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 /**
  29  * @addtogroup dali_toolkit_controls_item_view
  30  * @{
  31  */
  32
  33 /**
  34  * @brief Enumeration for default item layout mode.
  35  * @SINCE_1_0.0
  36  */
  37 namespace DefaultItemLayout
  38 {
  39 /**
  40  * @brief Enumeration for the type of DefaultItemLayout
  41  * @SINCE_1_0.0
  42  */
  43 enum Type
  44 {
  45   DEPTH, ///< Items arranged in a grid, scrolling along the Z-Axis. @SINCE_1_0.0
  46   GRID,  ///< Items arranged in a grid, scrolling along the Y-Axis. @SINCE_1_0.0
  47   LIST,  ///< One item per line, scrolling along the Y-Axis. @SINCE_1_0.0
  48   SPIRAL ///< Items arranged in a spiral, centered around the Y-Axis. @SINCE_1_0.0
  49 };
  50
  51 /**
  52  * @brief Creates a built-in default item-layout.
  53  *
  54  * @SINCE_1_0.0
  55  * @param[in] type The type of layout required
  56  * @return An ItemLayoutPtr to the newly created layout
  57  */
  58 DALI_TOOLKIT_API ItemLayoutPtr New(Type type);
  59
  60 } // namespace DefaultItemLayout
  61
  62 /**
  63  * @}
  64  */
  65 } // namespace Toolkit
  66
  67 } // namespace Dali
  68
  69 #endif // DALI_TOOLKIT_DEFAULT_ITEM_LAYOUT_H