Tizen 2.1 base
[framework/osp/uifw.git] / inc / FUiCtrlTab.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  * @file        FUiCtrlTab.h
19  * @brief       This is the header file for the %Tab class.
20  *
21  * This header file contains the declarations of the %Tab class and its helper classes.
22  */
23
24 #ifndef _FUI_CTRL_TAB_H_
25 #define _FUI_CTRL_TAB_H_
26
27 #include <FBaseObject.h>
28 #include <FBaseTypes.h>
29 #include <FBaseString.h>
30 #include <FGrpBitmap.h>
31 #include <FGrpRectangle.h>
32 #include <FUiControl.h>
33 #include <FUiContainer.h>
34 #include <FUiCtrlForm.h>
35 #include <FUiIActionEventListener.h>
36
37 namespace Tizen { namespace Ui
38 {
39 class IActionEventListener;
40 }}
41
42 namespace Tizen { namespace Ui { namespace Controls
43 {
44 class _PublicActionEvent;
45
46
47 /**
48  * @if OSPDEPREC
49  * @class       Tab
50  * @brief        <i> [Deprecated] </i> This class is an implementation of a %Tab control.
51  *
52  * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
53  * @since       2.0
54  *
55  * @remarks     Note that tabs are part of a Form control, not a Frame control. This means that each tab item cannot be a form. You can associate a Panel
56  *                              control or a ScrollPanel control to each tab item.
57  *
58  * The %Tab class is an implementation of a %Tab control.
59  * %Tab control displays the user selection in the form of a horizontal list. Each
60  * item of %Tab control consists of its text string and optional bitmap image.
61  * Items can be added to an itemlist of the tab model with AddItem(). Items can
62  * be inserted into an itemlist by InsertItemAt(), updated into an itemlist by SetItemAt(),
63  * removed from an itemlist by RemoveItemAt(), etc. It is possible to customize the
64  * background image of the tab shelf, and the image of the currently selected tab item.
65  * A badge icon can also be used to give more information for each tab item.
66  *
67  * Example:
68  *
69  * @image html ui_controls_tab.png
70  *
71  *
72  * This is the simple UI application that uses a %Tab control.
73  *
74  *
75  * @code
76 //Sample code for TabSample.h
77
78 #include <FUi.h>
79
80 class TabSample
81         : public Tizen::Ui::Controls::Form
82         , public Tizen::Ui::IActionEventListener
83 {
84 public:
85         TabSample(void)
86         : __pTab(null){}
87
88         bool Initialize(void);
89         virtual result OnInitializing(void);
90
91         // IActionEventListener
92         virtual void OnActionPerformed(const Tizen::Ui::Control& source, int actionId);
93
94 private:
95         Tizen::Ui::Controls::Tab* __pTab;
96 };
97  *      @endcode
98  *
99  *      @code
100 // Sample code for TabSample.cpp
101 #include "TabSample.h"
102
103 using namespace Tizen::Ui::Controls;
104
105 bool
106 TabSample::Initialize()
107 {
108         Construct(FORM_STYLE_NORMAL|FORM_STYLE_TEXT_TAB);
109         return true;
110 }
111
112 result
113 TabSample::OnInitializing(void)
114 {
115         result r = E_SUCCESS;
116
117         // Gets an instance of Tab
118         __pTab = GetTab();
119
120         // Adds items to the tab
121         __pTab->AddItem(L"First", 0);
122         __pTab->AddItem(L"Second", 1);
123         __pTab->AddActionEventListener(*this);
124
125         return r;
126 }
127
128 // IActionEventListener implementation
129 void
130 TabSample::OnActionPerformed(const Control& source, int actionId)
131 {
132         switch (actionId)
133         {
134         case 0:
135                 {
136                         // ....
137                 }
138                 break;
139         case 1:
140                 {
141                         // ....
142                 }
143                 break;
144         default:
145                 break;
146         }
147 }
148  * @endcode
149  * @endif
150  */
151 class _OSP_EXPORT_ Tab
152         : public Tizen::Ui::Control
153 {
154 public:
155         /**
156          * @if OSPDEPREC
157          * Adds a listener instance.
158          * The added listener can listen to events on the context of the given event dispatcher when they are fired.
159          *
160          * @brief        <i> [Deprecated] </i>
161          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
162          * @since               2.0
163          *
164          * @param[in]   listener        The event listener to be added
165          * @endif
166          */
167         void AddActionEventListener(Tizen::Ui::IActionEventListener& listener);
168
169         /**
170          * @if OSPDEPREC
171          * Removes a listener instance.
172          * The removed listener cannot listen to events when they are fired.
173          *
174          * @brief        <i> [Deprecated] </i>
175          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
176          * @since               2.0
177          *
178          * @param[in]   listener        The event listener to be removed
179          * @endif
180          */
181         void RemoveActionEventListener(Tizen::Ui::IActionEventListener& listener);
182
183 public:
184         /**
185          * @if OSPDEPREC
186          * Adds an item consisting of the specified text string.
187          *
188          * @brief        <i> [Deprecated] </i>
189          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
190          * @since               2.0
191          *
192          * @return              An error code
193          * @param[in]   text            The text string of the item
194          * @param[in]   actionId                The action ID for this item
195          * @exception   E_SUCCESS               The method is successful.
196          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
197          * @exception   E_SYSTEM                A system error has occurred, or @n
198          *                                                              the total number of items has exceed the %Tab control's maximum item count.
199          * @remarks             The @c actionId range is @c 0-999. @n
200          *                              The maximum number of items for %Tab with text style is @c 9. @n
201          *                              The maximum number of items for icon style %Tab is @c 8.
202          * @remarks     This method can only be used when the %Form control has the FORM_STYLE_TEXT_TAB style.
203          * @endif
204          */
205         result AddItem(const Tizen::Base::String& text, int actionId);
206
207         /**
208          * @if OSPDEPREC
209          * Adds an item consisting of the title icon and the specified text string.
210          *
211          * @brief        <i> [Deprecated] </i>
212          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
213          * @since               2.0
214          *
215          * @return              An error code
216          * @param[in]   titleIcon           The bitmap for the title icon
217          * @param[in]   text                    The text string of the item
218          * @param[in]   actionId                The specified @c actionId for this item
219          * @exception   E_SUCCESS       The method is successful.
220          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
221          * @exception   E_SYSTEM        A system error has occurred, or @n
222          *                                                              the total number of items has exceed the %Tab control's maximum item count.
223          * @remarks         The @c actionId range is @c 0-999. @n
224          *                              The maximum number of items for %Tab with text style is @c 9. @n
225          *              The maximum number of items for icon style %Tab is @c 8. @n
226          *                              This method can only be used when the %Form control has the FORM_STYLE_TEXT_TAB style.
227          * @remarks     If the size of bitmap is greater than the default size , the bitmap is scaled down.
228          * @endif
229          */
230         result AddItem(const Tizen::Graphics::Bitmap& titleIcon, const Tizen::Base::String& text, int actionId);
231
232         /**
233          * @if OSPDEPREC
234          * Adds the item that consists of the specified icon.
235          *
236          * @brief        <i> [Deprecated] </i>
237          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
238          * @since               2.0
239          *
240          * @return              An error code
241          * @param[in]   icon            The bitmap for the icon
242          * @param[in]   actionId                The specified @c actionId for this item
243          * @exception   E_SUCCESS       The method is successful.
244          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
245          * @exception   E_SYSTEM                A system error has occurred, or @n
246          *                                                              the total number of items has exceed the %Tab control's maximum item count.
247          * @remarks         The @c actionId range is @c 0-999. @n
248          *                              The maximum number of items for %Tab with text style is @c 9. @n
249          *                              The maximum number of items for icon style %Tab is @c 8. @n
250          *              This method can only be used when the Form control has the FORM_STYLE_ICON_TAB style. @n
251          *                              If the size of the bitmap is greater than the default size, the bitmap is scaled down.
252          * @endif
253          */
254         result AddItem(const Tizen::Graphics::Bitmap& icon, int actionId);
255
256         /**
257          * @if OSPDEPREC
258          * Inserts the item that consists of only a text string at the specified index.
259          *
260          * @brief        <i> [Deprecated] </i>
261          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
262          * @since               2.0
263          *
264          * @return              An error code
265          * @param[in]   index           The index of the item
266          * @param[in]   text            The text string of the item
267          * @param[in]   actionId        The specified @c actionId for this item
268          * @exception   E_SUCCESS       The method is successful.
269          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
270          * @exception   E_SYSTEM        A system error has occurred, or @n
271          *                                                              the total number of items has exceed the %Tab control's maximum item count.
272          * @remarks         The @c actionId range is @c 0-999. @n
273          *                              The maximum number of items for %Tab with text style is @c 9. @n
274          *                              The maximum number of items for icon style %Tab is @c 8.
275          * @remarks     This method can only be used when the Form control has the FORM_STYLE_TEXT_TAB style.
276          * @endif
277          */
278         result InsertItemAt(int index, const Tizen::Base::String& text, int actionId);
279
280         /**
281          * @if OSPDEPREC
282          * Inserts the item that consists of the title icon and specified text string at the specified index.
283          *
284          * @brief        <i> [Deprecated] </i>
285          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
286          * @since               2.0
287          *
288          * @return              An error code
289          * @param[in]   index           The index of the item
290          * @param[in]   titleIcon           The bitmap for the title icon
291          * @param[in]   text                    The text string of the item
292          * @param[in]   actionId                The specified @c actionId for this item
293          * @exception   E_SUCCESS       The method is successful.
294          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
295          * @exception   E_SYSTEM        A system error has occurred, or @n
296          *                                                              the total number of items has exceed the %Tab control's maximum item count.
297          * @remarks         The @c actionId range is @c 0-999.
298          * @remarks     The maximum number of items for %Tab with text style is @c 9. @n
299          *              The maximum number of items for icon style %Tab is @c 8. @n
300          *                              This method can only be used when the %Form control has the FORM_STYLE_TEXT_TAB style. @n
301          *                              If the size of bitmap is greater than the default size, the bitmap is scaled down.
302          * @endif
303          */
304         result InsertItemAt(int index, const Tizen::Graphics::Bitmap& titleIcon, const Tizen::Base::String& text, int actionId);
305
306         /**
307          * @if OSPDEPREC
308          * Inserts the item which consists of the title icon and specified text string at the specified index.
309          *
310          * @brief        <i> [Deprecated] </i>
311          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
312          * @since               2.0
313          *
314          * @return              An error code
315          * @param[in]   index                   The index of the item
316          * @param[in]   icon            The Bitmap for the Icon
317          * @param[in]   actionId                The specified @c actionId for this item
318          * @exception   E_SUCCESS       The method is successful.
319          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
320          * @exception   E_SYSTEM        A system error has occurred, or @n
321          *                                                              the total number of items has exceed the %Tab control's maximum item count.
322          * @remarks         The @c actionId range is @c 0-999.
323          * @remarks             The maximum number of items for %Tab with text style is @c 9. @n
324          *                              The maximum number of items for icon style %Tab is @c 8. @n
325          *                              This method can only be used when the Form control has the FORM_STYLE_ICON_TAB style. @n
326          *                              If the size of bitmap is greater than the default size, the bitmap is scaled down.
327          * @endif
328          */
329         result InsertItemAt(int index, const Tizen::Graphics::Bitmap& icon, int actionId);
330
331         /**
332          * @if OSPDEPREC
333          * Sets the item that consists of only a text string at the specified index.
334          *
335          * @brief        <i> [Deprecated] </i>
336          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
337          * @since               2.0
338          *
339          * @return              An error code
340          * @param[in]   index                   The index of the item
341          * @param[in]   text                    The text string of the item
342          * @param[in]   actionId                The specified @c actionId for this item
343          * @exception   E_SUCCESS       The method is successful.
344          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
345          * @exception   E_SYSTEM        A system error has occurred.
346          * @remarks         The @c actionId range is @c 0-999. @n
347          *                              This method can only be used when the Form control has the FORM_STYLE_TEXT_TAB style.
348          * @endif
349          */
350         result SetItemAt(int index, const Tizen::Base::String& text, int actionId);
351
352         /**
353          * @if OSPDEPREC
354          * Sets the item that consists of the title icon and the specified text string at the given index.
355          *
356          * @brief        <i> [Deprecated] </i>
357          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
358          * @since               2.0
359          *
360          * @return              An error code
361          * @param[in]   index           The index of the item
362          * @param[in]   titleIcon       The bitmap for the title icon
363          * @param[in]   text            The text string of the item
364          * @param[in]   actionId                The action ID for the item
365          * @exception   E_SUCCESS       The method is successful.
366          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
367          * @exception   E_SYSTEM        A system error has occurred.
368          * @remarks         The @c actionId range is @c 0-999. @n
369          *                              This method can only be used when the Form control has the FORM_STYLE_TEXT_TAB style. @n
370          *                              If the size of bitmap is greater than the default size, the bitmap is scaled down.
371          * @endif
372          */
373         result SetItemAt(int index, const Tizen::Graphics::Bitmap& titleIcon, const Tizen::Base::String& text, int actionId);
374
375         /**
376          * @if OSPDEPREC
377          * Sets the item that consists of only a title icon at the specified index.
378          *
379          * @brief        <i> [Deprecated] </i>
380          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
381          * @since               2.0
382          *
383          * @return              An error code
384          * @param[in]   index                   The index of the item
385          * @param[in]   icon            The bitmap for the icon
386          * @param[in]   actionId                The action ID for the item
387          * @exception   E_SUCCESS       The method is successful.
388          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
389          * @exception   E_SYSTEM        A system error has occurred.
390          * @remarks         The @c actionId range is @c 0-999. @n
391          *                              This method can only be used when the Form control has the FORM_STYLE_ICON_TAB style. @n
392          *                              If the size of bitmap is greater than the default size, the bitmap is scaled down.
393          * @endif
394          */
395         result SetItemAt(int index, const Tizen::Graphics::Bitmap& icon, int actionId);
396
397         /**
398          * @if OSPDEPREC
399          * Removes item at the given index from the tab.
400          *
401          * @brief        <i> [Deprecated] </i>
402          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
403          * @since               2.0
404          *
405          * @return              An error code
406          * @param[in]   index               The index of the item
407          * @exception   E_SUCCESS       The method is successful.
408          * @exception   E_INVALID_ARG   The specified input parameter is invalid.
409          * @exception   E_SYSTEM        A system error has occurred.
410          * @endif
411          */
412         result RemoveItemAt(int index);
413
414         /**
415          * @if OSPDEPREC
416          * Removes all the items from the tab.
417          *
418          * @brief        <i> [Deprecated] </i>
419          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
420          * @since               2.0
421          *
422          * @return              An error code
423          * @exception   E_SUCCESS               The method is successful.
424          * @exception   E_SYSTEM                A system error has occurred.
425          * @endif
426          */
427         result RemoveAllItems(void);
428
429         /**
430          * @if OSPDEPREC
431          * Sets the badge icon of the specified item.
432          *
433          * @brief        <i> [Deprecated] </i>
434          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
435          * @since               2.0
436          *
437          * @return              An error code
438          * @param[in]   actionId                The specified @c actionId for this item
439          * @param[in]   pBadgeIcon          The bitmap for the icon
440          * @exception   E_SUCCESS       The method is successful.
441          * @exception   E_OUT_OF_RANGE  The specified @c actionId is out of range.
442          * @exception   E_SYSTEM                A system error has occurred.
443          * @remarks         The @c actionId range is @c 0-999. @n
444          *                              If the size of bitmap is greater than the default size, the bitmap is scaled down.
445          * @endif
446          */
447         result SetBadgeIcon(int actionId, const Tizen::Graphics::Bitmap* pBadgeIcon);
448
449         /**
450          * @if OSPDEPREC
451          * Gets the number of items in the specified tab.
452          *
453          * @brief        <i> [Deprecated] </i>
454          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
455          * @since               2.0
456          *
457          * @return              The number of items in the tab
458          * @endif
459          */
460         int GetItemCount(void) const;
461
462         /**
463          * @if OSPDEPREC
464          * Gets the index of the item at the specified action ID.
465          *
466          * @brief        <i> [Deprecated] </i>
467          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
468          * @since               2.0
469          *
470          * @return              The index of the item, @n
471          *                          else @c -1 if an error occurs
472          * @param[in]   actionId                The action ID of the item
473          * @remarks             The @c actionId range is @c 0-999.
474          * @endif
475          */
476         int GetItemIndexFromActionId(int actionId) const;
477
478         /**
479          * @if OSPDEPREC
480          * Gets the action ID of the item at the specified index.
481          *
482          * @brief        <i> [Deprecated] </i>
483          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
484          * @since               2.0
485          *
486          * @return              The action ID of the item, @n
487          *              else @c -1 if @c index is less than @c 0 or greater than the item count of tab
488          * @param[in]   index           The index of the item
489          * @endif
490          */
491         int GetItemActionIdAt(int index) const;
492
493         /**
494          * @if OSPDEPREC
495          * Sets the selected item for the specified index.
496          *
497          * @brief        <i> [Deprecated] </i>
498          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
499          * @since               2.0
500          *
501          * @param[in]   index   The index of the item
502          * @endif
503          */
504         void SetSelectedItem(int index);
505
506         /**
507          * @if OSPDEPREC
508          * Gets the index of the selected item from the tab.
509          *
510          * @brief        <i> [Deprecated] </i>
511          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
512          * @since               2.0
513          *
514          * @return      The index of the item, @n
515          *                              else @c -1 if an error occurs
516          * @endif
517          */
518         int GetSelectedItemIndex(void) const;
519
520         /**
521          * @if OSPDEPREC
522          * Sets the edit-enabled mode.
523          *
524          * @brief        <i> [Deprecated] </i>
525          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
526          * @since               2.0
527          *
528          * @param[in]   enable  Set to @c true to enable edit mode, @n
529          *                                              else @c false
530          * @endif
531          */
532         void SetEditModeEnabled(bool enable);
533
534         /**
535          * @if OSPDEPREC
536          * Checks whether the edit mode is set.
537          *
538          * @brief        <i> [Deprecated] </i>
539          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
540          * @since               2.0
541          *
542          * @return              @c true if the edit mode is set, @n
543          *                              else @c false
544          * @endif
545          */
546         bool IsEditModeEnabled(void) const;
547
548         /**
549          * @if OSPDEPREC
550          * Sets the background bitmap of the tab.
551          *
552          * @brief        <i> [Deprecated] </i>
553          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
554          * @since               2.0
555          *
556          * @return          An error code
557          * @param[in]   bitmap                  The background bitmap
558          * @exception   E_SUCCESS       The method is successful.
559          * @exception   E_INVALID_ARG   The background bitmap is invalid.
560          * @exception   E_SYSTEM                A system error has occurred.
561          * @endif
562          */
563         result SetBackgroundBitmap(const Tizen::Graphics::Bitmap& bitmap);
564
565         /**
566          * @if OSPDEPREC
567          * Sets the background bitmap of the focused item.
568          *
569          * @brief        <i> [Deprecated] </i>
570          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
571          * @since               2.0
572          *
573          * @return              An error code
574          * @param[in]   bitmap                  The background bitmap of the focused item
575          * @exception   E_SUCCESS       The method is successful.
576          * @exception   E_INVALID_ARG   The background bitmap is invalid.
577          * @exception   E_SYSTEM                A system error has occurred.
578          * @endif
579          */
580         result SetFocusedItemBackgroundBitmap(const Tizen::Graphics::Bitmap& bitmap);
581
582         /**
583          * @if OSPDEPREC
584          * Sets the text color of the tab.
585          *
586          * @brief        <i> [Deprecated] </i>
587          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
588          * @since               2.0
589          *
590          * @param[in]   textColor               The color to be set
591          * @endif
592          */
593         void SetTextColor(const Tizen::Graphics::Color& textColor);
594
595         /**
596          * @if OSPDEPREC
597          * Gets the text color of the tab.
598          *
599          * @brief        <i> [Deprecated] </i>
600          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
601          * @since                       2.0
602          *
603          * @return                      The text color
604          * @endif
605          */
606         Tizen::Graphics::Color GetTextColor(void) const;
607
608         /**
609          * @if OSPDEPREC
610          * Sets the text color for the selected item of the tab.
611          *
612          * @brief        <i> [Deprecated] </i>
613          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
614          * @since                       2.0
615          *
616          * @param[in]           textColor               The color to be set
617          * @endif
618          */
619         void SetSelectedTextColor(const Tizen::Graphics::Color& textColor);
620
621         /**
622          * @if OSPDEPREC
623          * Gets the text color for the selected item of the tab.
624          *
625          * @brief        <i> [Deprecated] </i>
626          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
627          * @since                       2.0
628          *
629          * @return                      The text color
630          * @endif
631          */
632         Tizen::Graphics::Color GetSelectedTextColor(void) const;
633
634         /**
635          * @if OSPDEPREC
636          * Gets the color of the text when the %Tab item is highlighted.
637          *
638          * @brief        <i> [Deprecated] </i>
639          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
640          * @since           2.0
641          *
642          * @return          The highlighted text color
643          * @remarks         When a user navigates the user interface using the directional keys, the focused UI control is highlighted.
644          * @endif
645          */
646         Tizen::Graphics::Color GetHighlightedTextColor(void) const;
647
648         /**
649          * @if OSPDEPREC
650          * Sets the color of the text when the tab item is highlighted.
651          *
652          * @brief        <i> [Deprecated] </i>
653          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
654          * @since       2.0
655          *
656          * @param[in]   color   The color to be set
657          * @remarks     When a user navigates the user interface using the directional keys, the focused UI control is highlighted.
658          * @endif
659          */
660         void SetHighlightedTextColor(const Tizen::Graphics::Color& color);
661
662         /**
663          * @if OSPDEPREC
664          * Sets the background bitmap of the highlighted tab item.
665          *
666          * @brief        <i> [Deprecated] </i>
667          * @deprecated  This class is deprecated because the use of the %Tab control is no longer recommended.
668          * @since               2.0
669          *
670          * @return      An error code
671          * @param[in]   bitmap            The background bitmap of the focused item
672          * @exception   E_SUCCESS         The method is successful.
673          * @exception   E_INVALID_ARG     The background bitmap is invalid.
674          * @exception   E_SYSTEM          A system error has occurred.
675          * @remarks             The background bitmap must use the 9-patched bitmap.
676          * @remarks             When a user navigates the user interface using the directional keys, the focused UI control is highlighted.
677          * @endif
678          */
679         result SetHighlightedItemBackgroundBitmap(const Tizen::Graphics::Bitmap& bitmap);
680
681
682         //void SetStyle(int style);
683
684 private:
685         //
686         // This method is for internal use only.
687         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
688         //
689         // The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
690         // @since         2.0
691         //
692         Tab(void);
693
694         //
695         // This method is for internal use only.
696         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
697         //
698         // This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
699         // @since         2.0
700         //
701         virtual ~Tab(void);
702
703         //
704         // This method is for internal use only.
705         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
706         //
707         // Initializes this instance of %Tab with the specified parameter.
708         //
709         // @since         2.0
710         // @return              An error code
711         // @param[in]   tabHandle               The handle of the tab
712         // @exception   E_SUCCESS       The method is successful.
713         // @exception   E_SYSTEM                A system error has occurred.
714         //
715         result Construct(void);
716
717         //
718         // Stores __BitmapItem.
719         //
720         Tizen::Base::Collection::ArrayList __items;
721
722 private:
723         friend class _TabImpl;
724
725 };
726
727 }}} //Tizen::Ui::Controls
728
729 #endif // _FUI_CTRL_TAB_H_