1# inputmethod_text_avoid_info_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_text_avoid_info_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_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md) | InputMethod_TextAvoidInfo | 输入框避让信息。输入框用于避让键盘的信息。 | 30 31### 函数 32 33| 名称 | 描述 | 34| -- |-----------------------------------------------| 35| [InputMethod_TextAvoidInfo *OH_TextAvoidInfo_Create(double positionY, double height)](#oh_textavoidinfo_create) | 创建一个新的[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例。 | 36| [void OH_TextAvoidInfo_Destroy(InputMethod_TextAvoidInfo *info)](#oh_textavoidinfo_destroy) | 销毁一个[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例。 | 37| [InputMethod_ErrorCode OH_TextAvoidInfo_SetPositionY(InputMethod_TextAvoidInfo *info, double positionY)](#oh_textavoidinfo_setpositiony) | 设置[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)中的Y坐标值。 | 38| [InputMethod_ErrorCode OH_TextAvoidInfo_SetHeight(InputMethod_TextAvoidInfo *info, double height)](#oh_textavoidinfo_setheight) | 设置[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)中的高度值。 | 39| [InputMethod_ErrorCode OH_TextAvoidInfo_GetPositionY(InputMethod_TextAvoidInfo *info, double *positionY)](#oh_textavoidinfo_getpositiony) | 从[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)获取Y坐标值。 | 40| [InputMethod_ErrorCode OH_TextAvoidInfo_GetHeight(InputMethod_TextAvoidInfo *info, double *height)](#oh_textavoidinfo_getheight) | 从[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)获取高度值。 | 41 42## 函数说明 43 44### OH_TextAvoidInfo_Create() 45 46``` 47InputMethod_TextAvoidInfo *OH_TextAvoidInfo_Create(double positionY, double height) 48``` 49 50**描述** 51 52创建一个新的[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例。 53 54**起始版本：** 12 55 56 57**参数：** 58 59| 参数项 | 描述 | 60| -- | -- | 61| double positionY | 表示输入框位置的Y坐标值。 | 62| double height | 表示输入框高度。 | 63 64**返回：** 65 66| 类型 | 说明 | 67| -- | -- | 68| [InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md) * | 如果创建成功，返回一个指向新创建的[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例的指针。<br> 如果创建失败，对象返回NULL，可能的失败原因有应用地址空间满。 | 69 70### OH_TextAvoidInfo_Destroy() 71 72``` 73void OH_TextAvoidInfo_Destroy(InputMethod_TextAvoidInfo *info) 74``` 75 76**描述** 77 78销毁一个[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例。 79 80**起始版本：** 12 81 82 83**参数：** 84 85| 参数项 | 描述 | 86| -- | -- | 87| [InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md) *info | 表示指向即将被销毁的[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例的指针。 | 88 89### OH_TextAvoidInfo_SetPositionY() 90 91``` 92InputMethod_ErrorCode OH_TextAvoidInfo_SetPositionY(InputMethod_TextAvoidInfo *info, double positionY) 93``` 94 95**描述** 96 97设置[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)中的Y坐标值。 98 99**起始版本：** 12 100 101 102**参数：** 103 104| 参数项 | 描述 | 105| -- | -- | 106| [InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md) *info | 指向即将被设置值的[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例的指针。 | 107| double positionY | positionY值，即输入框顶点与物理屏幕上侧距离的绝对值。 | 108 109**返回：** 110 111| 类型 | 说明 | 112| -- | -- | 113| [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) | 返回一个特定的错误码。<br> [IME_ERR_OK](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 表示成功。<br> [IME_ERR_NULL_POINTER](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 非预期的空指针。<br> 具体错误码可以参考 [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode)。 | 114 115### OH_TextAvoidInfo_SetHeight() 116 117``` 118InputMethod_ErrorCode OH_TextAvoidInfo_SetHeight(InputMethod_TextAvoidInfo *info, double height) 119``` 120 121**描述** 122 123设置[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)中的高度值。 124 125**起始版本：** 12 126 127 128**参数：** 129 130| 参数项 | 描述 | 131| -- | -- | 132| [InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md) *info | 指向即将被设置值的[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例的指针。 | 133| double height | 高度值。 | 134 135**返回：** 136 137| 类型 | 说明 | 138| -- | -- | 139| [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) | 返回一个特定的错误码。<br> [IME_ERR_OK](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 表示成功。<br> [IME_ERR_NULL_POINTER](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 非预期的空指针。<br> 具体错误码可以参考 [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode)。 | 140 141### OH_TextAvoidInfo_GetPositionY() 142 143``` 144InputMethod_ErrorCode OH_TextAvoidInfo_GetPositionY(InputMethod_TextAvoidInfo *info, double *positionY) 145``` 146 147**描述** 148 149从[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)获取Y坐标值。 150 151**起始版本：** 12 152 153 154**参数：** 155 156| 参数项 | 描述 | 157| -- | -- | 158| [InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md) *info | 指向即将被获取值的[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例的指针。 | 159| double *positionY | 即输入框顶点与物理屏幕上侧距离的绝对值。 | 160 161**返回：** 162 163| 类型 | 说明 | 164| -- | -- | 165| [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) | 返回一个特定的错误码。<br> [IME_ERR_OK](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 表示成功。<br> [IME_ERR_NULL_POINTER](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 非预期的空指针。<br> 具体错误码可以参考 [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode)。 | 166 167### OH_TextAvoidInfo_GetHeight() 168 169``` 170InputMethod_ErrorCode OH_TextAvoidInfo_GetHeight(InputMethod_TextAvoidInfo *info, double *height) 171``` 172 173**描述** 174 175从[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)获取高度值。 176 177**起始版本：** 12 178 179 180**参数：** 181 182| 参数项 | 描述 | 183| -- | -- | 184| [InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md) *info | 指向即将被获取值的[InputMethod_TextAvoidInfo](capi-inputmethod-inputmethod-textavoidinfo.md)实例的指针。 | 185| double *height | 输入框高度。 | 186 187**返回：** 188 189| 类型 | 说明 | 190| -- | -- | 191| [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) | 返回一个特定的错误码。<br> [IME_ERR_OK](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 表示成功。<br> [IME_ERR_NULL_POINTER](capi-inputmethod-types-capi-h.md#inputmethod_errorcode) - 非预期的空指针。<br> 具体错误码可以参考 [InputMethod_ErrorCode](capi-inputmethod-types-capi-h.md#inputmethod_errorcode)。 | 192 193 194