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