awtk/docs/manual/edit_t.md

## edit\_t
### 概述
 文本控件。
![image](images/edit_t_0.png)

### 函数
<p id="edit_t_methods">

| 函数名称 | 说明 | 
| -------- | ------------ | 
| <a href="#edit_t_edit_cast">edit\_cast</a> |  转换为edit对象(供脚本语言使用)。
 |
| <a href="#edit_t_edit_create">edit\_create</a> |  创建edit对象
 |
| <a href="#edit_t_edit_get_double">edit\_get\_double</a> |  获取double类型的值。
 |
| <a href="#edit_t_edit_get_int">edit\_get\_int</a> |  获取int类型的值。
 |
| <a href="#edit_t_edit_set_auto_fix">edit\_set\_auto\_fix</a> |  设置编辑器是否为自动改正。
 |
| <a href="#edit_t_edit_set_double">edit\_set\_double</a> |  设置double类型的值。
 |
| <a href="#edit_t_edit_set_float_limit">edit\_set\_float\_limit</a> |  设置为浮点数输入及取值范围。
 |
| <a href="#edit_t_edit_set_input_tips">edit\_set\_input\_tips</a> |  设置编辑器的输入提示。
 |
| <a href="#edit_t_edit_set_input_type">edit\_set\_input\_type</a> |  设置编辑器的输入类型。
 |
| <a href="#edit_t_edit_set_int">edit\_set\_int</a> |  设置int类型的值。
 |
| <a href="#edit_t_edit_set_int_limit">edit\_set\_int\_limit</a> |  设置为整数输入及取值范围。
 |
| <a href="#edit_t_edit_set_password_visible">edit\_set\_password\_visible</a> |  当编辑器输入类型为密码时，设置密码是否可见。
 |
| <a href="#edit_t_edit_set_readonly">edit\_set\_readonly</a> |  设置编辑器是否为只读。
 |
| <a href="#edit_t_edit_set_text_limit">edit\_set\_text\_limit</a> |  设置为文本输入及其长度限制，不允许输入超过max个字符，少于min个字符时进入error状态。
 |
### 属性
<p id="edit_t_properties">

| 名属性称 | 类型 | 说明 | 
| -------- | ----- | ------------ | 
| <a href="#edit_t_auto_fix">auto\_fix</a> | bool_t |  输入无效时，是否自动改正。
 |
| <a href="#edit_t_bottom_margin">bottom\_margin</a> | uint8_t |  下边距。
 |
| <a href="#edit_t_input_type">input\_type</a> | input_type_t |  输入类型。XXX：需要在min/max/step之前设置。
 |
| <a href="#edit_t_left_margin">left\_margin</a> | uint8_t |  左边距。
 |
| <a href="#edit_t_max">max</a> | char* |  最大值或最大长度。
 |
| <a href="#edit_t_min">min</a> | char* |  最小值或最小长度。
 |
| <a href="#edit_t_password_visible">password\_visible</a> | bool_t |  密码是否可见。
 |
| <a href="#edit_t_readonly">readonly</a> | bool_t |  编辑器是否为只读。
 |
| <a href="#edit_t_right_margin">right\_margin</a> | uint8_t |  右边距。
 |
| <a href="#edit_t_step">step</a> | char* |  步长。
 |
| <a href="#edit_t_tips">tips</a> | char* |  输入提示。
 |
| <a href="#edit_t_top_margin">top\_margin</a> | uint8_t |  上边距。
 |
### 事件
<p id="edit_t_events">

| 事件名称 | 类型  | 说明 | 
| -------- | ----- | ------- | 
| EVT\_VALUE\_CHANGING | event\_t | 文本正在改变事件(编辑中)。 |
| EVT\_VALUE\_CHANGED | event\_t | 文本改变事件。 |
#### edit\_cast 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | edit对象。 |
| widget | widget\_t* | edit对象。 |
<p id="edit_t_edit_cast"> 转换为edit对象(供脚本语言使用)。



#### edit\_create 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | widget\_t* | 对象。 |
| parent | widget\_t* | 父控件 |
| x | xy\_t | x坐标 |
| y | xy\_t | y坐标 |
| w | wh\_t | 宽度 |
| h | wh\_t | 高度 |
<p id="edit_t_edit_create"> 创建edit对象



