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