1# inputmethod_types_capi.h 2<!--Kit: IME Kit--> 3<!--Subsystem: MiscServices--> 4<!--Owner: @illybyy--> 5<!--Designer: @andeszhang--> 6<!--Tester: @murphy1984--> 7<!--Adviser: @zhang_yixin13--> 8 9## 概述 10 11提供了输入法相关的类型定义。 12 13**引用文件：** <inputmethod/inputmethod_types_capi.h> 14 15**库：** libohinputmethod.so 16 17**系统能力：** SystemCapability.MiscServices.InputMethodFramework 18 19**起始版本：** 12 20 21**相关模块：** [InputMethod](capi-inputmethod.md) 22 23## 汇总 24 25### 枚举 26 27| 名称 | typedef关键字 | 描述 | 28| -- | -- | -- | 29| [InputMethod_KeyboardStatus](#inputmethod_keyboardstatus) | InputMethod_KeyboardStatus | 键盘状态。 | 30| [InputMethod_EnterKeyType](#inputmethod_enterkeytype) | InputMethod_EnterKeyType | 回车键功能类型。 | 31| [InputMethod_Direction](#inputmethod_direction) | InputMethod_Direction | 移动方向。 | 32| [InputMethod_ExtendAction](#inputmethod_extendaction) | InputMethod_ExtendAction | 编辑框中文本的扩展编辑操作类型。 | 33| [InputMethod_TextInputType](#inputmethod_textinputtype) | InputMethod_TextInputType | 文本输入类型。 | 34| [InputMethod_CommandValueType](#inputmethod_commandvaluetype) | InputMethod_CommandValueType | 私有数据类型。 | 35| [InputMethod_ErrorCode](#inputmethod_errorcode) | InputMethod_ErrorCode | 输入法错误码。 | 36| [InputMethod_RequestKeyboardReason](#inputmethod_requestkeyboardreason) | InputMethod_RequestKeyboardReason | 表示请求键盘输入原因。 | 37 38## 枚举类型说明 39 40### InputMethod_KeyboardStatus 41 42``` 43enum InputMethod_KeyboardStatus 44``` 45 46**描述** 47 48键盘状态。 49 50**起始版本：** 12 51 52| 枚举项 | 描述 | 53| -- | -- | 54| IME_KEYBOARD_STATUS_NONE = 0 | 键盘状态为NONE。 | 55| IME_KEYBOARD_STATUS_HIDE = 1 | 键盘状态为隐藏。 | 56| IME_KEYBOARD_STATUS_SHOW = 2 | 键盘状态为显示。 | 57 58### InputMethod_EnterKeyType 59 60``` 61enum InputMethod_EnterKeyType 62``` 63 64**描述** 65 66回车键功能类型。 67 68**起始版本：** 12 69 70| 枚举项 | 描述 | 71| -- | -- | 72| IME_ENTER_KEY_UNSPECIFIED = 0 | 未指定。 | 73| IME_ENTER_KEY_NONE = 1 | 回车键功能类型为NONE。 | 74| IME_ENTER_KEY_GO = 2 | 前往。 | 75| IME_ENTER_KEY_SEARCH = 3 | 搜索。 | 76| IME_ENTER_KEY_SEND = 4 | 发送。 | 77| IME_ENTER_KEY_NEXT = 5 | 下一步。 | 78| IME_ENTER_KEY_DONE = 6 | 完成。 | 79| IME_ENTER_KEY_PREVIOUS = 7 | 上一步。 | 80| IME_ENTER_KEY_NEWLINE = 8 | 换行。 | 81 82### InputMethod_Direction 83 84``` 85enum InputMethod_Direction 86``` 87 88**描述** 89 90移动方向。 91 92**起始版本：** 12 93 94| 枚举项 | 描述 | 95| -- | -- | 96| IME_DIRECTION_NONE = 0 | 移动方向为NONE。 | 97| IME_DIRECTION_UP = 1 | 向上。 | 98| IME_DIRECTION_DOWN = 2 | 向下。 | 99| IME_DIRECTION_LEFT = 3 | 向左。 | 100| IME_DIRECTION_RIGHT = 4 | 向右。 | 101 102### InputMethod_ExtendAction 103 104``` 105enum InputMethod_ExtendAction 106``` 107 108**描述** 109 110编辑框中文本的扩展编辑操作类型。 111 112**起始版本：** 12 113 114| 枚举项 | 描述 | 115| -- | -- | 116| IME_EXTEND_ACTION_SELECT_ALL = 0 | 全选。 | 117| IME_EXTEND_ACTION_CUT = 3 | 剪切。 | 118| IME_EXTEND_ACTION_COPY = 4 | 赋值。 | 119| IME_EXTEND_ACTION_PASTE = 5 | 粘贴。 | 120 121### InputMethod_TextInputType 122 123``` 124enum InputMethod_TextInputType 125``` 126 127**描述** 128 129文本输入类型。 130 131**起始版本：** 12 132 133| 枚举项 | 描述 | 134| -- | -- | 135| IME_TEXT_INPUT_TYPE_NONE = -1 | 文本输入类型为NONE。 | 136| IME_TEXT_INPUT_TYPE_TEXT = 0 | 文本类型。 | 137| IME_TEXT_INPUT_TYPE_MULTILINE = 1 | 多行类型。 | 138| IME_TEXT_INPUT_TYPE_NUMBER = 2 | 数字类型。 | 139| IME_TEXT_INPUT_TYPE_PHONE = 3 | 电话号码类型。 | 140| IME_TEXT_INPUT_TYPE_DATETIME = 4 | 日期类型。 | 141| IME_TEXT_INPUT_TYPE_EMAIL_ADDRESS = 5 | 邮箱地址类型。 | 142| IME_TEXT_INPUT_TYPE_URL = 6 | 链接类型。 | 143| IME_TEXT_INPUT_TYPE_VISIBLE_PASSWORD = 7 | 密码类型。 | 144| IME_TEXT_INPUT_TYPE_NUMBER_PASSWORD = 8 | 数字密码类型。 | 145| IME_TEXT_INPUT_TYPE_SCREEN_LOCK_PASSWORD = 9 | 锁屏密码类型。 | 146| IME_TEXT_INPUT_TYPE_USER_NAME = 10 | 用户名类型。 | 147| IME_TEXT_INPUT_TYPE_NEW_PASSWORD = 11 | 新密码类型。 | 148| IME_TEXT_INPUT_TYPE_NUMBER_DECIMAL = 12 | 数字小数类型。 | 149| IME_TEXT_INPUT_TYPE_ONE_TIME_CODE = 13 | 验证码类型。**起始版本：** 20 | 150 151### InputMethod_CommandValueType 152 153``` 154enum InputMethod_CommandValueType 155``` 156 157**描述** 158 159私有数据类型。 160 161**起始版本：** 12 162 163| 枚举项 | 描述 | 164| -- | -- | 165| IME_COMMAND_VALUE_TYPE_NONE = 0 | 私有数据类型为NONE。 | 166| IME_COMMAND_VALUE_TYPE_STRING = 1 | 字符串类型。 | 167| IME_COMMAND_VALUE_TYPE_BOOL = 2 | 布尔类型。 | 168| IME_COMMAND_VALUE_TYPE_INT32 = 3 | 32位带符号整数类型。 | 169 170### InputMethod_ErrorCode 171 172``` 173enum InputMethod_ErrorCode 174``` 175 176**描述** 177 178输入法错误码。 179 180**起始版本：** 12 181 182| 枚举项 | 描述 | 183| -- | -- | 184| IME_ERR_OK = 0 | 成功。 | 185| IME_ERR_UNDEFINED = 1 | 查询失败。 | 186| IME_ERR_PARAMCHECK = 401 | 参数检查失败。 | 187| IME_ERR_PACKAGEMANAGER = 12800001 | 包管理异常。 | 188| IME_ERR_IMENGINE = 12800002 | 输入法应用异常。 | 189| IME_ERR_IMCLIENT = 12800003 | 输入框客户端异常。 | 190| IME_ERR_CONFIG_PERSIST = 12800005 | 配置固化失败。当保存配置失败时，会报此错误码。 | 191| IME_ERR_CONTROLLER = 12800006 | 输入法控制器异常。 | 192| IME_ERR_SETTINGS = 12800007 | 输入法设置器异常。 | 193| IME_ERR_IMMS = 12800008 | 输入法管理服务异常。 | 194| IME_ERR_DETACHED = 12800009 | 输入框未绑定。 | 195| IME_ERR_NULL_POINTER = 12802000 | 空指针异常。 | 196| IME_ERR_QUERY_FAILED = 12802001 | 查询失败。 | 197 198### InputMethod_RequestKeyboardReason 199 200``` 201enum InputMethod_RequestKeyboardReason 202``` 203 204**描述** 205 206表示请求键盘输入原因。 207 208**起始版本：** 15 209 210| 枚举项 | 描述 | 211| -- | -- | 212| IME_REQUEST_REASON_NONE = 0 | 表示没有特定的原因触发键盘请求。 | 213| IME_REQUEST_REASON_MOUSE = 1 | 表示键盘请求是由鼠标操作触发的。 | 214| IME_REQUEST_REASON_TOUCH = 2 | 表示键盘请求是由触摸操作触发的。 | 215| IME_REQUEST_REASON_OTHER = 20 | 表示键盘请求是由其他原因触发的。 | 216 217 218