inc/FUiCtrlListViewTypes.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  * @file        FUiCtrlListViewTypes.h
  20  * @brief       This is the header file for the List enumerations.
  21  *
  22  * This header file contains the declarations of the List enumerations.
  23  */
  24 #ifndef _FUI_CTRL_LIST_VIEW_TYPES_H_
  25 #define _FUI_CTRL_LIST_VIEW_TYPES_H_
  26
  27 namespace Tizen { namespace Ui { namespace Controls
  28 {
  29
  30 /**
  31  * @enum  ListAnnexStyle
  32  *
  33  * Defines the style of annex in the items.
  34  *
  35  * @since 2.0
  36  */
  37 enum ListAnnexStyle
  38 {
  39         LIST_ANNEX_STYLE_NORMAL = 0,                /**< The no style annex */
  40         LIST_ANNEX_STYLE_MARK,                      /**< The mark style annex for multiple selection */
  41         LIST_ANNEX_STYLE_ONOFF_SLIDING,             /**< The slider style On/Off */
  42         LIST_ANNEX_STYLE_DETAILED,                  /**< Detailed style for further interaction */
  43         LIST_ANNEX_STYLE_RADIO,                     /**< The radio style for simple look */
  44         LIST_ANNEX_STYLE_ONOFF_SLIDING_WITH_DIVIDER /**< The slider style On/Off with divider @b Since: @b 2.1 */
  45 };
  46
  47 /**
  48  * @enum  ListItemDrawingStatus
  49  *
  50  * Defines the drawing state of the items.
  51  *
  52  * @since 2.0
  53  */
  54 enum ListItemDrawingStatus
  55 {
  56         LIST_ITEM_DRAWING_STATUS_NORMAL = 0,    /**< The normal drawing state */
  57         LIST_ITEM_DRAWING_STATUS_PRESSED,       /**< The pressed drawing state */
  58         LIST_ITEM_DRAWING_STATUS_HIGHLIGHTED    /**< The highlighted drawing state */
  59 };
  60
  61 /**
  62  * @enum  ListRefreshType
  63  *
  64  * Defines the update type of the list.
  65  *
  66  * @since 2.0
  67  */
  68 enum ListRefreshType
  69 {
  70         LIST_REFRESH_TYPE_ITEM_ADD = 0,         /**< The add type */
  71         LIST_REFRESH_TYPE_ITEM_REMOVE,          /**< The remove type */
  72         LIST_REFRESH_TYPE_ITEM_MODIFY           /**< The modify type */
  73 };
  74
  75 /**
  76  * @enum  ListItemStatus
  77  *
  78  * Defines the item state of the list.
  79  *
  80  * @since 2.0
  81  */
  82 enum ListItemStatus
  83 {
  84         LIST_ITEM_STATUS_SELECTED = 0,          /**< The selected item state */
  85         LIST_ITEM_STATUS_HIGHLIGHTED,           /**< The highlighted item state */
  86         LIST_ITEM_STATUS_CHECKED,               /**< The check item state */
  87         LIST_ITEM_STATUS_UNCHECKED,             /**< The uncheck item state */
  88         LIST_ITEM_STATUS_MORE                   /**< The more item state */
  89 };
  90
  91 /**
  92  * @enum  ListContextItemStatus
  93  *
  94  * Defines the state of the context items.
  95  *
  96  * @since 2.0
  97  */
  98 enum ListContextItemStatus
  99 {
 100         LIST_CONTEXT_ITEM_STATUS_SELECTED = 0,  /**< The selected context item state */
 101         LIST_CONTEXT_ITEM_STATUS_HIGHLIGHTED    /**< The highlighted context item state */
 102 };
 103
 104 /**
 105  * @enum  ListContextItemElementStatus
 106  *
 107  * Defines the element status of the context item.
 108  *
 109  * @since 2.1
 110  */
 111 enum ListContextItemElementStatus
 112 {
 113         LIST_CONTEXT_ITEM_ELEMENT_STATUS_NORMAL = 0,    /**< The normal element status */
 114         LIST_CONTEXT_ITEM_ELEMENT_STATUS_PRESSED,       /**< The pressed element status */
 115         LIST_CONTEXT_ITEM_ELEMENT_STATUS_HIGHLIGHTED    /**< The highlighted element status */
 116 };
 117
 118 /**
 119  * @enum  SweepDirection
 120  *
 121  * Defines the direction of the sweep interaction.
 122  *
 123  * @since 2.0
 124  */
 125 enum SweepDirection
 126 {
 127         SWEEP_DIRECTION_LEFT = 0,               /**< The left direction */
 128         SWEEP_DIRECTION_RIGHT                   /**< The right direction */
 129 };
 130
 131 /**
 132  * @enum ListScrollItemAlignment
 133  *
 134  * Defines the alignment information for item scroll.
 135  *
 136  * @since 2.0
 137  */
 138 enum ListScrollItemAlignment
 139 {
 140         LIST_SCROLL_ITEM_ALIGNMENT_TOP = 0,     /**< The item is aligned at the top of the ListView at item scroll*/
 141         LIST_SCROLL_ITEM_ALIGNMENT_BOTTOM       /**< The item is aligned at the bottom of the ListView at item scroll */
 142 };
 143
 144 /**
 145  * @enum ListScrollStyle
 146  *
 147  * Defines the scroll style of the list.
 148  *
 149  * @since 2.0
 150  */
 151 enum ListScrollStyle
 152 {
 153         SCROLL_STYLE_FADE_OUT = 0,              /**< The fade-out scroll style */
 154         SCROLL_STYLE_FIXED,                     /**< The fixed scroll style */
 155         SCROLL_STYLE_FAST_SCROLL,               /**< The fast scroll style */
 156         SCROLL_STYLE_JUMP_TO_TOP,               /**< The jump to top scroll style */
 157         SCROLL_STYLE_THUMB,                     /**< The thumb scroll style */
 158         SCROLL_STYLE_FAST_SCROLL_FIXED          /**< The fixed fast scroll style @b Since: @b 2.2 */
 159 };
 160
 161 }}} // Tizen::Ui::Controls
 162
 163 #endif // _FUI_CTRL_LIST_VIEW_TYPES_H_