inc/FUiCtrlIconListViewTypes.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                FUiCtrlIconListViewTypes.h
  20  * @brief               This is the header file for the %IconListView enumerations.
  21  *
  22  * This header file contains the declarations of the %IconListView enumerations.
  23  *
  24  * These enumerations define the various properties of the %IconListView control.
  25  */
  26
  27 #ifndef _FUI_CTRL_ICON_LIST_VIEW_TYPES_H_
  28 #define _FUI_CTRL_ICON_LIST_VIEW_TYPES_H_
  29
  30 namespace Tizen { namespace Ui { namespace Controls
  31 {
  32
  33 /**
  34  * @enum IconListViewStyle
  35  *
  36  * Defines the styles of the %IconListView control.
  37  *
  38  * @since 2.0
  39  */
  40 enum IconListViewStyle
  41 {
  42         ICON_LIST_VIEW_STYLE_NORMAL = 0,                    /**< The No mark or radio check */
  43         ICON_LIST_VIEW_STYLE_RADIO,                         /**< The radio style for a single selection */
  44         ICON_LIST_VIEW_STYLE_MARK                           /**< The mark style for multiple selections */
  45 };
  46
  47 /**
  48  * @enum IconListViewItemBorderStyle
  49  *
  50  * Defines the constants used to identify the border style of the item.
  51  *
  52  * @since 2.0
  53  */
  54 enum IconListViewItemBorderStyle
  55 {
  56         ICON_LIST_VIEW_ITEM_BORDER_STYLE_NONE = 0,    /**< The item that has no border */
  57         ICON_LIST_VIEW_ITEM_BORDER_STYLE_OUTLINE,     /**< The item that has a line border */
  58         ICON_LIST_VIEW_ITEM_BORDER_STYLE_SHADOW       /**< The item that has a bitmap border with the drop shadow effect */
  59 };
  60
  61 /**
  62  * @enum IconListViewScrollDirection
  63  *
  64  * Defines the scroll direction of the %IconListView control.
  65  *
  66  * @since 2.0
  67  */
  68 enum IconListViewScrollDirection
  69 {
  70         ICON_LIST_VIEW_SCROLL_DIRECTION_VERTICAL,           /**< The vertical direction */
  71         ICON_LIST_VIEW_SCROLL_DIRECTION_HORIZONTAL          /**< The horizontal direction */
  72 };
  73
  74 /**
  75  * @enum IconListViewItemTextVerticalAlignment
  76  *
  77  * Defines the vertical alignment of the item text.
  78  *
  79  * @since 2.0
  80  */
  81 enum IconListViewItemTextVerticalAlignment
  82 {
  83         ICON_LIST_VIEW_ITEM_TEXT_VERTICAL_ALIGNMENT_INSIDE_TOP,     /**< The text is top-aligned inside the item */
  84         ICON_LIST_VIEW_ITEM_TEXT_VERTICAL_ALIGNMENT_INSIDE_MIDDLE,  /**< The text is middle-aligned inside the item */
  85         ICON_LIST_VIEW_ITEM_TEXT_VERTICAL_ALIGNMENT_INSIDE_BOTTOM,  /**< The text is bottom-aligned inside the item */
  86         ICON_LIST_VIEW_ITEM_TEXT_VERTICAL_ALIGNMENT_OUTSIDE_TOP,    /**< The text is top-aligned outside the item */
  87         ICON_LIST_VIEW_ITEM_TEXT_VERTICAL_ALIGNMENT_OUTSIDE_BOTTOM  /**< The text is bottom-aligned outside the item */
  88 };
  89
  90 /**
  91  * @enum IconListViewItemStatus
  92  *
  93  * Defines the constants used to identify the item state.
  94  *
  95  * @since 2.0
  96  */
  97 enum IconListViewItemStatus
  98 {
  99         ICON_LIST_VIEW_ITEM_CHECKED = 0,                    /**< The item has been checked (toggle of the check area) */
 100         ICON_LIST_VIEW_ITEM_UNCHECKED,                      /**< The item has been unchecked (toggle of the check area) */
 101         ICON_LIST_VIEW_ITEM_SELECTED,                       /**< The item has been selected (non-check area of the item) */
 102         ICON_LIST_VIEW_ITEM_HIGHLIGHTED                     /**< The item has been highlighted (non-check area of the item) */
 103 };
 104
 105 /**
 106  * @enum  IconListViewItemDrawingStatus
 107  *
 108  * Defines the drawing state of the %IconListView control items.
 109  *
 110  * @since 2.0
 111  */
 112 enum IconListViewItemDrawingStatus
 113 {
 114         ICON_LIST_VIEW_ITEM_DRAWING_STATUS_NORMAL = 0,      /**< The drawing status for normal items */
 115         ICON_LIST_VIEW_ITEM_DRAWING_STATUS_PRESSED,         /**< The drawing status for pressed items */
 116         ICON_LIST_VIEW_ITEM_DRAWING_STATUS_HIGHLIGHTED      /**< The drawing status for highlighted items */
 117 };
 118
 119 /**
 120  * @enum IconListViewCheckBoxPosition
 121  *
 122  * Defines the checkbox position.
 123  *
 124  * @since 2.0
 125  */
 126 enum IconListViewCheckBoxPosition
 127 {
 128         ICON_LIST_VIEW_CHECK_BOX_POSITION_TOP_LEFT,         /**< The position of the checkbox is top-left */
 129         ICON_LIST_VIEW_CHECK_BOX_POSITION_TOP_RIGHT,        /**< The position of the checkbox is top-right */
 130         ICON_LIST_VIEW_CHECK_BOX_POSITION_BOTTOM_LEFT,      /**< The position of the checkbox is bottom-left */
 131         ICON_LIST_VIEW_CHECK_BOX_POSITION_BOTTOM_RIGHT      /**< The position of the checkbox is bottom-right */
 132 };
 133
 134 /**
 135  * @enum IconListViewScrollStyle
 136  *
 137  * Defines the scroll style of the %IconListView control.
 138  *
 139  * @since 2.0
 140  */
 141 enum IconListViewScrollStyle
 142 {
 143         ICON_LIST_SCROLL_STYLE_FADE_OUT = 0,    /**< The fade-out scroll style */
 144         ICON_LIST_SCROLL_STYLE_FIXED,                   /**< The fixed scroll style */
 145         ICON_LIST_SCROLL_STYLE_JUMP_TO_TOP,             /**< The jump to top scroll style */
 146         ICON_LIST_SCROLL_STYLE_THUMB                    /**< The thumb scroll style */
 147 };
 148
 149 }}} // Tizen::Ui::Controls
 150
 151 #endif // _FUI_CTRL_ICON_LIST_VIEW_TYPES_H_