input_method_t

概述

输入法接口。

常见的实现方式有以下几种：

  • 空实现。用于不需要输入法的嵌入式平台。

  • 缺省实现。用于需要输入法的嵌入式平台。

  • 基于SDL实现的平台原生输入法。用于桌面系统和手机系统。

    image

输入类型请参考：input_type

函数

函数名称 说明
input_method 获取全局输入法对象。
input_method_commit_text 提交输入文本。
input_method_commit_text_ex 提交输入文本。
input_method_create 创建输入法对象。在具体实现中实现。
input_method_destroy 销毁输入法对象。在具体实现中实现。
input_method_dispatch 分发一个事件。
input_method_dispatch_action 软键盘上的action按钮被点击时，调用本函数分发EVT_IM_ACTION事件。
input_method_dispatch_candidates 请求显示候选字。
input_method_dispatch_key 提交按键。
input_method_dispatch_to_widget 分发一个事件当前焦点控件。
input_method_off 注销指定事件的处理函数。
input_method_on 注册指定事件的处理函数。
input_method_request 打开或关闭输入法。
input_method_set 设置全局输入法对象。
input_method_update_action_button_info 设置软键盘上的action按钮的信息。

属性

属性名称 类型 说明
action_button_enable bool_t 软键盘的上的action按钮是否可用。
action_button_enable bool_t 软键盘的上的action按钮文本。
input_type input_type_t 当前输入的类型。

input_method 函数

  • 函数功能：

获取全局输入法对象。

  • 函数原型：
  1. input_method_t* input_method ();
  • 参数说明：
参数 类型 说明
返回值 input_method_t* 成功返回输入法对象，失败返回NULL。

input_method_commit_text 函数

  • 函数功能：

提交输入文本。

  • 函数原型：
  1. ret_t input_method_commit_text (input_method_t* im, char* text);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。
text char* 文本。

input_method_commit_text_ex 函数

  • 函数功能：

提交输入文本。

  • 函数原型：
  1. ret_t input_method_commit_text_ex (input_method_t* im, bool_t replace, char* text);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。
replace bool_t 是否替换原来的文本。
text char* 文本。

input_method_create 函数

  • 函数功能：

创建输入法对象。在具体实现中实现。

  • 函数原型：
  1. input_method_t* input_method_create ();
  • 参数说明：
参数 类型 说明
返回值 input_method_t* 成功返回输入法对象，失败返回NULL。

input_method_destroy 函数

  • 函数功能：

销毁输入法对象。在具体实现中实现。

  • 函数原型：
  1. ret_t input_method_destroy (input_method_t* im);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。

input_method_dispatch 函数

  • 函数功能：

分发一个事件。

  • 函数原型：
  1. ret_t input_method_dispatch (input_method_t* im, event_t* e);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 控件对象。
e event_t* 事件。

input_method_dispatch_action 函数

  • 函数功能：

软键盘上的action按钮被点击时，调用本函数分发EVT_IM_ACTION事件。

  • 函数原型：
  1. ret_t input_method_dispatch_action (input_method_t* im);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。

input_method_dispatch_candidates 函数

  • 函数功能：

请求显示候选字。

  • 函数原型：
  1. ret_t input_method_dispatch_candidates (input_method_t* im, char* strs, uint32_t nr);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。
strs char* 候选字列表。
nr uint32_t 候选字个数。

input_method_dispatch_key 函数

  • 函数功能：

提交按键。

  • 函数原型：
  1. ret_t input_method_dispatch_key (input_method_t* im, uint32_t key);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。
key uint32_t 键值。

input_method_dispatch_to_widget 函数

  • 函数功能：

分发一个事件当前焦点控件。

  • 函数原型：
  1. ret_t input_method_dispatch_to_widget (input_method_t* im, event_t* e);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 控件对象。
e event_t* 事件。

input_method_off 函数

  • 函数功能：

注销指定事件的处理函数。

  • 函数原型：
  1. ret_t input_method_off (input_method_t* im, uint32_t id);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。
id uint32_t input_method_on返回的ID。

input_method_on 函数

  • 函数功能：

注册指定事件的处理函数。

  • 函数原型：
  1. uint32_t input_method_on (input_method_t* im, event_type_t type, event_func_t on_event, void* ctx);
  • 参数说明：
参数 类型 说明
返回值 uint32_t 返回id，用于input_method_off。
im input_method_t* 输入法对象。
type event_type_t 事件类型。
on_event event_func_t 事件处理函数。
ctx void* 事件处理函数上下文。

input_method_request 函数

  • 函数功能：

打开或关闭输入法。

  • 函数原型：
  1. ret_t input_method_request (input_method_t* im, widget_t* widget);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。
widget widget_t* 焦点控件，为NULL时关闭输入法，非NULL时打开输入法。

input_method_set 函数

  • 函数功能：

设置全局输入法对象。

  • 函数原型：
  1. ret_t input_method_set (input_method_t* im);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。

input_method_update_action_button_info 函数

  • 函数功能：

设置软键盘上的action按钮的信息。

  • 函数原型：
  1. ret_t input_method_update_action_button_info (input_method_t* im, char* text, bool_t enable);
  • 参数说明：
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功，否则表示失败。
im input_method_t* 输入法对象。
text char* 按钮的文本。
enable bool_t 按钮的是否可用。

action_button_enable 属性

软键盘的上的action按钮是否可用。

  • 类型：bool_t
特性 是否支持
可直接读取 是
可直接修改 否

action_button_enable 属性

软键盘的上的action按钮文本。

  • 类型：bool_t
特性 是否支持
可直接读取 是
可直接修改 否

input_type 属性

当前输入的类型。

  • 类型：input_type_t
特性 是否支持
可直接读取 是
可直接修改 否