## mledit\_t
### 概述
![image](images/mledit_t_0.png)
多行编辑器控件。
mledit\_t是[widget\_t](widget_t.md)的子类控件,widget\_t的函数均适用于mledit\_t控件。
在xml中使用"mledit"标签创建多行编辑器控件。如:
```xml
| 函数名称 | 说明 | | -------- | ------------ | | mledit\_cast | 转换为mledit对象(供脚本语言使用)。 | | mledit\_create | 创建mledit对象 | | mledit\_set\_focus | 设置为焦点。 | | mledit\_set\_input\_tips | 设置编辑器的输入提示。 | | mledit\_set\_max\_lines | 设置编辑器的最大行数。 | | mledit\_set\_readonly | 设置编辑器是否为只读。 | | mledit\_set\_wrap\_word | 设置编辑器是否自动折行。 | ### 属性
| 属性名称 | 类型 | 说明 | | -------- | ----- | ------------ | | bottom\_margin | uint8\_t | 下边距。 | | left\_margin | uint8\_t | 左边距。 | | max\_lines | uint32\_t | 最大行数。 | | readonly | bool\_t | 编辑器是否为只读。 | | right\_margin | uint8\_t | 右边距。 | | tips | char* | 输入提示。 | | top\_margin | uint8\_t | 上边距。 | | wrap\_word | bool\_t | 是否自动折行。 | ### 事件
| 事件名称 | 类型 | 说明 | | -------- | ----- | ------- | | EVT\_VALUE\_CHANGING | event\_t | 文本正在改变事件(编辑中)。 | | EVT\_VALUE\_CHANGED | event\_t | 文本改变事件。 | #### mledit\_cast 函数 ----------------------- * 函数功能: >
转换为mledit对象(供脚本语言使用)。 * 函数原型: ``` widget_t* mledit_cast (widget_t* widget); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | widget\_t* | mledit对象。 | | widget | widget\_t* | mledit对象。 | #### mledit\_create 函数 ----------------------- * 函数功能: >
创建mledit对象 * 函数原型: ``` widget_t* mledit_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 | 高度 | #### mledit\_set\_focus 函数 ----------------------- * 函数功能: >
设置为焦点。 * 函数原型: ``` ret_t mledit_set_focus (widget_t* widget, bool_t focus); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | widget对象。 | | focus | bool\_t | 是否为焦点。 | #### mledit\_set\_input\_tips 函数 ----------------------- * 函数功能: >
设置编辑器的输入提示。 * 函数原型: ``` ret_t mledit_set_input_tips (widget_t* widget, char* tips); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | widget对象。 | | tips | char* | 输入提示。 | #### mledit\_set\_max\_lines 函数 ----------------------- * 函数功能: >
设置编辑器的最大行数。 * 函数原型: ``` ret_t mledit_set_max_lines (widget_t* widget, uint32_t max_lines); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | widget对象。 | | max\_lines | uint32\_t | 最大行数。 | #### mledit\_set\_readonly 函数 ----------------------- * 函数功能: >
设置编辑器是否为只读。 * 函数原型: ``` ret_t mledit_set_readonly (widget_t* widget, bool_t readonly); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | widget对象。 | | readonly | bool\_t | 只读。 | #### mledit\_set\_wrap\_word 函数 ----------------------- * 函数功能: >
设置编辑器是否自动折行。 * 函数原型: ``` ret_t mledit_set_wrap_word (widget_t* widget, bool_t wrap_word); ``` * 参数说明: | 参数 | 类型 | 说明 | | -------- | ----- | --------- | | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败。 | | widget | widget\_t* | widget对象。 | | wrap\_word | bool\_t | 是否自动折行。 | #### bottom\_margin 属性 ----------------------- >
下边距。 * 类型:uint8\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### left\_margin 属性 ----------------------- >
左边距。 * 类型:uint8\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### max\_lines 属性 ----------------------- >
最大行数。 * 类型:uint32\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### readonly 属性 ----------------------- >
编辑器是否为只读。 * 类型:bool\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### right\_margin 属性 ----------------------- >
右边距。 * 类型:uint8\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### tips 属性 ----------------------- >
输入提示。 * 类型:char* | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### top\_margin 属性 ----------------------- >
上边距。 * 类型:uint8\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 | #### wrap\_word 属性 ----------------------- >
是否自动折行。 * 类型:bool\_t | 特性 | 是否支持 | | -------- | ----- | | 可直接读取 | 是 | | 可直接修改 | 否 | | 可持久化 | 是 | | 可脚本化 | 是 | | 可在IDE中设置 | 是 | | 可在XML中设置 | 是 | | 可通过widget\_get\_prop读取 | 是 | | 可通过widget\_set\_prop修改 | 是 |