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