inc/FUiCtrlListTypes.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        FUiCtrlListTypes.h
  19  * @brief       This is the header file for the List enumerations.
  20  *
  21  * This header file contains the declarations of the List enumerations.
  22  */
  23 #ifndef _FUI_CTRL_LIST_TYPES_H_
  24 #define _FUI_CTRL_LIST_TYPES_H_
  25
  26 namespace Tizen { namespace Ui { namespace Controls
  27 {
  28
  29 //
  30 //This integer is for internal use only. Using this integer can cause behavioral, security-related,
  31 //and consistency-related issues in the application.
  32 //
  33 static const int LIST_ITEM_NOTFOUND = 0;
  34
  35 /**
  36  * The integer value that represents the unspecified item ID
  37  *
  38  * @since 2.0
  39  */
  40 static const int LIST_ITEM_UNSPECIFIED_ID = -1;
  41
  42 /**
  43  * @if OSPDEPREC
  44  * @enum ListStyle
  45  *
  46  * Defines the list style.
  47  *
  48  * @brief <i> [Deprecated]  </i>
  49  * @deprecated  This enum is deprecated. Instead of using this enum, use ListAnnexStyle enumeration for CustomItem or SimpleItem class. @n
  50  * @since 2.0
  51  * @endif
  52  */
  53 enum ListStyle
  54 {
  55         LIST_STYLE_NORMAL = 0,                          /**< @if OSPDEPREC The normal style @endif */
  56         LIST_STYLE_NUMBER,                              /**< @if OSPDEPREC The numbered style @endif */
  57         LIST_STYLE_RADIO,                               /**< @if OSPDEPREC The radio style for single selection @endif */
  58         LIST_STYLE_RADIO_WITH_DIVIDER,                  /**< @if OSPDEPREC The radio style with divider for single selection @endif */
  59         LIST_STYLE_MARK,                                /**< @if OSPDEPREC The mark style for multiple selection @endif */
  60         LIST_STYLE_MARK_WITH_DIVIDER,                   /**< @if OSPDEPREC The mark style with divider for multiple selection @endif */
  61         LIST_STYLE_ONOFF,                               /**< @if OSPDEPREC The On/Off style @endif */
  62         LIST_STYLE_ONOFF_WITH_DIVIDER                   /**< @if OSPDEPREC The On/Off style with divider @endif */
  63 };
  64
  65 /**
  66  * @if OSPDEPREC
  67  * @enum ListItemFormat
  68  *
  69  * Defines the list item format.
  70  *
  71  * @brief <i> [Deprecated]  </i>
  72  * @deprecated This enum is deprecated. There is no need to use this enum.
  73  * @since 2.0
  74  * @endif
  75  */
  76 enum ListItemFormat
  77 {
  78         LIST_ITEM_SINGLE_IMAGE = 0,                     /**< @if OSPDEPREC The single line of image @endif */
  79         LIST_ITEM_SINGLE_TEXT,                          /**< @if OSPDEPREC The single line of text @endif */
  80         LIST_ITEM_SINGLE_IMAGE_TEXT,                    /**< @if OSPDEPREC The single line of image, and text @endif */
  81         LIST_ITEM_SINGLE_TEXT_IMAGE,                    /**< @if OSPDEPREC The single line of text, and image @endif */
  82         LIST_ITEM_SINGLE_IMAGE_TEXT_IMAGE,              /**< @if OSPDEPREC The single line of image, text, and image @endif */
  83         LIST_ITEM_DOUBLE_IMAGE_TEXT_FULLTEXT,           /**< @if OSPDEPREC The 1st line of image and text, 2nd line of text @endif */
  84         LIST_ITEM_DOUBLE_FULLTEXT_IMAGE_TEXT,           /**< @if OSPDEPREC The 1st line of text, 2nd line of image, and text @endif */
  85         LIST_ITEM_DOUBLE_TEXT_IMAGE_FULLTEXT,           /**< @if OSPDEPREC The 1st line of text and image, 2nd line of text @endif */
  86         LIST_ITEM_DOUBLE_FULLTEXT_TEXT_IMAGE,           /**< @if OSPDEPREC The 1st line of text, 2nd line of text, and image @endif */
  87         LIST_ITEM_DOUBLE_IMAGE_TEXT_TEXT,               /**< @if OSPDEPREC A big image followed by two lines of text @endif */
  88         LIST_ITEM_DOUBLE_TEXT_TEXT_IMAGE                /**< @if OSPDEPREC The two lines of text followed by a big image @endif */
  89 };
  90
  91 /**
  92  * @if OSPDEPREC
  93  * @enum ListItemText
  94  *
  95  * Defines the option of text slide.
  96  *
  97  * @brief <i> [Deprecated]  </i>
  98  * @deprecated This enum is deprecated. There is no need to use this enum.
  99  * @since 2.0
 100  * @endif
 101  */
 102 enum ListItemText
 103 {
 104         LIST_ITEM_TEXT1,                                /**< @if OSPDEPREC The sliding of 1st text is switched on @endif */
 105         LIST_ITEM_TEXT2                                 /**< @if OSPDEPREC The sliding of 2nd text is switched on @endif */
 106 };
 107
 108 /**
 109  * @if OSPDEPREC
 110  * @enum FastScrollIndexDigit
 111  *
 112  * Defines the number of digits or characters of the fast scroll index.
 113  *
 114  * @brief <i> [Deprecated]  </i>
 115  * @deprecated This enum is deprecated. There is no need to use this enum.
 116  * @since 2.0
 117  * @endif
 118  */
 119 enum FastScrollIndexDigit
 120 {
 121         SCROLL_INDEX_DIGIT_NUM_1,                       /**< @if OSPDEPREC The number of digits or characters of the index is 1 @endif */
 122         SCROLL_INDEX_DIGIT_NUM_2                        /**< @if OSPDEPREC The number of digits or characters of the index is 2 @endif */
 123 };
 124
 125 }}} // Tizen::Ui::Controls
 126
 127 #endif //_FUI_CTRL_LIST_TYPES_H_