From 15e3b049d5b49b7c5b51bcfa8c3f6ccdd3f827e4 Mon Sep 17 00:00:00 2001 From: nyamatongwe Date: Fri, 24 Jan 2003 10:36:05 +0000 Subject: Modifications to formatting from Greg. --- doc/ScintillaDoc.html | 570 ++++++++++++++++++++++++++------------------------ 1 file changed, 299 insertions(+), 271 deletions(-) (limited to 'doc/ScintillaDoc.html') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 3ec3517db..2d51277d0 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -14,16 +14,15 @@ +/*]]>*/ +--> + @@ -33,7 +32,7 @@ Scintilla icon Scintilla + style="color:white;text-decoration:none;font-size:200%">Scintilla @@ -261,8 +260,9 @@ href="#Indicators">indicators. This allows 32 fundamental styles, which is enough for most languages, and three independent indicators so that, for example, syntax errors, deprecated names and bad indentation could all be displayed at once. The number of bits used for styles - can be altered with SCI_SETSTYLEBITS up to a - maximum of 7 bits. The remaining bits can be used for indicators.

+ can be altered with SCI_SETSTYLEBITS up to a maximum of 7 bits. The + remaining bits can be used for indicators.

Positions within the Scintilla document refer to a character or the gap before that character. The first character in a document is 0, the second 1 and so on. If a document @@ -280,7 +280,7 @@ largest font in any current style. This restriction is for performance; if lines differed in height then calculations involving positioning of text would require the text to be styled first.

- SCI_GETTEXT(int length, char *text)
+ SCI_GETTEXT(int length, char *text)
SCI_SETTEXT(<unused>, const char *text)
SCI_SETSAVEPOINT
SCI_GETLINE(int line, char *text)
@@ -302,7 +302,7 @@ *tr)
SCI_SETSTYLEBITS(int bits)
SCI_GETSTYLEBITS
- +

SCI_GETTEXT(int length, char *text)
This returns length-1 characters of text from the start of the document plus one @@ -312,11 +312,11 @@ *text). If you then save the text, you should use SCI_SETSAVEPOINT to mark the text as unmodified.

-

See also: SCI_GETSELTEXT, SCI_GETCURLINE, See also: SCI_GETSELTEXT, SCI_GETCURLINE, SCI_GETLINE, SCI_GETSTYLEDTEXT, SCI_GETTEXTRANGE

+ href="#SCI_GETTEXTRANGE">SCI_GETTEXTRANGE

SCI_SETTEXT(<unused>, const char *text)
This replaces all the text in the document with the zero terminated text string you pass @@ -332,8 +332,8 @@ href="#Notifications">notification messages, allowing the container to know if the file should be considered dirty or not.

-

See also: SCI_EMPTYUNDOBUFFER, SCI_GETMODIFY

+

See also: SCI_EMPTYUNDOBUFFER, SCI_GETMODIFY

