Tizen 2.1 base
[framework/osp/uifw.git] / inc / FUiControls.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                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 <FUiCtrlGroupedList.h>
59 #include <FUiCtrlGroupedListView.h>
60 #include <FUiCtrlGroupedListViewTypes.h>
61 #include <FUiCtrlGroupedTableView.h>
62 #include <FUiCtrlGroupItem.h>
63 #include <FUiCtrlGroupTypes.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 <FUiCtrlICustomListElement.h>
73 #include <FUiCtrlIExpandableEditAreaEventListener.h>
74 #include <FUiCtrlIFastScrollListener.h>
75 #include <FUiCtrlIFormBackEventListener.h>
76 #include <FUiCtrlIFrameEventListener.h>
77 #include <FUiCtrlIGalleryEventListener.h>
78 #include <FUiCtrlIGalleryItemProvider.h>
79 #include <FUiCtrlIGroupedListViewItemEventListener.h>
80 #include <FUiCtrlIGroupedListViewItemProvider.h>
81 #include <FUiCtrlIGroupedTableViewItemEventListener.h>
82 #include <FUiCtrlIGroupedTableViewItemProvider.h>
83 #include <FUiCtrlIIconListViewItemEventListener.h>
84 #include <FUiCtrlIIconListViewItemProvider.h>
85 #include <FUiCtrlIListViewItemEventListener.h>
86 #include <FUiCtrlIListViewItemProvider.h>
87 #include <FUiCtrlInputTypes.h>
88 #include <FUiCtrlIProgressPopupEventListener.h>
89 #include <FUiCtrlIScrollEventListener.h>
90 #include <FUiCtrlISearchBarEventListener.h>
91 #include <FUiCtrlISectionTableViewItemEventListener.h>
92 #include <FUiCtrlISectionTableViewItemProvider.h>
93 #include <FUiCtrlISliderEventListener.h>
94 #include <FUiCtrlISplitPanelEventListener.h>
95 #include <FUiCtrlITableViewItemEventListener.h>
96 #include <FUiCtrlITableViewItemProvider.h>
97 #include <FUiCtrlITokenFilter.h>
98 #include <FUiCtrlKeypad.h>
99 #include <FUiCtrlLabel.h>
100 #include <FUiCtrlLabelTypes.h>
101 #include <FUiCtrlList.h>
102 #include <FUiCtrlListContextItem.h>
103 #include <FUiCtrlListItemBase.h>
104 #include <FUiCtrlListTypes.h>
105 #include <FUiCtrlListView.h>
106 #include <FUiCtrlListViewTypes.h>
107 #include <FUiCtrlMessageBox.h>
108 #include <FUiCtrlOptionMenu.h>
109 #include <FUiCtrlOverlayPanel.h>
110 #include <FUiCtrlOverlayRegion.h>
111 #include <FUiCtrlPanel.h>
112 #include <FUiCtrlPopup.h>
113 #include <FUiCtrlProgress.h>
114 #include <FUiCtrlProgressPopup.h>
115 #include <FUiCtrlRadioGroup.h>
116 #include <FUiCtrlScrollEventTypes.h>
117 #include <FUiCtrlScrollPanel.h>
118 #include <FUiCtrlScrollPanelTypes.h>
119 #include <FUiCtrlSearchBar.h>
120 #include <FUiCtrlSectionTableView.h>
121 #include <FUiCtrlSimpleItem.h>
122 #include <FUiCtrlSlidableGroupedList.h>
123 #include <FUiCtrlSlidableList.h>
124 #include <FUiCtrlSlider.h>
125 #include <FUiCtrlSliderTypes.h>
126 #include <FUiCtrlSplitPanel.h>
127 #include <FUiCtrlSplitPanelTypes.h>
128 #include <FUiCtrlTab.h>
129 #include <FUiCtrlTabBar.h>
130 #include <FUiCtrlTabBarItem.h>
131 #include <FUiCtrlTableView.h>
132 #include <FUiCtrlTableViewContextItem.h>
133 #include <FUiCtrlTableViewGroupItem.h>
134 #include <FUiCtrlTableViewItem.h>
135 #include <FUiCtrlTableViewItemBase.h>
136 #include <FUiCtrlTableViewSimpleGroupItem.h>
137 #include <FUiCtrlTableViewSimpleItem.h>
138 #include <FUiCtrlTableViewTypes.h>
139 #include <FUiCtrlTextBox.h>
140 #include <FUiCtrlTimePicker.h>
141
142 namespace Tizen
143 {
144 /**
145  * @namespace   Tizen::Ui::Controls
146  * @brief               This namespace contains the classes and interfaces for creating rich user interface components for the applications.
147  * @since               2.0
148  *
149  * @remarks             @b %Header @b %file: @b \#include @b <FUi.h> @n
150  *                              @b Library : @b osp-uifw
151  *
152  * The %Ui::Controls namespace contains classes that have graphical representations that can be displayed on the screen as UI elements and with
153  * which the user can interact.
154  *
155  * 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>.
156  *
157  */
158
159 namespace Ui
160 {
161
162 namespace Controls
163 {
164
165 /**
166  * @if OSPDEPREC
167  * The system color for the text that appears in the indicator and the command area (for example, Header and Footer).
168  *
169  * @brief <i> [Deprecated]  </i>
170  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
171  * @since        2.0
172  *
173  * @remarks      Different color values can be defined for different device models.
174  * @endif
175  */
176 /**
177  * @if OSPDEPREC
178  * @htmlonly
179  * <!--
180  */
181 _OSP_EXPORT_
182 /**
183  * -->
184  * @endhtmlonly
185  * @endif
186  */
187 extern const Tizen::Graphics::Color SYSTEM_COLOR_TITLE_TEXT;
188
189 /**
190  * @if OSPDEPREC
191  * The system color for the text that appears in controls, has a different background color than that of its parent (for example, Button).
192  *
193  * @brief <i> [Deprecated]  </i>
194  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
195  * @since        2.0
196  *
197  * @remarks      Different color values can be defined for different device models.
198  * @endif
199  */
200 /**
201  * @if OSPDEPREC
202  * @htmlonly
203  * <!--
204  */
205 _OSP_EXPORT_
206 /**
207  * -->
208  * @endhtmlonly
209  * @endif
210  */
211 extern const Tizen::Graphics::Color SYSTEM_COLOR_BODY_TEXT;
212
213 /**
214  * @if OSPDEPREC
215  * The system default foreground color (for example, Label and CheckButton).
216  *
217  * @brief <i> [Deprecated]  </i>
218  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
219  * @since        2.0
220  *
221  * @remarks      Different color values can be defined for different device models.
222  * @endif
223  */
224 /**
225  * @if OSPDEPREC
226  * @htmlonly
227  * <!--
228  */
229 _OSP_EXPORT_
230 /**
231  * -->
232  * @endhtmlonly
233  * @endif
234  */
235 extern const Tizen::Graphics::Color SYSTEM_COLOR_FOREGROUND;
236
237 /**
238  * @if OSPDEPREC
239  * The system default background color (for example, Label, Panel, and ScrollPanel).
240  *
241  * @brief <i> [Deprecated]  </i>
242  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
243  * @since        2.0
244  *
245  * @remarks      Different color values can be defined for different device models.
246  * @endif
247  */
248 /**
249  * @if OSPDEPREC
250  * @htmlonly
251  * <!--
252  */
253 _OSP_EXPORT_
254 /**
255  * -->
256  * @endhtmlonly
257  * @endif
258  */
259 extern const Tizen::Graphics::Color SYSTEM_COLOR_BACKGROUND;
260
261 /**
262  * @if OSPDEPREC
263  * The system default color for the List background.
264  *
265  * @brief <i> [Deprecated]  </i>
266  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
267  * @since        2.0
268  *
269  * @remarks      Different color values can be defined for different device models.
270  * @endif
271  */
272 /**
273  * @if OSPDEPREC
274  * @htmlonly
275  * <!--
276  */
277 _OSP_EXPORT_
278 /**
279  * -->
280  * @endhtmlonly
281  * @endif
282  */
283 extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_BACKGROUND;
284
285 /**
286  * @if OSPDEPREC
287  * The system default color for the Form background.
288  *
289  * @brief <i> [Deprecated]  </i>
290  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
291  * @since        2.0
292  *
293  * @remarks      Different color values can be defined for different device models.
294  * @endif
295  */
296 /**
297  * @if OSPDEPREC
298  * @htmlonly
299  * <!--
300  */
301 _OSP_EXPORT_
302 /**
303  * -->
304  * @endhtmlonly
305  * @endif
306  */
307 extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_BACKGROUND;
308
309 /**
310  * @if OSPDEPREC
311  * The system default color for the background of the Form with grouped style child controls.
312  *
313  * @brief <i> [Deprecated]  </i>
314  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
315  * @since        2.0
316  *
317  * @remarks      Different color values can be defined for different device models.
318  * @endif
319  */
320 /**
321  * @if OSPDEPREC
322  * @htmlonly
323  * <!--
324  */
325 _OSP_EXPORT_
326 /**
327  * -->
328  * @endhtmlonly
329  * @endif
330  */
331 extern const Tizen::Graphics::Color SYSTEM_COLOR_FORM_GROUP_BACKGROUND;
332
333 /**
334  * @if OSPDEPREC
335  * The system default color for the Popup background.
336  *
337  * @brief <i> [Deprecated]  </i>
338  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
339  * @since        2.0
340  *
341  * @remarks      Different color values can be defined for different device models.
342  * @endif
343  */
344 /**
345  * @if OSPDEPREC
346  * @htmlonly
347  * <!--
348  */
349 _OSP_EXPORT_
350 /**
351  * -->
352  * @endhtmlonly
353  * @endif
354  */
355 extern const Tizen::Graphics::Color SYSTEM_COLOR_POPUP_BACKGROUND;
356
357 /**
358  * @if OSPDEPREC
359  * The system default color of the group item text.
360  *
361  * @brief <i> [Deprecated]  </i>
362  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
363  * @since        2.0
364  *
365  * @remarks      Different color values can be defined for different device models.
366  * @endif
367  */
368 /**
369  * @if OSPDEPREC
370  * @htmlonly
371  * <!--
372  */
373 _OSP_EXPORT_
374 /**
375  * -->
376  * @endhtmlonly
377  * @endif
378  */
379 extern const Tizen::Graphics::Color SYSTEM_COLOR_GROUP_ITEM_TEXT;
380
381 /**
382  * @if OSPDEPREC
383  * The system default color of the list text.
384  *
385  * @brief <i> [Deprecated]  </i>
386  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
387  * @since        2.0
388  *
389  * @remarks      Different color values can be defined for different device models.
390  * @endif
391  */
392 /**
393  * @if OSPDEPREC
394  * @htmlonly
395  * <!--
396  */
397 _OSP_EXPORT_
398 /**
399  * -->
400  * @endhtmlonly
401  * @endif
402  */
403 extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_TEXT;
404
405 /**
406  * @if OSPDEPREC
407  * The system default color of the list item text, when an item is selected.
408  *
409  * @brief <i> [Deprecated]  </i>
410  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
411  * @since        2.0
412  *
413  * @remarks      Different color values can be defined for different device models.
414  * @endif
415  */
416 /**
417  * @if OSPDEPREC
418  * @htmlonly
419  * <!--
420  */
421 _OSP_EXPORT_
422 /**
423  * -->
424  * @endhtmlonly
425  * @endif
426  */
427 extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_PRESSED_TEXT;
428
429 /**
430  * @if OSPDEPREC
431  * The system default color of the list element text when the item is highlighted.
432  *
433  * @brief <i> [Deprecated]  </i>
434  * @deprecated This object is provided only for backward compatibility and will be deleted in a future release.
435  * @since        2.0
436  *
437  * @remarks      Different color values can be defined for different device models.
438  * @endif
439  */
440 /**
441  * @if OSPDEPREC
442  * @htmlonly
443  * <!--
444  */
445 _OSP_EXPORT_
446 /**
447  * -->
448  * @endhtmlonly
449  *  @endif
450  */
451 extern const Tizen::Graphics::Color SYSTEM_COLOR_LIST_ITEM_HIGHLIGHTED_TEXT;
452
453 }; // Tizen::Ui::Controls
454 }; // Tizen::Ui
455 }; // Tizen
456 #endif // _FUI_CONTROLS_H_