Tizen 2.1 base
[framework/osp/uifw.git] / inc / FUiCtrlTableViewTypes.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 FUiCtrlTableViewTypes.h
20  * @brief This is the header file for the TableView enumerations.
21  *
22  * This header file contains the declarations of the TableView enumerations.
23  */
24 #ifndef _FUI_CTRL_TABLE_VIEW_TYPES_H_
25 #define _FUI_CTRL_TABLE_VIEW_TYPES_H_
26
27 namespace Tizen { namespace Ui { namespace Controls
28 {
29
30 /**
31  * @enum  TableViewAnnexStyle
32  *
33  * Defines the style of annex in the items.
34  *
35  * @since 2.0
36  */
37 enum TableViewAnnexStyle
38 {
39         TABLE_VIEW_ANNEX_STYLE_NORMAL = 0,                      /**< No annex */
40         TABLE_VIEW_ANNEX_STYLE_MARK,                            /**< Mark style check for multiple selection */
41         TABLE_VIEW_ANNEX_STYLE_ONOFF_SLIDING,           /**< On/Off slider style  */
42         TABLE_VIEW_ANNEX_STYLE_DETAILED,                        /**< Detailed style for further interaction */
43         TABLE_VIEW_ANNEX_STYLE_RADIO                            /**< Radio style check for simple look */
44 };
45
46 /**
47  * @enum  TableViewItemDrawingStatus
48  *
49  * Defines the drawing state of the items.
50  *
51  * @since 2.0
52  */
53 enum TableViewItemDrawingStatus
54 {
55         TABLE_VIEW_ITEM_DRAWING_STATUS_NORMAL = 0,              /**< The normal drawing state */
56         TABLE_VIEW_ITEM_DRAWING_STATUS_PRESSED,                 /**< The pressed drawing state */
57         TABLE_VIEW_ITEM_DRAWING_STATUS_HIGHLIGHTED              /**< The highlighted drawing state */
58 };
59
60 /**
61  * @enum  TableViewRefreshType
62  *
63  * Defines the update type of the TableView item.
64  *
65  * @since 2.0
66  */
67 enum TableViewRefreshType
68 {
69         TABLE_VIEW_REFRESH_TYPE_ITEM_ADD = 0,                   /**< Refresh request of adding an item */
70         TABLE_VIEW_REFRESH_TYPE_ITEM_REMOVE,                    /**< Refresh request of removing an item */
71         TABLE_VIEW_REFRESH_TYPE_ITEM_MODIFY                             /**< Refresh request of modifying an item */
72 };
73
74 /**
75  * @enum  TableViewItemStatus
76  *
77  * Defines the item state of the TableView.
78  *
79  * @since 2.0
80  */
81 enum TableViewItemStatus
82 {
83         TABLE_VIEW_ITEM_STATUS_SELECTED = 0,                    /**< The selected item state */
84         TABLE_VIEW_ITEM_STATUS_HIGHLIGHTED,                             /**< The highlighted item state */
85         TABLE_VIEW_ITEM_STATUS_CHECKED,                                 /**< The checked item state */
86         TABLE_VIEW_ITEM_STATUS_UNCHECKED,                               /**< The unchecked item state */
87         TABLE_VIEW_ITEM_STATUS_MORE                                             /**< The more item state */
88 };
89
90 /**
91  * @enum  TableViewSweepDirection
92  *
93  * Defines the direction of the sweep interaction.
94  *
95  * @since 2.0
96  */
97 enum TableViewSweepDirection
98 {
99         TABLE_VIEW_SWEEP_DIRECTION_LEFT = 0,                    /**< The left direction */
100         TABLE_VIEW_SWEEP_DIRECTION_RIGHT                                /**< The right direction */
101 };
102
103 /**
104  * @enum TableViewScrollItemAlignment
105  *
106  * Defines the alignment information for item scroll.
107  *
108  * @since 2.0
109  */
110 enum  TableViewScrollItemAlignment
111 {
112         TABLE_VIEW_SCROLL_ITEM_ALIGNMENT_TOP = 0,               /**< The item is aligned at the top of the TableView at item scroll*/
113         TABLE_VIEW_SCROLL_ITEM_ALIGNMENT_BOTTOM                 /**< The item is aligned at the bottom of the TableView at item scroll */
114 };
115
116 /**
117  * @enum TableViewScrollBarStyle
118  *
119  * Defines the scroll bar style of the list.
120  *
121  * @since 2.0
122  */
123 enum TableViewScrollBarStyle
124 {
125         TABLE_VIEW_SCROLL_BAR_STYLE_NONE = 0,                                                   /**< No scroll bar */
126         TABLE_VIEW_SCROLL_BAR_STYLE_FADE_OUT,                                            /**< The fade-out scroll bar style */
127         TABLE_VIEW_SCROLL_BAR_STYLE_FIXED,                                                                       /**< The fixed scroll bar style */
128         TABLE_VIEW_SCROLL_BAR_STYLE_JUMP_TO_TOP,                                                 /**< The jump to top scroll bar style */
129         TABLE_VIEW_SCROLL_BAR_STYLE_THUMB,                                                                 /**< The thumb scroll bar style */
130         TABLE_VIEW_SCROLL_BAR_STYLE_FAST_SCROLL                                                  /**< The fast scroll bar style */
131
132 };
133
134 /**
135  * @enum ScrollInputMode
136  *
137  * Defines the scroll interaction mode
138  *
139  * @since 2.0
140  */
141 enum ScrollInputMode
142 {
143         SCROLL_INPUT_MODE_ALLOW_ANY_DIRECTION = 0,                               /** < Scroll interaction is available to any direction. */
144         SCROLL_INPUT_MODE_RESTRICT_TO_INITIAL_DIRECTION                          /** < Scroll interaction is restricted to first direction. */
145 };
146
147
148 }}} // Tizen::Ui::Controls
149
150 #endif // _FUI_CTRL_TABLE_VIEW_TYPES_H_