SCI_GETLINE(int line, char *text)
This fills the buffer defined by text with the contents of the nominated line (lines start at @@ -344,11 +344,11 @@ characters. If you ask for a line number outside the range of lines in the document, 0 characters are copied.

-

See also: SCI_GETCURLINE, SCI_GETSELTEXT, See also: SCI_GETCURLINE, SCI_GETSELTEXT, SCI_GETTEXTRANGE, SCI_GETSTYLEDTEXT, SCI_GETTEXT

+ href="#SCI_GETTEXT">SCI_GETTEXT

SCI_REPLACESEL(<unused>, const char *text)
The currently selected text between the anchor @@ -360,7 +360,7 @@ SCI_GETREADONLY
These messages set and get the read-only flag for the document. If you mark a document as read only, attempts to modify the text cause the
SCN_MODIFYATTEMPTRO notification.

+ href="#SCN_MODIFYATTEMPTRO">SCN_MODIFYATTEMPTRO notification.

SCI_GETTEXTRANGE(<unused>, TextRange *tr)
@@ -371,11 +371,11 @@ longer than the number of characters you wish to read. The return value is the length of the returned text not including the terminating 0.

-

See also: SCI_GETSELTEXT, SCI_GETLINE, See also: SCI_GETSELTEXT, SCI_GETLINE, SCI_GETCURLINE, SCI_GETSTYLEDTEXT, SCI_GETTEXT

+ href="#SCI_GETTEXT">SCI_GETTEXT

SCI_GETSTYLEDTEXT(<unused>, TextRange *tr)
@@ -388,11 +388,11 @@ cpMin or cpMax. Positions outside the document return character codes and style bytes of 0.

-

See also: SCI_GETSELTEXT, SCI_GETLINE, See also: SCI_GETSELTEXT, SCI_GETLINE, SCI_GETCURLINE, SCI_GETTEXTRANGE, SCI_GETTEXT

+ href="#SCI_GETTEXT">SCI_GETTEXT

SCI_ADDTEXT(int length, const char *s)
This inserts the first length characters from the string s, @@ -452,7 +452,8 @@ struct TextRange {

Searching

- SCI_FINDTEXT(int flags, TextToFind *ttf)
+ SCI_FINDTEXT(int flags, TextToFind + *ttf)
SCI_SEARCHANCHOR
SCI_SEARCHNEXT(int searchFlags, const char *text)
@@ -460,7 +461,7 @@ struct TextRange { *text)
Search and replace using the target
- +

searchFlags
Several of the search routines use flag options, which include a simple regular expression @@ -611,7 +612,8 @@ struct TextRange { is succeeds. The chrgText.cpMin and chrgText.cpMax members of TextToFind are filled in with the start and end positions of the found text.

-

See also: SCI_SEARCHINTARGET

+

See also: SCI_SEARCHINTARGET

TextToFind
This structure is defined to have exactly the same shape as the Win32 structure @@ -630,7 +632,7 @@ struct TextToFind { These messages provide relocatable search support. This allows multiple incremental interactive searches to be macro recorded while still setting the selection to found text so the find/select operation is self-contained. These three messages send SCN_MACRORECORD SCN_MACRORECORD notifications if macro recording is enabled.

SCI_SEARCHANCHOR sets the search start point used by @@ -649,16 +651,16 @@ struct TextToFind { of the matching text. The selection is updated to show the matched text, but is not scrolled into view.

-

See also: SCI_SEARCHINTARGET, SCI_FINDTEXT

+

See also: SCI_SEARCHINTARGET, + SCI_FINDTEXT

Search and replace using the target

-

Using SCI_REPLACESEL, modifications cause - scrolling and other visible changes, which may take some time and cause unwanted display - updates. If performing many changes, such as a replace all command, the target can be used - instead. First, set the range to be replaced. Then call SCI_REPLACETARGET or - SCI_REPLACETARGETRE.

+

Using SCI_REPLACESEL, + modifications cause scrolling and other visible changes, which may take some time and cause + unwanted display updates. If performing many changes, such as a replace all command, the target + can be used instead. First, set the range to be replaced. Then call + SCI_REPLACETARGET or SCI_REPLACETARGETRE.

Searching can be performed within the target range with SCI_SEARCHINTARGET, which uses a counted string to allow searching for null characters. It returns the length of @@ -666,9 +668,10 @@ struct TextToFind { SCI_SEARCHINTARGET such as SCFIND_MATCHCASE, SCFIND_WHOLEWORD, SCFIND_WORDSTART, and SCFIND_REGEXP can be set with SCI_SETSEARCHFLAGS. SCI_SEARCHINTARGET may be simpler - for some clients to use than SCI_FINDTEXT, as that - requires using a pointer to a structure.

- SCI_SETTARGETSTART(int pos)
+ for some clients to use than SCI_FINDTEXT, as that requires using a pointer to a + structure.

+ SCI_SETTARGETSTART(int pos)
SCI_GETTARGETSTART
SCI_SETTARGETEND(int pos)
SCI_GETTARGETEND
@@ -680,7 +683,7 @@ struct TextToFind { SCI_GETSEARCHFLAGS
SCI_SEARCHINTARGET(int length, const char *text)
- +

SCI_SETTARGETSTART(int pos)
SCI_GETTARGETSTART
@@ -718,7 +721,7 @@ struct TextToFind { text and the return value is the position of the start of the matching text. If the search fails, the result is -1.

-

See also: SCI_FINDTEXT

+

See also: SCI_FINDTEXT

Overtype

@@ -765,7 +768,7 @@ struct TextToFind { These sequences occur between SCI_BEGINUNDOACTION and SCI_ENDUNDOACTION messages. These sequences can be nested and only the top-level sequences are undone as units.

- SCI_UNDO
+ SCI_UNDO
SCI_CANUNDO
SCI_EMPTYUNDOBUFFER
SCI_REDO
@@ -775,7 +778,7 @@ struct TextToFind { SCI_GETUNDOCOLLECTION
SCI_BEGINUNDOACTION
SCI_ENDUNDOACTION
- +

SCI_UNDO
SCI_CANUNDO
@@ -801,7 +804,7 @@ struct TextToFind { href="#SCN_SAVEPOINTREACHED">SCN_SAVEPOINTREACHED notification to be sent to the container.

-

See also: SCI_SETSAVEPOINT

+

See also: SCI_SETSAVEPOINT

SCI_SETUNDOCOLLECTION(bool collectUndo)
SCI_GETUNDOCOLLECTION
You can control whether Scintilla collects undo information with @@ -810,7 +813,7 @@ struct TextToFind { SCI_EMPTYUNDOBUFFER to avoid the undo buffer being unsynchronized with the data in the buffer.

- +

You might wish to turn off saving undo information if you use the Scintilla to store text generated by a program (a Log view) or in a display window where text is often deleted and @@ -831,7 +834,7 @@ struct TextToFind { (after the last character). If you use messages, there is nothing to stop you setting a position that is in the middle of a CRLF pair, or in the middle of a 2 byte character. However, keyboard commands will not move the caret into such positions.

- SCI_GETTEXTLENGTH
+ SCI_GETTEXTLENGTH
SCI_GETLENGTH
SCI_GETLINECOUNT
SCI_GETFIRSTVISIBLELINE
@@ -873,7 +876,7 @@ struct TextToFind { SCI_TEXTWIDTH(int styleNumber, char *text)
SCI_TEXTHEIGHT(int line)
SCI_CHOOSECARETX
- +

SCI_GETTEXTLENGTH
SCI_GETLENGTH
@@ -896,13 +899,13 @@ struct TextToFind {

SCI_GETMODIFY
This returns non-zero if the document is modified and 0 if it is unmodified. The modified status of a document is determined by the undo position relative to the save point. The save - point is set by SCI_SETSAVEPOINT, usually when - you have saved data to a file.

+ point is set by SCI_SETSAVEPOINT, + usually when you have saved data to a file.

If you need to be notified when the document becomes modified, Scintilla notifies the container that it has entered or left the save point with the SCN_SAVEPOINTREACHED and SCN_SAVEPOINTLEFT SCN_SAVEPOINTREACHED and SCN_SAVEPOINTLEFT notification messages.

SCI_SETSEL(int anchorPos, int currentPos)
@@ -927,7 +930,7 @@ struct TextToFind { This sets the current position and creates a selection between the anchor and the current position. The caret is not scrolled into view.

-

See also: SCI_SCROLLCARET

+

See also: SCI_SCROLLCARET

SCI_GETCURRENTPOS
This returns the current position.

@@ -936,7 +939,7 @@ struct TextToFind { This sets the anchor position and creates a selection between the anchor position and the current position. The caret is not scrolled into view.

-

See also: SCI_SCROLLCARET

+

See also: SCI_SCROLLCARET

SCI_GETANCHOR
This returns the current anchor position.

@@ -978,7 +981,7 @@ struct TextToFind { -

See also: SCI_SCROLLCARET

+

See also: SCI_SCROLLCARET

SCI_GETSELECTIONSTART
SCI_GETSELECTIONEND
@@ -1021,12 +1024,13 @@ struct TextToFind { buffer. The buffer must be at least SCI_GETSELECTIONEND()-SCI_SETSELECTIONSTART()+1 bytes long.

+ - -

See also: SCI_GETCURLINE, SCI_GETLINE, SCI_GETTEXT, SCI_GETSTYLEDTEXT, SCI_GETTEXTRANGE

+

See also: SCI_GETCURLINE, SCI_GETLINE, SCI_GETTEXT, SCI_GETSTYLEDTEXT, SCI_GETTEXTRANGE

SCI_GETCURLINE(int textLen, char *text)
This retrieves the text of the line containing the caret and returns the position within the @@ -1034,10 +1038,11 @@ struct TextToFind { the text you wish to retrieve and a terminating 0 character. Set textLen to the length of the buffer.

-

See also: SCI_GETSELTEXT, SCI_GETLINE, SCI_GETTEXT, SCI_GETSTYLEDTEXT, SCI_GETTEXTRANGE

+

See also: SCI_GETSELTEXT, SCI_GETLINE, SCI_GETTEXT, SCI_GETSTYLEDTEXT, SCI_GETTEXTRANGE

SCI_SELECTIONISRECTANGLE
This returns 1 if the current selection is in rectangle mode, 0 if not.

@@ -1052,9 +1057,9 @@ struct TextToFind { onlyWordCharacters)
These messages return the start and end of words using the same definition of words as used internally within Scintilla. You can set your own list of characters that count as words with - SCI_SETWORDCHARS. The position sets the start - or the search, which is forwards when searching for the end and backwards when searching for - the start.

+ SCI_SETWORDCHARS. The position + sets the start or the search, which is forwards when searching for the end and backwards when + searching for the start.

Set onlyWordCharacters to true (1) to stop searching at the first non-word character in the search direction. If onlyWordCharacters is @@ -1162,9 +1167,9 @@ struct TextToFind {

SCI_HIDESELECTION(bool hide)
The normal state is to make the selection visible by drawing it as set by SCI_SETSELFORE and SCI_SETSELBACK. However, if you hide the selection, it is drawn as - normal text.

+ href="#SCI_SETSELFORE">SCI_SETSELFORE and SCI_SETSELBACK. However, if you hide the selection, it + is drawn as normal text.

SCI_CHOOSECARETX
Scintilla remembers the x value of the last position horizontally moved to explicitly by the @@ -1172,7 +1177,7 @@ struct TextToFind { This message sets the current x position of the caret as the remembered value.

Scrolling and automatic scrolling

- SCI_LINESCROLL(int column, int line)
+ SCI_LINESCROLL(int column, int line)
SCI_SCROLLCARET
SCI_SETXCARETPOLICY(int caretPolicy, int caretSlop)
@@ -1191,7 +1196,7 @@ struct TextToFind { SCI_SETENDATLASTLINE(bool endAtLastLine)
SCI_GETENDATLASTLINE
- +

SCI_LINESCROLL(int column, int line)
This will attempt to scroll the display by the number of columns and lines that you specify. @@ -1202,7 +1207,7 @@ struct TextToFind { the column at the left edge of the view (i.e. they move the text leftwards as far as the user is concerned). Negative values do the reverse.

-

See also: SCI_SETXOFFSET

+

See also: SCI_SETXOFFSET

SCI_SCROLLCARET
If the current position (this is the caret if there is no selection) is not visible, the view @@ -1460,9 +1465,9 @@ struct TextToFind {

SCI_SETVISIBLEPOLICY(int caretPolicy, int caretSlop)
This determines how the vertical positioning is determined when SCI_ENSUREVISIBLEENFORCEPOLICY is called. It takes - VISIBLE_SLOP and VISIBLE_STRICT flags for the policy parameter. It is - similar in operation to SCI_ENSUREVISIBLEENFORCEPOLICY is + called. It takes VISIBLE_SLOP and VISIBLE_STRICT flags for the policy + parameter. It is similar in operation to SCI_SETYCARETPOLICY(int caretPolicy, int caretSlop).

@@ -1485,7 +1490,7 @@ struct TextToFind { view. A value of 0 is the normal position with the first text column visible at the left of the view.

-

See also: SCI_LINESCROLL

+

See also: SCI_LINESCROLL

SCI_SETSCROLLWIDTH(int pixelWidth)
SCI_GETSCROLLWIDTH
@@ -1499,13 +1504,13 @@ struct TextToFind { scrolling one page below the last line.

White space

- SCI_SETVIEWWS(int wsMode)
+ SCI_SETVIEWWS(int wsMode)
SCI_GETVIEWWS
SCI_SETWHITESPACEFORE(bool useWhitespaceForeColour, int colour)
SCI_SETWHITESPACEBACK(bool useWhitespaceBackColour, int colour)
- +

SCI_SETVIEWWS(int wsMode)
SCI_GETVIEWWS
@@ -1607,12 +1612,12 @@ struct TextToFind { this can be changed with the SCI_SETEOLMODE message. You can also convert the entire document to one of these line endings with SCI_CONVERTEOLS. Finally, you can choose to display the line endings with SCI_SETVIEWEOL.

- SCI_SETEOLMODE(int eolMode)
+ SCI_SETEOLMODE(int eolMode)
SCI_GETEOLMODE
SCI_CONVERTEOLS(int eolMode)
SCI_SETVIEWEOL(bool visible)
SCI_GETVIEWEOL
- +

SCI_SETEOLMODE(int eolMode)
SCI_GETEOLMODE
@@ -1640,17 +1645,18 @@ struct TextToFind { divide the 8 style bits available for each character into 5 bits (0 to 4 = styles 0 to 31) that set a style and three bits (5 to 7) that define indicators. You can change the balance between - styles and indicators with SCI_SETSTYLEBITS. If - your styling needs can be met by one of the standard lexers, or if you can write your own, then - a lexer is probably the easiest way to style your document. If you choose to use the container - to do the styling you can use the SCI_SETLEXER - command to select SCLEX_CONTAINER, in which case the container is sent a SCN_STYLENEEDED SCI_SETSTYLEBITS. If your styling needs can be met by + one of the standard lexers, or if you can write your own, then a lexer is probably the easiest + way to style your document. If you choose to use the container to do the styling you can use + the SCI_SETLEXER command to select + SCLEX_CONTAINER, in which case the container is sent a SCN_STYLENEEDED notification each time text needs styling for display. As another alternative, you might use idle time to style the document. Even if you use a lexer, you might use the styling commands to mark errors detected by a compiler. The following commands can be used.

- SCI_GETENDSTYLED
+ SCI_GETENDSTYLED
SCI_STARTSTYLING(int position, int mask)
SCI_SETSTYLING(int length, int style)
SCI_SETSTYLINGEX(int length, const char @@ -1658,7 +1664,7 @@ struct TextToFind { SCI_SETLINESTATE(int line, int value)
SCI_GETLINESTATE(int line)
SCI_GETMAXLINESTATE
- +

SCI_GETENDSTYLED
Scintilla keeps a record of the last character that is likely to be styled correctly. This is @@ -1710,9 +1716,10 @@ struct TextToFind {

While the style setting messages mentioned above, change the style numbers associated with text, these messages define how those style numbers are interpreted visually. There are 128 lexer styles that can be set, numbered 0 to STYLEMAX (127). Unless you use SCI_SETSTYLEBITS to change the number of style - bits, styles 0 to 31 are used to set the text attributes. There are also some predefined - numbered styles starting at 32, The following STYLE_* constants are defined.

+ class="message" href="#SCI_SETSTYLEBITS">SCI_SETSTYLEBITS to change the number + of style bits, styles 0 to 31 are used to set the text attributes. There are also some + predefined numbered styles starting at 32, The following STYLE_* constants are + defined.

@@ -1734,7 +1741,7 @@ struct TextToFind { 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. + href="#SCI_SETMARGINMASKN">SCI_SETMARGINMASKN for more about masks. @@ -1743,9 +1750,9 @@ struct TextToFind { + class="message" href="#BraceHighlighting">SCI_BRACEHIGHLIGHT message and + when highlighting the corresponding indentation with SCI_SETHIGHLIGHTGUIDE. @@ -1754,7 +1761,8 @@ struct TextToFind { + SCI_BRACEBADLIGHT + message. @@ -1764,7 +1772,7 @@ struct TextToFind { + href="#SCI_SETCONTROLCHARSYMBOL">SCI_SETCONTROLCHARSYMBOL. @@ -1794,8 +1802,8 @@ struct TextToFind { + if you used SCI_SETSTYLEBITS + to set more than 5 style bits.
34 This style sets the attributes used when highlighting braces with the SCI_BRACEHIGHLIGHT message and when - highlighting the corresponding indentation with SCI_SETHIGHLIGHTGUIDE.
35 This style sets the display attributes used when marking an unmatched brace with the - SCI_BRACEBADLIGHT message.
This style sets the display attributes used when drawing control characters. See also: SCI_SETCONTROLCHARSYMBOL.
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.
@@ -1809,7 +1817,7 @@ struct TextToFind {

It is entirely up to you how you use styles. If you want to use syntax colouring you might use style 0 for white space, style 1 for numbers, style 2 for keywords, style 3 for strings, style 4 for preprocessor, style 5 for operators, and so on.

- SCI_STYLERESETDEFAULT
+ SCI_STYLERESETDEFAULT
SCI_STYLECLEARALL
SCI_STYLESETFONT(int styleNumber, char *fontName)
@@ -1835,7 +1843,7 @@ struct TextToFind { visible)
SCI_STYLESETCHANGEABLE(int styleNumber, bool changeable)
- +

SCI_STYLERESETDEFAULT
This message resets STYLE_DEFAULT to its state when Scintilla was @@ -1854,11 +1862,12 @@ struct TextToFind { SCI_STYLESETBOLD(int styleNumber, bool bold)
SCI_STYLESETITALIC(int styleNumber, bool italic)
These messages (plus SCI_STYLESETCHARACTERSET) set the font attributes that are - used to match the fonts you request to those available. The fontName is a zero - terminated string holding the name of a font. Under Windows, only the first 32 characters of - the name are used and the name is not case sensitive. For internal caching, Scintilla tracks - fonts by name and does care about the casing of font names, so please be consistent.

+ href="#SCI_STYLESETCHARACTERSET">SCI_STYLESETCHARACTERSET) set the font + attributes that are used to match the fonts you request to those available. The + fontName is a zero terminated string holding the name of a font. Under Windows, + only the first 32 characters of the name are used and the name is not case sensitive. For + internal caching, Scintilla tracks fonts by name and does care about the casing of font names, + so please be consistent.

SCI_STYLESETUNDERLINE(int styleNumber, bool underline)
@@ -1932,7 +1941,7 @@ struct TextToFind { it was not selected. When there is no selection, the current insertion point is marked by the text caret. This is a vertical line that is normally blinking on and off to attract the users attention.

- SCI_SETSELFORE(bool useSelectionForeColour, int + SCI_SETSELFORE(bool useSelectionForeColour, int colour)
SCI_SETSELBACK(bool useSelectionBackColour, int colour)
@@ -1950,7 +1959,7 @@ struct TextToFind { SCI_SETCONTROLCHARSYMBOL(int symbol)
SCI_GETCONTROLCHARSYMBOL
- +

SCI_SETSELFORE(bool useSelectionForeColour, int colour)
@@ -1989,9 +1998,10 @@ struct TextToFind {

SCI_SETCARETWIDTH(int pixels)
SCI_GETCARETWIDTH
- The width of the caret can be set with SCI_SETCARETWIDTH to a value of 1, 2 or 3 - pixels. The default width is 1 pixel. You can read back the current width with - SCI_GETCARETWIDTH.

+ The width of the caret can be set with SCI_SETCARETWIDTH to a value of 0, 1, 2 or + 3 pixels. The default width is 1 pixel. You can read back the current width with + SCI_GETCARETWIDTH. A width of 0 makes the caret invisible (added at version + 1.50).

SCI_SETCONTROLCHARSYMBOL(int symbol)
SCI_GETCONTROLCHARSYMBOL
@@ -2012,20 +2022,21 @@ struct TextToFind {

There may be up to three margins to the left of the text display, plus a gap either side of the text. Each margin can be set to display either symbols or line numbers with SCI_SETMARGINTYPEN. The markers that can be - displayed in each margin are set with SCI_SETMARGINMASKN. Any markers not associated with a visible - margin will be displayed as changes in background colour in the text. A width in pixels can be - set for each margin. Margins with a zero width are ignored completely. You can choose if a - mouse click in a margin sends a SCN_MARGINCLICK - notification to the container or selects a line of text.

+ class="message" href="#SCI_SETMARGINTYPEN">SCI_SETMARGINTYPEN. The markers + that can be displayed in each margin are set with SCI_SETMARGINMASKN. Any markers not associated with + a visible margin will be displayed as changes in background colour in the text. A width in + pixels can be set for each margin. Margins with a zero width are ignored completely. You can + choose if a mouse click in a margin sends a SCN_MARGINCLICK notification to the container or + selects a line of text.

The margins are numbered 0 to 2. Using a margin number outside the valid range has no effect. By default, margin 0 is set to display line numbers, but is given a width of 0, so it is hidden. Margin 1 is set to display non-folding symbols and is given a width of 16 pixels, so it is visible. Margin 2 is set to display the folding symbols, but is given a width of 0, so it is hidden. Of course, you can set the margins to be whatever you wish.

- SCI_SETMARGINTYPEN(int margin, int + SCI_SETMARGINTYPEN(int margin, int type)
SCI_GETMARGINTYPEN(int margin)
SCI_SETMARGINWIDTHN(int margin, int @@ -2044,7 +2055,7 @@ struct TextToFind { SCI_SETMARGINRIGHT(<unused>, int pixels)
SCI_GETMARGINRIGHT
- +

SCI_SETMARGINTYPEN(int margin, int iType)
SCI_GETMARGINTYPEN(int margin)
@@ -2071,16 +2082,16 @@ struct TextToFind { symbols used to denote folding. You can assign a wide range of symbols and colours to each of the 32 logical symbols, see Markers for more information. If (mask & SC_MASK_FOLDERS)==0, the margin background colour is controlled by style 33 (STYLE_LINENUMBER).

+ class="message" href="#StyleDefinition">STYLE_LINENUMBER).

You add logical markers to a line with SCI_MARKERADD. If a line has an associated marker that does not - appear in the mask of any margin with a non-zero width, the marker changes the background - colour of the line. For example, suppose you decide to use logical marker 10 to mark lines with - a syntax error and you want to show such lines by changing the background colour. The mask for - this marker is 1 shifted left 10 times (1<<10) which is 0x400. If you make sure that no - symbol margin includes 0x400 in its mask, any line with the marker gets the background colour - changed.

+ href="#SCI_MARKERADD">SCI_MARKERADD. If a line has an associated marker that + does not appear in the mask of any margin with a non-zero width, the marker changes the + background colour of the line. For example, suppose you decide to use logical marker 10 to mark + lines with a syntax error and you want to show such lines by changing the background colour. + The mask for this marker is 1 shifted left 10 times (1<<10) which is 0x400. If you make + sure that no symbol margin includes 0x400 in its mask, any line with the marker gets the + background colour changed.

To set a non-folding margin 1 use SCI_SETMARGINMASKN(1, ~SC_MASK_FOLDERS); to set a folding margin 2 use SCI_SETMARGINMASKN(2, SC_MASK_FOLDERS). This is the @@ -2092,10 +2103,11 @@ struct TextToFind { sensitive)
SCI_GETMARGINSENSITIVEN(int margin)
Each of the three margins can be set sensitive or insensitive to mouse clicks. A click in a - sensitive margin sends a SCN_MARGINCLICK notification to the container. Margins that are not - sensitive act as selection margins which make it easy to select ranges of lines. By default, - all margins are insensitive.

+ sensitive margin sends a SCN_MARGINCLICK notification to the container. Margins that are not sensitive act as + selection margins which make it easy to select ranges of lines. By default, all margins are + insensitive.

SCI_SETMARGINLEFT(<unused>, int pixels)
SCI_GETMARGINLEFT
@@ -2105,7 +2117,8 @@ struct TextToFind { The default is to one pixel on each side.

Other settings

- SCI_SETUSEPALETTE(bool allowPaletteUse)
+ SCI_SETUSEPALETTE(bool + allowPaletteUse)
SCI_GETUSEPALETTE
SCI_SETBUFFEREDDRAW(bool isBuffered)
SCI_GETBUFFEREDDRAW
@@ -2116,7 +2129,7 @@ struct TextToFind { SCI_GRABFOCUS
SCI_SETFOCUS(bool focus)
SCI_GETFOCUS
- +

SCI_SETUSEPALETTE(bool allowPaletteUse)
SCI_GETUSEPALETTE
@@ -2199,19 +2212,20 @@ struct TextToFind { but with the need to indicate that Scintilla has the logical focus.

Brace highlighting

- SCI_BRACEHIGHLIGHT(int pos1, int pos2)
+ SCI_BRACEHIGHLIGHT(int pos1, int + pos2)
SCI_BRACEBADLIGHT(int pos1)
SCI_BRACEMATCH(int position, int maxReStyle)
- +

SCI_BRACEHIGHLIGHT(int pos1, int pos2)
Up to two characters can be highlighted in a 'brace highlighting style', which is defined as - style number STYLE_BRACELIGHT (34). If you have - enabled indent guides, you may also wish to highlight the indent that corresponds with the - brace. You can locate the column with SCI_GETCOLUMN and highlight the indent with SCI_SETHIGHLIGHTGUIDE.

+ style number STYLE_BRACELIGHT (34). + If you have enabled indent guides, you may also wish to highlight the indent that corresponds + with the brace. You can locate the column with SCI_GETCOLUMN and highlight the indent with SCI_SETHIGHLIGHTGUIDE.

SCI_BRACEBADLIGHT(int pos1)
If there is no matching brace then the brace @@ -2244,7 +2258,7 @@ struct TextToFind { inserting a tab at the current character position and backspace unindents the line rather than deleting a character. Scintilla can also display indentation guides (vertical lines) to help you to generate code.

- SCI_SETTABWIDTH(int widthInChars)
+ SCI_SETTABWIDTH(int widthInChars)
SCI_GETTABWIDTH
SCI_SETUSETABS(bool useTabs)
SCI_GETUSETABS
@@ -2265,7 +2279,7 @@ struct TextToFind { SCI_GETINDENTATIONGUIDES
SCI_SETHIGHLIGHTGUIDE(int column)
SCI_GETHIGHLIGHTGUIDE
- +

SCI_SETTABWIDTH(int widthInChars)
SCI_GETTABWIDTH
@@ -2278,16 +2292,16 @@ struct TextToFind { SCI_SETUSETABS determines whether indentation should be created out of a mixture of tabs and spaces or be based purely on spaces. Set useTabs to false (0) to create all tabs and indents out of spaces. The default is true. You can use - SCI_GETCOLUMN to get the column of a position - taking the width of a tab into account.

+ SCI_GETCOLUMN to get the column of a + position taking the width of a tab into account.

SCI_SETINDENT(int widthInChars)
SCI_GETINDENT
SCI_SETINDENT sets the size of indentation in terms of the width of a space in STYLE_DEFAULT. If you set a width of 0, the indent - size is the same as the tab size. There are no limits on indent sizes, but values less than 0 - or large values may have undesirable effects.
+ class="message" href="#StyleDefinition">STYLE_DEFAULT. If you set a width of + 0, the indent size is the same as the tab size. There are no limits on indent sizes, but values + less than 0 or large values may have undesirable effects.

- +

SCI_SETTABINDENTS(bool tabIndents)
SCI_GETTABINDENTS
@@ -2313,15 +2327,15 @@ struct TextToFind { Indentation guides are dotted vertical lines that appear within indentation white space every indent size columns. They make it easy to see which constructs line up especially when they extend over multiple pages. Style STYLE_INDENTGUIDE (37) is used to specify the foreground and - background colour of the indentation guides.

+ href="#StyleDefinition">STYLE_INDENTGUIDE (37) is used to specify the + foreground and background colour of the indentation guides.

SCI_SETHIGHLIGHTGUIDE(int column)
SCI_GETHIGHLIGHTGUIDE
When brace highlighting occurs, the indentation guide corresponding to the braces may be highlighted with the brace highlighting style, STYLE_BRACELIGHT (34). Set column to 0 to cancel this - highlight.

+ href="#StyleDefinition">STYLE_BRACELIGHT (34). Set column to 0 to + cancel this highlight.

Markers

@@ -2346,7 +2360,7 @@ struct TextToFind { top of lower numbered ones. Markers try to move with their text by tracking where the start of their line moves. When a line is deleted, its markers are combined, by an OR operation, with the markers of the previous line.

- SCI_MARKERDEFINE(int markerNumber, int + SCI_MARKERDEFINE(int markerNumber, int markerSymbols)
SCI_MARKERDEFINEPIXMAP(int markerNumber, const char *xpm)
@@ -2366,7 +2380,7 @@ struct TextToFind { SCI_MARKERLINEFROMHANDLE(int handle)
SCI_MARKERDELETEHANDLE(int handle)
- +

SCI_MARKERDEFINE(int markerNumber, int markerSymbols)
This message associates a marker number in the range 0 to 31 with one of the marker symbols or @@ -2404,7 +2418,7 @@ struct TextToFind { number 1 use:
SCI_MARKETDEFINE(1, SC_MARK_CHARACETR+65).

- +

The marker numbers SC_MARKNUM_FOLDER and SC_MARKNUM_FOLDEROPEN are used for showing that a fold is present and open or closed. Any symbols may be assigned for @@ -2534,11 +2548,11 @@ struct TextToFind { This message adds marker number markerNumber to a line. The message returns -1 if this fails (illegal line number, out of memory) or it returns a marker handle number that identifies the added marker. You can use this returned handle with SCI_MARKERLINEFROMHANDLE to find where a marker is after - moving or combining lines and with SCI_MARKERDELETEHANDLE to delete the marker based on its - handle. The message does not check that the value of markerNumber, nor does it check if the - line already contains the marker.

+ href="#SCI_MARKERLINEFROMHANDLE">SCI_MARKERLINEFROMHANDLE to find where a + marker is after moving or combining lines and with SCI_MARKERDELETEHANDLE to delete the marker + based on its handle. The message does not check that the value of markerNumber, nor does it + check if the line already contains the marker.

SCI_MARKERDELETE(int line, int markerNumber)
This searches the given line number for the given marker number and deletes it if it is @@ -2566,14 +2580,14 @@ struct TextToFind {

SCI_MARKERLINEFROMHANDLE(int markerHandle)
The markerHandle argument is an identifier for a marker returned by SCI_MARKERADD. This function searches the document - for the marker with this handle and returns the line number that contains it or -1 if it is not - found.

+ class="message" href="#SCI_MARKERADD">SCI_MARKERADD. This function searches + the document for the marker with this handle and returns the line number that contains it or -1 + if it is not found.

SCI_MARKERDELETEHANDLE(int markerHandle)
The markerHandle argument is an identifier for a marker returned by SCI_MARKERADD. This function searches the document - for the marker with this handle and deletes the marker if it is found.

+ class="message" href="#SCI_MARKERADD">SCI_MARKERADD. This function searches + the document for the marker with this handle and deletes the marker if it is found.

Indicators

@@ -2584,27 +2598,28 @@ struct TextToFind { line of small 'T' shapes, a line of diagonal hatching or as strike-out.

The indicators are set using SCI_STARTSTYLING with a INDICS_MASK mask and SCI_SETSTYLING with the values + href="#SCI_STARTSTYLING">SCI_STARTSTYLING with a INDICS_MASK mask + and SCI_SETSTYLING with the values INDIC0_MASK, INDIC1_MASK and INDIC2_MASK.

The number of bits used for styles can be altered with SCI_SETSTYLEBITS from 0 to 7 bits. The remaining bits can be used - for indicators, so there can be from 1 to 8 indicators. However, the INDIC*_MASK - constants defined in Scintilla.h all assume 5 bits of styling information and 3 - indicators. If you use a different arrangement, you must define your own constants.

+ href="#SCI_SETSTYLEBITS">SCI_SETSTYLEBITS from 0 to 7 bits. The remaining bits + can be used for indicators, so there can be from 1 to 8 indicators. However, the + INDIC*_MASK constants defined in Scintilla.h all assume 5 bits of + styling information and 3 indicators. If you use a different arrangement, you must define your + own constants.

The SCI_INDIC* messages allow you to get and set the visual appearance of the indicators. They all use an indicatorNumber argument in the range 0 to 7 to set the indicator to style. With the default settings, only indicators 0, 1 and 2 will have any visible effect.

- SCI_INDICSETSTYLE(int indicatorNumber, int + SCI_INDICSETSTYLE(int indicatorNumber, int indicatorStyle)
SCI_INDICGETSTYLE(int indicatorNumber)
SCI_INDICSETFORE(int indicatorNumber, int colour)
SCI_INDICGETFORE(int indicatorNumber)
- +

SCI_INDICSETSTYLE(int indicatorNumber, int indicatorStyle)
@@ -2694,7 +2709,7 @@ struct TextToFind {

To make use of autocompletion you must monitor each character added to the document. See SciTEBase::CharAdded() in SciTEBase.cxx for an example of autocompletion.

- SCI_AUTOCSHOW(int lenEntered, const char + SCI_AUTOCSHOW(int lenEntered, const char *list)
SCI_AUTOCCANCEL
SCI_AUTOCACTIVE
@@ -2723,19 +2738,20 @@ struct TextToFind { SCI_AUTOCSETDROPRESTOFWORD(bool dropRestOfWord)
SCI_AUTOCGETDROPRESTOFWORD
- +

SCI_AUTOCSHOW(int lenEntered, const char *list)
This message causes a list to be displayed. lenEntered is the number of characters of the word already entered and list is the list of words separated by separator characters. The initial separator character is a space but this can be set or got - with SCI_AUTOCSETSEPARATOR and SCI_AUTOCGETSEPARATOR.

+ with SCI_AUTOCSETSEPARATOR + and SCI_AUTOCGETSEPARATOR.

The list of words should be in sorted order. If set to ignore case mode with SCI_AUTOCSETIGNORECASE, then strings are - matched after being converted to upper case. One result of this is that the list should be - sorted with the punctuation characters '[', '\', ']', '^', '_', and '`' sorted after + class="message" href="#SCI_AUTOCSETIGNORECASE">SCI_AUTOCSETIGNORECASE, then + strings are matched after being converted to upper case. One result of this is that the list + should be sorted with the punctuation characters '[', '\', ']', '^', '_', and '`' sorted after letters.

SCI_AUTOCCANCEL
@@ -2743,7 +2759,7 @@ struct TextToFind { should disappear when the user types a character that can not be part of the autocompletion, such as '.', '(' or '[' when typing an identifier. A set of characters that will cancel autocompletion can be specified with SCI_AUTOCSTOPS.

+ href="#SCI_AUTOCSTOPS">SCI_AUTOCSTOPS.

SCI_AUTOCACTIVE
This message returns non-zero if there is an active autocompletion list and zero if there is @@ -2769,12 +2785,13 @@ struct TextToFind {

SCI_AUTOCSELECT(<unused>,const char *select)
This message selects an item in the autocompletion list. It searches the list of words for the first that matches select. By default, comparisons are case sensitive, but you can - change this with SCI_AUTOCSETIGNORECASE. - The match is character by character for the length of the select string. That is, - if select is "Fred" it will match "Frederick" if this is the first item in the list that begins - with "Fred". If an item is found, it is selected. If the item is not found, the autocompletion - list closes if auto-hide is true (see SCI_AUTOCSETAUTOHIDE).

+ change this with SCI_AUTOCSETIGNORECASE. The match is character + by character for the length of the select string. That is, if select is "Fred" it + will match "Frederick" if this is the first item in the list that begins with "Fred". If an + item is found, it is selected. If the item is not found, the autocompletion list closes if + auto-hide is true (see SCI_AUTOCSETAUTOHIDE).

SCI_AUTOCSETCANCELATSTART(bool cancel)
SCI_AUTOCGETCANCELATSTART
@@ -2805,7 +2822,7 @@ struct TextToFind { By default, the list is cancelled if there are no viable matches (the user has typed characters that no longer match a list entry). If you want to keep displaying the original list, set autoHide to false. This also effects SCI_AUTOCSELECT.

+ href="#SCI_AUTOCSELECT">SCI_AUTOCSELECT.

SCI_AUTOCSETDROPRESTOFWORD(bool dropRestOfWord)
SCI_AUTOCGETDROPRESTOFWORD
@@ -2831,10 +2848,11 @@ struct TextToFind {

SCI_USERLISTSHOW(int listType, const char *list)
The listType parameter is returned to the container as the wParam - field of the SCNotification structure. It must be - greater than 0 as this is how Scintilla tells the difference between an autocompletion list and - a user list. If you have different types of list, for example a list of buffers and a list of - macros, you can use listType to tell which one has returned a selection.

+ field of the SCNotification + structure. It must be greater than 0 as this is how Scintilla tells the difference between an + autocompletion list and a user list. If you have different types of list, for example a list of + buffers and a list of macros, you can use listType to tell which one has returned + a selection.

Call tips

@@ -2855,7 +2873,7 @@ struct TextToFind { href="#SCN_DWELLEND">SCN_DWELLEND. This method could be used in a debugger to give the value of a variable, or during editing to give information about the word under the pointer.

- SCI_CALLTIPSHOW(int posStart, const char + SCI_CALLTIPSHOW(int posStart, const char *definition)
SCI_CALLTIPCANCEL
SCI_CALLTIPACTIVE
@@ -2863,7 +2881,7 @@ struct TextToFind { SCI_CALLTIPSETHLT(int highlightStart, int highlightEnd)
SCI_CALLTIPSETBACK(int colour)
- +

SCI_CALLTIPSHOW(int posStart, const char *definition)
This message starts the process by displaying the call tip window. If a call tip is already @@ -2908,7 +2926,7 @@ struct TextToFind {

To allow the container application to perform any of the actions available to the user with keyboard, all the keyboard actions are messages. They do not take any parameters. These commands are also used when redefining the key bindings with the SCI_ASSIGNCMDKEY message.

+ href="#SCI_ASSIGNCMDKEY">SCI_ASSIGNCMDKEY message.

@@ -3073,12 +3091,12 @@ struct TextToFind { class="jump" href="#KeyboardCommands">keyboard commands discussed above, but any Scintilla command that has no arguments can be mapped). You can change the mapping to suit your own requirements.

- SCI_ASSIGNCMDKEY(int keyDefinition, int + SCI_ASSIGNCMDKEY(int keyDefinition, int sciCommand)
SCI_CLEARCMDKEY(int keyDefinition)
SCI_CLEARALLCMDKEYS
SCI_NULL
- +

keyDefinition
A key definition contains the key code in the low 16-bits and the key modifiers in the high @@ -3141,16 +3159,16 @@ struct TextToFind { which can include a printer display context. Printed output shows text styling as on the screen, but it hides all margins except a line number margin. All special marker effects are removed and the selection and caret are hidden.

- SCI_FORMATRANGE(bool bDraw, RangeToFormat + SCI_FORMATRANGE(bool bDraw, RangeToFormat *pfr)
SCI_SETPRINTMAGNIFICATION(int magnification)
SCI_GETPRINTMAGNIFICATION
SCI_SETPRINTCOLOURMODE(int mode)
SCI_GETPRINTCOLOURMODE
- SCI_SETPRINTWRAPMODE(int wrapMode)
+ SCI_SETPRINTWRAPMODE
SCI_GETPRINTWRAPMODE
- +

SCI_FORMATRANGE(bool bDraw, RangeToFormat *pfr)
This call allows Windows users to render a range of text into a device context. If you use @@ -3191,7 +3209,7 @@ struct RangeToFormat {

SCI_SETPRINTMAGNIFICATION(int magnification)
SCI_GETPRINTMAGNIFICATION
- SCI_SETPRINTMAGNIFICATION lets you to print at a different size than the screen + SCI_GETPRINTMAGNIFICATION lets you to print at a different size than the screen font. magnification is the number of points to add to the size of each screen font. A value of -3 or -4 gives reasonably small print. You can get this value with SCI_GETPRINTMAGNIFICATION.

@@ -3261,15 +3279,17 @@ struct RangeToFormat {

SCI_SETPRINTWRAPMODE(int wrapMode)
SCI_GETPRINTWRAPMODE
- Set wrapMode to SC_WRAP_WORD (1) to enable line wrapping and to - SC_WRAP_NONE (0) to disable line wrapping. - The default setting is SC_WRAP_WORD. - You can get this value with SCI_GETPRINTWRAPMODE.

+ These two functions get and set the printer wrap mode. wrapMode can be + set to SC_WRAP_NONE (0) or SC_WRAP_WORD (1). The default is + SC_WRAP_WORD, which wraps printed output so that all characters fit + into the print rectangle. If you set SC_WRAP_NONE, each line of text + generates one line of output and the line is truncated if it is too long to fit + into the print area.

Direct access

- SCI_GETDIRECTFUNCTION
+ SCI_GETDIRECTFUNCTION
SCI_GETDIRECTPOINTER
- +

On Windows, the message-passing scheme used to communicate between the container and Scintilla is mediated by the operating system SendMessage function and can lead to @@ -3327,7 +3347,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ releases of Scintilla you should treat pDoc as an opaque void*. That is, you can use and store the pointer as described in this section but you should not dereference it.

- SCI_GETDOCPOINTER
+ SCI_GETDOCPOINTER
SCI_SETDOCPOINTER(<unused>, document *pDoc)
SCI_CREATEDOCUMENT
@@ -3335,7 +3355,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ *pDoc)
SCI_RELEASEDOCUMENT(<unused>, document *pDoc)
- +

SCI_GETDOCPOINTER
This returns a pointer to the document currently in use by the window. It has no other @@ -3391,7 +3411,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ The best way to see how this is done is to search the SciTE source code for the messages used in this section of the documentation and see how they are used. You will also need to use markers and a folding margin to complete your folding implementation.

- SCI_VISIBLEFROMDOCLINE(int docLine)
+ SCI_VISIBLEFROMDOCLINE(int + docLine)
SCI_DOCLINEFROMVISIBLE(int displayLine)
SCI_SHOWLINES(int lineStart, int lineEnd)
@@ -3409,7 +3430,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_ENSUREVISIBLE(int line)
SCI_ENSUREVISIBLEENFORCEPOLICY(int line)
- +

SCI_VISIBLEFROMDOCLINE(int docLine)
When some lines are folded, then a particular line in the document may be displayed at a @@ -3455,13 +3476,13 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ If you use a lexer, you should not need to use SCI_SETFOLDLEVEL as this is far better handled by the lexer. You will need to use SCI_GETFOLDLEVEL to decide how to handle user folding requests. If you do change the fold levels, the folding margin will - update to match your changes. + update to match your changes.

SCI_SETFOLDFLAGS(int flags)
In addition to showing markers in the folding margin, you can indicate folds to the user by drawing lines in the text area. The lines are drawn in the foreground colour set for STYLE_DEFAULT. Bits set in flags - determine where folding lines are drawn:
+ class="message" href="#StyleDefinition">STYLE_DEFAULT. Bits set in + flags determine where folding lines are drawn:

@@ -3554,14 +3575,14 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ message travels up the fold hierarchy, expanding any contracted folds until they reach the top level. The line will then be visible. If you use SCI_ENSUREVISIBLEENFORCEPOLICY, the vertical caret policy set by SCI_SETVISIBLEPOLICY is then applied.

+ href="#SCI_SETVISIBLEPOLICY">SCI_SETVISIBLEPOLICY is then applied.

Line wrapping

- SCI_SETWRAPMODE(int wrapMode)
+ SCI_SETWRAPMODE(int wrapMode)
SCI_GETWRAPMODE
SCI_SETLAYOUTCACHE(int cacheMode)
SCI_GETLAYOUTCACHE
- +

By default, Scintilla does not wrap lines of text. If you enable line wrapping, lines wider than the window width are continued on the following lines. Lines are broken after space or tab @@ -3644,18 +3665,18 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){



- +

Zooming

Scintilla incorporates a "zoom factor" that lets you make all the text in the document larger or smaller in steps of one point. The displayed point size never goes below 2, whatever zoom factor you set. You can set zoom factors in the range -10 to +20 points.

- SCI_ZOOMIN
+ SCI_ZOOMIN
SCI_ZOOMOUT
SCI_SETZOOM(int zoomInPoints)
SCI_GETZOOM
- +

SCI_ZOOMIN
SCI_ZOOMOUT
@@ -3673,13 +3694,13 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

You can choose to mark lines that exceed a given length by drawing a vertical line or by colouring the background of characters that exceed the set length.

- SCI_SETEDGEMODE(int mode)
+ SCI_SETEDGEMODE(int mode)
SCI_GETEDGEMODE
SCI_SETEDGECOLUMN(int column)
SCI_GETEDGECOLUMN
SCI_SETEDGECOLOUR(int colour)
SCI_GETEDGECOLOUR
- +

SCI_SETEDGEMODE(int edgeMode)
SCI_GETEDGEMODE
@@ -3713,9 +3734,10 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ 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. . + 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. . @@ -3730,7 +3752,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

- +

SCI_SETEDGECOLUMN(int column)
SCI_GETEDGECOLUMN
@@ -3756,7 +3778,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

Scintilla (Windows version) also supports external lexers. These are DLLs that export four functions: GetLexerCount, GetLexerName, Lex and Fold. See externalLexer.cxx for more.

- SCI_SETLEXER(int lexer)
+ SCI_SETLEXER(int lexer)
SCI_GETLEXER
SCI_SETLEXERLANGUAGE(<unused>, char *name)
@@ -3764,7 +3786,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_SETPROPERTY(char *key, char *value)
SCI_SETKEYWORDS(int keyWordSet, char *keyWordList)
- +

SCI_SETLEXER(int lexer)
SCI_GETLEXER
@@ -3786,8 +3808,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ LexerModule constructor is the name to use.

To test if your lexer assignment worked, use SCI_GETLEXER before and after setting the new lexer to see if the - lexer number changed.

+ href="#SCI_GETLEXER">SCI_GETLEXER before and after setting the new lexer to + see if the lexer number changed.

SCI_COLOURISE(int startPos, int endPos)
This forces the current lexer or the container (if the lexer is set to @@ -3875,7 +3897,7 @@ struct SCNotification {

The notification messages that your container can choose to handle and the messages associated with them are:

- SCN_STYLENEEDED
+ SCN_STYLENEEDED
SCN_CHARADDED
SCN_SAVEPOINTREACHED
SCN_SAVEPOINTLEFT
@@ -3893,29 +3915,31 @@ struct SCNotification { SCN_DWELLSTART
SCN_DWELLEND
SCN_ZOOM
- +

The following SCI_* messages are associated with these notifications:

- SCI_SETMODEVENTMASK(int eventMask)
+ SCI_SETMODEVENTMASK(int + eventMask)
SCI_GETMODEVENTMASK
SCI_SETMOUSEDWELLTIME
SCI_GETMOUSEDWELLTIME
- +

The following additional notifications are sent using the WM_COMMAND message on Windows and the "Command" signal on GTK+ to emulate the windows edit control:

- SCEN_CHANGE
+ SCEN_CHANGE
SCEN_SETFOCUS
SCEN_KILLFOCUS
- +

SCN_STYLENEEDED
If you used SCI_SETLEXER(SCLEX_CONTAINER) to make the container act as the lexer, you will receive this notification when Scintilla is about to display or print text that requires styling. You are required to style the text from the line that contains the position - returned by SCI_GETENDSTYLED up to the position - passed in SCNotification.position. Symbolically, you need code of the form:

+ returned by SCI_GETENDSTYLED up to + the position passed in SCNotification.position. Symbolically, you need code of the + form:

     startPos = SCI_GETENDSTYLED()
     lineNumber = SCI_POSITIONFROMLINE(lineNumber);
      SCN_SAVEPOINTLEFT
Sent to the container when the save point is entered or left, allowing the container to display a "document dirty" indicator and change its menus.
- See also: SCI_SETSAVEPOINT, SCI_GETMODIFY

+ See also: SCI_SETSAVEPOINT, SCI_GETMODIFY

SCN_MODIFYATTEMPTRO
When in read-only mode, this notification is sent to the container if the user tries to change @@ -3960,16 +3984,17 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); This was previously called SCN_CHECKBRACE because a common use is to check whether the caret is next to a brace and set highlights on this brace and its corresponding matching brace. - This also replaces SCN_POSCHANGED, which is now - deprecated.

+ This also replaces SCN_POSCHANGED, + which is now deprecated.

SCN_MODIFIED
This notification is sent when the text or styling of the document changes or is about to change. You can set a mask for the notifications that are sent to the container with SCI_SETMODEVENTMASK. The notification structure - contains information about what changed, how the change occurred and whether this changed the - number of lines in the document. No modifications may be performed while in a - SCN_MODIFIED event. The SCNotification fields used are:

+ class="message" href="#SCI_SETMODEVENTMASK">SCI_SETMODEVENTMASK. The + notification structure contains information about what changed, how the change occurred and + whether this changed the number of lines in the document. No modifications may be performed + while in a SCN_MODIFIED event. The SCNotification fields used + are:

@@ -4174,7 +4199,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); + class="message" href="#SCI_SETMODEVENTMASK">SCI_SETMODEVENTMASK. @@ -4187,15 +4212,16 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); "Command" signal on GTK+ as this is the behavior of the standard edit control (SCEN_CHANGE has the same value as the Windows edit control EN_CHANGE). No other information is sent. If you need more detailed information - use SCN_MODIFIED. You can filter the types of - changes you are notified about with SCI_SETMODEVENTMASK.

+ use SCN_MODIFIED. You can filter the + types of changes you are notified about with SCI_SETMODEVENTMASK.

SCI_SETMODEVENTMASK(int eventMask)
SCI_GETMODEVENTMASK
These messages set and get an event mask that determines which document change events are - notified to the container with SCN_MODIFIED and SCEN_CHANGE. For example, a container may decide to see + notified to the container with SCN_MODIFIED and SCEN_CHANGE. For example, a container may decide to see only notifications about changes to text and not styling changes by calling SCI_SETMODEVENTMASK(SC_MOD_INSERTTEXT|SC_MOD_DELETETEXT).

@@ -4218,12 +4244,13 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber);

SCN_MACRORECORD
The SCI_STARTRECORD and SCI_STOPRECORD messages enable and disable macro - recording. When enabled, each time a recordable change occurs, the SCN_MACRORECORD - notification is sent to the container. It is up to the container to record the action. To see - the complete list of SCI_* messages that are recordable, search the Scintilla - source Editor.cxx for Editor::NotifyMacroRecord. The fields of - SCNotification set in this notification are:

+ class="message" href="#SCI_STOPRECORD">SCI_STOPRECORD messages enable and + disable macro recording. When enabled, each time a recordable change occurs, the + SCN_MACRORECORD notification is sent to the container. It is up to the container + to record the action. To see the complete list of SCI_* messages that are + recordable, search the Scintilla source Editor.cxx for + Editor::NotifyMacroRecord. The fields of SCNotification set in this + notification are:

0xf77 This is a mask for all valid flags. This is the default mask state set by SCI_SETMODEVENTMASK. None
@@ -4258,8 +4285,9 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber);

SCN_MARGINCLICK
This notification tells the container that the mouse was clicked inside a margin that was marked as sensitive (see SCI_SETMARGINSENSITIVEN). This can be used to perform - folding or to place breakpoints. The following SCNotification fields are used:

+ href="#SCI_SETMARGINSENSITIVEN">SCI_SETMARGINSENSITIVEN). This can be used to + perform folding or to place breakpoints. The following SCNotification fields are + used:

@@ -4300,7 +4328,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); point is deleted. This message is sent to the container in case it wants to make the line visible in some unusual way such as making the whole document visible. Most containers will just ensure each line in the range is visible by calling SCI_ENSUREVISIBLE. The position and + href="#SCI_ENSUREVISIBLE">SCI_ENSUREVISIBLE. The position and length fields of SCNotification indicate the range of the document that should be made visible. The container code will be similar to the following code skeleton:

@@ -4333,8 +4361,8 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next + class="message" href="#SCI_USERLISTSHOW">SCI_USERLISTSHOW message that + initiated the list. @@ -4346,7 +4374,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next
wParam This is set to the listType parameter from the SCI_USERLISTSHOW message that initiated the - list.


- +

SCN_URIDROPPED
Only on the GTK+ version. Indicates that the user has dragged a URI such as a file name or web @@ -4390,7 +4418,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next

- +

SCI_SETMOUSEDWELLTIME
SCI_GETMOUSEDWELLTIME
@@ -4460,13 +4488,13 @@ EM_FORMATRANGE

SCN_POSCHANGED() Deprecated
Fired when the user moves the cursor to a different position in the text. Use SCN_UPDATEUI instead.

+ class="message" href="#SCN_UPDATEUI">SCN_UPDATEUI instead.

SCN_CHECKBRACE Deprecated
Either the text or styling of the document has changed or the selection range has changed. - This is replaced by SCN_UPDATEUI. You can also use - SCN_MODIFIED for more detailed - information on text and styling changes,

+ This is replaced by SCN_UPDATEUI. You + can also use SCN_MODIFIED for more + detailed information on text and styling changes,

Edit messages never supported by Scintilla

-- 
cgit v1.2.3