Scintilla Documentation

V · This change may be incompatible with existing client code.

+struct CharacterRange {
+    long cpMin;
+    long cpMax;
+};
+
+struct TextRange {
+    struct CharacterRange chrg;
+    char *lpstrText;
+};
+
+struct TextToFind {
+    struct CharacterRange chrg;     // range to search
+    char *lpstrText;                // the search pattern (zero terminated)
+    struct CharacterRange chrgText; // returned as position of matching text
+};
+
+struct RangeToFormat {
+    SurfaceID hdc;        // The HDC (device context) we print to
+    SurfaceID hdcTarget;  // The HDC we use for measuring (may be same as hdc)
+    PRectangle rc;        // Rectangle in which to print
+    PRectangle rcPage;    // Physically printable page size
+    CharacterRange chrg;  // Range of characters to print
+};
+
+#include "Scintilla.h"
+SciFnDirect pSciMsg = (SciFnDirect)SendMessage(hSciWnd, SCI_GETDIRECTFUNCTION, 0, 0);
+sptr_t pSciWndData = (sptr_t)SendMessage(hSciWnd, SCI_GETDIRECTPOINTER, 0, 0);
+
+// now a wrapper to call Scintilla directly
+sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
+    return pSciMsg(pSciWndData, iMessage, wParam, lParam);
+}
+
+struct NotifyHeader {   // This matches the Win32 NMHDR structure
+    void *hwndFrom;     // environment specific window handle/pointer
+    uptr_t idFrom;	// CtrlID of the window issuing the notification
+    unsigned int code;  // The SCN_* notification code
+};
+
+struct SCNotification {
+    struct NotifyHeader nmhdr;
+    int position;
+    // SCN_STYLENEEDED, SCN_DOUBLECLICK, SCN_MODIFIED, SCN_DWELLSTART,
+    // SCN_DWELLEND, SCN_CALLTIPCLICK,
+    // SCN_HOTSPOTCLICK, SCN_HOTSPOTDOUBLECLICK
+    int ch;             // SCN_CHARADDED, SCN_KEY
+    int modifiers;      // SCN_KEY, SCN_HOTSPOTCLICK, SCN_HOTSPOTDOUBLECLICK
+    int modificationType; // SCN_MODIFIED
+    const char *text;   // SCN_MODIFIED, SCN_USERLISTSELECTION, SCN_AUTOCSELECTION
+    int length;         // SCN_MODIFIED
+    int linesAdded;     // SCN_MODIFIED
+    int message;        // SCN_MACRORECORD
+    uptr_t wParam;      // SCN_MACRORECORD
+    sptr_t lParam;      // SCN_MACRORECORD
+    int line;           // SCN_MODIFIED, SCN_DOUBLECLICK
+    int foldLevelNow;   // SCN_MODIFIED
+    int foldLevelPrev;  // SCN_MODIFIED
+    int margin;         // SCN_MARGINCLICK
+    int listType;       // SCN_USERLISTSELECTION, SCN_AUTOCSELECTION
+    int x;              // SCN_DWELLSTART, SCN_DWELLEND
+    int y;              // SCN_DWELLSTART, SCN_DWELLEND
+};
+
+    startPos = SCI_GETENDSTYLED()
+    lineNumber = SCI_LINEFROMPOSITION(startPos);
+    startPos = SCI_POSITIONFROMLINE(lineNumber);
+    MyStyleRoutine(startPos, SCNotification.position);
+
+firstLine = SCI_LINEFROMPOSITION(scn.position)
+lastLine = SCI_LINEFROMPOSITION(scn.position+scn.length-1)
+for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next
+
+WM_GETTEXT(int length, char *text)
+WM_SETTEXT(<unused>, const char *text)
+EM_GETLINE(int line, char *text)
+EM_REPLACESEL(<unused>, const char *text)
+EM_SETREADONLY
+EM_GETTEXTRANGE(<unused>, TEXTRANGE *tr)
+WM_CUT
+WM_COPY
+WM_PASTE
+WM_CLEAR
+WM_UNDO
+EM_CANUNDO
+EM_EMPTYUNDOBUFFER
+WM_GETTEXTLENGTH
+EM_GETFIRSTVISIBLELINE
+EM_GETLINECOUNT
+EM_GETMODIFY
+EM_SETMODIFY(bool isModified)
+EM_GETRECT(RECT *rect)
+EM_GETSEL(int *start, int *end)
+EM_EXGETSEL(<unused>, CHARRANGE *cr)
+EM_SETSEL(int start, int end)
+EM_EXSETSEL(<unused>, CHARRANGE *cr)
+EM_GETSELTEXT(<unused>, char *text)
+EM_LINEFROMCHAR(int position)
+EM_EXLINEFROMCHAR(int position)
+EM_LINEINDEX(int line)
+EM_LINELENGTH(int position)
+EM_SCROLL(int line)
+EM_LINESCROLL(int column, int line)
+EM_SCROLLCARET()
+EM_CANPASTE
+EM_CHARFROMPOS(<unused>, POINT *location)
+EM_POSFROMCHAR(int position, POINT *location)
+EM_SELECTIONTYPE
+EM_HIDESELECTION(bool hide)
+EM_FINDTEXT(int flags, FINDTEXTEX *ft)
+EM_FINDTEXTEX(int flags, FINDTEXTEX *ft)
+EM_GETMARGINS
+EM_SETMARGINS(EC_LEFTMARGIN or EC_RIGHTMARGIN or EC_USEFONTINFO, int val)
+EM_FORMATRANGE
+
+EM_GETWORDBREAKPROC EM_GETWORDBREAKPROCEX
+EM_SETWORDBREAKPROC EM_SETWORDBREAKPROCEX
+EM_GETWORDWRAPMODE EM_SETWORDWRAPMODE
+EM_LIMITTEXT EM_EXLIMITTEXT
+EM_SETRECT EM_SETRECTNP
+EM_FMTLINES
+EM_GETHANDLE EM_SETHANDLE
+EM_GETPASSWORDCHAR EM_SETPASSWORDCHAR
+EM_SETTABSTOPS
+EM_FINDWORDBREAK
+EM_GETCHARFORMAT EM_SETCHARFORMAT
+EM_GETOLEINTERFACE EM_SETOLEINTERFACE
+EM_SETOLECALLBACK
+EM_GETPARAFORMAT EM_SETPARAFORMAT
+EM_PASTESPECIAL
+EM_REQUESTRESIZE
+EM_GETBKGNDCOLOR EM_SETBKGNDCOLOR
+EM_STREAMIN EM_STREAMOUT
+EM_GETIMECOLOR EM_SETIMECOLOR
+EM_GETIMEOPTIONS EM_SETIMEOPTIONS
+EM_GETOPTIONS EM_SETOPTIONS
+EM_GETPUNCTUATION EM_SETPUNCTUATION
+EM_GETTHUMB
+EM_GETEVENTMASK
+EM_SETEVENTMASK
+EM_DISPLAYBAND
+EM_SETTARGETDEVICE
+
+
+	hmod = LoadLibrary("SciLexer.DLL");
+		if (hmod==NULL)
+		{
+			MessageBox(hwndParent,
+			"The Scintilla DLL could not be loaded.",
+			"Error loading Scintilla",
+			MB_OK | MB_ICONERROR);
+		}
+		
+
+	hwndScintilla = CreateWindowEx(0,
+		"Scintilla","", WS_CHILD | WS_VISIBLE | WS_TABSTOP | WS_CLIPCHILDREN,
+		10,10,500,400,hwndParent,(HMENU)GuiID, hInstance,NULL);
+		
+
+	SendMessage(hwndScintilla,sci_command,wparam,lparam);
+			
+
+	SendMessage(hwndScintilla,SCI_CREATEDOCUMENT, 0, 0);
+			
+
+	int (*fn)(void*,int,int,int);
+	void * ptr;
+	int canundo;
+
+	fn = (int (__cdecl *)(void *,int,int,int))SendMessage(
+		hwndScintilla,SCI_GETDIRECTFUNCTION,0,0);
+	ptr = (void *)SendMessage(hwndScintilla,SCI_GETDIRECTPOINTER,0,0);
+
+	canundo = fn(ptr,SCI_CANUNDO,0,0);
+			
+	NMHDR *lpnmhdr;
+
+	[...]
+
+	case WM_NOTIFY:
+		lpnmhdr = (LPNMHDR) lParam;
+
+		if(lpnmhdr->hwndFrom==hwndScintilla)
+		{
+			switch(lpnmhdr->code)
+			{
+				case SCN_CHARADDED:
+					/* Hey, Scintilla just told me that a new */
+					/* character was added to the Edit Control.*/
+					/* Now i do something cool with that char. */
+				break;
+			}
+		}
+	break;
+

