VincentWei/minigui-docs

Fork 0

mirror of https://github.com/VincentWei/minigui-docs.git synced 2025-10-20 13:24:04 +08:00

Files

Vincent Wei 39379d6497 tune format manually

2019-10-28 17:05:45 +08:00

26 KiB

Raw Blame History

第二部分第十二章编辑框系列控件

Chapter 12 of Part 2 Edit Box Series Control

编辑框控件简介

Brief Introduction of Edit Box Control

编辑框控件（Edit）是GUI系统中不可或缺的的重要控件之一，主要用于接受用户的字符输入，实现用户交互和文本编辑的功能。实现上分为单行编辑框（Single Line Edit）和多行编辑框（Multiline Edit），单行编辑框用来接受用户内容相对简单的单行文本输入，与之相对，多行文本用来接受复杂的、大量的文本的输入。

Edit box control is one of the essential controls in GUI system, which is mainly used to receive character input of the users and realize the function of user interaction and text edition. In Realization, it is divided into single line edit and multiline edit. Single line edit box is used to receive single line text input with comparatively simple user content, in comparison, multiline text is used to receive complicated and large volume of text input.

编辑框类层次关系
Class hierarchical relation of edit box
mWidget

示例图:
Example diagram

`mEdit`

控件窗口类: NCSCTRL_EDIT
控件英文名: Edit
简介: 编辑框系列控件的基础类，是单行编辑框和多行编辑框的抽象父类，定义了两者共同的使用接口。
示意图: %RED%抽象类,不能直接使用%ENDCOLOR%
Control window class: NCSCTRL_EDIT
Control English name: Edit
Brief introduction: Foundation class of edit box series controls, it is the abstract parent class of single line edit box and multiline edit box, which defines the common use interface of the two.
Schematic diagram: %RED%Abstract class, and cannot be used directly%ENDCOLOR%

`mEdit风格`

Style of `mEdit`

`mEdit属性`

Property of `mEdit`

继承自 mScrollView 的属性 | 属性 | mstudio属性名 | 类型 | 权限 | 说明 | | NCSP_EDIT_LIMITTEXT | MaxLength | int | RW | 字符数目限定值 | | NCSP_EDIT_CARETPOS | -- | int | RW | 光标位置 |

`mEdit事件`

Event of `mEdit`

`mEdit方法`

Method of `mEdit`

继承自 mScrollView 的方法

It is inherited from the method of mScrollView

`setContent`

void setContent(mEdit *self, const char* str, int start, int len)

参数：
str -- 显示在edit中的文字内容
start -- 显示开始位置(相对str的起始位置)，0表示从头开始
len -- 显示字符数目，-1表示一直到str的结束为止
说明：
设置编辑框的显示内容，该方法会从str字符串中获取从第个字符位置开始的一共个字符，替换掉edit中现有的内容。
示例：
Parameter
str -- literal content displayed in edi
start -- display starting location (relative to the starting location of str), 0 represents starting from the beginning
len -- display character number, -1 represents ending till the end of str
Explanation:
Set the display content of the edit box. The method will get altogether characters from No. character location from str character string, and replace the existing content in edit.
Example:

//edit中会显示字符串"dddd Show Me"从第6个字符开始一直到结尾的字符串，这里就是“Show Me”

// In edit, character string starting from the sixth character till the end of characterstring “dddd Show Me” will be displayed, and here it is “Show Me”
_c(edit)->setContent(edit, "dddd Show Me", 6, -1);

`replaceText`

void replaceText(mEdit *self, const char* str, 
    int start, int len, int replace_start, int replace_end)

参数：
str -- 用于替换的源字符串
start -- 用于替换的源文本相对于str的的偏移，0表示从头开始
len -- 用到的源文本的长度，-1表示从start开始，直到str结束
replace_start -- 替换开始的位置（相对于edit中的现有内容）
replace_end -- 替换结束的位置（相对于edit中的现有内容）
说明：

字符串的替换，该方法会从str字符串中获取从第个字符位置开始的一共个字符，替换掉edit中现有的从<replace_start>到<repalce_end>的内容。str是要替换成的字符串，start是相对str的起始位置，0表示从头开始，len是长度，-1表示一直到str的结束为止，replace_start、replace_end分别是要替换的位置的起点和终点，是相对于edit中现有的文本内容的位置偏移。

