Messages of edit control
[Edit/MEdit control]

Data Structures

Defines

Typedefs


Define Documentation

#define ED_CARETSHAPE_BLOCK   1

Block-shaped caret.

Definition at line 755 of file edit.h.

#define ED_CARETSHAPE_LINE   0

Line-shaped caret.

Definition at line 749 of file edit.h.

#define EM_CHANGECARETSHAPE   0xF0D3

Changes the shape of the caret.

 EM_CHANGECARETSHAPE

 int caret_shape;
 
 wParam = (WPARAM)caret_shape;
 lParam = 0;
Parameters:
caret_shape Shape index of the caret, can be ED_CARETSHAPE_LINE or ED_CARETSHAPE_BLOCK.
Returns:
The old create shape

Definition at line 774 of file edit.h.

#define EM_COPYTOCB   0xF0B5

Copies the currently selected text to the clipboard.

 EM_COPYTOCB

 wParam = 0;
 lParam = 0
Returns:
Length of the text which is really copied to clipboard.

Definition at line 331 of file edit.h.

#define EM_CUTTOCB   0xF0B6

Cuts the currently selected text to the clipboard.

 EM_CUTTOCB

 wParam = 0;
 lParam = 0
Returns:
Length of the text which is really copied to clipboard.

Definition at line 346 of file edit.h.

#define EM_ENABLECARET   0xF0D5

To enable or disable the input caret.

 EM_ENABLECARET

 BOOL bEnable;

 wParam = (WPARAM)bEnable;
 lParam = 0;
Parameters:
bEnable TRUE to enable caret.
Returns:
The previous caret enabled status.

Definition at line 799 of file edit.h.

#define EM_FMTLINES   0xF0C8

reserved.

Definition at line 609 of file edit.h.

#define EM_GETCARETPOS   0xF0B9

Gets the position of the caret.

 EM_GETCARETPOS
 int* line_pos;
 int* char_pos;

 wParam = (WPARAM)line_pos;
 lParam = (LPARAM)char_pos;
Parameters:
line_pos Pointer to a integer buffer to save the caret line position. For single line editor, it is always zero. Note : Here "line" means a text string ended with a line seperator, not a single text line in wrap mode. So, char_pos means the character position in a text string.
char_pos Pointer to a integer buffer to save the caret character position.
Returns:
The string length of the text from the beginning to the caret pos.

Definition at line 414 of file edit.h.

#define EM_GETCARETPOSBYLINE   0xF0DA

Gets the position of the caret.

 EM_GETCARETPOSBYLINE
 int* line_pos;
 int* char_pos;

 wParam = (WPARAM)line_pos;
 lParam = (LPARAM)char_pos;
Parameters:
line_pos Pointer to a integer buffer to save the caret line position. For single line editor, it is always zero.
char_pos Pointer to a integer buffer to save the caret character position.
Returns:
The string length of the text from the beginning to the caret pos.

Definition at line 1073 of file edit.h.

#define EM_GETLIMITTEXT   0xF0D6

Get text limit value of the edit control.

Returns:
-1 when user doesn't set limit value, otherwise return current limit value.

Definition at line 808 of file edit.h.

#define EM_GETLINE   0xF0C4

reserved.

Definition at line 558 of file edit.h.

#define EM_GETLINECOUNT   0xF0BC

Gets the line number.

 EM_GETLINECOUNT

 wParam = 0;
 lParam = 0;
Returns:
Line number on success, otherwise -1.
Note:
Implemented for TextEdit control.

Definition at line 464 of file edit.h.

#define EM_GETLINEHEIGHT   0xF0BD

Gets the height of a line.

 EM_GETLINEHEIGHT

 wParam = 0;
 lParam = 0;
Returns:
Height value.
Note:
Implemented for TextEdit control.

Definition at line 480 of file edit.h.

#define EM_GETLINELENGTH   0xF0E7

Gets the specified line length in textedit control.

 EM_GETLINELENGTH
 wParam = (WPARAM) index;
Returns:
The length of text.

Definition at line 1141 of file edit.h.

#define EM_GETLINELENGTHINMCHAR   0xF0E6

Gets the specified line length in textedit control. in charactors not byte.

 EM_GETLINELENGTHINMCHAR
 wParam = (WPARAM) index;
Returns:
The length of text.

Definition at line 1128 of file edit.h.

#define EM_GETLINETEXT   0xF0E8

