Tizen 2.1 base
[framework/osp/uifw.git] / inc / FUiCtrlListViewTypes.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Flora License, Version 1.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://floralicense.org/license/
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an AS IS BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17
18 /**
19  * @file        FUiCtrlListViewTypes.h
20  * @brief       This is the header file for the List enumerations.
21  *
22  * This header file contains the declarations of the List enumerations.
23  */
24 #ifndef _FUI_CTRL_LIST_VIEW_TYPES_H_
25 #define _FUI_CTRL_LIST_VIEW_TYPES_H_
26
27 namespace Tizen { namespace Ui { namespace Controls
28 {
29
30 /**
31  * @enum  ListAnnexStyle
32  *
33  * Defines the style of annex in the items.
34  *
35  * @since 2.0
36  */
37 enum ListAnnexStyle
38 {
39         LIST_ANNEX_STYLE_NORMAL = 0,                /**< The no style annex */
40         LIST_ANNEX_STYLE_MARK,                      /**< The mark style annex for multiple selection */
41         LIST_ANNEX_STYLE_ONOFF_SLIDING,             /**< The slider style On/Off */
42         LIST_ANNEX_STYLE_DETAILED,                  /**< Detailed style for further interaction */
43         LIST_ANNEX_STYLE_RADIO                      /**< The radio style for simple look */
44 };
45
46 /**
47  * @enum  ListItemDrawingStatus
48  *
49  * Defines the drawing state of the items.
50  *
51  * @since 2.0
52  */
53 enum ListItemDrawingStatus
54 {
55         LIST_ITEM_DRAWING_STATUS_NORMAL = 0,        /**< The normal drawing state */
56         LIST_ITEM_DRAWING_STATUS_PRESSED,           /**< The pressed drawing state */
57         LIST_ITEM_DRAWING_STATUS_HIGHLIGHTED        /**< The highlighted drawing state */
58 };
59
60 /**
61  * @enum  ListRefreshType
62  *
63  * Defines the update type of the list.
64  *
65  * @since 2.0
66  */
67 enum ListRefreshType
68 {
69         LIST_REFRESH_TYPE_ITEM_ADD = 0,             /**< The add type */
70         LIST_REFRESH_TYPE_ITEM_REMOVE,              /**< The remove type */
71         LIST_REFRESH_TYPE_ITEM_MODIFY                           /**< The modify type */
72 };
73
74 /**
75  * @enum  ListItemStatus
76  *
77  * Defines the item state of the list.
78  *
79  * @since 2.0
80  */
81 enum ListItemStatus
82 {
83         LIST_ITEM_STATUS_SELECTED = 0,              /**< The selected item state */
84         LIST_ITEM_STATUS_HIGHLIGHTED,               /**< The highlighted item state */
85         LIST_ITEM_STATUS_CHECKED,                   /**< The check item state */
86         LIST_ITEM_STATUS_UNCHECKED,                 /**< The uncheck item state */
87         LIST_ITEM_STATUS_MORE                       /**< The more item state */
88 };
89
90 /**
91  * @enum  ListContextItemStatus
92  *
93  * Defines the state of the context items.
94  *
95  * @since 2.0
96  */
97 enum ListContextItemStatus
98 {
99         LIST_CONTEXT_ITEM_STATUS_SELECTED = 0,      /**< The selected context item state */
100         LIST_CONTEXT_ITEM_STATUS_HIGHLIGHTED        /**< The highlighted context item state */
101 };
102
103 /**
104  * @enum  SweepDirection
105  *
106  * Defines the direction of the sweep interaction.
107  *
108  * @since 2.0
109  */
110 enum SweepDirection
111 {
112         SWEEP_DIRECTION_LEFT = 0,                   /**< The left direction */
113         SWEEP_DIRECTION_RIGHT                       /**< The right direction */
114 };
115
116 /**
117  * @enum ListScrollItemAlignment
118  *
119  * Defines the alignment information for item scroll.
120  *
121  * @since 2.0
122  */
123 enum ListScrollItemAlignment
124 {
125         LIST_SCROLL_ITEM_ALIGNMENT_TOP = 0,         /**< The item is aligned at the top of the ListView at item scroll*/
126         LIST_SCROLL_ITEM_ALIGNMENT_BOTTOM           /**< The item is aligned at the bottom of the ListView at item scroll */
127 };
128
129 /**
130  * @enum ListScrollStyle
131  *
132  * Defines the scroll style of the list.
133  *
134  * @since 2.0
135  */
136 enum ListScrollStyle
137 {
138         SCROLL_STYLE_FADE_OUT = 0,      /**< The fade-out scroll style */
139         SCROLL_STYLE_FIXED,                     /**< The fixed scroll style */
140         SCROLL_STYLE_FAST_SCROLL,       /**< The fast scroll style */
141         SCROLL_STYLE_JUMP_TO_TOP,   /**< The jump to top scroll style */
142         SCROLL_STYLE_THUMB                      /**< The thumb scroll style */
143 };
144
145 }}} // Tizen::Ui::Controls
146
147 #endif // _FUI_CTRL_LIST_VIEW_TYPES_H_