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