Gets the specified line text from textedit control.

 EM_GETLINETEXT
 const char buffer[BUF_SIZE];
 TEXTPOSINFO info;

 info.start_pos = 0;
 info.copy_len = BUF_SIZE;
 info.buff = buffer;
 info.line_index = -1;

 wParam = (WPARAM)&info;
Returns:
The copied length of text which doesn't include terminate character 0x0.

Definition at line 1163 of file edit.h.

#define EM_GETMAXLIMIT   0xF0C3

Get text limit of a single-line edit control.

Definition at line 550 of file edit.h.

#define EM_GETNUMOFPARAGRAPHS   0xF0E0

Gets the number of paragraphs in textedit control.

Returns:
The number of paragraphs.

Definition at line 976 of file edit.h.

#define EM_GETPARAGRAPHLENGTH   0xF0E1

Gets the specified paragraph length in textedit control.

 EM_GETPARAGRAPHLENGTH
 wParam = (WPARAM) index;
Returns:
The length of text.

Definition at line 988 of file edit.h.

#define EM_GETPARAGRAPHLENGTHINMCHAR   0xF0E5

Gets the specified paragraph length in textedit control. in text not charactors.

 EM_GETPARAGRAPHLENGTHINCHAR
 wParam = (WPARAM) index;
Returns:
The length of text.

Definition at line 1114 of file edit.h.

#define EM_GETPARAGRAPHTEXT   0xF0E2

Gets the specified paragraph text from textedit control.

 EM_GETPARAGRAPHTEXT
 const char buffer[BUF_SIZE];
 TEXTPOSINFO info;

 info.start_pos = 0;
 info.copy_len = BUF_SIZE;
 info.buff = buffer;
 info.paragraph_index = -1;

 wParam = (WPARAM)&info;
Returns:
The copied length of text which doesn't include terminate character 0x0.

Definition at line 1009 of file edit.h.

#define EM_GETPASSWORDCHAR   0xF0D2

Returns the character that edit controls uses in conjunction with the ES_PASSWORD style.

 EM_GETPASSWORDCHAR

 wParam = 0;
 lParam = 0;
Returns:
The currently used password character

Definition at line 737 of file edit.h.

#define EM_GETSEL   0xF0B0

Gets the selected string in the edit control.

 EM_GETSEL

 char *buffer;
 int len;

 wParam = (WPARAM)len;
 lParam = (LPARAM)buffer;
Parameters:
len Length of buffer.
buffer Pointer to the string buffer
Returns:
Length of the selected string

Definition at line 220 of file edit.h.

#define EM_GETSELPOS   0xF0B3

Gets the position of the selection point.

 EM_GETSELPOS
 int* line_pos;
 int* char_pos;

 wParam = (WPARAM)line_pos;
 lParam = (LPARAM)char_pos;
Parameters:
line_pos Pointer to a integer buffer to save the selection line position. For single line editor, it is always zero. Note : Here "line" means a text string ended with a line seperator, not a single text line in wrap mode. So, char_pos means the character position in a text string.
char_pos Pointer to a integer buffer to save the selection character position.
Returns:
The string length of the text from the beginning to the selection point.

Definition at line 298 of file edit.h.

#define EM_GETSELPOSBYLINE   0xF0E4

Gets the position of the selection point.

 EM_GETSELPOSBYLINE
 int* line_pos;
 int* char_pos;

 wParam = (WPARAM)line_pos;
 lParam = (LPARAM)char_pos;
Parameters:
line_pos Pointer to a integer buffer to save the selection line position. For single line editor, it is always zero.
char_pos Pointer to a integer buffer to save the selection character position.
Returns:
The string length of the text from the beginning to the selection point.

Definition at line 1100 of file edit.h.

#define EM_GETTIPTEXT   0xF0DF

Gets the tip text displayed when content is empty.

 EM_GETTIPTEXT
 const char *buffer;
 int len;

 wParam = (WPARAM)len;
 lParam = (LPARAM)buffer;
Parameters:
len Should be length of buffer minus 1, left space for '\0'
buffer String buffer
Returns:
Length of tip text

Definition at line 948 of file edit.h.

#define EM_GETTITLETEXT   0xF0DD

Gets the title text displayed before content text.

 EM_GETTITLETEXT
 const char *buffer;
 int len;

 wParam = (WPARAM)len;
 lParam = (LPARAM)buffer;
Parameters:
len Should be length of buffer minus 1, left space for '\0'
buffer String buffer
Returns:
Length of title
Note:
Implemented for TextEdit control.

Definition at line 912 of file edit.h.