示例：
Parameter
str -- source character string used for replacement
start -- deviation of the source text used for replacement relative to str, 0 represents starting from the beginning
len -- length used to the source text, -1 represents starting from start and ending till str
replace_start -- replace the starting location (relative to the existing content in edit)
replace_end -- replace the ending location (relative to the existing content in edit)
Explanation:
Replacement of character string, the method will get altogether characters starting from No. character location from str character string, and replaces the existing content from to in edit. Str is the character string to be replaced to, start is the starting location relative to str, 0 represents starting from the beginning, len is the length, -1 represents ending till the end of str, replace_start and replace_end are the starting point and ending point of the location to be replaced, and they are location deviation relative to the existing text content in edit.
Example:

//edit中会用字符串"dddd Show Me"从第6个字符开始一直到结尾的字符串（这里就是“Show Me”），
//来替换掉edit中现有文本的从第二个到第十个的字符

// In edit, character string starting from the sixth character to the end of the character string “dddd Show Me” will be used (here it is “Show Me”),
// To replace the characters from the second one to the tenth one of the existing text in edit
_c(edit)->replaceText(edit, "dddd Show Me", 6, -1, 2, 10);

insert

void insert(mEdit *self, const char* str, int start, int len, int at)

参数：
str -- 要插入的源字符串
start -- 使用到的源文本的起始位置，0表示从头开始
len -- 使用到的源文本的长度，-1表示从start开始，直到str结束
at -- 插入点的位置（相对于edit中的现有内容）,-1表示结尾处
说明：

字符串的插入，该方法会从str字符串中获取从第个字符位置开始的一共个字符，插入到edit中现有的内容的第个字符的位置。str是要插入的字符串，start是相对str的起始位置，0表示从头开始，len是长度，-1表示一直到str的结束为止, at参数是要插入的位置，是相对于edit中现有的文本内容的位置偏移。

示例：
Parameter
str -- source character string to be inserted
start -- starting location of the source text used, 0 represents starting from the beginning
len -- length of the source text used, -1 represents starting from start, and ending till str
at -- location of the insert point (relative to the existing content in edit), -1 represents the end
Explanation:
Insert of the character string, the method will get altogether characters starting from No. character location in str character string, and it is inserting into location of No. character of the existing content in edit. Str is the character string to be inserted, start is the starting location relative to str, 0 represents starting from the beginning, len is the length, -1 represents ending till the end of str, at parameter is the location to insert, and it is the location deviation relative to the existing text content in edit
Example:

//edit中会用字符串"dddd Show Me"从第6个字符开始一直到结尾的字符串（这里就是“Show Me”），
//来插入到edit中现有文本的从第二个字符之后

//In edit, character string starting from the sixth character till the end of the character string “dddd Show Me” will be used (here it is “Show Me”), 
// To insert to after the second character of the existing text in edit
_c(edit)->insert(edit, "dddd Show Me", 6, -1,  2);

append

void append(mEdit *self, const char* str, int start, int len)

参数：
str -- 要追加的源字符串
start -- 使用到的源文本的起始位置，0表示从头开始
len -- 使用到的源文本的长度，-1表示从start开始，直到str结束
说明：

字符串的追加，该方法会从str字符串中获取从第个字符位置开始的一共个字符，追加到edit中现有的内容的后面。str是要追加的字符串，start是相对str的起始位置，0表示从头开始，len是长度，-1表示一直到str的结束为止。

示例：
Parameter
str -- source character string to append
start -- starting location of the source text used, 0 represents starting from the beginning
len -- length of the source text used, -1 represents starting from start and ending till str
Explanation:
Append the character string, the method will get altogether characters starting from No. character location from str character string, and append to after the existing content in edit. str is the character string to append, start is the starting location relative to str, 0 represents starting from the beginning, len is the length, and -1 represents ending till the end of str.
Example:

//edit中会用字符串"dddd Show Me"从第6个字符开始一直到结尾的字符串（这里就是“Show Me”），
//来追加到edit中现有文本的末尾

// In edit, character string starting from the sixth character till the end of the character string “dddd Show Me” will be used (here it is “Show Me”),
// To append till the end of the existing text in edit
_c(edit)->append(edit, "dddd Show Me", 6, -1);

