## candidates\_t
### 概述
![image](images/candidates_t_0.png)
输入法候选字词控件。
如果希望启用用数字选择对应的候选字,请设置属性grab_keys="true"。如:
```xml
| 函数名称 | 说明 | | -------- | ------------ | | candidates\_cast | 转换为candidates对象(供脚本语言使用)。 | | candidates\_create | 创建candidates对象 | | candidates\_get\_widget\_vtable | 获取 candidates 虚表。 | | candidates\_set\_auto\_hide | 设置是否自动隐藏。 | | candidates\_set\_button\_style | 设置按钮的style名称。 | | candidates\_set\_pre | 设置是否为预候选字列表。 | | candidates\_set\_select\_by\_num | 设置是否启用用数字选择候选字。 | ### 属性
| 属性名称 | 类型 | 说明 | | -------- | ----- | ------------ | | auto\_hide | bool\_t | 没有候选字时,是否自动隐藏控件。 | | button\_style | char* | 按钮的style名称。 | | enable\_preview | bool\_t | 是否启用候选字预览。 | | pre | bool\_t | 是否为预候选字。 | | select\_by\_num | bool\_t | 是否启用用数字选择候选字。比如按下1选择第1个候选字,按下2选择第2个候选字。 | #### candidates\_cast 函数 ----------------------- * 函数功能: >
转换为candidates对象(供脚本语言使用)。 * 函数原型: ``` widget_t* candidates_cast (widget_t* widget); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | candidates对象。 | | widget | widget\_t* | candidates对象。 | #### candidates\_create 函数 ----------------------- * 函数功能: >
创建candidates对象 * 函数原型: ``` widget_t* candidates_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | 对象。 | | parent | widget\_t* | 父控件 | | x | xy\_t | x坐标 | | y | xy\_t | y坐标 | | w | wh\_t | 宽度 | | h | wh\_t | 高度 | #### candidates\_get\_widget\_vtable 函数 ----------------------- * 函数功能: >
获取 candidates 虚表。 * 函数原型: ``` const widget_vtable_t* candidates_get_widget_vtable (); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | const widget\_vtable\_t* | 成功返回 candidates 虚表。 | #### candidates\_set\_auto\_hide 函数 ----------------------- * 函数功能: >
设置是否自动隐藏。 * 函数原型: ``` ret_t candidates_set_auto_hide (widget_t* widget, bool_t auto_hide); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | auto\_hide | bool\_t | 是否自动隐藏。 | #### candidates\_set\_button\_style 函数 ----------------------- * 函数功能: >
设置是否为预候选字列表。 > 为预候选字列表则注册EVT\_IM\_SHOW\_PRE\_CANDIDATES,否则注册EVT\_IM\_SHOW\_CANDIDATES事件。 * 函数原型: ``` ret_t candidates_set_pre (widget_t* widget, bool_t pre); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | pre | bool\_t | 是否为预候选字列表。 | #### candidates\_set\_select\_by\_num 函数 ----------------------- * 函数功能: >
设置是否启用用数字选择候选字。 * 函数原型: ``` ret_t candidates_set_select_by_num (widget_t* widget, bool_t select_by_num); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | 控件对象。 | | select\_by\_num | bool\_t | 是否启用用数字选择候选字。 | #### auto\_hide 属性 ----------------------- >
没有候选字时,是否自动隐藏控件。 * 类型:bool\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### button\_style 属性 ----------------------- >
是否启用候选字预览。 * 类型:bool\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### pre 属性 ----------------------- >
是否为预候选字。 > 预候选字: 在有的输入法中,比如T9硬键盘输入时,按下12两个键时,预候选字会显示可用的拼音列表。 > 从预候选字列表中选择拼音,再查询拼音对应的候选字列表。 * 类型:bool\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### select\_by\_num 属性 ----------------------- >
是否启用用数字选择候选字。比如按下1选择第1个候选字,按下2选择第2个候选字。 * 类型:bool\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 |