For autocompletion lists	For margin markers
12x12	16x16	24x24	32x32

bool	Arguments expect the values 0 for `false` and 1 for + `true`.
int	Arguments are 32-bit signed integers.
const char *	Arguments point at text that is being passed to Scintilla but not modified. The text + may be zero terminated or another argument may specify the character count, the + description will make this clear.
char *	Arguments point at text buffers that Scintilla will fill with text. In some cases, + another argument will tell Scintilla the buffer size. In others, you must make sure that + the buffer is big enough to hold the requested text. If a NULL pointer (0) is passed + then, for SCI_* calls, the length that should be allocated is returned.
colour	Colours are set using the RGB format (Red, Green, Blue). The intensity of each colour + is set in the range 0 to 255. If you have three such intensities, they are combined as: + red \| (green << 8) \| (blue << 16). If you set all intensities to 255, the + colour is white. If you set all intensities to 0, the colour is black. When you set a + colour, you are making a request. What you will get depends on the capabilities of the + system and the current screen mode.
alpha	Translucency is set using an alpha value. + Alpha ranges from 0 (SC_ALPHA_TRANSPARENT) which is completely transparent to + 255 (SC_ALPHA_OPAQUE) which is opaque. The value 256 (SC_ALPHA_NOALPHA) + is opaque and uses code that is not alpha-aware and may be faster. Not all platforms support + translucency and only some Scintilla features implement translucency. + The default alpha value for most features is SC_ALPHA_NOALPHA.
<unused>	This is an unused argument. Setting it to 0 will ensure compatibility with future + enhancements.