#### edit\_get\_double 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | double | 返回double的值。 |
| widget | widget\_t* | widget对象。 |
<p id="edit_t_edit_get_double"> 获取double类型的值。



#### edit\_get\_int 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回int的值。 |
| widget | widget\_t* | widget对象。 |
<p id="edit_t_edit_get_int"> 获取int类型的值。



#### edit\_set\_auto\_fix 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| auto\_fix | bool\_t | 自动改正。 |
<p id="edit_t_edit_set_auto_fix"> 设置编辑器是否为自动改正。



#### edit\_set\_double 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| value | double | 值。 |
<p id="edit_t_edit_set_double"> 设置double类型的值。



#### edit\_set\_float\_limit 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| min | double | 最小值。 |
| max | double | 最大值。 |
| step | double | 步长。 |
<p id="edit_t_edit_set_float_limit"> 设置为浮点数输入及取值范围。



#### edit\_set\_input\_tips 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| tips | char* | 输入提示。 |
<p id="edit_t_edit_set_input_tips"> 设置编辑器的输入提示。



#### edit\_set\_input\_type 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| type | input\_type\_t | 输入类型。 |
<p id="edit_t_edit_set_input_type"> 设置编辑器的输入类型。



#### edit\_set\_int 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| value | int32\_t | 值。 |
<p id="edit_t_edit_set_int"> 设置int类型的值。



#### edit\_set\_int\_limit 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| min | int32\_t | 最小值。 |
| max | int32\_t | 最大值。 |
| step | int32\_t | 步长。 |
<p id="edit_t_edit_set_int_limit"> 设置为整数输入及取值范围。



#### edit\_set\_password\_visible 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| password\_visible | bool\_t | 密码是否可见。 |
<p id="edit_t_edit_set_password_visible"> 当编辑器输入类型为密码时，设置密码是否可见。



#### edit\_set\_readonly 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| readonly | bool\_t | 只读。 |
<p id="edit_t_edit_set_readonly"> 设置编辑器是否为只读。



#### edit\_set\_text\_limit 函数
-----------------------

| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| widget | widget\_t* | widget对象。 |
| min | uint32\_t | 最小长度。 |
| max | uint32\_t | 最大长度。 |
<p id="edit_t_edit_set_text_limit"> 设置为文本输入及其长度限制，不允许输入超过max个字符，少于min个字符时进入error状态。



#### auto\_fix 属性
-----------------------
<p id="edit_t_auto_fix"> 输入无效时，是否自动改正。


* 类型：bool\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### bottom\_margin 属性
-----------------------
<p id="edit_t_bottom_margin"> 下边距。


* 类型：uint8\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### input\_type 属性
-----------------------
<p id="edit_t_input_type"> 输入类型。XXX：需要在min/max/step之前设置。


* 类型：input\_type\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 否 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 否 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### left\_margin 属性
-----------------------
<p id="edit_t_left_margin"> 左边距。


* 类型：uint8\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### max 属性
-----------------------
<p id="edit_t_max"> 最大值或最大长度。


* 类型：char*

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 否 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 否 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### min 属性
-----------------------
<p id="edit_t_min"> 最小值或最小长度。


* 类型：char*

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 否 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 否 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### password\_visible 属性
-----------------------
<p id="edit_t_password_visible"> 密码是否可见。


* 类型：bool\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### readonly 属性
-----------------------
<p id="edit_t_readonly"> 编辑器是否为只读。


* 类型：bool\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### right\_margin 属性
-----------------------
<p id="edit_t_right_margin"> 右边距。


* 类型：uint8\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### step 属性
-----------------------
<p id="edit_t_step"> 步长。


* 类型：char*

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 否 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 否 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### tips 属性
-----------------------
<p id="edit_t_tips"> 输入提示。


* 类型：char*

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |
#### top\_margin 属性
-----------------------
<p id="edit_t_top_margin"> 上边距。


* 类型：uint8\_t

| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |
| 可持久化   | 是 |
| 可脚本化   | 是 |
| 可在IDE中设置 | 是 |
| 可在XML中设置 | 是 |
| 支通过widget_get_prop读取 | 是 |
| 支通过widget_set_prop修改 | 是 |