inputmethod_cursor_info_capi.h

概述

提供光标信息（即用于描述文本输入时光标的位置与尺寸信息，在输入法服务中用于确定光标所在区域以实现精准输入）对象的创建、销毁与读写方法。

引用文件： <inputmethod/inputmethod_cursor_info_capi.h>

库： libohinputmethod.so

系统能力： SystemCapability.MiscServices.InputMethodFramework

起始版本： 12

相关模块： InputMethod

名称	typedef关键字	描述
InputMethod_CursorInfo	InputMethod_CursorInfo	光标信息。光标的坐标位置、宽度和高度。

名称	描述
InputMethod_CursorInfo *OH_CursorInfo_Create(double left, double top, double width, double height)	创建一个新的InputMethod_CursorInfo实例。
void OH_CursorInfo_Destroy(InputMethod_CursorInfo *cursorInfo)	销毁一个InputMethod_CursorInfo实例。
InputMethod_ErrorCode OH_CursorInfo_SetRect(InputMethod_CursorInfo *cursorInfo, double left, double top, double width, double height)	设置光标信息内容。
InputMethod_ErrorCode OH_CursorInfo_GetRect(InputMethod_CursorInfo cursorInfo, double left, double top, double width, double *height)	获取光标信息内容。

InputMethod_CursorInfo *OH_CursorInfo_Create(double left, double top, double width, double height)

描述

创建一个新的InputMethod_CursorInfo实例。

起始版本： 12

参数：

参数项	描述
double left	光标靠左点相对于物理屏幕左侧的距离的绝对值，单位px。
double top	光标顶点与物理屏幕上侧距离的绝对值，单位px。
double width	宽度，单位px。
double height	高度，单位px。

返回：

类型	说明
InputMethod_CursorInfo *	如果创建成功，返回一个指向新创建的InputMethod_CursorInfo实例的指针。如果创建失败，对象返回NULL，可能的失败原因有应用程序的地址空间耗尽。

void OH_CursorInfo_Destroy(InputMethod_CursorInfo *cursorInfo)

描述

起始版本： 12

参数：

参数项	描述
InputMethod_CursorInfo *cursorInfo	表示指向即将被销毁的InputMethod_CursorInfo实例的指针。

InputMethod_ErrorCode OH_CursorInfo_SetRect(InputMethod_CursorInfo *cursorInfo, double left, double top, double width, double height)

描述

设置光标信息内容。

起始版本： 12

参数：

参数项	描述
InputMethod_CursorInfo *cursorInfo	表示指向InputMethod_CursorInfo实例的指针。
double left	光标靠左点与物理屏幕左侧距离的绝对值，单位px。
double top	光标顶点与物理屏幕上侧距离的绝对值，单位px。
double width	宽度，单位px。
double height	高度，单位px。

返回：

类型	说明
InputMethod_ErrorCode	返回一个特定的错误码。 IME_ERR_OK - 表示成功。 IME_ERR_NULL_POINTER - 非预期的空指针。具体错误码可以参考 InputMethod_ErrorCode。

InputMethod_ErrorCode OH_CursorInfo_GetRect(InputMethod_CursorInfo *cursorInfo, double *left, double *top, double *width, double *height)

描述

获取光标信息内容。

起始版本： 12

参数：

参数项	描述
InputMethod_CursorInfo *cursorInfo	表示指向InputMethod_CursorInfo实例的指针。
double *left	靠左点与物理屏幕左侧距离的绝对值，单位px。
double *top	顶点与物理屏幕上侧距离的绝对值，单位px。
double *width	宽度，单位px。
double *height	高度，单位px。

返回：

类型	说明
InputMethod_ErrorCode	返回一个特定的错误码。 IME_ERR_OK - 表示成功。 IME_ERR_NULL_POINTER - 非预期的空指针。具体错误码可以参考 InputMethod_ErrorCode。