o Text retrieval and + modification	o Searching and replacing	o Overtype
o Cut, copy and paste	o Error handling	o Undo and Redo
o Selection and information	o Scrolling and automatic + scrolling	o White space
o Cursor	o Mouse capture	o Line endings
o Styling	o Style definition	o Caret, selection, and hotspot styles
o Margins	o Other settings	o Brace highlighting
o Tabs and Indentation + Guides	o Markers	o Indicators
o Autocompletion	o User lists	o Call tips
o Keyboard commands	o Key bindings	o Popup edit menu
o Macro recording	o Printing	o Direct access
o Multiple views	o Folding	o Line wrapping
o Zooming	o Long lines	o Lexer
o Notifications	o GTK+	o Deprecated messages
o Edit messages never + supported by Scintilla	o Building Scintilla

`SCFIND_MATCHCASE`	A match only occurs with text that matches the case of the search string.
`SCFIND_WHOLEWORD`	A match only occurs if the characters before and after are not word characters.
`SCFIND_WORDSTART`	A match only occurs if the character before is not a word character.
`SCFIND_REGEXP`	The search string should be interpreted as a regular expression.
`SCFIND_POSIX`	Treat regular expression in a more POSIX compatible manner + by interpreting bare ( and ) for tagged sections rather than \( and \).