#define EM_INSERTCBTEXT   0xF0B4

Inserts the text in the clipboard to the current caret position.

 EM_INSERTCBTEXT
 int len;
 const char *string;

 wParam = (WPARAM)len;
 lParam = (LPARAM)string;
Parameters:
len Length of string
string Pointer to the text string

Definition at line 316 of file edit.h.

#define EM_INSERTTEXT   0xF0C0

Inserts the specified text to the current caret position.

Normally used to input a long string.

 EM_INSERTTEXT
 int len;
 const char *string;

 wParam = (WPARAM)len;
 lParam = (LPARAM)string;
Parameters:
len Length of string
string Pointer to the text string

Definition at line 528 of file edit.h.

#define EM_LIMITTEXT   0xF0C5

Set text limit of an edit control.

 EM_LIMITTEXT
 int newLimit;

 wParam = (WPARAM)newLimit;
 lParam = 0;
Parameters:
newLimit The new text limit of an edit control, by character.

Definition at line 574 of file edit.h.

#define EM_LINEFROMCHAR   0xF0C9

reserved.

Definition at line 617 of file edit.h.

#define EM_LINELENGTH   0xF0C1

reserved.

Definition at line 536 of file edit.h.

#define EM_LINESCROLL   0xF0BF

reserved.

Definition at line 508 of file edit.h.

#define EM_REDO   0xF0C6

Redo operation.

 wParam = 0;
 lParam = 0;

Definition at line 587 of file edit.h.

#define EM_REFRESHCARET   0xF0D4

Refresh caret of the edit control.

Definition at line 780 of file edit.h.

#define EM_REPLACESEL   0xF0C2

reserved.

Definition at line 544 of file edit.h.

#define EM_SELECTALL   0xF0B2

Selects all the texts, the same meaning as ctrl+a.

 EM_SELECTALL

 wParam = 0;
 lParam = 0;

Definition at line 274 of file edit.h.

#define EM_SETCARETPOS   0xF0BA

Sets the position of the caret.

 EM_SETCARETPOS
 int line_pos;
 int char_pos;

 wParam = (WPARAM)line_pos;
 lParam = (LPARAM)char_pos;
Parameters:
line_pos The new caret line position. For single line editor, it will be ignored. Note : Here "line" means a text string ended with a line seperator, not a single text line in wrap mode. So, char_pos means the character position in a text string.
char_pos The new caret character position.
Returns:
Length of the string from the beginning to the caret position on success, otherwise -1.

Definition at line 438 of file edit.h.

#define EM_SETCARETPOSBYLINE   0xF0D9

Sets the selected point in the edit control and makes the text between insertion point and selection point selected. This is set by really line. That means if you set the TES_AUTOWRAP, the line number you set, the caret pos line number you see. This is different from EM_SETCARETPOS.

 EM_SETCARETPOSBYLINE

 int line_pos;
 int char_pos;

 wParam = (WPARAM)line_pos;
 lParam = (LPARAM)char_pos;
Parameters:
line_pos Line position of the selection point. For single line editor, it is always zero. Note : For multi-line editor, "line" means a text string ended with a line seperator, in wrap mode there also is the really line number. So, char_pos means the character position in a text string.
char_pos Character(wide character) position of the selection point.
Returns:
Length of the selected string

Definition at line 1051 of file edit.h.

#define EM_SETDRAWSELECTFUNC   0xF0D0

Sets the callback function on drawing selected chars.

 EM_SETDRAWSELECTFUNC
 ED_DRAWSEL_FUNC drawsel;

 wParam = 0;
 lParam = (LPARAM)drawsel;
Parameters:
drawsel The callback function used to draw selected strings.

Definition at line 697 of file edit.h.

#define EM_SETGETCARETWIDTHFUNC   0xF0D1

Sets the callback function on getting caret width.

 EM_SETGETCARETWIDTHFUNC
 int (*get_caret_width) (HWND, int);

 wParam = 0;
 lParam = (LPARAM)get_caret_width;
Parameters:
get_caret_width The callback function used to get caret width. The window handle and the maximum caret width are passed as arguments.
Returns:
The desired caret width.

Definition at line 716 of file edit.h.

#define EM_SETINSERTION   EM_SETCARETPOS
See also:
EM_SETCARETPOS

Definition at line 444 of file edit.h.

#define EM_SETLFDISPCHAR   0xF0B7

Sets the char used to represent the line seperator.

