inc/FUiCtrlEditTypes.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                        FUiCtrlEditTypes.h
  20  * @brief                       This is the header file for the Ui::Controls edit control enumerations.
  21  *
  22  * This header file contains the declarations of the Ui::Controls edit control enumerations.
  23  */
  24 #ifndef _FUI_CTRL_EDIT_ENUM_H_
  25 #define _FUI_CTRL_EDIT_ENUM_H_
  26
  27 namespace Tizen { namespace Ui { namespace Controls
  28 {
  29
  30 /**
  31  * @if OSPDEPREC
  32  * @enum EditInputModeCategory
  33  *
  34  * Defines the input modes.
  35  *
  36  * @brief <i> [Deprecated]  </i>
  37  * @deprecated We no longer provide a method to specify the list of styles which the user can set the keypad to, or the current mode to initially set the keypad to, @n
  38  *                         from this list. It is recommended to use the styles offered in EditFieldStyle or KeypadStyle enumerations instead.
  39  * @since               2.0
  40  * @endif
  41  */
  42 enum EditInputModeCategory
  43 {
  44         EDIT_INPUTMODE_ALPHA = 0x0001, /**< @if OSPDEPREC The alphabetic input mode @endif */
  45         EDIT_INPUTMODE_PREDICTIVE = 0x0002, /**< @if OSPDEPREC The predictive input mode @endif */
  46         EDIT_INPUTMODE_NUMERIC = 0x0004, /**< @if OSPDEPREC The numeric input mode @endif */
  47         EDIT_INPUTMODE_SYMBOL = 0x0008 /**< @if OSPDEPREC The symbolic input mode @endif */
  48 };
  49
  50 /**
  51  * @enum EditFieldStyle
  52  *
  53  * Defines the EditField style.
  54  *
  55  * @since               2.0
  56  */
  57 enum EditFieldStyle
  58 {
  59         EDIT_FIELD_STYLE_NORMAL, /**< The normal style */
  60         EDIT_FIELD_STYLE_PASSWORD, /**< The password style '****' */
  61         EDIT_FIELD_STYLE_NORMAL_SMALL, /**< The small normal style */
  62         EDIT_FIELD_STYLE_PASSWORD_SMALL, /**< The small password style '****' */
  63         EDIT_FIELD_STYLE_EMAIL, /**< The email style */
  64         EDIT_FIELD_STYLE_URL, /**< The URL style */
  65         EDIT_FIELD_STYLE_EMAIL_SMALL, /**< The small email style */
  66         EDIT_FIELD_STYLE_URL_SMALL, /**< The small URL style */
  67         EDIT_FIELD_STYLE_NUMBER, /**< The number style */
  68         EDIT_FIELD_STYLE_NUMBER_SMALL,  /**< The small number style */
  69         EDIT_FIELD_STYLE_PHONE_NUMBER, /**< The phone number style */
  70         EDIT_FIELD_STYLE_PHONE_NUMBER_SMALL,    /**< The small phone number style */
  71         EDIT_FIELD_STYLE_PASSWORD_NUMBER, /**< The number password style */
  72         EDIT_FIELD_STYLE_PASSWORD_NUMBER_SMALL, /**< The small number password style */
  73         EDIT_FIELD_STYLE_IP_V4, /**< The IP V4 style */
  74         EDIT_FIELD_STYLE_IP_V4_SMALL, /**< The small IP V4 style */
  75 };
  76
  77 /**
  78  * @enum CommandButtonPosition
  79  *
  80  * Defines the command button position.
  81  *
  82  * @since               2.0
  83  */
  84 enum CommandButtonPosition
  85 {
  86         COMMAND_BUTTON_POSITION_LEFT, /**< The position is to the left */
  87         COMMAND_BUTTON_POSITION_RIGHT /**< The position is to the right */
  88 };
  89
  90 /**
  91  * @enum EditMarginType
  92  *
  93  * Defines the possible margin types of EditField and EditArea.
  94  *
  95  * @since               2.0
  96  */
  97 enum EditMarginType
  98 {
  99         EDIT_MARGIN_TYPE_VERTICAL, /**< The margin for top and bottom */
 100         EDIT_MARGIN_TYPE_HORIZONTAL /**< The margin for left and right */
 101 };
 102
 103 /**
 104  * @enum EditTextColor
 105  *
 106  * Defines the possible Edit's text colors.
 107  *
 108  * @since               2.0
 109  */
 110 enum EditTextColor
 111 {
 112         EDIT_TEXT_COLOR_NORMAL,         /**< The normal text color */
 113         EDIT_TEXT_COLOR_DISABLED,       /**< The disabled text color */
 114         EDIT_TEXT_COLOR_HIGHLIGHTED,    /**< The selected text color */
 115         EDIT_TEXT_COLOR_LINK            /**< The highlighted text color */
 116 };
 117
 118 /**
 119  * @enum EditStatus
 120  *
 121  * Defines the possible Edit's states.
 122  *
 123  * @since               2.0
 124  */
 125 enum EditStatus
 126 {
 127         EDIT_STATUS_NORMAL,         /**< The normal state */
 128         EDIT_STATUS_DISABLED,       /**< The disabled state */
 129         EDIT_STATUS_HIGHLIGHTED,    /**< The highlighted state */
 130         EDIT_STATUS_PRESSED         /**< The pressed state */
 131 };
 132
 133 /**
 134  * @enum EditFieldTitleStyle
 135  *
 136  * Defines the possible styles of title.
 137  *
 138  * @since               2.0
 139  */
 140 enum EditFieldTitleStyle
 141 {
 142         EDIT_FIELD_TITLE_STYLE_NONE = 0,        /**< No title */
 143         EDIT_FIELD_TITLE_STYLE_INNER,           /**< The title appears inside of the EditField's input field */
 144         EDIT_FIELD_TITLE_STYLE_TOP              /**< The title appears at the top input field */
 145 };
 146
 147 /**
 148  * @enum EllipsisPosition
 149  *
 150  * Defines the possible positions of ellipsis.
 151  *
 152  * @since               2.0
 153  */
 154 enum EllipsisPosition
 155 {
 156         ELLIPSIS_POSITION_START = 0,        /**< The ellipsis appears at the start of text block */
 157         ELLIPSIS_POSITION_MIDDLE,           /**< The ellipsis appears at the middle of text block */
 158         ELLIPSIS_POSITION_END,              /**< The ellipsis appears at the end of text block */
 159 };
 160
 161 /**
 162  * @enum KeypadStyle
 163  *
 164  * Defines the initial keypad style.
 165  *
 166  * @since               2.0
 167  */
 168 enum KeypadStyle
 169 {
 170         KEYPAD_STYLE_NORMAL = 0, /**< The normal style */
 171         KEYPAD_STYLE_PASSWORD, /**< The password style '****' */
 172         KEYPAD_STYLE_EMAIL, /**< The email style */
 173         KEYPAD_STYLE_URL, /**< The URL style */
 174         KEYPAD_STYLE_NUMBER, /**< The number style  */
 175         KEYPAD_STYLE_PHONE_NUMBER, /**< The phone number style  */
 176         KEYPAD_STYLE_IP_V4, /**< The IP V4 style  */
 177 };
 178
 179 }}} // Tizen::Ui::Controls
 180 #endif // _FUI_CTRL_EDIT_ENUM_H_