`.`	Matches any character
`\(`	This marks the start of a region for tagging a match.
`\)`	This marks the end of a tagged region.
`\n`	Where `n` is 1 through 9 refers to the first through ninth tagged region + when replacing. For example, if the search string was `Fred\([1-9]\)XXX` and + the replace string was `Sam\1YYY`, when applied to `Fred2XXX` this + would generate `Sam2YYY`.
`\<`	This matches the start of a word using Scintilla's definitions of words.
\>	This matches the end of a word using Scintilla's definition of words.
`\x`	This allows you to use a character x that would otherwise have a special meaning. For + example, \[ would be interpreted as [ and not as the start of a character set.
`[...]`	This indicates a set of characters, for example, [abc] means any of the characters a, + b or c. You can also use ranges, for example [a-z] for any lower case character.
`[^...]`	The complement of the characters in the set. For example, [^A-Za-z] means any + character except an alphabetic character.
`^`	This matches the start of a line (unless used inside a set, see above).
`$`	This matches the end of a line.
`*`	This matches 0 or more times. For example, `Sa*m` matches `Sm`, + `Sam`, `Saam`, `Saaam` and so on.
`+`	This matches 1 or more times. For example, `Sa+m` matches + `Sam`, `Saam`, `Saaam` and so on.

+	anchor	current
`SCI_SETSELECTIONSTART`	`pos`	`Max(pos, current)`
`SCI_SETSELECTIONEND`	`Min(anchor, pos)`	`pos`

Initial state	end, true	end, false	start, true	start, false
..ww..\|..ww..	..ww..\|..ww..	..ww....\|ww..	..ww..\|..ww..	..ww\|....ww..
....ww\|ww....	....wwww\|....	....wwww\|....	....\|wwww....	....\|wwww....
..ww\|....ww..	..ww\|....ww..	..ww....\|ww..	..\|ww....ww..	..\|ww....ww..
..ww....\|ww..	..ww....ww\|..	..ww....ww\|..	..ww....\|ww..	..ww\|....ww..

`CARET_SLOP`	If set, we can define a slop value: `caretSlop`. This value defines an + unwanted zone (UZ) where the caret is... unwanted. This zone is defined as a number of + pixels near the vertical margins, and as a number of lines near the horizontal margins. + By keeping the caret away from the edges, it is seen within its context. This makes it + likely that the identifier that the caret is on can be completely seen, and that the + current line is seen with some of the lines following it, which are often dependent on + that line.
`CARET_STRICT`	If set, the policy set by `CARET_SLOP` is enforced... strictly. The caret + is centred on the display if `caretSlop` is not set, and cannot go in the UZ + if `caretSlop` is set.
`CARET_JUMPS`	If set, the display is moved more energetically so the caret can move in the same + direction longer before the policy is applied again. '3UZ' notation is used to indicate + three time the size of the UZ as a distance to the margin.
`CARET_EVEN`	If not set, instead of having symmetrical UZs, the left and bottom UZs are extended + up to right and top UZs respectively. This way, we favour the displaying of useful + information: the beginning of lines, where most code reside, and the lines after the + caret, for example, the body of a function.

slop	strict	jumps	even	Caret can go to the margin	On reaching limit (going out of visibility + or going into the UZ) display is...
0	0	0	0	Yes	moved to put caret on top/on right
0	0	0	1	Yes	moved by one position
0	0	1	0	Yes	moved to put caret on top/on right
0	0	1	1	Yes	centred on the caret
0	1	-	0	Caret is always on top/on right of display	-
0	1	-	1	No, caret is always centred	-
1	0	0	0	Yes	moved to put caret out of the asymmetrical UZ
1	0	0	1	Yes	moved to put caret out of the UZ
1	0	1	0	Yes	moved to put caret at 3UZ of the top or right margin
1	0	1	1	Yes	moved to put caret at 3UZ of the margin
1	1	-	0	Caret is always at UZ of top/right margin	-
1	1	0	1	No, kept out of UZ	moved by one position
1	1	1	0	No, kept out of UZ	moved to put caret at 3UZ of the margin

`SCWS_INVISIBLE`	0	The normal display mode with white space displayed as an empty background + colour.
`SCWS_VISIBLEALWAYS`	1	White space characters are drawn as dots and arrows,
`SCWS_VISIBLEAFTERINDENT`	2	White space used for indentation is displayed normally but after the first visible + character, it is shown as dots and arrows.

`SC_CURSORNORMAL`	-1	The normal cursor is displayed.
`SC_CURSORWAIT`	4	The wait cursor is displayed when the mouse is over or owned by the Scintilla + window.

`STYLE_DEFAULT`	32	This style defines the attributes that all styles receive when the + `SCI_STYLECLEARALL` message is used.
`STYLE_LINENUMBER`	33	This style sets the attributes of the text used to display line numbers in a line + number margin. The background colour set for this style also sets the background colour + for all margins that do not have any folding mask bits set. That is, any margin for which + `mask & SC_MASK_FOLDERS` is 0. See `SCI_SETMARGINMASKN` for more about masks.
`STYLE_BRACELIGHT`	34	This style sets the attributes used when highlighting braces with the `SCI_BRACEHIGHLIGHT` message and + when highlighting the corresponding indentation with `SCI_SETHIGHLIGHTGUIDE`.
`STYLE_BRACEBAD`	35	This style sets the display attributes used when marking an unmatched brace with the + `SCI_BRACEBADLIGHT` + message.
`STYLE_CONTROLCHAR`	36	This style sets the font used when drawing control characters. + Only the font, size, bold, italics, and character set attributes are used and not + the colour attributes. See + also: `SCI_SETCONTROLCHARSYMBOL`.
`STYLE_INDENTGUIDE`	37	This style sets the foreground and background colours used when drawing the + indentation guides.
`STYLE_CALLTIP`	38	Call tips normally use the font attributes defined by `STYLE_DEFAULT`. + Use of `SCI_CALLTIPUSESTYLE` + causes call tips to use this style instead. Only the font face name, font size, + foreground and background colours and character set attributes are used.
`STYLE_LASTPREDEFINED`	39	To make it easier for client code to discover the range of styles that are + predefined, this is set to the style number of the last predefined style. This is + currently set to 39 and the last style with an identifier is 38, which reserves space + for one future predefined style.
`STYLE_MAX`	127	This is not a style but is the number of the maximum style that can be set. Styles + between `STYLE_LASTPREDEFINED` and `STYLE_MAX` would be appropriate + if you used `SCI_SETSTYLEBITS` + to set more than 5 style bits.

`SC_MARKNUM_`*	Arrow	Plus/minus	Circle tree	Box tree
`FOLDEROPEN`	`ARROWDOWN`	`MINUS`	`CIRCLEMINUS`	`BOXMINUS`
`FOLDER`	`ARROW`	`PLUS`	`CIRCLEPLUS`	`BOXPLUS`
`FOLDERSUB`	`EMPTY`	`EMPTY`	`VLINE`	`VLINE`
`FOLDERTAIL`	`EMPTY`	`EMPTY`	`LCORNERCURVE`	`LCORNER`
`FOLDEREND`	`EMPTY`	`EMPTY`	`CIRCLEPLUSCONNECTED`	`BOXPLUSCONNECTED`
`FOLDEROPENMID`	`EMPTY`	`EMPTY`	`CIRCLEMINUSCONNECTED`	`BOXMINUSCONNECTED`
`FOLDERMIDTAIL`	`EMPTY`	`EMPTY`	`TCORNERCURVE`	`TCORNER`

Symbol	Value	Visual effect
`INDIC_PLAIN`	0	Underlined with a single, straight line.
`INDIC_SQUIGGLE`	1	A squiggly underline.
`INDIC_TT`	2	A line of small T shapes.
`INDIC_DIAGONAL`	3	Diagonal hatching.
`INDIC_STRIKE`	4	Strike out.
`INDIC_HIDDEN`	5	An indicator with no visual effect.
`INDIC_BOX`	6	A rectangle around the text.
`INDIC_ROUNDBOX`	7	A rectangle with rounded corners around the text using translucent drawing with the + interior more transparent than the border.

`SCI_LINEDOWN`	`SCI_LINEDOWNEXTEND`	`SCI_LINEDOWNRECTEXTEND`	`SCI_LINESCROLLDOWN`
`SCI_LINEUP`	`SCI_LINEUPEXTEND`	`SCI_LINEUPRECTEXTEND`	`SCI_LINESCROLLUP`
`SCI_PARADOWN`	`SCI_PARADOWNEXTEND`	`SCI_PARAUP`	`SCI_PARAUPEXTEND`
`SCI_CHARLEFT`	`SCI_CHARLEFTEXTEND`	`SCI_CHARLEFTRECTEXTEND`
`SCI_CHARRIGHT`	`SCI_CHARRIGHTEXTEND`	`SCI_CHARRIGHTRECTEXTEND`
`SCI_WORDLEFT`	`SCI_WORDLEFTEXTEND`	`SCI_WORDRIGHT`	`SCI_WORDRIGHTEXTEND`
`SCI_WORDLEFTEND`	`SCI_WORDLEFTENDEXTEND`	`SCI_WORDRIGHTEND`	`SCI_WORDRIGHTENDEXTEND`
`SCI_WORDPARTLEFT`	`SCI_WORDPARTLEFTEXTEND`	`SCI_WORDPARTRIGHT`	`SCI_WORDPARTRIGHTEXTEND`
`SCI_HOME`	`SCI_HOMEEXTEND`	`[SCI_HOMERECTEXTEND]`
`SCI_HOMEDISPLAY`	`SCI_HOMEDISPLAYEXTEND`	`SCI_HOMEWRAP`	`SCI_HOMEWRAPEXTEND`
`SCI_VCHOME`	`SCI_VCHOMEEXTEND`	`SCI_VCHOMERECTEXTEND`
`SCI_VCHOMEWRAP`	`SCI_VCHOMEWRAPEXTEND`
`SCI_LINEEND`	`SCI_LINEENDEXTEND`	`SCI_LINEENDRECTEXTEND`
`SCI_LINEENDDISPLAY`	`SCI_LINEENDDISPLAYEXTEND`	`SCI_LINEENDWRAP`	`SCI_LINEENDWRAPEXTEND`
`SCI_DOCUMENTSTART`	`SCI_DOCUMENTSTARTEXTEND`	`SCI_DOCUMENTEND`	`SCI_DOCUMENTENDEXTEND`
`SCI_PAGEUP`	`SCI_PAGEUPEXTEND`	`SCI_PAGEUPRECTEXTEND`
`SCI_PAGEDOWN`	`SCI_PAGEDOWNEXTEND`	`SCI_PAGEDOWNRECTEXTEND`
`SCI_STUTTEREDPAGEUP`	`SCI_STUTTEREDPAGEUPEXTEND`
`SCI_STUTTEREDPAGEDOWN`	`SCI_STUTTEREDPAGEDOWNEXTEND`
`SCI_DELETEBACK`	`SCI_DELETEBACKNOTLINE`	`SCI_DELWORDLEFT`	`SCI_DELWORDRIGHT`
`SCI_DELLINELEFT`	`SCI_DELLINERIGHT`	`SCI_LINEDELETE`
`SCI_LINECUT`	`SCI_LINECOPY`	`SCI_LINETRANSPOSE`	`SCI_LINEDUPLICATE`
`SCI_LOWERCASE`	`SCI_UPPERCASE`	`SCI_CANCEL`	`SCI_EDITTOGGLEOVERTYPE`
`SCI_NEWLINE`	`SCI_FORMFEED`	`SCI_TAB`	`SCI_BACKTAB`
`SCI_SELECTIONDUPLICATE`

Value	Effect
1	Experimental - draw boxes if expanded
2	Draw above if expanded
4	Draw above if not expanded
8	Draw below if expanded
16	Draw below if not expanded
64	display hexadecimal fold levels in line margin to aid debugging of + folding. This feature needs to be redesigned to be sensible.

Symbol	Value	Effect
`SC_WRAPVISUALFLAG_NONE`	0	No visual flags
`SC_WRAPVISUALFLAG_END`	1	Visual flag at end of subline of a wrapped line.
`SC_WRAPVISUALFLAG_START`	2	Visual flag at begin of subline of a wrapped line. + Subline is indented by at least 1 to make room for the flag. +

Symbol	Value	Meaning	SCNotification fields
`SC_MOD_INSERTTEXT`	0x01	Text has been inserted into the document.	`position, length, text, linesAdded`
`SC_MOD_DELETETEXT`	0x02	Text has been removed from the document.	`position, length, text, linesAdded`
`SC_MOD_CHANGESTYLE`	0x04	A style change has occurred.	`position, length`
`SC_MOD_CHANGEFOLD`	0x08	A folding change has occurred.	`line, foldLevelNow, foldLevelPrev`
`SC_PERFORMED_USER`	0x10	Information: the operation was done by the user.	None
`SC_PERFORMED_UNDO`	0x20	Information: this was the result of an Undo.	None
`SC_PERFORMED_REDO`	0x40	Information: this was the result of a Redo.	None
`SC_MULTISTEPUNDOREDO`	0x80	This is part of a multi-step Undo or Redo.	None
`SC_LASTSTEPINUNDOREDO`	0x100	This is the final step in an Undo or Redo.	None
`SC_MOD_CHANGEMARKER`	0x200	One or more markers has changed in a line.	`line`
`SC_MOD_BEFOREINSERT`	0x400	Text is about to be inserted into the document.	`position, if performed by user then text in cells, length in cells`
`SC_MOD_BEFOREDELETE`	0x800	Text is about to be deleted from the document.	`position, length`
`SC_MULTILINEUNDOREDO`	0x1000	This is part of an Undo or Redo with multi-line changes.	None
`SC_MODEVENTMASKALL`	0x1fff	This is a mask for all valid flags. This is the default mask state set by `SCI_SETMODEVENTMASK`.	None

Field	Usage
`message`	The `SCI_*` message that caused the notification.
`wParam`	The value of `wParam` in the `SCI_*` message.
`lParam`	The value of `lParam` in the `SCI_*` message.

Symbol	Value	Purpose
`SC_PRINT_NORMAL`	0	Print using the current screen colours. This is the default.
`SC_PRINT_INVERTLIGHT`	1	If you use a dark screen background this saves ink by inverting the light value of + all colours and printing on a white background.
`SC_PRINT_BLACKONWHITE`	2	Print all text as black on a white background.
`SC_PRINT_COLOURONWHITE`	3	Everything prints in its own colour on a white background.
`SC_PRINT_COLOURONWHITEDEFAULTBG`	4	Everything prints in its own colour on a white background except that line numbers + use their own background colour.

Symbol	Value	Effect
`SC_WRAPVISUALFLAGLOC_DEFAULT`	0	Visual flags drawn near border
`SC_WRAPVISUALFLAGLOC_END_BY_TEXT`	1	Visual flag at end of subline drawn near text
`SC_WRAPVISUALFLAGLOC_START_BY_TEXT`	2	Visual flag at begin of subline drawn near text

Symbol	Value	Layout cached for these lines
`SC_CACHE_NONE`	0	No lines are cached.
`SC_CACHE_CARET`	1	The line containing the text caret. This is the default.
`SC_CACHE_PAGE`	2	Visible lines plus the line containing the caret.
`SC_CACHE_DOCUMENT`	3	All lines in the document.

Symbol	Value	Long line display mode
`EDGE_NONE`	0	Long lines are not marked. This is the default state.
`EDGE_LINE`	1	A vertical line is drawn at the column number set by `SCI_SETEDGECOLUMN`. + This works well for monospaced fonts. The line is drawn at a position based on the width + of a space character in `STYLE_DEFAULT`, so it may not work very well if + your styles use proportional fonts or if your style have varied font sizes or you use a + mixture of bold, italic and normal text. .
`EDGE_BACKGROUND`	2	The background colour of characters after the column limit is changed to the colour + set by `SCI_SETEDGECOLOUR`. This is recommended for proportional fonts.

Field	Usage
`modificationType`	A set of flags that identify the change(s) made. See the next + table.
`position`	Start position of a text or styling change. Set to 0 if not used.
`length`	Length of the change in cells or characters when the text or styling + changes. Set to 0 if not used.
`linesAdded`	Number of added lines. If negative, the number of deleted lines. Set to + 0 if not used or no lines added or deleted.
`text`	Valid for text changes, not for style changes. If we are collecting undo + information this holds a pointer to the text that is handed to the Undo system, otherwise + it is zero. For user performed SC_MOD_BEFOREDELETE the text field is 0 and + for user performed SC_MOD_BEFOREINSERT the text field points to an array of cells, + not bytes and the length is the number of cells.
`line`	The line number at which a fold level or marker change occurred. This is + 0 if unused and may be -1 if more than one line changed.
`foldLevelNow`	The new fold level applied to the line or 0 if this field is + unused.
`foldLevelPrev`	The previous folding level of the line or 0 if this field is + unused.

Field	Usage
`modifiers`	The appropriate combination of `SCI_SHIFT`, + `SCI_CTRL` and `SCI_ALT` to indicate the keys that were held down + at the time of the margin click.
`position`	The position of the start of the line in the document that corresponds + to the margin click.
`margin`	The margin number that was clicked.

Field	Usage
`wParam`	This is set to the `listType` parameter from the `SCI_USERLISTSHOW` message that + initiated the list.
`text`	The text of the selection.

Field	Usage
`position`	This is the nearest position in the document to the position where the + mouse pointer was lingering.
`x, y`	Where the pointer lingered. The `position` field is set to + `SCI_POSITIONFROMPOINTCLOSE(x, y)`.

Field	Usage
`lParam`	The start position of the word being completed.
`text`	The text of the selection.

+ Top level structure +

+ Portability Library +

+ Point, PRectangle +

+ Colour, ColourPair, Palette +

+ Font +

+ Surface +

+ Window +

+ ListBox +

+ Menu +

+ Platform +

+ Core Code +

+ CellBuffer +

+ Document +

+ Editor +

+ ScintillaBase +

+ Platform Events and API +

+ Icons +

+ Code Style +

+ Introduction +

+ Language features +

+ Casting +

+ Warnings +

+ Allocation +

+ Bracketing +

+ Spacing +

+ Names +

Scintilla Documentation

Introduction

Contents

Text retrieval and modification

GTK+-specific: Access to encoded text

Searching

Search and replace using the target

Overtype

Cut, copy and paste

Error handling

Undo and Redo

Selection and information

Scrolling and automatic scrolling

White space

Cursor

Mouse capture

Line endings

Styling

Style definition

Caret, selection, and hotspot styles

Margins

Other settings

Brace highlighting

Tabs and Indentation Guides

Markers

Indicators

Autocompletion

User lists

Call tips

Keyboard commands

Key bindings

Popup edit menu

Macro recording

Printing

Direct access

Multiple views

Folding

Line wrapping

Zooming

Long lines

Lexer

Notifications

GTK+

Deprecated messages and notifications

Edit messages never supported by Scintilla

Building Scintilla

Static linking

Ensuring lexers are linked into Scintilla

Changing set of lexers

+ Download. +

+ Release 1.71 +

+ Source Code +

+ Windows Executable Code +

+ History of Scintilla and SciTE +