In default case, the line sperator will not be shown. If the char used to represent the line seperator is not zero, this char will be shown in place of line seperator.

 EM_SETLFDISPCHAR
 unsigned char ch;

 wParam = 0;
 lParam = ch;
Parameters:
ch The char used to represent the line seperator

Definition at line 366 of file edit.h.

#define EM_SETLIMITTEXT   EM_LIMITTEXT
See also:
EM_LIMITTEXT

Definition at line 743 of file edit.h.

#define EM_SETLINEHEIGHT   0xF0BE

Sets the height of a line.

 EM_SETLINEHEIGHT

 wParam = (WPARAM)height;
 lParam = 0;
Returns:
The old height value.
Note:
Implemented for TextEdit control.

Definition at line 496 of file edit.h.

#define EM_SETLINESEP   0xF0B8

Sets the line seperator.

In default case, the line sperator is Line Feed characters(LF , ASCII 10, '
').

 EM_SETLINESEP
 unsigned char ch;

 wParam = 0;
 lParam = ch;
Parameters:
ch The new line seperator

Definition at line 385 of file edit.h.

#define EM_SETPASSWORDCHAR   0xF0CC

Defines the character that edit control uses in conjunction with the ES_PASSWORD style.

 EM_SETPASSWORDCHAR
 char passwdChar;

 wParam = (WPARAM)passwdChar;
 lParam = 0;

Definition at line 640 of file edit.h.

#define EM_SETREADONLY   0xF0CF

Sets or removes the read-only style (ES_READONLY) in an edit control.

 EM_SETREADONLY
 int readonly;

 wParam = (WPARAM)readonly;
 lParam = 0;
Parameters:
readonly Indicates whether the edit control is read-only:

  • Zero
    Not read-only.
  • Non zero
    Read-only.

Definition at line 665 of file edit.h.

#define EM_SETSEL   0xF0B1

Sets the selected point in the edit control and makes the text between insertion point and selection point selected.

Generally, you should send EM_SETCARETPOS first to set insertion point before you use EM_SETSEL to select text.

 EM_SETSEL

 int line_pos;
 int char_pos;

 wParam = (WPARAM)line_pos;
 lParam = (LPARAM)char_pos;
Parameters:
line_pos Line position of the selection point. For single line editor, it is always zero. Note : For multi-line editor, "line" means a text string ended with a line seperator, not a single text line in wrap mode. So, char_pos means the character position in a text string.
char_pos Character(wide character) position of the selection point.
Returns:
Length of the selected string

Definition at line 249 of file edit.h.

#define EM_SETSELECTION   EM_SETSEL
See also:
EM_SETSEL

Definition at line 261 of file edit.h.

#define EM_SETSELPOS   EM_SETSEL
See also:
EM_SETSEL

Definition at line 255 of file edit.h.

#define EM_SETSELPOSBYLINE   0xF0DB
See also:
EM_SETSELBYLINE

Definition at line 1079 of file edit.h.

#define EM_SETTABSTOPS   0xF0CB

reserved.

Definition at line 625 of file edit.h.

#define EM_SETTIPTEXT   0xF0DE

Sets the tip text displayed when content is empty.

 EM_SETTIPTEXT
 const char *buffer;
 int len;

 wParam = (WPARAM)len;
 lParam = (LPARAM)buffer;

Definition at line 928 of file edit.h.

#define EM_SETTITLETEXT   0xF0DC

Sets the title text displayed before content text.

 EM_SETTITLETEXT
 const char *title;
 int len;

 wParam = (WPARAM)len;
 lParam = (LPARAM)title;
Note:
Implemented for TextEdit control.

Definition at line 890 of file edit.h.

#define EM_UNDO   0xF0C7

Undo operation.

 wParam = 0;
 lParam = 0;

Definition at line 601 of file edit.h.


Typedef Documentation

typedef int(* ED_DRAWSEL_FUNC)(HWND hWnd, HDC hdc, int startx, int starty, const char *content, int len, int selout)

Type of the edit control callback function on drawing selected strings.

Parameters:
hWnd Handle of the edit control.
startx x value of the beginning drawing position.
starty y value of the beginning drawing position.
content The string which will be drawed.
len Length of the string which should be drawed by this callback.
selout Length of the selected string that have been drawed before calling this callback function.
Returns:
Width of the outputed strings.

Definition at line 680 of file edit.h.

typedef struct _TEXTPOSINFO TEXTPOSINFO

Structure defines text position information.

Generated on Thu Apr 7 16:01:45 2011 for MiniGUI V3.0.12 API Reference by  doxygen 1.6.3