show OverlayRegion when FormActivated
[platform/framework/native/uifw.git] / inc / FUiControls.h
1 //
2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
4 //
5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
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                FUiControls.h
20  * @brief               This is the header file for the %Tizen::Ui::Controls namespace.
21  *
22  * This header file contains the declarations and descriptions of the %Tizen::Ui::Controls namespace.
23  */
24
25 #ifndef _FUI_CONTROLS_H_
26 #define _FUI_CONTROLS_H_
27
28 #include <FUiCtrlAnimation.h>
29 #include <FUiCtrlAnimationFrame.h>
30 #include <FUiCtrlButton.h>
31 #include <FUiCtrlButtonItem.h>
32 #include <FUiCtrlCheckButton.h>
33 #include <FUiCtrlColorPicker.h>
34 #include <FUiCtrlContextMenu.h>
35 #include <FUiCtrlControlsTypes.h>
36 #include <FUiCtrlCustomItem.h>
37 #include <FUiCtrlCustomList.h>
38 #include <FUiCtrlCustomListItem.h>
39 #include <FUiCtrlCustomListItemFormat.h>
40 #include <FUiCtrlCustomListTypes.h>
41 #include <FUiCtrlDatePicker.h>
42 #include <FUiCtrlDateTimePicker.h>
43 #include <FUiCtrlEditArea.h>
44 #include <FUiCtrlEditDate.h>
45 #include <FUiCtrlEditField.h>
46 #include <FUiCtrlEditTime.h>
47 #include <FUiCtrlEditTypes.h>
48 #include <FUiCtrlExpandableEditArea.h>
49 #include <FUiCtrlExpandableList.h>
50 #include <FUiCtrlFooter.h>
51 #include <FUiCtrlFooterItem.h>
52 #include <FUiCtrlForm.h>
53 #include <FUiCtrlFrame.h>
54 #include <FUiCtrlFrameTypes.h>
55 #include <FUiCtrlGallery.h>
56 #include <FUiCtrlGalleryItem.h>
57 #include <FUiCtrlGalleryTypes.h>
58 #include <FUiCtrlGroupContainer.h>
59 #include <FUiCtrlGroupedList.h>
60 #include <FUiCtrlGroupedListView.h>
61 #include <FUiCtrlGroupedListViewTypes.h>
62 #include <FUiCtrlGroupedTableView.h>
63 #include <FUiCtrlGroupItem.h>
64 #include <FUiCtrlHeader.h>
65 #include <FUiCtrlHeaderItem.h>
66 #include <FUiCtrlIconList.h>
67 #include <FUiCtrlIconListTypes.h>
68 #include <FUiCtrlIconListView.h>
69 #include <FUiCtrlIconListViewItem.h>
70 #include <FUiCtrlIconListViewTypes.h>
71 #include <FUiCtrlICustomElement.h>
72 #include <FUiCtrlICustomElementF.h>
73 #include <FUiCtrlICustomListElement.h>
74 #include <FUiCtrlIEditTextFilter.h>
75 #include <FUiCtrlIExpandableEditAreaEventListener.h>
76 #include <FUiCtrlIFastScrollListener.h>
77 #include <FUiCtrlIFormBackEventListener.h>
78 #include <FUiCtrlIFormMenuEventListener.h>
79 #include <FUiCtrlIFrameEventListener.h>
80 #include <FUiCtrlIGalleryEventListener.h>
81 #include <FUiCtrlIGalleryItemProvider.h>
82 #include <FUiCtrlIGroupedListViewItemEventListener.h>
83 #include <FUiCtrlIGroupedListViewItemProvider.h>
84 #include <FUiCtrlIGroupedListViewItemProviderF.h>
85 #include <FUiCtrlIGroupedTableViewItemEventListener.h>
86 #include <FUiCtrlIGroupedTableViewItemProvider.h>
87 #include <FUiCtrlIGroupedTableViewItemProviderF.h>
88 #include <FUiCtrlIIconListViewItemEventListener.h>
89 #include <FUiCtrlIIconListViewItemProvider.h>
90 #include <FUiCtrlIListViewItemEventListener.h>
91 #include <FUiCtrlIListViewItemProvider.h>
92 #include <FUiCtrlIListViewItemProviderF.h>
93 #include <FUiCtrlInputTypes.h>
94 #include <FUiCtrlIProgressPopupEventListener.h>
95 #include <FUiCtrlIScrollEventListener.h>
96 #include <FUiCtrlIScrollEventListenerF.h>
97 #include <FUiCtrlISearchBarEventListener.h>
98 #include <FUiCtrlISectionTableViewItemEventListener.h>
99 #include <FUiCtrlISectionTableViewItemProvider.h>
100 #include <FUiCtrlISectionTableViewItemProviderF.h>
101 #include <FUiCtrlISliderEventListener.h>
102 #include <FUiCtrlISplitPanelEventListener.h>
103 #include <FUiCtrlISplitPanelEventListenerF.h>
104 #include <FUiCtrlITableViewItemEventListener.h>
105 #include <FUiCtrlITableViewItemProvider.h>
106 #include <FUiCtrlITableViewItemProviderF.h>
107 #include <FUiCtrlITokenFilter.h>
108 #include <FUiCtrlKeypad.h>
109 #include <FUiCtrlLabel.h>
110 #include <FUiCtrlLabelTypes.h>
111 #include <FUiCtrlList.h>
112 #include <FUiCtrlListContextItem.h>
113 #include <FUiCtrlListItemBase.h>
114 #include <FUiCtrlListTypes.h>
115 #include <FUiCtrlListView.h>
116 #include <FUiCtrlListViewTypes.h>
117 #include <FUiCtrlMessageBox.h>
118 #include <FUiCtrlOptionMenu.h>
119 #include <FUiCtrlOverlayPanel.h>
120 #include <FUiCtrlOverlayRegion.h>
121 #include <FUiCtrlPanel.h>
122 #include <FUiCtrlPopup.h>
123 #include <FUiCtrlProgress.h>
124 #include <FUiCtrlProgressPopup.h>
125 #include <FUiCtrlRadioGroup.h>
126 #include <FUiCtrlScrollEventTypes.h>
127 #include <FUiCtrlScrollPanel.h>
128 #include <FUiCtrlScrollPanelTypes.h>
129 #include <FUiCtrlSearchBar.h>
130 #include <FUiCtrlSectionTableView.h>
131 #include <FUiCtrlSimpleItem.h>
132 #include <FUiCtrlSlidableGroupedList.h>
133 #include <FUiCtrlSlidableList.h>
134 #include <FUiCtrlSlider.h>
135 #include <FUiCtrlSliderTypes.h>
136 #include <FUiCtrlSplitPanel.h>
137 #include <FUiCtrlSplitPanelTypes.h>
138 #include <FUiCtrlTab.h>
139 #include <FUiCtrlTabBar.h>
140 #include <FUiCtrlTabBarItem.h>
141 #include <FUiCtrlTableView.h>
142 #include <FUiCtrlTableViewContextItem.h>
143 #include <FUiCtrlTableViewGroupItem.h>
144 #include <FUiCtrlTableViewItem.h>
145 #include <FUiCtrlTableViewItemBase.h>
146 #include <FUiCtrlTableViewSimpleGroupItem.h>
147 #include <FUiCtrlTableViewSimpleItem.h>
148 #include <FUiCtrlTableViewTypes.h>
149 #include <FUiCtrlTextBox.h>
150 #include <FUiCtrlTimePicker.h>
151
152 namespace Tizen
153 {
154 /**
155  * @namespace   Tizen::Ui::Controls
156  * @brief               This namespace contains the classes and interfaces for creating rich user interface components for the applications.
157  * @since               2.0
158  *
159  * @remarks             @b %Header @b %file: @b \#include @b <FUi.h> @n
160  *                              @b Library : @b osp-uifw
161  *
162  * The %Ui::Controls namespace contains classes that have graphical representations that can be displayed on the screen as UI elements and with
163  * which the user can interact.
164  *
165  * For more information on the %Ui::Controls namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/controls.htm">UI Controls Guide</a>.
166  *
167  */
168
169 namespace Ui
170 {
171
172 namespace Controls
173 {
174
175 /**
176  * @if OSPDEPREC
177  * The system color for the text that appears in the indicator and the command area (for example, Header and Footer).
178  *
179  * @brief <i> [Deprecated]  </i>
180  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
181  * @since        2.0
182  *
183  * @remarks      Different color values can be defined for different device models.
184  * @endif
185  */
186 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_TITLE_TEXT;
187
188 /**
189  * @if OSPDEPREC
190  * The system color for the text that appears in controls, has a different background color than that of its parent (for example, Button).
191  *
192  * @brief <i> [Deprecated]  </i>
193  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
194  * @since        2.0
195  *
196  * @remarks      Different color values can be defined for different device models.
197  * @endif
198  */
199 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_BODY_TEXT;
200
201 /**
202  * @if OSPDEPREC
203  * The system default foreground color (for example, Label and CheckButton).
204  *
205  * @brief <i> [Deprecated]  </i>
206  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
207  * @since        2.0
208  *
209  * @remarks      Different color values can be defined for different device models.
210  * @endif
211  */
212 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_FOREGROUND;
213
214 /**
215  * @if OSPDEPREC
216  * The system default background color (for example, Label, Panel, and ScrollPanel).
217  *
218  * @brief <i> [Deprecated]  </i>
219  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
220  * @since        2.0
221  *
222  * @remarks      Different color values can be defined for different device models.
223  * @endif
224  */
225 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_BACKGROUND;
226
227 /**
228  * @if OSPDEPREC
229  * The system default color for the List background.
230  *
231  * @brief <i> [Deprecated]  </i>
232  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
233  * @since        2.0
234  *
235  * @remarks      Different color values can be defined for different device models.
236  * @endif
237  */
238 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_BACKGROUND;
239
240 /**
241  * @if OSPDEPREC
242  * The system default color for the Form background.
243  *
244  * @brief <i> [Deprecated]  </i>
245  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
246  * @since        2.0
247  *
248  * @remarks      Different color values can be defined for different device models.
249  * @endif
250  */
251 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_BACKGROUND;
252
253 /**
254  * @if OSPDEPREC
255  * The system default color for the background of the Form with grouped style child controls.
256  *
257  * @brief <i> [Deprecated]  </i>
258  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
259  * @since        2.0
260  *
261  * @remarks      Different color values can be defined for different device models.
262  * @endif
263  */
264 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_GROUP_BACKGROUND;
265
266 /**
267  * @if OSPDEPREC
268  * The system default color for the Popup background.
269  *
270  * @brief <i> [Deprecated]  </i>
271  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
272  * @since        2.0
273  *
274  * @remarks      Different color values can be defined for different device models.
275  * @endif
276  */
277 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_POPUP_BACKGROUND;
278
279 /**
280  * @if OSPDEPREC
281  * The system default color of the group item text.
282  *
283  * @brief <i> [Deprecated]  </i>
284  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
285  * @since        2.0
286  *
287  * @remarks      Different color values can be defined for different device models.
288  * @endif
289  */
290 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_GROUP_ITEM_TEXT;
291
292 /**
293  * @if OSPDEPREC
294  * The system default color of the list text.
295  *
296  * @brief <i> [Deprecated]  </i>
297  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
298  * @since        2.0
299  *
300  * @remarks      Different color values can be defined for different device models.
301  * @endif
302  */
303 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_TEXT;
304
305 /**
306  * @if OSPDEPREC
307  * The system default color of the list item text, when an item is selected.
308  *
309  * @brief <i> [Deprecated]  </i>
310  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
311  * @since        2.0
312  *
313  * @remarks      Different color values can be defined for different device models.
314  * @endif
315  */
316 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_PRESSED_TEXT;
317
318 /**
319  * @if OSPDEPREC
320  * The system default color of the list element text when the item is highlighted.
321  *
322  * @brief <i> [Deprecated]  </i>
323  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
324  * @since        2.0
325  *
326  * @remarks      Different color values can be defined for different device models.
327  * @endif
328  */
329 _OSP_EXPORT_ extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_HIGHLIGHTED_TEXT;
330
331 }; // Tizen::Ui::Controls
332 }; // Tizen::Ui
333 }; // Tizen
334 #endif // _FUI_CONTROLS_H_