`getTextLength`

int getTextLength(mEdit *self)

说明：
获取Edit中字符串内容的长度
示例：
Explanation:
Get length of the content of the character string in Edit
Example:

int text_len = _c(edit)->getTextLength(edit);

`getContent`

int getContent(mEdit *self, char *strbuff, int buf_len, int start, int end)

参数：
strbuff -- 获取到字符串的存放位置（应该提前分配好存放空间）
buff_len -- strbuff的大小
start -- 获取内容的起始位置
end -- 获取内容的终止位置
说明：
获取Edit中字符串内容，从现有的内容中获取从到位置的内容写入到strbuff中，写入的最大数目限定为buff_len。
示例：
Parameter:
strbuff -- get storage location to the character string (storage space shall be distributed in advance)
buff_len -- size of strbuff
start -- starting location of the obtained content
end -- ending location of the obtained content
Explanation:
Get character string content in edit, and get the content from to location from the existing content and write into strbuff, and the maximum number to write in is limited to buff_len.
Example:

char buff[128];
_c(edit)->getContent(edit, buff, 127, 0, -1);//取出edit中的全部内容，buff最多存127个字符

// Get out all the content in edit, and buff stores 127 characters to the maximum

`setSel、getSel`

    int setSel(mEdit *self, int start, int end)
    int getSel(mEdit *self, int *pstart, int *pend)

参数：
start \end -- 选中区域的起点、终点
pstart\pend -- 选中区域的起点、终点，用于函数返回
说明：
设置、获取选中文本的区域，后两个参数分别对应选中区域的起点和终点。
示例：
Parameter:
start \end -- starting point and ending point of the selected region
pstart\pend -- starting point and ending point of the selected region, used for function return
Explanation:
Set and get the region of the selected text, and the last two parameters correspond to the starting point and ending point of the selected region respectively
Example:

_c(edit)->setSel(edit, 2, 10);//设置edit的第2~10个字符为选中状态

// Set No.2 to No.10 characters of edit as selected status

int ps,pe;
_c(edit)->getSel(edit, &ps, &pe);//获取选中区域

// Get the selected region

`setMargin`

void setMargin(mEdit *self, int left, int top, int right, int bottom)

参数：
left,top,right,bottom -- 上下左右的留白，这个参数不是矩形的概念，只是沿用了矩形的数据结构方便参数传递
说明：
设置编辑区的上下左右留白
示例：
Parameter:
left,top,right,bottom -- margin of left, top, right and bottom, the parameter is not a concept of rectangle, and it just continues to use the data structure of rectangle for the convenience of parameter transmission
Explanation:
Set left, top, right and bottom margin of the edit region
Example:

//设置留白

// Set margin
_c(edit)- >setMargin(edit, 10,10,10,10);

copy、paste、cut

    void copy(mEdit *self)
    void cut(mEdit *self)
    void paste(mEdit *self)
    TextCopyPaste * setCopyPaste(mEdit *self, TextCopyPaste* cp)

剪切、复制、粘贴都是针对选中区域的操作，edit中默认实现了一组使用minigui剪切板的操作集,用户还可以通过setCopyPaste设置自己实现的操作集。

Cut, copy and paste aim at the operation of the selected region. In edit, a group of operation set using minigui cut board is realized by default, and the users can set operation set realized by itself through setCopyPaste.

makevisible

    BOOL makevisible(mEdit *self, int pos)

参数：
pos -- 需要可见的位置
说明：
控制编辑区的滚动，使位置的字符变为可见。
示例：
Parameter:
pos -- location needs to be visible
Explanation:
Control scrolling of the edit region, making the characters of the location become visible.
Example:

//是第201个字符处可见

// Visible at No. 201 character
_c(edit)- >makevisible(edit, 201);

`mSlEdit`

控件窗口类: NCSCTRL_SLEDIT
控件英文名: Single Line Edit 或者SlEdit
简介: 单行文本编辑框
示意图:
Control window class: NCSCTRL_SLEDIT
Control English name: Single Line Edit 或者SlEdit
Brief introduction: Single line text edit box
Schematic diagram:

`mSlEdit风格`

Style of `mSIEdit`

`mSlEdit属性`

Property of `mSIEdit`

`mSlEdit事件`

Event of `mSIEdit`

