Merge "Add ALIASES for new DALi doxygen tagging rule to dali.doxy.in" into devel...
[platform/core/uifw/dali-toolkit.git] / 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 namespace DefaultItemLayout
35 {
36
37 enum Type
38 {
39   DEPTH,     ///< Items arranged in a grid, scrolling along the Z-Axis.
40   GRID,      ///< Items arranged in a grid, scrolling along the Y-Axis.
41   LIST,      ///< One item per line, scrolling along the Y-Axis.
42   SPIRAL     ///< Items arranged in a spiral, centered around the Y-Axis.
43 };
44
45 /**
46  * @brief Creates a built-in default item-layout
47  *
48  * @param[in]  type  The type of layout required.
49  *
50  * @return An ItemLayoutPtr to the newly created layout.
51  */
52 DALI_IMPORT_API ItemLayoutPtr New( Type type );
53
54 } // namespace DefaultItemLayout
55
56 /**
57  * @}
58  */
59 } // namespace Toolkit
60
61 } // namespace Dali
62
63 #endif // __DALI_TOOLKIT_DEFAULT_ITEM_LAYOUT_H__