继承自 mEdit 的事件 | 事件ID | 参数 | 说明 | | NCSN_SLEDIT_ENTER | -- | 捕获到enter键消息 |

`mSlEdit方法`

Method of `mSIEdit`

继承自 mEdit 的方法
%RED%没有新引入的方法%ENDCOLOR%

It is inherited from the method of mEdit
%RED%There is no newly introduced method%ENDCOLOR%

`mSlEdit编程示例`

Programming Example of `mSIEdit`

SlEdit示例代码 ：edit.c
我们这样来定义SlEdit的使用模板
SlEdit Example code: edit.c
We define use template of SIEdit in this way

%INCLUDE{"%ATTACHURL%/edit.c.txt" pattern="^.*?//START_OF_SLEDIT_TEMPLATE(.*?)//END_OF_SLEDIT_TEMPLATE.*"}%

`mMlEdit`

控件窗口类: NCSCTRL_MLEDIT
控件英文名: Multiline Edit 或者 MlEdit
简介: 多行文本编辑框
示意图:
Control window class: NCSCTRL_MLEDIT
Control English name: Multiline Edit 或者 MlEdit
Brief introduction: Multiline text edit box
Schematic diagram:

`mMlEdit风格`

Style of `mMIEdit`

`mMlEdit属性`

Property of `mMIEdit`

继承自 mEdit 的属性 | 属性 | mstudio属性名 | 类型 | 权限 | 说明 | | NCSP_MLEDIT_LINECOUNT| -- | int | RO | 行数 | | NCSP_MLEDIT_LINEHEIGHT| LineHeight | int | RW | 行高 | | NCSP_MLEDIT_LINEFEEDISPCHAR | -- | char | WO | 换行符改用该字符显示出来 | | NCSP_MLEDIT_LINESEP | LineSeperator | char | RW | 换行符标记，默认是‘\n’ | | NCSP_MLEDIT_CARETSHAPE | CaretShap | int | RW | 光标形状ED_CARETSHAPE_LINE 或者 ED_CARETSHAPE_BLOCK | | NCSP_MLEDIT_NUMOFPARAGRAPHS | -- | int | RO | 段落的数目 |

`mMlEdit事件`

Event of `mMIEdit`

继承自 mEdit 的事件
%RED%没有新引入的事件%ENDCOLOR%

It is inherited from the event of mEdit
%RED%There is no newly introduced event%ENDCOLOR%

`mMlEdit方法`

Method of `mMIEdit`

继承自 mEdit 的方法

It is inherited from the method of mEdit

`mMlEdit编程示例`

Programming Example of `mMIEdit`

MlEdit示例代码 ：edit.c
我们这样来定义MlEdit的使用模板
MlEdit Example code: edit.c
We define the use template of MIEdit in this way

%INCLUDE{"%ATTACHURL%/edit.c.txt" pattern="^.*?//START_OF_MLEDIT_TEMPLATE(.*?)//END_OF_MLEDIT_TEMPLATE.*"}%

[Next](MStudioMGNCSV1dot0PGP2C11][Previous]] < MStudioMGNCSV1dot0PG][Index > [[MStudioMGNCSV1dot0PGP2C13)

-- Main.XiaodongLi - 22 Feb 2010

<< | Table of Contents | >>

26 KiB Raw Blame History Unescape Escape

第二部分 第十二章 编辑框系列控件

Chapter 12 of Part 2 Edit Box Series Control

编辑框控件简介

Brief Introduction of Edit Box Control

mEdit

mEdit风格

Style of mEdit

mEdit属性

Property of mEdit

mEdit事件

Event of mEdit

mEdit方法

Method of mEdit

setContent

replaceText

insert

append

getTextLength

getContent

setSel、getSel

setMargin

copy、paste、cut

makevisible

mSlEdit

mSlEdit风格

Style of mSIEdit

mSlEdit属性

Property of mSIEdit

mSlEdit事件

Event of mSIEdit

mSlEdit方法

Method of mSIEdit

mSlEdit编程示例

Programming Example of mSIEdit

mMlEdit

mMlEdit风格

Style of mMIEdit

mMlEdit属性

Property of mMIEdit

mMlEdit事件

Event of mMIEdit

mMlEdit方法

Method of mMIEdit

mMlEdit编程示例

Programming Example of mMIEdit