From ec830eeb2f0ee7e6ed422f1e2c801db6047ee483 Mon Sep 17 00:00:00 2001 From: Neil Date: Thu, 29 Sep 2016 14:11:47 +1000 Subject: Increased compatibility between interface definition and documentation. Made parameter names and types more consistent. Document return types. Use more classes in documentation to facilitate scripting and styling. --- doc/ScintillaDoc.html | 2191 +++++++++++++++++++++++------------------------ include/Scintilla.iface | 191 +++-- 2 files changed, 1186 insertions(+), 1196 deletions(-) diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index a4e5ef20c..b50a891f3 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -14,13 +14,14 @@ @@ -84,7 +88,7 @@

Scintilla Documentation

-

Last edited 20 September 2016 NH

+

Last edited 29 September 2016 NH

There is an overview of the internal design of Scintilla.
@@ -395,38 +399,36 @@ 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) → int
SCI_SETTEXT(<unused>, const char *text)
SCI_SETSAVEPOINT
- SCI_GETLINE(int line, char *text)
+ SCI_GETLINE(int line, char *text) → int
SCI_REPLACESEL(<unused>, const char *text)
SCI_SETREADONLY(bool readOnly)
- SCI_GETREADONLY
- SCI_GETTEXTRANGE(<unused>, Sci_TextRange - *tr)
- SCI_ALLOCATE(int bytes, <unused>)
- SCI_ADDTEXT(int length, const char *s)
- SCI_ADDSTYLEDTEXT(int length, cell *s)
- SCI_APPENDTEXT(int length, const char *s)
+ SCI_GETREADONLY → bool
+ SCI_GETTEXTRANGE(<unused>, Sci_TextRange *tr) → int
+ SCI_ALLOCATE(int bytes)
+ SCI_ADDTEXT(int length, const char *text)
+ SCI_ADDSTYLEDTEXT(int length, cell *c)
+ SCI_APPENDTEXT(int length, const char *text)
SCI_INSERTTEXT(int pos, const char *text)
SCI_CHANGEINSERTION(int length, const char *text)
SCI_CLEARALL
- SCI_DELETERANGE(int pos, int deleteLength)
+ SCI_DELETERANGE(int start, int lengthDelete)
SCI_CLEARDOCUMENTSTYLE
- SCI_GETCHARAT(int position)
- SCI_GETSTYLEAT(int position)
- SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange - *tr)
+ SCI_GETCHARAT(int pos) → int
+ SCI_GETSTYLEAT(int pos) → int
+ SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr) → int
SCI_RELEASEALLEXTENDEDSTYLES
- SCI_ALLOCATEEXTENDEDSTYLES(int numberStyles)
- SCI_TARGETASUTF8(<unused>, char *s)
- SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded)
+ SCI_ALLOCATEEXTENDEDSTYLES(int numberStyles) → int
+ SCI_TARGETASUTF8(<unused>, char *s) → int
+ SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → int
SCI_SETLENGTHFORENCODE(int bytes)
 -

SCI_GETTEXT(int length, char *text NUL-terminated)
- This returns length-1 characters of text from the start of the document plus one +

SCI_GETTEXT(int length, char *text NUL-terminated) → int
+ This returns length-1 characters of text from the start of the document plus one terminating 0 character. To collect all the text in a document, use SCI_GETLENGTH to get the number of characters in the document (nLen), allocate a character buffer of length nLen+1 bytes, then call SCI_GETTEXT(nLen+1, char @@ -435,11 +437,11 @@ If you then save the text, you should use SCI_SETSAVEPOINT to mark the text as unmodified.

-

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

+

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

SCI_SETTEXT(<unused>, const char *text)
This replaces all the text in the document with the zero terminated text string you pass @@ -458,7 +460,7 @@

See also: SCI_EMPTYUNDOBUFFER, SCI_GETMODIFY

-

SCI_GETLINE(int line, char *text)
+

SCI_GETLINE(int line, char *text) → int
This fills the buffer defined by text with the contents of the nominated line (lines start at 0). The buffer is not terminated by a 0 character. It is up to you to make sure that the buffer is long enough for the text, use -

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

+

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

SCI_REPLACESEL(<unused>, const char *text)
The currently selected text between the anchor @@ -481,13 +483,12 @@ positioned after the inserted text and the caret is scrolled into view.

SCI_SETREADONLY(bool readOnly)
- SCI_GETREADONLY
+ SCI_GETREADONLY → bool
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.

-

SCI_GETTEXTRANGE(<unused>, Sci_TextRange *tr)
+

SCI_GETTEXTRANGE(<unused>, Sci_TextRange *tr) → int
This collects the text between the positions cpMin and cpMax and copies it to lpstrText (see struct Sci_TextRange in Scintilla.h). If cpMax is -1, text is returned to the end of the @@ -495,14 +496,13 @@ 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, SCI_GETCURLINE, SCI_GETSTYLEDTEXT, SCI_GETTEXT

+

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

-

SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr)
+

SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr) → int
This collects styled text into a buffer using two bytes for each cell, with the character at the lower address of each pair and the style byte at the upper address. Characters between the positions cpMin and cpMax are copied to lpstrText (see @@ -512,34 +512,36 @@ cpMin or cpMax. Positions outside the document return character codes and style bytes of 0.

-

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

+

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

-

SCI_ALLOCATE(int bytes, <unused>)
+

SCI_ALLOCATE(int bytes)
Allocate a document buffer large enough to store a given number of bytes. The document will not be made smaller than its current contents.

-

SCI_ADDTEXT(int length, const char *s)
- This inserts the first length characters from the string s +

SCI_ADDTEXT(int length, const char *text)
+ This inserts the first length characters from the string + text at the current position. This will include any 0's in the string that you might have expected to stop the insert operation. The current position is set at the end of the inserted text, but it is not scrolled into view.

-

SCI_ADDSTYLEDTEXT(int length, cell *s)
+

SCI_ADDSTYLEDTEXT(int length, cell *c)
This behaves just like SCI_ADDTEXT, but inserts styled text.

-

SCI_APPENDTEXT(int length, const char *s)
- This adds the first length characters from the string s to the end +

SCI_APPENDTEXT(int length, const char *text)
+ This adds the first length characters from the string + text to the end of the document. This will include any 0's in the string that you might have expected to stop the operation. The current selection is not changed and the new text is not scrolled into view.

SCI_INSERTTEXT(int pos, const char *text)
- This inserts the zero terminated text string at position pos or at - the current position if pos is -1. If the current position is after the insertion point + This inserts the zero terminated text string at position pos or at + the current position if pos is -1. If the current position is after the insertion point then it is moved along with its surrounding text but no scrolling is performed.

SCI_CHANGEINSERTION(int length, const char *text)
@@ -549,7 +551,7 @@

SCI_CLEARALL
Unless the document is read-only, this deletes all the text.

-

SCI_DELETERANGE(int pos, int deleteLength)
+

SCI_DELETERANGE(int start, int lengthDelete)
Deletes a range of text in the document.

SCI_CLEARDOCUMENTSTYLE
@@ -557,16 +559,16 @@ SCI_CLEARDOCUMENTSTYLE can be used to clear all styling information and reset the folding state.

-

SCI_GETCHARAT(int pos)
- This returns the character at pos in the document or 0 if pos is +

SCI_GETCHARAT(int pos) → int
+ This returns the character at pos in the document or 0 if pos is negative or past the end of the document.

-

SCI_GETSTYLEAT(int pos)
- This returns the style at pos in the document, or 0 if pos is +

SCI_GETSTYLEAT(int pos) → int
+ This returns the style at pos in the document, or 0 if pos is negative or past the end of the document.

SCI_RELEASEALLEXTENDEDSTYLES
- SCI_ALLOCATEEXTENDEDSTYLES(int numberStyles)
+ SCI_ALLOCATEEXTENDEDSTYLES(int numberStyles) → int
Extended styles are used for features like textual margins and annotations as well as internally by Scintilla. They are outside the range 0..255 used for the styles bytes associated with document bytes. These functions manage the use of extended styles to ensures that components cooperate in defining styles. @@ -574,8 +576,8 @@ SCI_ALLOCATEEXTENDEDSTYLES allocates a range of style numbers after the byte style values and returns the number of the first allocated style. Ranges for margin and annotation styles should be allocated before calling - SCI_MARGINSETSTYLEOFFSET or - SCI_ANNOTATIONSETSTYLEOFFSET.

+ SCI_MARGINSETSTYLEOFFSET or + SCI_ANNOTATIONSETSTYLEOFFSET.

Sci_TextRange and Sci_CharacterRange
These structures are defined to be exactly the same shape as the Win32 TEXTRANGE @@ -599,7 +601,7 @@ struct Sci_TextRange {

Specific to GTK+, Cocoa and Windows only: Access to encoded text

-

SCI_TARGETASUTF8(<unused>, char *s)
+

SCI_TARGETASUTF8(<unused>, char *s) → int
This method retrieves the value of the target encoded as UTF-8 which is the default encoding of GTK+ so is useful for retrieving text for use in other parts of the user interface, such as find and replace dialogs. The length of the encoded text in bytes is returned. @@ -607,7 +609,7 @@ struct Sci_TextRange { more complex work of transcoding from the various encodings supported.

-

SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded)
+

SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → int
SCI_SETLENGTHFORENCODE(int bytes)
SCI_ENCODEDFROMUTF8 converts a UTF-8 string into the document's encoding which is useful for taking the results of a find dialog, for example, and receiving @@ -622,7 +624,7 @@ struct Sci_TextRange {

There are methods to search for text and for regular expressions. Most applications should use - SCI_SEARCHINTARGET + SCI_SEARCHINTARGET as the basis for their search implementations. Other calls augment this or were implemented before SCI_SEARCHINTARGET.

@@ -635,7 +637,7 @@ struct Sci_TextRange { A different regular expression library can be integrated into Scintilla or can be called from the container using direct access to the buffer contents through - SCI_GETCHARACTERPOINTER. + SCI_GETCHARACTERPOINTER.

Search and replace using the target

@@ -646,30 +648,26 @@ struct Sci_TextRange { SCI_SEARCHINTARGET such as SCFIND_MATCHCASE, SCFIND_WHOLEWORD, SCFIND_WORDSTART, and SCFIND_REGEXP can be set with SCI_SETSEARCHFLAGS.

- SCI_SETTARGETSTART(int pos)
- SCI_GETTARGETSTART
- SCI_SETTARGETEND(int pos)
- SCI_GETTARGETEND
+ SCI_SETTARGETSTART(int start)
+ SCI_GETTARGETSTART → position
+ SCI_SETTARGETEND(int end)
+ SCI_GETTARGETEND → position
SCI_SETTARGETRANGE(int start, int end)
SCI_TARGETFROMSELECTION
SCI_TARGETWHOLEDOCUMENT
SCI_SETSEARCHFLAGS(int searchFlags)
- SCI_GETSEARCHFLAGS
- SCI_SEARCHINTARGET(int length, const char - *text)
- SCI_GETTARGETTEXT(<unused>, - char *text)
- SCI_REPLACETARGET(int length, const char - *text)
- SCI_REPLACETARGETRE(int length, const char - *text)
- SCI_GETTAG(int tagNumber, char *tagValue)
+ SCI_GETSEARCHFLAGS → int
+ SCI_SEARCHINTARGET(int length, const char *text) → int
+ SCI_GETTARGETTEXT(<unused>, char *text) → int
+ SCI_REPLACETARGET(int length, const char *text) → int
+ SCI_REPLACETARGETRE(int length, const char *text) → int
+ SCI_GETTAG(int tagNumber, char *tagValue) → int
 -

SCI_SETTARGETSTART(int pos)
- SCI_GETTARGETSTART
- SCI_SETTARGETEND(int pos)
- SCI_GETTARGETEND
+

SCI_SETTARGETSTART(int start)
+ SCI_GETTARGETSTART → position
+ SCI_SETTARGETEND(int end)
+ SCI_GETTARGETEND → position
SCI_SETTARGETRANGE(int start, int end)
These functions set and return the start and end of the target. When searching you can set start greater than end to find the last matching text in the @@ -683,47 +681,47 @@ struct Sci_TextRange { Set the target start to the start of the document and target end to the end of the document.

SCI_SETSEARCHFLAGS(int searchFlags)
- SCI_GETSEARCHFLAGS
- These get and set the searchFlags used by + SCI_GETSEARCHFLAGS → int
+ These get and set the searchFlags used by SCI_SEARCHINTARGET. There are several option flags including a simple regular expression search.

-

SCI_SEARCHINTARGET(int length, const char *text)
+

SCI_SEARCHINTARGET(int length, const char *text) → int
This searches for the first occurrence of a text string in the target defined by SCI_SETTARGETSTART and SCI_SETTARGETEND. The text string is not zero - terminated; the size is set by length. The search is modified by the search flags + terminated; the size is set by length. The search is modified by the search flags set by SCI_SETSEARCHFLAGS. If the search succeeds, the target is set to the found text and the return value is the position of the start of the matching text. If the search fails, the result is -1.

-

SCI_GETTARGETTEXT(<unused>, char *text)
+

SCI_GETTARGETTEXT(<unused>, char *text) → int
Retrieve the value in the target.

-

SCI_REPLACETARGET(int length, const char *text)
- If length is -1, text is a zero terminated string, otherwise - length sets the number of character to replace the target with. +

SCI_REPLACETARGET(int length, const char *text) → int
+ If length is -1, text is a zero terminated string, otherwise + length sets the number of character to replace the target with. After replacement, the target range refers to the replacement text. The return value is the length of the replacement string.
Note that the recommended way to delete text in the document is to set the target to the text to be removed, and to perform a replace target with an empty string.

-

SCI_REPLACETARGETRE(int length, const char *text)
- This replaces the target using regular expressions. If length is -1, - text is a zero terminated string, otherwise length is the number of +

SCI_REPLACETARGETRE(int length, const char *text) → int
+ This replaces the target using regular expressions. If length is -1, + text is a zero terminated string, otherwise length is the number of characters to use. The replacement string is formed from the text string with any sequences of \1 through \9 replaced by tagged matches from the most recent regular expression search. \0 is replaced with all the matched text from the most recent search. After replacement, the target range refers to the replacement text. The return value is the length of the replacement string.

-

SCI_GETTAG(int tagNumber, char *tagValue NUL-terminated)
+

SCI_GETTAG(int tagNumber, char *tagValue NUL-terminated) → int
Discover what text was matched by tagged expressions in a regular expression search. This is useful if the application wants to interpret the replacement string itself.

See also: SCI_FINDTEXT

-

searchFlags
+

searchFlags
Several of the search routines use flag options, which include a simple regular expression search. Combine the flag options by adding them:

@@ -876,19 +874,15 @@ struct Sci_TextRange { generally similar to regular expression support in JavaScript. See the documentation of your C++ runtime for details on what is supported.

- SCI_FINDTEXT(int flags, Sci_TextToFind - *ttf)
+ SCI_FINDTEXT(int searchFlags, Sci_TextToFind *ft) → position
SCI_SEARCHANCHOR
- SCI_SEARCHNEXT(int searchFlags, const char - *text)
- SCI_SEARCHPREV(int searchFlags, const char - *text)
+ SCI_SEARCHNEXT(int searchFlags, const char *text) → int
+ SCI_SEARCHPREV(int searchFlags, const char *text) → int
 -

SCI_FINDTEXT(int searchFlags, Sci_TextToFind *ttf)
+

SCI_FINDTEXT(int searchFlags, Sci_TextToFind *ft) → position
This message searches for text in the document. It does not use or move the current selection. - The searchFlags argument controls the + The searchFlags argument controls the search type, which includes regular expression searches.

You can @@ -922,8 +916,8 @@ struct Sci_TextToFind {

SCI_SEARCHANCHOR
- SCI_SEARCHNEXT(int searchFlags, const char *text)
- SCI_SEARCHPREV(int searchFlags, const char *text)
+ SCI_SEARCHNEXT(int searchFlags, const char *text) → int
+ SCI_SEARCHPREV(int searchFlags, const char *text) → int
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 SCI_SEARCHNEXT and SCI_SEARCHPREV search for the next and previous occurrence of the zero terminated search string pointed at by text. The search is modified by - the searchFlags.

+ the searchFlags.

The return value is -1 if nothing is found, otherwise the return value is the start position of the matching text. The selection is updated to show the matched text, but is not scrolled @@ -949,12 +943,16 @@ struct Sci_TextToFind {

Overtype

+ SCI_SETOVERTYPE(bool overType)
+ SCI_GETOVERTYPE → bool
+ +

SCI_SETOVERTYPE(bool overType)
- SCI_GETOVERTYPE
+ SCI_GETOVERTYPE → bool
When overtype is enabled, each typed character replaces the character to the right of the text caret. When overtype is disabled, characters are inserted at the caret. - SCI_GETOVERTYPE returns TRUE (1) if overtyping is active, otherwise - FALSE (0) will be returned. Use SCI_SETOVERTYPE to set the overtype + SCI_GETOVERTYPE returns true (1) if overtyping is active, otherwise + false (0) will be returned. Use SCI_SETOVERTYPE to set the overtype mode.

Cut, copy and paste

@@ -963,20 +961,19 @@ struct Sci_TextToFind { SCI_COPY
SCI_PASTE
SCI_CLEAR
- SCI_CANPASTE
+ SCI_CANPASTE → bool
SCI_COPYRANGE(int start, int end)
- SCI_COPYTEXT(int length, - const char *text)
+ SCI_COPYTEXT(int length, const char *text)
SCI_COPYALLOWLINE
SCI_SETPASTECONVERTENDINGS(bool convert)
- SCI_GETPASTECONVERTENDINGS
+ SCI_GETPASTECONVERTENDINGS → bool

SCI_CUT
SCI_COPY
SCI_PASTE
SCI_CLEAR
- SCI_CANPASTE
+ SCI_CANPASTE → bool
SCI_COPYALLOWLINE
These commands perform the standard tasks of cutting and copying data to the clipboard, pasting from the clipboard into the document, and clearing the document. @@ -985,7 +982,7 @@ struct Sci_TextToFind { SCI_GETSELECTIONEMPTY(), which will be zero if there are any non-empty selection ranges implying that a copy or cut to the clipboard should work.

-

GTK+ does not really support SCI_CANPASTE and always returns TRUE +

GTK+ does not really support SCI_CANPASTE and always returns true unless the document is read-only.

On X, the clipboard is asynchronous and may require several messages between @@ -1004,16 +1001,20 @@ struct Sci_TextToFind { text to the system clipboard.

SCI_SETPASTECONVERTENDINGS(bool convert)
- SCI_GETPASTECONVERTENDINGS
+ SCI_GETPASTECONVERTENDINGS → bool
If this property is set then when text is pasted any line ends are converted to match the document's end of line mode as set with - SCI_SETEOLMODE. + SCI_SETEOLMODE. Defaults to true.

Error handling

+ SCI_SETSTATUS(int status)
+ SCI_GETSTATUS → int
+ +

SCI_SETSTATUS(int status)
- SCI_GETSTATUS
+ SCI_GETSTATUS → int
If an error occurs, Scintilla may set an internal error number that can be retrieved with SCI_GETSTATUS. To clear the error status call SCI_SETSTATUS(0). @@ -1062,20 +1063,19 @@ struct Sci_TextToFind { SCI_ENDUNDOACTION messages. These transactions can be nested and only the top-level sequences are undone as units.

SCI_UNDO
- SCI_CANUNDO
+ SCI_CANUNDO → bool
SCI_EMPTYUNDOBUFFER
SCI_REDO
- SCI_CANREDO
- SCI_SETUNDOCOLLECTION(bool - collectUndo)
- SCI_GETUNDOCOLLECTION
+ SCI_CANREDO → bool
+ SCI_SETUNDOCOLLECTION(bool collectUndo)
+ SCI_GETUNDOCOLLECTION → bool
SCI_BEGINUNDOACTION
SCI_ENDUNDOACTION
SCI_ADDUNDOACTION(int token, int flags)

SCI_UNDO
- SCI_CANUNDO
+ SCI_CANUNDO → bool
SCI_UNDO undoes one action, or if the undo buffer has reached a SCI_ENDUNDOACTION point, all the actions back to the corresponding SCI_BEGINUNDOACTION.

@@ -1084,7 +1084,7 @@ struct Sci_TextToFind { typically use the result of this message to enable/disable the Edit menu Undo command.

SCI_REDO
- SCI_CANREDO
+ SCI_CANREDO → bool
SCI_REDO undoes the effect of the last SCI_UNDO operation.

SCI_CANREDO returns 0 if there is no action to redo and 1 if there are undo @@ -1101,7 +1101,7 @@ struct Sci_TextToFind {

See also: SCI_SETSAVEPOINT

SCI_SETUNDOCOLLECTION(bool collectUndo)
- SCI_GETUNDOCOLLECTION
+ SCI_GETUNDOCOLLECTION → bool
You can control whether Scintilla collects undo information with SCI_SETUNDOCOLLECTION. Pass in true (1) to collect information and false (0) to stop collecting. If you stop collection, you should also use @@ -1150,78 +1150,73 @@ struct Sci_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_GETLENGTH
- SCI_GETLINECOUNT
- SCI_LINESONSCREEN
- SCI_GETMODIFY
- SCI_SETSEL(int anchorPos, int currentPos)
- SCI_GOTOPOS(int position)
+ SCI_GETTEXTLENGTH → int
+ SCI_GETLENGTH → int
+ SCI_GETLINECOUNT → int
+ SCI_LINESONSCREEN → int
+ SCI_GETMODIFY → bool
+ SCI_SETSEL(int anchor, int caret)
+ SCI_GOTOPOS(int caret)
SCI_GOTOLINE(int line)
- SCI_SETCURRENTPOS(int position)
- SCI_GETCURRENTPOS
- SCI_SETANCHOR(int position)
- SCI_GETANCHOR
- SCI_SETSELECTIONSTART(int position)
- SCI_GETSELECTIONSTART
- SCI_SETSELECTIONEND(int position)
- SCI_GETSELECTIONEND
- SCI_SETEMPTYSELECTION(int pos)
+ SCI_SETCURRENTPOS(int caret)
+ SCI_GETCURRENTPOS → position
+ SCI_SETANCHOR(int anchor)
+ SCI_GETANCHOR → position
+ SCI_SETSELECTIONSTART(int anchor)
+ SCI_GETSELECTIONSTART → position
+ SCI_SETSELECTIONEND(int caret)
+ SCI_GETSELECTIONEND → position
+ SCI_SETEMPTYSELECTION(int caret)
SCI_SELECTALL
- SCI_LINEFROMPOSITION(int position)
- SCI_POSITIONFROMLINE(int line)
- SCI_GETLINEENDPOSITION(int line)
- SCI_LINELENGTH(int line)
- SCI_GETCOLUMN(int position)
- SCI_FINDCOLUMN(int line, int column)
- SCI_POSITIONFROMPOINT(int x, int y)
- SCI_POSITIONFROMPOINTCLOSE(int x, int - y)
- SCI_CHARPOSITIONFROMPOINT(int x, int y)
- SCI_CHARPOSITIONFROMPOINTCLOSE(int x, int - y)
- SCI_POINTXFROMPOSITION(<unused>, int - position)
- SCI_POINTYFROMPOSITION(<unused>, int - position)
+ SCI_LINEFROMPOSITION(int pos) → int
+ SCI_POSITIONFROMLINE(int line) → position
+ SCI_GETLINEENDPOSITION(int line) → position
+ SCI_LINELENGTH(int line) → int
+ SCI_GETCOLUMN(int pos) → int
+ SCI_FINDCOLUMN(int line, int column) → int
+ SCI_POSITIONFROMPOINT(int x, int y) → position
+ SCI_POSITIONFROMPOINTCLOSE(int x, int y) → position
+ SCI_CHARPOSITIONFROMPOINT(int x, int y) → position
+ SCI_CHARPOSITIONFROMPOINTCLOSE(int x, int y) → position
+ SCI_POINTXFROMPOSITION(<unused>, int pos) → int
+ SCI_POINTYFROMPOSITION(<unused>, int pos) → int
SCI_HIDESELECTION(bool hide)
- SCI_GETSELTEXT(<unused>, char *text)
- SCI_GETCURLINE(int textLen, char *text)
- SCI_SELECTIONISRECTANGLE
- SCI_SETSELECTIONMODE(int mode)
- SCI_GETSELECTIONMODE
- SCI_GETLINESELSTARTPOSITION(int line)
- SCI_GETLINESELENDPOSITION(int line)
+ SCI_GETSELTEXT(<unused>, char *text) → int
+ SCI_GETCURLINE(int length, char *text) → int
+ SCI_SELECTIONISRECTANGLE → bool
+ SCI_SETSELECTIONMODE(int selectionMode)
+ SCI_GETSELECTIONMODE → int
+ SCI_GETLINESELSTARTPOSITION(int line) → position
+ SCI_GETLINESELENDPOSITION(int line) → position
SCI_MOVECARETINSIDEVIEW
- SCI_POSITIONBEFORE(int position)
- SCI_POSITIONAFTER(int position)
- SCI_POSITIONRELATIVE(int position, int relative)
- SCI_COUNTCHARACTERS(int startPos, int endPos)
- SCI_TEXTWIDTH(int styleNumber, const char *text)
- SCI_TEXTHEIGHT(int line)
+ SCI_POSITIONBEFORE(int pos) → position
+ SCI_POSITIONAFTER(int pos) → position
+ SCI_POSITIONRELATIVE(int pos, int relative) → position
+ SCI_COUNTCHARACTERS(int start, int end) → int
+ SCI_TEXTWIDTH(int style, const char *text) → int
+ SCI_TEXTHEIGHT(int line) → int
SCI_CHOOSECARETX
SCI_MOVESELECTEDLINESUP
SCI_MOVESELECTEDLINESDOWN
- SCI_SETMOUSESELECTIONRECTANGULARSWITCH(bool - mouseSelectionRectangularSwitch)
- SCI_GETMOUSESELECTIONRECTANGULARSWITCH
+ SCI_SETMOUSESELECTIONRECTANGULARSWITCH(bool mouseSelectionRectangularSwitch)
+ SCI_GETMOUSESELECTIONRECTANGULARSWITCH → bool
 -

SCI_GETTEXTLENGTH
- SCI_GETLENGTH
+

SCI_GETTEXTLENGTH → int
+ SCI_GETLENGTH → int
Both these messages return the length of the document in bytes.

-

SCI_GETLINECOUNT
+

SCI_GETLINECOUNT → int
This returns the number of lines in the document. An empty document contains 1 line. A document holding only an end of line sequence has 2 lines.

-

SCI_LINESONSCREEN
+

SCI_LINESONSCREEN → int
This returns the number of complete lines visible on the screen. With a constant line height, this is the vertical space available divided by the line separation. Unless you arrange to size your window to an integral number of lines, there may be a partial line visible at the bottom of the view.

-

SCI_GETMODIFY
+

SCI_GETMODIFY → bool
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, @@ -1233,44 +1228,44 @@ struct Sci_TextToFind { href="#SCN_SAVEPOINTLEFT">SCN_SAVEPOINTLEFT notification messages.

-

SCI_SETSEL(int anchorPos, int currentPos)
- This message sets both the anchor and the current position. If currentPos is - negative, it means the end of the document. If anchorPos is negative, it means - remove any selection (i.e. set the anchor to the same position as currentPos). The +

SCI_SETSEL(int anchor, int caret)
+ This message sets both the anchor and the current position. If caret is + negative, it means the end of the document. If anchor is negative, it means + remove any selection (i.e. set the anchor to the same position as caret). The caret is scrolled into view after this operation.

-

SCI_GOTOPOS(int pos)
- This removes any selection, sets the caret at pos and scrolls the view to make +

SCI_GOTOPOS(int caret)
+ This removes any selection, sets the caret at caret and scrolls the view to make the caret visible, if necessary. It is equivalent to - SCI_SETSEL(pos, pos). The anchor position is set the same as the current + SCI_SETSEL(caret, caret). The anchor position is set the same as the current position.

SCI_GOTOLINE(int line)
- This removes any selection and sets the caret at the start of line number line + This removes any selection and sets the caret at the start of line number line and scrolls the view (if needed) to make it visible. The anchor position is set the same as the - current position. If line is outside the lines in the document (first line is 0), + current position. If line is outside the lines in the document (first line is 0), the line set is the first or last.

-

SCI_SETCURRENTPOS(int pos)
+

SCI_SETCURRENTPOS(int caret)
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

-

SCI_GETCURRENTPOS
+

SCI_GETCURRENTPOS → position
This returns the current position.

-

SCI_SETANCHOR(int pos)
+

SCI_SETANCHOR(int anchor)
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

-

SCI_GETANCHOR
+

SCI_GETANCHOR → position
This returns the current anchor position.

-

SCI_SETSELECTIONSTART(int pos)
- SCI_SETSELECTIONEND(int pos)
+

SCI_SETSELECTIONSTART(int anchor)
+ SCI_SETSELECTIONEND(int caret)
These set the selection based on the assumption that the anchor position is less than the current position. They do not make the caret visible. The table shows the positions of the anchor and the current position after using these messages.

@@ -1279,11 +1274,12 @@ struct Sci_TextToFind { + New value for anchor - current + caret @@ -1291,96 +1287,96 @@ struct Sci_TextToFind { SCI_SETSELECTIONSTART - pos + anchor - Max(pos, current) + Max(anchor, current) SCI_SETSELECTIONEND - Min(anchor, pos) + Min(anchor, caret) - pos + caret

See also: SCI_SCROLLCARET

-

SCI_GETSELECTIONSTART
- SCI_GETSELECTIONEND
+

SCI_GETSELECTIONSTART → position
+ SCI_GETSELECTIONEND → position
These return the start and end of the selection without regard to which end is the current position and which is the anchor. SCI_GETSELECTIONSTART returns the smaller of the current position or the anchor position. SCI_GETSELECTIONEND returns the larger of the two values.

-

SCI_SETEMPTYSELECTION(int pos)
- This removes any selection and sets the caret at pos. The caret is not scrolled into view.

+

SCI_SETEMPTYSELECTION(int caret)
+ This removes any selection and sets the caret at caret. The caret is not scrolled into view.

SCI_SELECTALL
This selects all the text in the document. The current position is not scrolled into view.

-

SCI_LINEFROMPOSITION(int pos)
- This message returns the line that contains the position pos in the document. The - return value is 0 if pos <= 0. The return value is the last line if - pos is beyond the end of the document.

+

SCI_LINEFROMPOSITION(int pos) → int
+ This message returns the line that contains the position pos in the document. The + return value is 0 if pos <= 0. The return value is the last line if + pos is beyond the end of the document.

-

SCI_POSITIONFROMLINE(int line)
+

SCI_POSITIONFROMLINE(int line) → position
This returns the document position that corresponds with the start of the line. If - line is negative, the position of the line holding the start of the selection is - returned. If line is greater than the lines in the document, the return value is - -1. If line is equal to the number of lines in the document (i.e. 1 line past the + line is negative, the position of the line holding the start of the selection is + returned. If line is greater than the lines in the document, the return value is + -1. If line is equal to the number of lines in the document (i.e. 1 line past the last line), the return value is the end of the document.

-

SCI_GETLINEENDPOSITION(int line)
- This returns the position at the end of the line, before any line end characters. If line +

SCI_GETLINEENDPOSITION(int line) → position
+ This returns the position at the end of the line, before any line end characters. If line is the last line in the document (which does not have any end of line characters) or greater, the result is the size of the document. - If line is negative the result is undefined.

+ If line is negative the result is undefined.

-

SCI_LINELENGTH(int line)
- This returns the length of the line, including any line end characters. If line +

SCI_LINELENGTH(int line) → int
+ This returns the length of the line, including any line end characters. If line is negative or beyond the last line in the document, the result is 0. If you want the length of the line not including any end of line characters, use SCI_GETLINEENDPOSITION(line) - SCI_POSITIONFROMLINE(line).

-

SCI_GETSELTEXT(<unused>, char *text NUL-terminated)
- This copies the currently selected text and a terminating 0 byte to the text - buffer. The buffer size should be determined by calling with a NULL pointer for the text argument +

SCI_GETSELTEXT(<unused>, char *text NUL-terminated) → int
+ This copies the currently selected text and a terminating 0 byte to the text + buffer. The buffer size should be determined by calling with a NULL pointer for the text argument SCI_GETSELTEXT(0,0). This allows for rectangular and discontiguous selections as well as simple selections. See Multiple Selection for information on how multiple and rectangular selections and virtual space are copied.

-

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 NUL-terminated)
+

SCI_GETCURLINE(int length, char *text NUL-terminated) → int
This retrieves the text of the line containing the caret and returns the position within the line of the caret. Pass in char* text pointing at a buffer large enough to hold the text you wish to retrieve and a terminating 0 character. - Set textLen to the + Set length to the length of the buffer which must be at least 1 to hold the terminating 0 character. If the text argument is 0 then the length that should be allocated to store the entire current line is returned.

-

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

-

SCI_SELECTIONISRECTANGLE
+

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

-

SCI_SETSELECTIONMODE(int mode)
- SCI_GETSELECTIONMODE
+

SCI_SETSELECTIONMODE(int selectionMode)
+ SCI_GETSELECTIONMODE → int
The two functions set and get the selection mode, which can be stream (SC_SEL_STREAM=0) or rectangular (SC_SEL_RECTANGLE=1) or @@ -1393,8 +1389,8 @@ struct Sci_TextToFind { SC_SEL_THIN is the mode after a rectangular selection has been typed into and ensures that no characters are selected.

-

SCI_GETLINESELSTARTPOSITION(int line)
- SCI_GETLINESELENDPOSITION(int line)
+

SCI_GETLINESELSTARTPOSITION(int line) → position
+ SCI_GETLINESELENDPOSITION(int line) → position
Retrieve the position of the start and end of the selection at the given line with INVALID_POSITION returned if no selection on this line.

@@ -1402,61 +1398,61 @@ struct Sci_TextToFind { If the caret is off the top or bottom of the view, it is moved to the nearest line that is visible to its current position. Any selection is lost.

-

SCI_POSITIONBEFORE(int position)
- SCI_POSITIONAFTER(int position)
+

SCI_POSITIONBEFORE(int pos) → position
+ SCI_POSITIONAFTER(int pos) → position
These messages return the position before and after another position in the document taking into account the current code page. The minimum position returned is 0 and the maximum is the last position in the document. If called with a position within a multi byte character will return the position of the start/end of that character.

-

SCI_POSITIONRELATIVE(int position, int relative)
+

SCI_POSITIONRELATIVE(int pos, int relative) → position
Count a number of whole characters before or after the argument position and return that position. The minimum position returned is 0 and the maximum is the last position in the document. If the position goes past the document end then 0 is returned.

-

SCI_COUNTCHARACTERS(int startPos, int endPos)
+

SCI_COUNTCHARACTERS(int start, int end) → int
Returns the number of whole characters between two positions..

-

SCI_TEXTWIDTH(int styleNumber, const char *text)
- This returns the pixel width of a string drawn in the given styleNumber which can +

SCI_TEXTWIDTH(int style, const char *text) → int
+ This returns the pixel width of a string drawn in the given style which can be used, for example, to decide how wide to make the line number margin in order to display a given number of numerals.

-

SCI_TEXTHEIGHT(int line)
+

SCI_TEXTHEIGHT(int line) → int
This returns the height in pixels of a particular line. Currently all lines are the same height.

-

SCI_GETCOLUMN(int pos)
- This message returns the column number of a position pos within the document +

SCI_GETCOLUMN(int pos) → int
+ This message returns the column number of a position pos within the document taking the width of tabs into account. This returns the column number of the last tab on the - line before pos, plus the number of characters between the last tab and - pos. If there are no tab characters on the line, the return value is the number of + line before pos, plus the number of characters between the last tab and + pos. If there are no tab characters on the line, the return value is the number of characters up to the position on the line. In both cases, double byte characters count as a single character. This is probably only useful with monospaced fonts.

-

SCI_FINDCOLUMN(int line, int column)
- This message returns the position of a column on a line +

SCI_FINDCOLUMN(int line, int column) → int
+ This message returns the position of a column on a line taking the width of tabs into account. It treats a multi-byte character as a single column. Column numbers, like lines start at 0.

-

SCI_POSITIONFROMPOINT(int x, int y)
- SCI_POSITIONFROMPOINTCLOSE(int x, int y)
+

SCI_POSITIONFROMPOINT(int x, int y) → position
+ SCI_POSITIONFROMPOINTCLOSE(int x, int y) → position
SCI_POSITIONFROMPOINT finds the closest character position to a point and SCI_POSITIONFROMPOINTCLOSE is similar but returns -1 if the point is outside the window or not close to any characters.

-

SCI_CHARPOSITIONFROMPOINT(int x, int y)
- SCI_CHARPOSITIONFROMPOINTCLOSE(int x, int y)
+

SCI_CHARPOSITIONFROMPOINT(int x, int y) → position
+ SCI_CHARPOSITIONFROMPOINTCLOSE(int x, int y) → position
SCI_CHARPOSITIONFROMPOINT finds the closest character to a point and SCI_CHARPOSITIONFROMPOINTCLOSE is similar but returns -1 if the point is outside the window or not close to any characters. This is similar to the previous methods but finds characters rather than inter-character positions.

-

SCI_POINTXFROMPOSITION(<unused>, int pos)
- SCI_POINTYFROMPOSITION(<unused>, int pos)
- These messages return the x and y display pixel location of text at position pos +

SCI_POINTXFROMPOSITION(<unused>, int pos) → int
+ SCI_POINTYFROMPOSITION(<unused>, int pos) → int
+ These messages return the x and y display pixel location of text at position pos in the document.

SCI_HIDESELECTION(bool hide)
@@ -1482,7 +1478,7 @@ struct Sci_TextToFind {

SCI_SETMOUSESELECTIONRECTANGULARSWITCH(bool mouseSelectionRectangularSwitch)
- SCI_GETMOUSESELECTIONRECTANGULARSWITCH
+ SCI_GETMOUSESELECTIONRECTANGULARSWITCH → bool
Enable or disable the ability to switch to rectangular selection mode while making a selection with the mouse. When this option is turned on, mouse selections in stream mode can be switched to rectangular mode by pressing the corresponding modifier key. They then stick to rectangular mode even when the modifier key is released again. @@ -1493,61 +1489,61 @@ struct Sci_TextToFind { SCI_SETMULTIPLESELECTION(bool multipleSelection)
- SCI_GETMULTIPLESELECTION
+ SCI_GETMULTIPLESELECTION → bool
SCI_SETADDITIONALSELECTIONTYPING(bool additionalSelectionTyping)
- SCI_GETADDITIONALSELECTIONTYPING
+ SCI_GETADDITIONALSELECTIONTYPING → bool
SCI_SETMULTIPASTE(int multiPaste)
- SCI_GETMULTIPASTE
+ SCI_GETMULTIPASTE → int
SCI_SETVIRTUALSPACEOPTIONS(int virtualSpaceOptions)
- SCI_GETVIRTUALSPACEOPTIONS
+ SCI_GETVIRTUALSPACEOPTIONS → int
SCI_SETRECTANGULARSELECTIONMODIFIER(int modifier)
- SCI_GETRECTANGULARSELECTIONMODIFIER
+ SCI_GETRECTANGULARSELECTIONMODIFIER → int

- SCI_GETSELECTIONS
- SCI_GETSELECTIONEMPTY
+ SCI_GETSELECTIONS → int
+ SCI_GETSELECTIONEMPTY → bool
SCI_CLEARSELECTIONS
- SCI_SETSELECTION(int caret, int anchor)
- SCI_ADDSELECTION(int caret, int anchor)
+ SCI_SETSELECTION(int caret, int anchor) → int
+ SCI_ADDSELECTION(int caret, int anchor) → int
SCI_DROPSELECTIONN(int selection)
SCI_SETMAINSELECTION(int selection)
- SCI_GETMAINSELECTION
+ SCI_GETMAINSELECTION → int

- SCI_SETSELECTIONNCARET(int selection, int pos)
- SCI_GETSELECTIONNCARET(int selection)
+ SCI_SETSELECTIONNCARET(int selection, int caret)
+ SCI_GETSELECTIONNCARET(int selection) → position
SCI_SETSELECTIONNCARETVIRTUALSPACE(int selection, int space)
- SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection)
- SCI_SETSELECTIONNANCHOR(int selection, int posAnchor)
- SCI_GETSELECTIONNANCHOR(int selection)
+ SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection) → int
+ SCI_SETSELECTIONNANCHOR(int selection, int anchor)
+ SCI_GETSELECTIONNANCHOR(int selection) → position
SCI_SETSELECTIONNANCHORVIRTUALSPACE(int selection, int space)
- SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection)
- SCI_SETSELECTIONNSTART(int selection, int pos)
- SCI_GETSELECTIONNSTART(int selection)
- SCI_SETSELECTIONNEND(int selection, int pos)
- SCI_GETSELECTIONNEND(int selection)
+ SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection) → int
+ SCI_SETSELECTIONNSTART(int selection, int anchor)
+ SCI_GETSELECTIONNSTART(int selection) → position
+ SCI_SETSELECTIONNEND(int selection, int caret)
+ SCI_GETSELECTIONNEND(int selection) → position

- SCI_SETRECTANGULARSELECTIONCARET(int pos)
- SCI_GETRECTANGULARSELECTIONCARET
+ SCI_SETRECTANGULARSELECTIONCARET(int caret)
+ SCI_GETRECTANGULARSELECTIONCARET → position
SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE(int space)
- SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE
- SCI_SETRECTANGULARSELECTIONANCHOR(int posAnchor)
- SCI_GETRECTANGULARSELECTIONANCHOR
+ SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE → int
+ SCI_SETRECTANGULARSELECTIONANCHOR(int anchor)
+ SCI_GETRECTANGULARSELECTIONANCHOR → position
SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE(int space)
- SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE
+ SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → int

- SCI_SETADDITIONALSELALPHA(int alpha)
- SCI_GETADDITIONALSELALPHA
- SCI_SETADDITIONALSELFORE(int colour)
- SCI_SETADDITIONALSELBACK(int colour)
- SCI_SETADDITIONALCARETFORE(int colour)
- SCI_GETADDITIONALCARETFORE
+ SCI_SETADDITIONALSELALPHA(alpha alpha)
+ SCI_GETADDITIONALSELALPHA → int
+ SCI_SETADDITIONALSELFORE(colour fore)
+ SCI_SETADDITIONALSELBACK(colour back)
+ SCI_SETADDITIONALCARETFORE(colour fore)
+ SCI_GETADDITIONALCARETFORE → colour
SCI_SETADDITIONALCARETSBLINK(bool additionalCaretsBlink)
- SCI_GETADDITIONALCARETSBLINK
+ SCI_GETADDITIONALCARETSBLINK → bool
SCI_SETADDITIONALCARETSVISIBLE(bool additionalCaretsVisible)
- SCI_GETADDITIONALCARETSVISIBLE
+ SCI_GETADDITIONALCARETSVISIBLE → bool

SCI_SWAPMAINANCHORCARET
@@ -1586,26 +1582,26 @@ struct Sci_TextToFind {

SCI_SETMULTIPLESELECTION(bool multipleSelection)
- SCI_GETMULTIPLESELECTION
+ SCI_GETMULTIPLESELECTION → bool
Enable or disable multiple selection. When multiple selection is disabled, it is not possible to select multiple ranges by holding down the Ctrl key while dragging with the mouse.

SCI_SETADDITIONALSELECTIONTYPING(bool additionalSelectionTyping)
- SCI_GETADDITIONALSELECTIONTYPING
+ SCI_GETADDITIONALSELECTIONTYPING → bool
Whether typing, new line, cursor left/right/up/down, backspace, delete, home, and end work with multiple selections simultaneously. Also allows selection and word and line deletion commands.

SCI_SETMULTIPASTE(int multiPaste)
- SCI_GETMULTIPASTE
+ SCI_GETMULTIPASTE → int
When pasting into multiple selections, the pasted text can go into just the main selection with SC_MULTIPASTE_ONCE=0 or into each selection with SC_MULTIPASTE_EACH=1. SC_MULTIPASTE_ONCE is the default.

- SCI_SETVIRTUALSPACEOPTIONS(int virtualSpace)
- SCI_GETVIRTUALSPACEOPTIONS
+ SCI_SETVIRTUALSPACEOPTIONS(int virtualSpaceOptions)
+ SCI_GETVIRTUALSPACEOPTIONS → int
Virtual space can be enabled or disabled for rectangular selections or in other circumstances or in both. There are three bit flags SCVS_RECTANGULARSELECTION=1, SCVS_USERACCESSIBLE=2, and @@ -1618,7 +1614,7 @@ struct Sci_TextToFind {

SCI_SETRECTANGULARSELECTIONMODIFIER(int modifier)
- SCI_GETRECTANGULARSELECTIONMODIFIER
+ SCI_GETRECTANGULARSELECTIONMODIFIER → int
On GTK+, the key used to indicate that a rectangular selection should be created when combined with a mouse drag can be set. The three possible values are SCMOD_CTRL=2 (default), SCMOD_ALT=4 or SCMOD_SUPER=8. Since SCMOD_ALT is often already used by a window manager, the window manager may need configuring to allow this choice. @@ -1626,11 +1622,11 @@ struct Sci_TextToFind { Command key on a Mac.

- SCI_GETSELECTIONS
+ SCI_GETSELECTIONS → int
Return the number of selections currently active. There is always at least one selection.

- SCI_GETSELECTIONEMPTY
+ SCI_GETSELECTIONEMPTY → bool
Return 1 if every selected range is empty else 0.

@@ -1638,12 +1634,12 @@ struct Sci_TextToFind { Set a single empty selection at 0 as the only selection.

- SCI_SETSELECTION(int caret, int anchor)
- Set a single selection from anchor to caret as the only selection.

+ SCI_SETSELECTION(int caret, int anchor) → int
+ Set a single selection from anchor to caret as the only selection.

- SCI_ADDSELECTION(int caret, int anchor)
- Add a new selection from anchor to caret as the main selection retaining all other + SCI_ADDSELECTION(int caret, int anchor) → int
+ Add a new selection from anchor to caret as the main selection retaining all other selections as additional selections. Since there is always at least one selection, to set a list of selections, the first selection should be added with SCI_SETSELECTION and later selections added with SCI_ADDSELECTION

@@ -1652,51 +1648,51 @@ struct Sci_TextToFind { SCI_DROPSELECTIONN(int selection)
If there are multiple selections, remove the indicated selection. If this was the main selection then make the previous selection the main and if it was the first then the last selection becomes main. - If there is only one selection, or there is no selection selection, then there is no effect.

+ If there is only one selection, or there is no selection selection, then there is no effect.

SCI_SETMAINSELECTION(int selection)
- SCI_GETMAINSELECTION
+ SCI_GETMAINSELECTION → int
One of the selections is the main selection which is used to determine what range of text is automatically visible. The main selection may be displayed in different colours or with a differently styled caret. Only an already existing selection can be made main.

- SCI_SETSELECTIONNCARET(int selection, int pos)
- SCI_GETSELECTIONNCARET(int selection)
+ SCI_SETSELECTIONNCARET(int selection, int caret)
+ SCI_GETSELECTIONNCARET(int selection) → position
SCI_SETSELECTIONNCARETVIRTUALSPACE(int selection, int space)
- SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection)
- SCI_SETSELECTIONNANCHOR(int selection, int posAnchor)
- SCI_GETSELECTIONNANCHOR(int selection)
+ SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection) → int
+ SCI_SETSELECTIONNANCHOR(int selection, int anchor)
+ SCI_GETSELECTIONNANCHOR(int selection) → position
SCI_SETSELECTIONNANCHORVIRTUALSPACE(int selection, int space)
- SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection)
+ SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection) → int
Set or query the position and amount of virtual space for the caret and anchor of each already existing selection.

- SCI_SETSELECTIONNSTART(int selection, int pos)
- SCI_GETSELECTIONNSTART(int selection)
- SCI_SETSELECTIONNEND(int selection, int pos)
- SCI_GETSELECTIONNEND(int selection)
+ SCI_SETSELECTIONNSTART(int selection, int anchor)
+ SCI_GETSELECTIONNSTART(int selection) → position
+ SCI_SETSELECTIONNEND(int selection, int caret)
+ SCI_GETSELECTIONNEND(int selection) → position
Set or query the start and end position of each already existing selection. Mostly of use to query each range for its text. The selection parameter is zero-based.

- SCI_SETRECTANGULARSELECTIONCARET(int pos)
- SCI_GETRECTANGULARSELECTIONCARET
+ SCI_SETRECTANGULARSELECTIONCARET(int caret)
+ SCI_GETRECTANGULARSELECTIONCARET → position
SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE(int space)
- SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE
- SCI_SETRECTANGULARSELECTIONANCHOR(int posAnchor)
- SCI_GETRECTANGULARSELECTIONANCHOR
+ SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE → int
+ SCI_SETRECTANGULARSELECTIONANCHOR(int anchor)
+ SCI_GETRECTANGULARSELECTIONANCHOR → position
SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE(int space)
- SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE
+ SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → int
Set or query the position and amount of virtual space for the caret and anchor of the rectangular selection. After setting the rectangular selection, this is broken down into multiple selections, one for each line.

- SCI_SETADDITIONALSELALPHA(int alpha)
- SCI_GETADDITIONALSELALPHA
- SCI_SETADDITIONALSELFORE(int colour)
- SCI_SETADDITIONALSELBACK(int colour)
+ SCI_SETADDITIONALSELALPHA(alpha alpha)
+ SCI_GETADDITIONALSELALPHA → int
+ SCI_SETADDITIONALSELFORE(colour fore)
+ SCI_SETADDITIONALSELBACK(colour back)
Modify the appearance of additional selections so that they can be differentiated from the main selection which has its appearance set with SCI_SETSELALPHA, SCI_GETSELALPHA, @@ -1711,10 +1707,10 @@ struct Sci_TextToFind { and SCI_SETSELBACK will overwrite the values set by SCI_SETADDITIONALSEL* functions.

- SCI_SETADDITIONALCARETFORE(int colour)
- SCI_GETADDITIONALCARETFORE
+ SCI_SETADDITIONALCARETFORE(colour fore)
+ SCI_GETADDITIONALCARETFORE → colour
SCI_SETADDITIONALCARETSBLINK(bool additionalCaretsBlink)
- SCI_GETADDITIONALCARETSBLINK
+ SCI_GETADDITIONALCARETSBLINK → bool
Modify the appearance of additional carets so that they can be differentiated from the main caret which has its appearance set with SCI_SETCARETFORE, SCI_GETCARETFORE, @@ -1723,7 +1719,7 @@ struct Sci_TextToFind {

SCI_SETADDITIONALCARETSVISIBLE(bool additionalCaretsVisible)
- SCI_GETADDITIONALCARETSVISIBLE
+ SCI_GETADDITIONALCARETSVISIBLE → bool
Determine whether to show additional carets (defaults to true).

@@ -1744,44 +1740,44 @@ struct Sci_TextToFind {

Scrolling and automatic scrolling

- SCI_SETFIRSTVISIBLELINE(int lineDisplay)
- SCI_GETFIRSTVISIBLELINE
+ SCI_SETFIRSTVISIBLELINE(int displayLine)
+ SCI_GETFIRSTVISIBLELINE → int
SCI_SETXOFFSET(int xOffset)
- SCI_GETXOFFSET
- SCI_LINESCROLL(int column, int line)
+ SCI_GETXOFFSET → int
+ SCI_LINESCROLL(int columns, int lines)
SCI_SCROLLCARET
SCI_SCROLLRANGE(int secondary, int primary)
SCI_SETXCARETPOLICY(int caretPolicy, int caretSlop)
SCI_SETYCARETPOLICY(int caretPolicy, int caretSlop)
- SCI_SETVISIBLEPOLICY(int caretPolicy, int - caretSlop)
+ SCI_SETVISIBLEPOLICY(int visiblePolicy, int + visibleSlop)
SCI_SETHSCROLLBAR(bool visible)
- SCI_GETHSCROLLBAR
+ SCI_GETHSCROLLBAR → bool
SCI_SETVSCROLLBAR(bool visible)
- SCI_GETVSCROLLBAR
+ SCI_GETVSCROLLBAR → bool
SCI_SETSCROLLWIDTH(int pixelWidth)
- SCI_GETSCROLLWIDTH
+ SCI_GETSCROLLWIDTH → int
SCI_SETSCROLLWIDTHTRACKING(bool tracking)
- SCI_GETSCROLLWIDTHTRACKING
+ SCI_GETSCROLLWIDTHTRACKING → bool
SCI_SETENDATLASTLINE(bool endAtLastLine)
- SCI_GETENDATLASTLINE
+ SCI_GETENDATLASTLINE → bool
 -

SCI_SETFIRSTVISIBLELINE(int lineDisplay)
- SCI_GETFIRSTVISIBLELINE
+

SCI_SETFIRSTVISIBLELINE(int displayLine)
+ SCI_GETFIRSTVISIBLELINE → int
These messages retrieve and set the line number of the first visible line in the Scintilla view. The first line in the document is numbered 0. The value is a visible line rather than a document line.

SCI_SETXOFFSET(int xOffset)
- SCI_GETXOFFSET
- The xOffset is the horizontal scroll position in pixels of the start of the text + SCI_GETXOFFSET → int
+ The xOffset is the horizontal scroll position in pixels of the start of the text view. A value of 0 is the normal position with the first text column visible at the left of the view.

-

SCI_LINESCROLL(int column, int line)
+

SCI_LINESCROLL(int columns, int lines)
This will attempt to scroll the display by the number of columns and lines that you specify. Positive line values increase the line number at the top of the screen (i.e. they move the text upwards as far as the user is concerned), Negative line values do the reverse.

@@ -1806,7 +1802,7 @@ struct Sci_TextToFind {

SCI_SETXCARETPOLICY(int caretPolicy, int caretSlop)
SCI_SETYCARETPOLICY(int caretPolicy, int caretSlop)
- These set the caret policy. The value of caretPolicy is a combination of + These set the caret policy. The value of caretPolicy is a combination of CARET_SLOP, CARET_STRICT, CARET_JUMPS and CARET_EVEN.

@@ -1815,7 +1811,7 @@ struct Sci_TextToFind { CARET_SLOP - If set, we can define a slop value: caretSlop. This value defines an + 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 @@ -1828,8 +1824,8 @@ struct Sci_TextToFind { 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. + is centred on the display if caretSlop is not set, and cannot go in the UZ + if caretSlop is set. @@ -2054,7 +2050,7 @@ struct Sci_TextToFind { -

SCI_SETVISIBLEPOLICY(int caretPolicy, int caretSlop)
+

SCI_SETVISIBLEPOLICY(int visiblePolicy, int visibleSlop)
This determines how the vertical positioning is determined when SCI_ENSUREVISIBLEENFORCEPOLICY is called. It takes VISIBLE_SLOP and VISIBLE_STRICT flags for the policy @@ -2063,16 +2059,16 @@ struct Sci_TextToFind { caretSlop).

SCI_SETHSCROLLBAR(bool visible)
- SCI_GETHSCROLLBAR
+ SCI_GETHSCROLLBAR → bool
The horizontal scroll bar is only displayed if it is needed for the assumed width. If you never wish to see it, call SCI_SETHSCROLLBAR(0). Use SCI_SETHSCROLLBAR(1) to enable it again. SCI_GETHSCROLLBAR returns the current state. The default state is to display it when needed.

-

See also: SCI_SETSCROLLWIDTH.

+

See also: SCI_SETSCROLLWIDTH.

SCI_SETVSCROLLBAR(bool visible)
- SCI_GETVSCROLLBAR
+ SCI_GETVSCROLLBAR → bool
By default, the vertical scroll bar is always displayed when required. You can choose to hide or show it with SCI_SETVSCROLLBAR and get the current state with SCI_GETVSCROLLBAR.

@@ -2080,7 +2076,7 @@ struct Sci_TextToFind {

See also: SCI_LINESCROLL

SCI_SETSCROLLWIDTH(int pixelWidth)
- SCI_GETSCROLLWIDTH
+ SCI_GETSCROLLWIDTH → int
For performance, Scintilla does not measure the display width of the document to determine the properties of the horizontal scroll bar. Instead, an assumed width is used. These messages set and get the document width in pixels assumed by Scintilla. @@ -2089,39 +2085,39 @@ struct Sci_TextToFind { SCI_SETSCROLLWIDTHTRACKING

SCI_SETSCROLLWIDTHTRACKING(bool tracking)
- SCI_GETSCROLLWIDTHTRACKING
+ SCI_GETSCROLLWIDTHTRACKING → bool
If scroll width tracking is enabled then the scroll width is adjusted to ensure that all of the lines currently displayed can be completely scrolled. This mode never adjusts the scroll width to be narrower.

SCI_SETENDATLASTLINE(bool endAtLastLine)
- SCI_GETENDATLASTLINE
+ SCI_GETENDATLASTLINE → bool
SCI_SETENDATLASTLINE sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default). Setting this to false allows scrolling one page below the last line.

White space

- SCI_SETVIEWWS(int wsMode)
- SCI_GETVIEWWS
+ SCI_SETVIEWWS(int viewWS)
+ SCI_GETVIEWWS → int
SCI_SETWHITESPACEFORE(bool - useWhitespaceForeColour, int colour)
+ useSetting, colour fore)
SCI_SETWHITESPACEBACK(bool - useWhitespaceBackColour, int colour)
+ useSetting, colour back)
SCI_SETWHITESPACESIZE(int size)
- SCI_GETWHITESPACESIZE
+ SCI_GETWHITESPACESIZE → int
SCI_SETEXTRAASCENT(int extraAscent)
- SCI_GETEXTRAASCENT
+ SCI_GETEXTRAASCENT → int
SCI_SETEXTRADESCENT(int extraDescent)
- SCI_GETEXTRADESCENT
+ SCI_GETEXTRADESCENT → int
 -

SCI_SETVIEWWS(int wsMode)
- SCI_GETVIEWWS
+

SCI_SETVIEWWS(int viewWS)
+ SCI_GETVIEWWS → int
White space can be made visible which may be useful for languages in which white space is significant, such as Python. Space characters appear as small centred dots and tab characters as light arrows pointing to the right. There are also ways to control the display of end of line characters. The two messages set and get the - white space display mode. The wsMode argument can be one of:

+ white space display mode. The viewWS argument can be one of:

@@ -2161,28 +2157,26 @@ struct Sci_TextToFind {
-

The effect of using any other wsMode value is undefined.

+

The effect of using any other viewWS value is undefined.

-

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

SCI_SETWHITESPACEFORE(bool useSetting, colour fore)
+ SCI_SETWHITESPACEBACK(bool useSetting, colour back)
By default, the colour of visible white space is determined by the lexer in use. The foreground and/or background colour of all visible white space can be set globally, overriding the lexer's colours with SCI_SETWHITESPACEFORE and SCI_SETWHITESPACEBACK.

SCI_SETWHITESPACESIZE(int size)
- SCI_GETWHITESPACESIZE
+ SCI_GETWHITESPACESIZE → int
SCI_SETWHITESPACESIZE sets the size of the dots used for mark space characters. The SCI_GETWHITESPACESIZE message retrieves the current size.

SCI_SETEXTRAASCENT(int extraAscent)
- SCI_GETEXTRAASCENT
+ SCI_GETEXTRAASCENT → int
SCI_SETEXTRADESCENT(int extraDescent)
- SCI_GETEXTRADESCENT
+ SCI_GETEXTRADESCENT → int
Text is drawn with the base of each character on a 'baseline'. The height of a line is found from the maximum that any style extends above the baseline (its 'ascent'), added to the maximum that any style extends below the baseline (its 'descent'). @@ -2192,14 +2186,14 @@ struct Sci_TextToFind {

Cursor

- SCI_SETCURSOR(int curType)
- SCI_GETCURSOR
+ SCI_SETCURSOR(int cursorType)
+ SCI_GETCURSOR → int
-

SCI_SETCURSOR(int curType)
- SCI_GETCURSOR
+

SCI_SETCURSOR(int cursorType)
+ SCI_GETCURSOR → int
The cursor is normally chosen in a context sensitive way, so it will be different over the margin than when over the text. When performing a slow action, you may wish to change to a wait - cursor. You set the cursor type with SCI_SETCURSOR. The curType + cursor. You set the cursor type with SCI_SETCURSOR. The cursorType argument can be:

@@ -2224,24 +2218,24 @@ struct Sci_TextToFind {

Cursor values 1 through 7 have defined cursors, but only SC_CURSORWAIT is - usefully controllable. Other values of curType cause a pointer to be displayed. + usefully controllable. Other values of cursorType cause a pointer to be displayed. The SCI_GETCURSOR message returns the last cursor type you set, or SC_CURSORNORMAL (-1) if you have not set a cursor type.

Mouse capture

SCI_SETMOUSEDOWNCAPTURES(bool captures)
- SCI_GETMOUSEDOWNCAPTURES
+ SCI_GETMOUSEDOWNCAPTURES → bool
SCI_SETMOUSEWHEELCAPTURES(bool captures)
- SCI_GETMOUSEWHEELCAPTURES
+ SCI_GETMOUSEWHEELCAPTURES → bool

SCI_SETMOUSEDOWNCAPTURES(bool captures)
- SCI_GETMOUSEDOWNCAPTURES
+ SCI_GETMOUSEDOWNCAPTURES → bool
When the mouse is pressed inside Scintilla, it is captured so future mouse movement events are sent to Scintilla. This behaviour may be turned off with SCI_SETMOUSEDOWNCAPTURES(0).

SCI_SETMOUSEWHEELCAPTURES(bool captures)
- SCI_GETMOUSEWHEELCAPTURES
+ SCI_GETMOUSEWHEELCAPTURES → bool
On Windows, Scintilla captures all WM_MOUSEWHEEL messages if it has the focus, even if the mouse pointer is nowhere near the Scintilla editor window. This behavior can be changed with SCI_SETMOUSEWHEELCAPTURES(0) so that @@ -2268,50 +2262,50 @@ struct Sci_TextToFind { Unicode line ends.

SCI_SETEOLMODE(int eolMode)
- SCI_GETEOLMODE
+ SCI_GETEOLMODE → int
SCI_CONVERTEOLS(int eolMode)
SCI_SETVIEWEOL(bool visible)
- SCI_GETVIEWEOL
+ SCI_GETVIEWEOL → bool
- SCI_GETLINEENDTYPESSUPPORTED
+ SCI_GETLINEENDTYPESSUPPORTED → int
SCI_SETLINEENDTYPESALLOWED(int lineEndBitSet)
- SCI_GETLINEENDTYPESALLOWED
- SCI_GETLINEENDTYPESACTIVE
+ SCI_GETLINEENDTYPESALLOWED → int
+ SCI_GETLINEENDTYPESACTIVE → int

SCI_SETEOLMODE(int eolMode)
- SCI_GETEOLMODE
+ SCI_GETEOLMODE → int
SCI_SETEOLMODE sets the characters that are added into the document when the user - presses the Enter key. You can set eolMode to one of SC_EOL_CRLF (0), + presses the Enter key. You can set eolMode to one of SC_EOL_CRLF (0), SC_EOL_CR (1), or SC_EOL_LF (2). The SCI_GETEOLMODE message retrieves the current state.

SCI_CONVERTEOLS(int eolMode)
This message changes all the end of line characters in the document to match - eolMode. Valid values are: SC_EOL_CRLF (0), SC_EOL_CR + eolMode. Valid values are: SC_EOL_CRLF (0), SC_EOL_CR (1), or SC_EOL_LF (2).

SCI_SETVIEWEOL(bool visible)
- SCI_GETVIEWEOL
+ SCI_GETVIEWEOL → bool
Normally, the end of line characters are hidden, but SCI_SETVIEWEOL allows you to - display (or hide) them by setting visible true (or + display (or hide) them by setting visible true (or false). The visible rendering of the end of line characters is similar to (CR), (LF), or (CR)(LF). SCI_GETVIEWEOL returns the current state.

-

SCI_GETLINEENDTYPESSUPPORTED
+

SCI_GETLINEENDTYPESSUPPORTED → int
SCI_GETLINEENDTYPESSUPPORTED reports the different types of line ends supported by the current lexer. This is a bit set although there is currently only a single choice with either SC_LINE_END_TYPE_DEFAULT (0) or SC_LINE_END_TYPE_UNICODE (1). These values are also used by the other messages concerned with Unicode line ends.

SCI_SETLINEENDTYPESALLOWED(int lineEndBitSet)
- SCI_GETLINEENDTYPESALLOWED
+ SCI_GETLINEENDTYPESALLOWED → int
By default, only the ASCII line ends are interpreted. Unicode line ends may be requested with SCI_SETLINEENDTYPESALLOWED(SC_LINE_END_TYPE_UNICODE) but this will be ineffective unless the lexer also allows you Unicode line ends. SCI_GETLINEENDTYPESALLOWED returns the current state.

-

SCI_GETLINEENDTYPESACTIVE
+

SCI_GETLINEENDTYPESACTIVE → int
SCI_GETLINEENDTYPESACTIVE reports the set of line ends currently interpreted by Scintilla. It is SCI_GETLINEENDTYPESSUPPORTED & SCI_GETLINEENDTYPESALLOWED.

@@ -2340,45 +2334,41 @@ struct Sci_TextToFind { SCI_WORDPARTRIGHTEXTEND.

- SCI_WORDENDPOSITION(int position, bool - onlyWordCharacters)
- SCI_WORDSTARTPOSITION(int position, bool - onlyWordCharacters)
- SCI_ISRANGEWORD(int start, int end)
+ SCI_WORDENDPOSITION(int pos, bool onlyWordCharacters) → int
+ SCI_WORDSTARTPOSITION(int pos, bool onlyWordCharacters) → int
+ SCI_ISRANGEWORD(int start, int end) → bool
SCI_SETWORDCHARS(<unused>, const char *characters)
- SCI_GETWORDCHARS(<unused>, char *characters)
+ SCI_GETWORDCHARS(<unused>, char *characters) → int
SCI_SETWHITESPACECHARS(<unused>, const char *characters)
- SCI_GETWHITESPACECHARS(<unused>, char *characters)
+ SCI_GETWHITESPACECHARS(<unused>, char *characters) → int
SCI_SETPUNCTUATIONCHARS(<unused>, const char *characters)
- SCI_GETPUNCTUATIONCHARS(<unused>, char *characters)
+ SCI_GETPUNCTUATIONCHARS(<unused>, char *characters) → int
SCI_SETCHARSDEFAULT
-

SCI_WORDENDPOSITION(int position, bool - onlyWordCharacters)
- SCI_WORDSTARTPOSITION(int position, bool - onlyWordCharacters)
+

SCI_WORDENDPOSITION(int pos, bool onlyWordCharacters) → int
+ SCI_WORDSTARTPOSITION(int pos, bool onlyWordCharacters) → int
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_ISRANGEWORD(int start, int end)
+

SCI_ISRANGEWORD(int start, int end) → bool
Is the range start..end a word or set of words? This message checks that start is at a word start transition and that end is at a word end transition. It does not check whether there are any spaces inside the range.

- SCI_ISRANGEWORD(int start, int end)
+ SCI_ISRANGEWORD(int start, int end) → bool
-

Set onlyWordCharacters to true (1) to stop searching at the first - non-word character in the search direction. If onlyWordCharacters is +

Set onlyWordCharacters to true (1) to stop searching at the first + non-word character in the search direction. If onlyWordCharacters is false (0), the first character in the search direction sets the type of the search as word or non-word and the search stops at the first non-matching character. Searches are also terminated by the start or end of the document.

If "w" represents word characters and "." represents non-word characters and "|" represents the position and true or false is the state of - onlyWordCharacters:

+ onlyWordCharacters:

@@ -2453,14 +2443,14 @@ struct Sci_TextToFind { use:
SCI_SETWORDCHARS(0, "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789");

-

SCI_GETWORDCHARS(<unused>, char *characters)
+

SCI_GETWORDCHARS(<unused>, char *characters) → int
This fills the characters parameter with all the characters included in words. The characters parameter must be large enough to hold all of the characters. If the characters parameter is 0 then the length that should be allocated to store the entire set is returned.

SCI_SETWHITESPACECHARS(<unused>, const char *characters)
- SCI_GETWHITESPACECHARS(<unused>, char *characters)
+ SCI_GETWHITESPACECHARS(<unused>, char *characters) → int
Similar to SCI_SETWORDCHARS, this message allows the user to define which chars Scintilla considers as whitespace. Setting the whitespace chars allows the user to fine-tune Scintilla's behaviour doing such things as moving the cursor to the start or end of a word; for example, by defining punctuation chars @@ -2470,7 +2460,7 @@ struct Sci_TextToFind { SCI_GETWHITESPACECHARS behaves similarly to SCI_GETWORDCHARS.

SCI_SETPUNCTUATIONCHARS(<unused>, const char *characters)
- SCI_GETPUNCTUATIONCHARS(<unused>, char *characters)
+ SCI_GETPUNCTUATIONCHARS(<unused>, char *characters) → int
Similar to SCI_SETWORDCHARS and SCI_SETWHITESPACECHARS, this message allows the user to define which chars Scintilla considers as punctuation. SCI_GETPUNCTUATIONCHARS behaves similarly to SCI_GETWORDCHARS.

@@ -2511,19 +2501,19 @@ struct Sci_TextToFind { 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_STARTSTYLING(int position, int unused)
+ SCI_GETENDSTYLED → position
+ SCI_STARTSTYLING(int start, int unused)
SCI_SETSTYLING(int length, int style)
SCI_SETSTYLINGEX(int length, const char *styles)
SCI_SETIDLESTYLING(int idleStyling)
- SCI_GETIDLESTYLING
- SCI_SETLINESTATE(int line, int value)
- SCI_GETLINESTATE(int line)
- SCI_GETMAXLINESTATE
+ SCI_GETIDLESTYLING → int
+ SCI_SETLINESTATE(int line, int state)
+ SCI_GETLINESTATE(int line) → int
+ SCI_GETMAXLINESTATE → int
 -

SCI_GETENDSTYLED
+

SCI_GETENDSTYLED → position
Scintilla keeps a record of the last character that is likely to be styled correctly. This is moved forwards when characters after it are styled and moved backwards if changes are made to the text of the document before it. Before drawing text, this position is checked to see if any @@ -2532,29 +2522,29 @@ struct Sci_TextToFind { container. The container can send SCI_GETENDSTYLED to work out where it needs to start styling. Scintilla will always ask to style whole lines.

-

SCI_STARTSTYLING(int pos, int unused)
- This prepares for styling by setting the styling position pos to start at. +

SCI_STARTSTYLING(int start, int unused)
+ This prepares for styling by setting the styling position start to start at. The unused argument was used in earlier versions but is now ignored. After SCI_STARTSTYLING, send multiple SCI_SETSTYLING messages for each lexical entity to style or send SCI_SETSTYLINGEX to style in blocks.

SCI_SETSTYLING(int length, int style)
- This message sets the style of length characters starting at the styling position - and then increases the styling position by length, ready for the next call. + This message sets the style of length characters starting at the styling position + and then increases the styling position by length, ready for the next call. SCI_STARTSTYLING should be called before the first call to this.

SCI_SETSTYLINGEX(int length, const char *styles)
As an alternative to SCI_SETSTYLING, which applies the same style to each byte, - you can use this message which specifies the styles for each of length bytes from - the styling position and then increases the styling position by length, ready for + you can use this message which specifies the styles for each of length bytes from + the styling position and then increases the styling position by length, ready for the next call. SCI_STARTSTYLING should be called before the first call to this.

SCI_SETIDLESTYLING(int idleStyling)
- SCI_GETIDLESTYLING
+ SCI_GETIDLESTYLING → int
By default, SC_IDLESTYLING_NONE (0), syntax styling is performed for all the currently visible text before displaying it. On very large files, this may make scrolling down slow. @@ -2570,8 +2560,8 @@ struct Sci_TextToFind { the document is displayed wrapped.

-

SCI_SETLINESTATE(int line, int value)
- SCI_GETLINESTATE(int line)
+

SCI_SETLINESTATE(int line, int state)
+ SCI_GETLINESTATE(int line) → int
As well as the 8 bits of lexical state stored for each character there is also an integer stored for each line. This can be used for longer lived parse states such as what the current scripting language is in an ASP page. Use SCI_SETLINESTATE to set the integer @@ -2579,7 +2569,7 @@ struct Sci_TextToFind { Changing the value produces a SC_MOD_CHANGELINESTATE notification.

-

SCI_GETMAXLINESTATE
+

SCI_GETMAXLINESTATE → int
This returns the last line that has any line state.

Style definition

@@ -2662,7 +2652,7 @@ struct Sci_TextToFind { @@ -2700,51 +2690,49 @@ struct Sci_TextToFind { style 4 for preprocessor, style 5 for operators, and so on.

SCI_STYLERESETDEFAULT
SCI_STYLECLEARALL
- SCI_STYLESETFONT(int styleNumber, char + SCI_STYLESETFONT(int style, const char *fontName)
- SCI_STYLEGETFONT(int styleNumber, char *fontName)
- SCI_STYLESETSIZE(int styleNumber, int - sizeInPoints)
- SCI_STYLEGETSIZE(int styleNumber)
- SCI_STYLESETSIZEFRACTIONAL(int styleNumber, int - sizeInHundredthPoints)
- SCI_STYLEGETSIZEFRACTIONAL(int styleNumber)
- SCI_STYLESETBOLD(int styleNumber, bool + SCI_STYLEGETFONT(int style, char *fontName) → int
+ SCI_STYLESETSIZE(int style, int + sizePoints)
+ SCI_STYLEGETSIZE(int style) → int
+ SCI_STYLESETSIZEFRACTIONAL(int style, int + sizeHundredthPoints)
+ SCI_STYLEGETSIZEFRACTIONAL(int style) → int
+ SCI_STYLESETBOLD(int style, bool bold)
- SCI_STYLEGETBOLD(int styleNumber)
- SCI_STYLESETWEIGHT(int styleNumber, int + SCI_STYLEGETBOLD(int style) → bool
+ SCI_STYLESETWEIGHT(int style, int weight)
- SCI_STYLEGETWEIGHT(int styleNumber)
- SCI_STYLESETITALIC(int styleNumber, bool + SCI_STYLEGETWEIGHT(int style) → int
+ SCI_STYLESETITALIC(int style, bool italic)
- SCI_STYLEGETITALIC(int styleNumber)
- SCI_STYLESETUNDERLINE(int styleNumber, bool + SCI_STYLEGETITALIC(int style) → bool
+ SCI_STYLESETUNDERLINE(int style, bool underline)
- SCI_STYLEGETUNDERLINE(int styleNumber)
- SCI_STYLESETFORE(int styleNumber, int - colour)
- SCI_STYLEGETFORE(int styleNumber)
- SCI_STYLESETBACK(int styleNumber, int - colour)
- SCI_STYLEGETBACK(int styleNumber)
- SCI_STYLESETEOLFILLED(int styleNumber, bool + SCI_STYLEGETUNDERLINE(int style) → bool
+ SCI_STYLESETFORE(int style, colour fore)
+ SCI_STYLEGETFORE(int style) → colour
+ SCI_STYLESETBACK(int style, colour back)
+ SCI_STYLEGETBACK(int style) → colour
+ SCI_STYLESETEOLFILLED(int style, bool eolFilled)
- SCI_STYLEGETEOLFILLED(int styleNumber)
- SCI_STYLESETCHARACTERSET(int styleNumber, - int charSet)
- SCI_STYLEGETCHARACTERSET(int styleNumber)
- SCI_STYLESETCASE(int styleNumber, int - caseMode)
- SCI_STYLEGETCASE(int styleNumber)
- SCI_STYLESETVISIBLE(int styleNumber, bool + SCI_STYLEGETEOLFILLED(int style) → bool
+ SCI_STYLESETCHARACTERSET(int style, + int characterSet)
+ SCI_STYLEGETCHARACTERSET(int style) → int
+ SCI_STYLESETCASE(int style, int + caseVisible)
+ SCI_STYLEGETCASE(int style) → int
+ SCI_STYLESETVISIBLE(int style, bool visible)
- SCI_STYLEGETVISIBLE(int styleNumber)
- SCI_STYLESETCHANGEABLE(int styleNumber, bool + SCI_STYLEGETVISIBLE(int style) → bool
+ SCI_STYLESETCHANGEABLE(int style, bool changeable)
- SCI_STYLEGETCHANGEABLE(int styleNumber)
- SCI_STYLESETHOTSPOT(int styleNumber, bool + SCI_STYLEGETCHANGEABLE(int style) → bool
+ SCI_STYLESETHOTSPOT(int style, bool hotspot)
- SCI_STYLEGETHOTSPOT(int styleNumber)
+ SCI_STYLEGETHOTSPOT(int style) → bool

SCI_STYLERESETDEFAULT
@@ -2759,23 +2747,23 @@ struct Sci_TextToFind { 2. Use SCI_STYLECLEARALL to copy this to all styles.
3. Set the style attributes that make your lexical styles different.

-

SCI_STYLESETFONT(int styleNumber, const char *fontName)
- SCI_STYLEGETFONT(int styleNumber, char *fontName NUL-terminated)
- SCI_STYLESETSIZE(int styleNumber, int sizeInPoints)
- SCI_STYLEGETSIZE(int styleNumber)
- SCI_STYLESETSIZEFRACTIONAL(int styleNumber, int sizeInHundredthPoints)
- SCI_STYLEGETSIZEFRACTIONAL(int styleNumber)
- SCI_STYLESETBOLD(int styleNumber, bool bold)
- SCI_STYLEGETBOLD(int styleNumber)
- SCI_STYLESETWEIGHT(int styleNumber, int weight)
- SCI_STYLEGETWEIGHT(int styleNumber)
- SCI_STYLESETITALIC(int styleNumber, bool italic)
- SCI_STYLEGETITALIC(int styleNumber)
+

SCI_STYLESETFONT(int style, const char *fontName)
+ SCI_STYLEGETFONT(int style, char *fontName NUL-terminated) → int
+ SCI_STYLESETSIZE(int style, int sizePoints)
+ SCI_STYLEGETSIZE(int style) → int
+ SCI_STYLESETSIZEFRACTIONAL(int style, int sizeHundredthPoints)
+ SCI_STYLEGETSIZEFRACTIONAL(int style) → int
+ SCI_STYLESETBOLD(int style, bool bold)
+ SCI_STYLEGETBOLD(int style) → bool
+ SCI_STYLESETWEIGHT(int style, int weight)
+ SCI_STYLEGETWEIGHT(int style) → int
+ SCI_STYLESETITALIC(int style, bool italic)
+ SCI_STYLEGETITALIC(int style) → bool
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, + fontName is a zero terminated string holding the name of a font. Under Windows, only the first 32 characters of the name are used, the name is decoded as UTF-8, 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. @@ -2798,36 +2786,34 @@ struct Sci_TextToFind { and 1 SC_WEIGHT_BOLD.

-

SCI_STYLESETUNDERLINE(int styleNumber, bool +

SCI_STYLESETUNDERLINE(int style, bool underline)
- SCI_STYLEGETUNDERLINE(int styleNumber)
+ SCI_STYLEGETUNDERLINE(int style) → bool
You can set a style to be underlined. The underline is drawn in the foreground colour. All characters with a style that includes the underline attribute are underlined, even if they are white space.

-

SCI_STYLESETFORE(int styleNumber, int colour)
- SCI_STYLEGETFORE(int styleNumber)
- SCI_STYLESETBACK(int styleNumber, int colour)
- SCI_STYLEGETBACK(int styleNumber)
+

SCI_STYLESETFORE(int style, colour fore)
+ SCI_STYLEGETFORE(int style) → colour
+ SCI_STYLESETBACK(int style, colour back)
+ SCI_STYLEGETBACK(int style) → colour
Text is drawn in the foreground colour. The space in each character cell that is not occupied by the character is drawn in the background colour.

-

SCI_STYLESETEOLFILLED(int styleNumber, bool +

SCI_STYLESETEOLFILLED(int style, bool eolFilled)
- SCI_STYLEGETEOLFILLED(int styleNumber)
+ SCI_STYLEGETEOLFILLED(int style) → bool
If the last character in the line has a style with this attribute set, the remainder of the line up to the right edge of the window is filled with the background colour set for the last character. This is useful when a document contains embedded sections in another language such - as HTML pages with embedded JavaScript. By setting eolFilled to true + as HTML pages with embedded JavaScript. By setting eolFilled to true and a consistent background colour (different from the background colour set for the HTML styles) to all JavaScript styles then JavaScript sections will be easily distinguished from HTML.

-

SCI_STYLESETCHARACTERSET(int styleNumber, int - charSet)
- SCI_STYLEGETCHARACTERSET(int styleNumber)
+

SCI_STYLESETCHARACTERSET(int style, int + characterSet)
+ SCI_STYLEGETCHARACTERSET(int style) → int
You can set a style to use a different character set than the default. The places where such characters sets are likely to be useful are comments and literal strings. For example, SCI_STYLESETCHARACTERSET(SCE_C_STRING, SC_CHARSET_RUSSIAN) would ensure that @@ -2894,30 +2880,30 @@ struct Sci_TextToFind { SC_CHARSET_TURKISH, SC_CHARSET_VIETNAMESE.

-

SCI_STYLESETCASE(int styleNumber, int caseMode)
- SCI_STYLEGETCASE(int styleNumber)
- The value of caseMode determines how text is displayed. You can set upper case +

SCI_STYLESETCASE(int style, int caseVisible)
+ SCI_STYLEGETCASE(int style) → int
+ The value of caseVisible determines how text is displayed. You can set upper case (SC_CASE_UPPER, 1) or lower case (SC_CASE_LOWER, 2) or camel case (SC_CASE_CAMEL, 3) or display normally (SC_CASE_MIXED, 0). This does not change the stored text, only how it is displayed.

-

SCI_STYLESETVISIBLE(int styleNumber, bool visible)
- SCI_STYLEGETVISIBLE(int styleNumber)
+

SCI_STYLESETVISIBLE(int style, bool visible)
+ SCI_STYLEGETVISIBLE(int style) → bool
Text is normally visible. However, you can completely hide it by giving it a style with the - visible set to 0. This could be used to hide embedded formatting instructions or + visible set to 0. This could be used to hide embedded formatting instructions or hypertext keywords in HTML or XML.

-

SCI_STYLESETCHANGEABLE(int styleNumber, bool +

SCI_STYLESETCHANGEABLE(int style, bool changeable)
- SCI_STYLEGETCHANGEABLE(int styleNumber)
+ SCI_STYLEGETCHANGEABLE(int style) → bool
This is an experimental and incompletely implemented style attribute. The default setting is - changeable set true but when set false it makes text + changeable set true but when set false it makes text read-only. Currently it only stops the caret from being within not-changeable text and does not yet stop deleting a range that contains not-changeable text.

-

SCI_STYLESETHOTSPOT(int styleNumber, bool +

SCI_STYLESETHOTSPOT(int style, bool hotspot)
- SCI_STYLEGETHOTSPOT(int styleNumber)
+ SCI_STYLEGETHOTSPOT(int style) → bool
This style is used to mark ranges of text that can detect mouse clicks. The cursor changes to a hand over hotspots, and the foreground, and background colours may change and an underline appear to indicate that these areas are sensitive to clicking. @@ -2931,71 +2917,68 @@ struct Sci_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 colour)
- SCI_SETSELBACK(bool useSelectionBackColour, int colour)
- SCI_SETSELALPHA(int alpha)
- SCI_GETSELALPHA
+ SCI_SETSELFORE(bool useSetting, colour fore)
+ SCI_SETSELBACK(bool useSetting, colour back)
+ SCI_SETSELALPHA(alpha alpha)
+ SCI_GETSELALPHA → int
SCI_SETSELEOLFILLED(bool filled)
- SCI_GETSELEOLFILLED
- SCI_SETCARETFORE(int colour)
- SCI_GETCARETFORE
+ SCI_GETSELEOLFILLED → bool
+ SCI_SETCARETFORE(colour fore)
+ SCI_GETCARETFORE → colour
SCI_SETCARETLINEVISIBLE(bool show)
- SCI_GETCARETLINEVISIBLE
- SCI_SETCARETLINEBACK(int colour)
- SCI_GETCARETLINEBACK
- SCI_SETCARETLINEBACKALPHA(int alpha)
- SCI_GETCARETLINEBACKALPHA
+ SCI_GETCARETLINEVISIBLE → bool
+ SCI_SETCARETLINEBACK(colour back)
+ SCI_GETCARETLINEBACK → colour
+ SCI_SETCARETLINEBACKALPHA(alpha alpha)
+ SCI_GETCARETLINEBACKALPHA → int
SCI_SETCARETLINEVISIBLEALWAYS(bool alwaysVisible)
- SCI_GETCARETLINEVISIBLEALWAYS
- SCI_SETCARETPERIOD(int milliseconds)
- SCI_GETCARETPERIOD
- SCI_SETCARETSTYLE(int style)
- SCI_GETCARETSTYLE
- SCI_SETCARETWIDTH(int pixels)
- SCI_GETCARETWIDTH
- SCI_SETHOTSPOTACTIVEFORE(bool useSetting, int colour)
- SCI_GETHOTSPOTACTIVEFORE
- SCI_SETHOTSPOTACTIVEBACK(bool useSetting, int colour)
- SCI_GETHOTSPOTACTIVEBACK
+ SCI_GETCARETLINEVISIBLEALWAYS → bool
+ SCI_SETCARETPERIOD(int periodMilliseconds)
+ SCI_GETCARETPERIOD → int
+ SCI_SETCARETSTYLE(int caretStyle)
+ SCI_GETCARETSTYLE → int
+ SCI_SETCARETWIDTH(int pixelWidth)
+ SCI_GETCARETWIDTH → int
+ SCI_SETHOTSPOTACTIVEFORE(bool useSetting, colour fore)
+ SCI_GETHOTSPOTACTIVEFORE → colour
+ SCI_SETHOTSPOTACTIVEBACK(bool useSetting, colour back)
+ SCI_GETHOTSPOTACTIVEBACK → colour
SCI_SETHOTSPOTACTIVEUNDERLINE(bool underline)
- SCI_GETHOTSPOTACTIVEUNDERLINE
+ SCI_GETHOTSPOTACTIVEUNDERLINE → bool
SCI_SETHOTSPOTSINGLELINE(bool singleLine)
- SCI_GETHOTSPOTSINGLELINE
+ SCI_GETHOTSPOTSINGLELINE → bool
SCI_SETCARETSTICKY(int useCaretStickyBehaviour)
- SCI_GETCARETSTICKY
+ SCI_GETCARETSTICKY → int
SCI_TOGGLECARETSTICKY
 -

SCI_SETSELFORE(bool useSelectionForeColour, int colour)
- SCI_SETSELBACK(bool useSelectionBackColour, int colour)
+

SCI_SETSELFORE(bool useSetting, colour fore)
+ SCI_SETSELBACK(bool useSetting, colour back)
You can choose to override the default selection colouring with these two messages. The colour - you provide is used if you set useSelection*Colour to true. If it is - set to false, the default styled colouring is used and the colour + you provide is used if you set useSelection*Colour to true. If it is + set to false, the default styled colouring is used and the + fore or back argument has no effect.

-

SCI_SETSELALPHA(int alpha)
- SCI_GETSELALPHA
+

SCI_SETSELALPHA(alpha alpha)
+ SCI_GETSELALPHA → int
The selection can be drawn translucently in the selection background colour by setting an alpha value.

SCI_SETSELEOLFILLED(bool filled)
- SCI_GETSELEOLFILLED
+ SCI_GETSELEOLFILLED → bool
The selection can be drawn up to the right hand border by setting this property.

-

SCI_SETCARETFORE(int colour)
- SCI_GETCARETFORE
+

SCI_SETCARETFORE(colour fore)
+ SCI_GETCARETFORE → colour
The colour of the caret can be set with SCI_SETCARETFORE and retrieved with SCI_GETCARETFORE.

SCI_SETCARETLINEVISIBLE(bool show)
- SCI_GETCARETLINEVISIBLE
- SCI_SETCARETLINEBACK(int colour)
- SCI_GETCARETLINEBACK
- SCI_SETCARETLINEBACKALPHA(int alpha)
- SCI_GETCARETLINEBACKALPHA
+ SCI_GETCARETLINEVISIBLE → bool
+ SCI_SETCARETLINEBACK(colour back)
+ SCI_GETCARETLINEBACK → colour
+ SCI_SETCARETLINEBACKALPHA(alpha alpha)
+ SCI_GETCARETLINEBACKALPHA → int
You can choose to make the background colour of the line containing the caret different with these messages. To do this, set the desired background colour with SCI_SETCARETLINEBACK, then use SCI_SETCARETLINEVISIBLE(true) to @@ -3010,20 +2993,20 @@ struct Sci_TextToFind {

SCI_SETCARETLINEVISIBLEALWAYS(bool alwaysVisible)
- SCI_GETCARETLINEVISIBLEALWAYS
+ SCI_GETCARETLINEVISIBLEALWAYS → bool
Choose to make the caret line always visible even when the window is not in focus. Default behaviour SCI_SETCARETLINEVISIBLEALWAYS(false) the caret line is only visible when the window is in focus.

-

SCI_SETCARETPERIOD(int milliseconds)
- SCI_GETCARETPERIOD
+

SCI_SETCARETPERIOD(int periodMilliseconds)
+ SCI_GETCARETPERIOD → int
The rate at which the caret blinks can be set with SCI_SETCARETPERIOD which determines the time in milliseconds that the caret is visible or invisible before changing state. Setting the period to 0 stops the caret blinking. The default value is 500 milliseconds. SCI_GETCARETPERIOD returns the current setting.

-

SCI_SETCARETSTYLE(int style)
- SCI_GETCARETSTYLE
+

SCI_SETCARETSTYLE(int caretStyle)
+ SCI_GETCARETSTYLE → int
The style of the caret can be set with SCI_SETCARETSTYLE to be a line caret (CARETSTYLE_LINE=1), a block caret (CARETSTYLE_BLOCK=2) or to not draw at all (CARETSTYLE_INVISIBLE=0). The default value is the line caret (CARETSTYLE_LINE=1). @@ -3034,8 +3017,8 @@ struct Sci_TextToFind { the cursor is positioned at these characters, which may result in only drawing a part of the cursor character sequence. This is most notable on Windows platforms.

-

SCI_SETCARETWIDTH(int pixels)
- SCI_GETCARETWIDTH
+

SCI_SETCARETWIDTH(int pixelWidth)
+ SCI_GETCARETWIDTH → int
The width of the line 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 @@ -3043,22 +3026,21 @@ struct Sci_TextToFind { This setting only affects the width of the cursor when the cursor style is set to line caret mode, it does not affect the width for a block caret.

-

SCI_SETHOTSPOTACTIVEFORE(bool useHotSpotForeColour, int colour)
- SCI_GETHOTSPOTACTIVEFORE
- SCI_SETHOTSPOTACTIVEBACK(bool useHotSpotBackColour, int colour)
- SCI_GETHOTSPOTACTIVEBACK
+

SCI_SETHOTSPOTACTIVEFORE(bool useSetting, colour fore)
+ SCI_GETHOTSPOTACTIVEFORE → colour
+ SCI_SETHOTSPOTACTIVEBACK(bool useSetting, + colour back)
+ SCI_GETHOTSPOTACTIVEBACK → colour
SCI_SETHOTSPOTACTIVEUNDERLINE(bool underline)
- SCI_GETHOTSPOTACTIVEUNDERLINE
+ SCI_GETHOTSPOTACTIVEUNDERLINE → bool
SCI_SETHOTSPOTSINGLELINE(bool singleLine)
- SCI_GETHOTSPOTSINGLELINE
+ SCI_GETHOTSPOTSINGLELINE → bool
While the cursor hovers over text in a style with the hotspot attribute set, the default colouring can be modified and an underline drawn with these settings. Single line mode stops a hotspot from wrapping onto next line.

SCI_SETCARETSTICKY(int useCaretStickyBehaviour)
- SCI_GETCARETSTICKY
+ SCI_GETCARETSTICKY → int
SCI_TOGGLECARETSTICKY
These messages set, get or toggle the caretSticky setting which controls when the last position of the caret on the line is saved.

@@ -3100,14 +3082,14 @@ struct Sci_TextToFind { SCI_SETREPRESENTATION(const char *encodedCharacter, const char *representation)
- SCI_GETREPRESENTATION(const char *encodedCharacter, char *representation)
+ SCI_GETREPRESENTATION(const char *encodedCharacter, char *representation) → int
SCI_CLEARREPRESENTATION(const char *encodedCharacter)
SCI_SETCONTROLCHARSYMBOL(int symbol)
- SCI_GETCONTROLCHARSYMBOL
+ SCI_GETCONTROLCHARSYMBOL → int

SCI_SETREPRESENTATION(const char *encodedCharacter, const char *representation)
- SCI_GETREPRESENTATION(const char *encodedCharacter, char *representation NUL-terminated)
+ SCI_GETREPRESENTATION(const char *encodedCharacter, char *representation NUL-terminated) → int
SCI_CLEARREPRESENTATION(const char *encodedCharacter)
Any character, including those normally displayed as mnemonics may be represented by a string inverted in a rounded rectangle.

@@ -3123,7 +3105,7 @@ struct Sci_TextToFind { character is specified as an empty string.

SCI_SETCONTROLCHARSYMBOL(int symbol)
- SCI_GETCONTROLCHARSYMBOL
+ SCI_GETCONTROLCHARSYMBOL → int
The mnemonics may be replaced by a nominated symbol with an ASCII code in the range 32 to 255. If you set a symbol value less than 32, all control characters are displayed as mnemonics. The symbol you set is rendered in the font of the style set for the character. @@ -3159,52 +3141,50 @@ struct Sci_TextToFind { SCI_SETMARGINS(int margins)
- SCI_GETMARGINS
- SCI_SETMARGINTYPEN(int margin, int type)
- SCI_GETMARGINTYPEN(int margin)
+ SCI_GETMARGINS → int
+ SCI_SETMARGINTYPEN(int margin, int marginType)
+ SCI_GETMARGINTYPEN(int margin) → int
SCI_SETMARGINWIDTHN(int margin, int pixelWidth)
- SCI_GETMARGINWIDTHN(int margin)
+ SCI_GETMARGINWIDTHN(int margin) → int
SCI_SETMARGINMASKN(int margin, int mask)
- SCI_GETMARGINMASKN(int margin)
+ SCI_GETMARGINMASKN(int margin) → int
SCI_SETMARGINSENSITIVEN(int margin, bool sensitive)
- SCI_GETMARGINSENSITIVEN(int - margin)
+ SCI_GETMARGINSENSITIVEN(int margin) → bool
SCI_SETMARGINCURSORN(int margin, int cursor)
- SCI_GETMARGINCURSORN(int - margin)
- SCI_SETMARGINBACKN(int margin, int colour)
- SCI_GETMARGINBACKN(int margin)
+ SCI_GETMARGINCURSORN(int margin) → int
+ SCI_SETMARGINBACKN(int margin, colour back)
+ SCI_GETMARGINBACKN(int margin) → colour
SCI_SETMARGINLEFT(<unused>, int - pixels)
- SCI_GETMARGINLEFT
+ pixelWidth)
+ SCI_GETMARGINLEFT → int
SCI_SETMARGINRIGHT(<unused>, int - pixels)
- SCI_GETMARGINRIGHT
- SCI_SETFOLDMARGINCOLOUR(bool useSetting, int colour)
- SCI_SETFOLDMARGINHICOLOUR(bool useSetting, int colour)
- SCI_MARGINSETTEXT(int line, char *text)
- SCI_MARGINGETTEXT(int line, char *text)
+ pixelWidth)
+ SCI_GETMARGINRIGHT → int
+ SCI_SETFOLDMARGINCOLOUR(bool useSetting, colour back)
+ SCI_SETFOLDMARGINHICOLOUR(bool useSetting, colour fore)
+ SCI_MARGINSETTEXT(int line, const char *text)
+ SCI_MARGINGETTEXT(int line, char *text) → int
SCI_MARGINSETSTYLE(int line, int style)
- SCI_MARGINGETSTYLE(int line)
- SCI_MARGINSETSTYLES(int line, char *styles)
- SCI_MARGINGETSTYLES(int line, char *styles)
+ SCI_MARGINGETSTYLE(int line) → int
+ SCI_MARGINSETSTYLES(int line, const char *styles)
+ SCI_MARGINGETSTYLES(int line, char *styles) → int
SCI_MARGINTEXTCLEARALL
SCI_MARGINSETSTYLEOFFSET(int style)
- SCI_MARGINGETSTYLEOFFSET
+ SCI_MARGINGETSTYLEOFFSET → int
SCI_SETMARGINOPTIONS(int marginOptions)
- SCI_GETMARGINOPTIONS
+ SCI_GETMARGINOPTIONS → int

SCI_SETMARGINS(int margins)
- SCI_GETMARGINS
+ SCI_GETMARGINS → int
Allocate the number of margins or find the number of margins currently allocated.

-

SCI_SETMARGINTYPEN(int margin, int iType)
- SCI_GETMARGINTYPEN(int margin)
+

SCI_SETMARGINTYPEN(int margin, int marginType)
+ SCI_GETMARGINTYPEN(int margin) → int
These two routines set and get the type of a margin. The margin argument should be 0, 1, 2, 3 or 4. You can use the predefined constants SC_MARGIN_SYMBOL (0) and SC_MARGIN_NUMBER (1) to set a margin as either a line number or a symbol margin. @@ -3217,7 +3197,7 @@ struct Sci_TextToFind { foreground colours or a specified colour.

SCI_SETMARGINWIDTHN(int margin, int pixelWidth)
- SCI_GETMARGINWIDTHN(int margin)
+ SCI_GETMARGINWIDTHN(int margin) → int
These routines set and get the width of a margin in pixels. A margin with zero width is invisible. By default, Scintilla sets margin 1 for symbols with a width of 16 pixels, so this is a reasonable guess if you are not sure what would be appropriate. Line number margins widths @@ -3227,7 +3207,7 @@ struct Sci_TextToFind { suitable width.

SCI_SETMARGINMASKN(int margin, int mask)
- SCI_GETMARGINMASKN(int margin)
+ SCI_GETMARGINMASKN(int margin) → int
The mask is a 32-bit value. Each bit corresponds to one of 32 logical symbols that can be displayed in a margin that is enabled for symbols. There is a useful constant, SC_MASK_FOLDERS (0xFE000000 or -33554432), that is a mask for the 7 logical @@ -3254,7 +3234,7 @@ struct Sci_TextToFind {

SCI_SETMARGINSENSITIVEN(int margin, bool sensitive)
- SCI_GETMARGINSENSITIVEN(int margin)
+ SCI_GETMARGINSENSITIVEN(int margin) → bool
Each of the five margins can be set sensitive or insensitive to mouse clicks. A click in a sensitive margin sends a SCN_MARGINCLICK SCI_SETMARGINCURSORN(int margin, int cursor)
- SCI_GETMARGINCURSORN(int margin)
+ SCI_GETMARGINCURSORN(int margin) → int
A reversed arrow cursor is normally shown over all margins. This may be changed to a normal arrow with SCI_SETMARGINCURSORN(margin, SC_CURSORARROW) or restored to a reversed arrow with SCI_SETMARGINCURSORN(margin, SC_CURSORREVERSEARROW).

- -

SCI_SETMARGINBACKN(int margin, int colour)
- SCI_GETMARGINBACKN(int margin)
+

SCI_SETMARGINBACKN(int margin, colour back)
+ SCI_GETMARGINBACKN(int margin) → colour
A margin of type SC_MARGIN_COLOUR may have its colour set with SCI_SETMARGINBACKN.

-

SCI_SETMARGINLEFT(<unused>, int pixels)
- SCI_GETMARGINLEFT
- SCI_SETMARGINRIGHT(<unused>, int pixels)
- SCI_GETMARGINRIGHT
+

SCI_SETMARGINLEFT(<unused>, int pixelWidth)
+ SCI_GETMARGINLEFT → int
+ SCI_SETMARGINRIGHT(<unused>, int pixelWidth)
+ SCI_GETMARGINRIGHT → int
These messages set and get the width of the blank margin on both sides of the text in pixels. The default is to one pixel on each side.

-

SCI_SETFOLDMARGINCOLOUR(bool useSetting, int colour)
- SCI_SETFOLDMARGINHICOLOUR(bool useSetting, int colour)
+

SCI_SETFOLDMARGINCOLOUR(bool useSetting, colour back)
+ SCI_SETFOLDMARGINHICOLOUR(bool useSetting, colour fore)
These messages allow changing the colour of the fold margin and fold margin highlight. On Windows the fold margin colour defaults to ::GetSysColor(COLOR_3DFACE) and the fold margin highlight colour to ::GetSysColor(COLOR_3DHIGHLIGHT).

- SCI_MARGINSETTEXT(int line, char *text)
- SCI_MARGINGETTEXT(int line, char *text)
+ SCI_MARGINSETTEXT(int line, const char *text)
+ SCI_MARGINGETTEXT(int line, char *text) → int
SCI_MARGINSETSTYLE(int line, int style)
- SCI_MARGINGETSTYLE(int line)
- SCI_MARGINSETSTYLES(int line, char *styles)
- SCI_MARGINGETSTYLES(int line, char *styles)
+ SCI_MARGINGETSTYLE(int line) → int
+ SCI_MARGINSETSTYLES(int line, const char *styles)
+ SCI_MARGINGETSTYLES(int line, char *styles) → int
SCI_MARGINTEXTCLEARALL
Text margins are created with the type SC_MARGIN_TEXT or SC_MARGIN_RTEXT. A different string may be set for each line with SCI_MARGINSETTEXT. @@ -3311,19 +3290,19 @@ struct Sci_TextToFind {

SCI_MARGINSETSTYLEOFFSET(int style)
- SCI_MARGINGETSTYLEOFFSET
+ SCI_MARGINGETSTYLEOFFSET → int
Margin styles may be completely separated from standard text styles by setting a style offset. For example, SCI_MARGINSETSTYLEOFFSET(256) would allow the margin styles to be numbered from 256 up to 511 so they do not overlap styles set by lexers. Each style number set with SCI_MARGINSETSTYLE or SCI_MARGINSETSTYLES has the offset added before looking up the style.

- Always call SCI_ALLOCATEEXTENDEDSTYLES + Always call SCI_ALLOCATEEXTENDEDSTYLES before SCI_MARGINSETSTYLEOFFSET and use the result as the argument to SCI_MARGINSETSTYLEOFFSET.

SCI_SETMARGINOPTIONS(int marginOptions)
- SCI_GETMARGINOPTIONS
+ SCI_GETMARGINOPTIONS → int
Define margin options by enabling appropriate bit flags. At the moment, only one flag is available SC_MARGINOPTION_SUBLINESELECT=1, which controls how wrapped lines are selected when clicking on margin in front of them. If SC_MARGINOPTION_SUBLINESELECT is set only sub line of wrapped @@ -3344,28 +3323,28 @@ struct Sci_TextToFind {

Annotations used for inline diagnostics

- SCI_ANNOTATIONSETTEXT(int line, char *text)
- SCI_ANNOTATIONGETTEXT(int line, char *text)
+ SCI_ANNOTATIONSETTEXT(int line, const char *text)
+ SCI_ANNOTATIONGETTEXT(int line, char *text) → int
SCI_ANNOTATIONSETSTYLE(int line, int style)
- SCI_ANNOTATIONGETSTYLE(int line)
- SCI_ANNOTATIONSETSTYLES(int line, char *styles)
- SCI_ANNOTATIONGETSTYLES(int line, char *styles)
- SCI_ANNOTATIONGETLINES(int line)
+ SCI_ANNOTATIONGETSTYLE(int line) → int
+ SCI_ANNOTATIONSETSTYLES(int line, const char *styles)
+ SCI_ANNOTATIONGETSTYLES(int line, char *styles) → int
+ SCI_ANNOTATIONGETLINES(int line) → int
SCI_ANNOTATIONCLEARALL
SCI_ANNOTATIONSETVISIBLE(int visible)
- SCI_ANNOTATIONGETVISIBLE
+ SCI_ANNOTATIONGETVISIBLE → int
SCI_ANNOTATIONSETSTYLEOFFSET(int style)
- SCI_ANNOTATIONGETSTYLEOFFSET
+ SCI_ANNOTATIONGETSTYLEOFFSET → int

- SCI_ANNOTATIONSETTEXT(int line, char *text)
- SCI_ANNOTATIONGETTEXT(int line, char *text)
+ SCI_ANNOTATIONSETTEXT(int line, const char *text)
+ SCI_ANNOTATIONGETTEXT(int line, char *text) → int
SCI_ANNOTATIONSETSTYLE(int line, int style)
- SCI_ANNOTATIONGETSTYLE(int line)
- SCI_ANNOTATIONSETSTYLES(int line, char *styles)
- SCI_ANNOTATIONGETSTYLES(int line, char *styles)
- SCI_ANNOTATIONGETLINES(int line)
+ SCI_ANNOTATIONGETSTYLE(int line) → int
+ SCI_ANNOTATIONSETSTYLES(int line, const char *styles)
+ SCI_ANNOTATIONGETSTYLES(int line, char *styles) → int
+ SCI_ANNOTATIONGETLINES(int line) → int
SCI_ANNOTATIONCLEARALL
A different string may be set for each line with SCI_ANNOTATIONSETTEXT. To clear annotations call SCI_ANNOTATIONSETTEXT with a NULL pointer. @@ -3388,9 +3367,9 @@ struct Sci_TextToFind {

SCI_ANNOTATIONSETVISIBLE(int visible)
- SCI_ANNOTATIONGETVISIBLE
+ SCI_ANNOTATIONGETVISIBLE → int
Annotations can be made visible in a view and there is a choice of display style when visible. - The two messages set and get the annotation display mode. The visible + The two messages set and get the annotation display mode. The visible argument can be one of:

38 Call tips normally use the font attributes defined by STYLE_DEFAULT. - Use of SCI_CALLTIPUSESTYLE + 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.
@@ -3431,7 +3410,7 @@ struct Sci_TextToFind {

SCI_ANNOTATIONSETSTYLEOFFSET(int style)
- SCI_ANNOTATIONGETSTYLEOFFSET
+ SCI_ANNOTATIONGETSTYLEOFFSET → int
Annotation styles may be completely separated from standard text styles by setting a style offset. For example, SCI_ANNOTATIONSETSTYLEOFFSET(512) would allow the annotation styles to be numbered from 512 up to 767 so they do not overlap styles set by lexers (or margins if margins offset is 256). @@ -3439,29 +3418,29 @@ struct Sci_TextToFind { or SCI_ANNOTATIONSETSTYLES has the offset added before looking up the style.

- Always call SCI_ALLOCATEEXTENDEDSTYLES + Always call SCI_ALLOCATEEXTENDEDSTYLES before SCI_ANNOTATIONSETSTYLEOFFSET and use the result as the argument to SCI_ANNOTATIONSETSTYLEOFFSET.

Other settings

- SCI_SETBUFFEREDDRAW(bool isBuffered)
- SCI_GETBUFFEREDDRAW
+ SCI_SETBUFFEREDDRAW(bool buffered)
+ SCI_GETBUFFEREDDRAW → bool
SCI_SETPHASESDRAW(int phases)
- SCI_GETPHASESDRAW
+ SCI_GETPHASESDRAW → int
SCI_SETTWOPHASEDRAW(bool twoPhase)
- SCI_GETTWOPHASEDRAW
+ SCI_GETTWOPHASEDRAW → bool
SCI_SETTECHNOLOGY(int technology)
- SCI_GETTECHNOLOGY
+ SCI_GETTECHNOLOGY → int
SCI_SETFONTQUALITY(int fontQuality)
- SCI_GETFONTQUALITY
+ SCI_GETFONTQUALITY → int
SCI_SETCODEPAGE(int codePage)
- SCI_GETCODEPAGE
+ SCI_GETCODEPAGE → int
SCI_SETIMEINTERACTION(int imeInteraction)
- SCI_GETIMEINTERACTION
+ SCI_GETIMEINTERACTION → int
SCI_GRABFOCUS
SCI_SETFOCUS(bool focus)
- SCI_GETFOCUS
+ SCI_GETFOCUS → bool

To forward a message (WM_XXXX, WPARAM, LPARAM) to Scintilla, you can use @@ -3473,8 +3452,8 @@ struct Sci_TextToFind { collect changes to mouse settings, but could be used for other user interface items in the future).

-

SCI_SETBUFFEREDDRAW(bool isBuffered)
- SCI_GETBUFFEREDDRAW
+

SCI_SETBUFFEREDDRAW(bool buffered)
+ SCI_GETBUFFEREDDRAW → bool
These messages turn buffered drawing on or off and report the buffered drawing state. Buffered drawing draws each line into a bitmap rather than directly to the screen and then copies the bitmap to the screen. This avoids flickering although it does take longer. The default is for @@ -3488,7 +3467,7 @@ struct Sci_TextToFind {

SCI_SETPHASESDRAW(int phases)
- SCI_GETPHASESDRAW
+ SCI_GETPHASESDRAW → int
There are several orders in which the text area may be drawn offering a trade-off between speed and allowing all pixels of text to be seen even when they overlap other elements.

In single phase drawing (SC_PHASES_ONE) each @@ -3520,12 +3499,12 @@ struct Sci_TextToFind { or higher can ensure that multiple phase drawing is not significantly slower.

SCI_SETTWOPHASEDRAW(bool twoPhase)
- SCI_GETTWOPHASEDRAW
+ SCI_GETTWOPHASEDRAW → bool
This property has been replaced with the preceding PHASESDRAW property which is more general, allowing multiple phase drawing as well as one and two phase drawing.

SCI_SETTECHNOLOGY(int technology)
- SCI_GETTECHNOLOGY
+ SCI_GETTECHNOLOGY → int
The technology property allows choosing between different drawing APIs and options. On most platforms, the only choice is SC_TECHNOLOGY_DEFAULT (0). On Windows Vista or later, SC_TECHNOLOGY_DIRECTWRITE (1), @@ -3544,7 +3523,7 @@ struct Sci_TextToFind { are provisional, they may be changed or removed in a future release if a better solution is found.

SCI_SETFONTQUALITY(int fontQuality)
- SCI_GETFONTQUALITY
+ SCI_GETFONTQUALITY → int
Manage font quality (antialiasing method). Currently, the following values are available on Windows: SC_EFF_QUALITY_DEFAULT (backward compatible), SC_EFF_QUALITY_NON_ANTIALIASED, @@ -3554,14 +3533,14 @@ struct Sci_TextToFind { by SC_EFF_QUALITY_MASK (0xf) will be used for quality.

SCI_SETCODEPAGE(int codePage)
- SCI_GETCODEPAGE
+ SCI_GETCODEPAGE → int
Scintilla has some support for Japanese, Chinese and Korean DBCS. Use this message with - codePage set to the code page number to set Scintilla to use code page information + codePage set to the code page number to set Scintilla to use code page information to ensure double byte characters are treated as one character rather than two. This also stops the caret from moving between the two bytes in a double byte character. Do not use this message to choose between different single byte character sets: it doesn't do that. Call with - codePage set to zero to disable DBCS support. The default is + codePage set to zero to disable DBCS support. The default is SCI_SETCODEPAGE(0).

Code page SC_CP_UTF8 (65001) sets Scintilla into Unicode mode with the document @@ -3576,7 +3555,7 @@ struct Sci_TextToFind { although these may require installation of language specific support.

SCI_SETIMEINTERACTION(int imeInteraction)
- SCI_GETIMEINTERACTION
+ SCI_GETIMEINTERACTION → int
When entering text in Chinese, Japanese, or Korean an Input Method Editor (IME) may be displayed. The IME may be an extra window appearing above Scintilla or may be displayed by Scintilla itself as text. On some platforms there is a choice between the two techniques. @@ -3590,7 +3569,7 @@ struct Sci_TextToFind {

SCI_GRABFOCUS
SCI_SETFOCUS(bool focus)
- SCI_GETFOCUS
+ SCI_GETFOCUS → bool
Scintilla can be told to grab the focus with this message. This is needed more on GTK+ where focus handling is more complicated than on Windows.

@@ -3599,16 +3578,15 @@ struct Sci_TextToFind { but with the need to indicate that Scintilla has the logical focus.

Brace highlighting

- SCI_BRACEHIGHLIGHT(int pos1, int - pos2)
- SCI_BRACEBADLIGHT(int pos1)
- SCI_BRACEHIGHLIGHTINDICATOR(bool useBraceHighlightIndicator, int indicatorNumber)
- SCI_BRACEBADLIGHTINDICATOR(bool useBraceBadLightIndicator, int indicatorNumber)
- SCI_BRACEMATCH(int position, int - maxReStyle)
+ SCI_BRACEHIGHLIGHT(int posA, int + posB)
+ SCI_BRACEBADLIGHT(int pos)
+ SCI_BRACEHIGHLIGHTINDICATOR(bool useSetting, int indicator)
+ SCI_BRACEBADLIGHTINDICATOR(bool useSetting, int indicator)
+ SCI_BRACEMATCH(int pos, int maxReStyle) → position
 -

SCI_BRACEHIGHLIGHT(int pos1, int pos2)
+

SCI_BRACEHIGHLIGHT(int posA, int posB)
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 @@ -3616,21 +3594,21 @@ struct Sci_TextToFind { href="#SCI_GETCOLUMN">SCI_GETCOLUMN and highlight the indent with SCI_SETHIGHLIGHTGUIDE.

-

SCI_BRACEBADLIGHT(int pos1)
+

SCI_BRACEBADLIGHT(int pos)
If there is no matching brace then the brace badlighting style, style STYLE_BRACEBAD (35), can be used to show the brace that is unmatched. Using a position of INVALID_POSITION (-1) removes the highlight.

-

SCI_BRACEHIGHLIGHTINDICATOR(bool useBraceHighlightIndicator, int indicatorNumber)
+

SCI_BRACEHIGHLIGHTINDICATOR(bool useSetting, int indicator)
Use specified indicator to highlight matching braces instead of changing their style.

-

SCI_BRACEBADLIGHTINDICATOR(bool useBraceBadLightIndicator, int indicatorNumber)
+

SCI_BRACEBADLIGHTINDICATOR(bool useSetting, int indicator)
Use specified indicator to highlight non matching brace instead of changing its style.

-

SCI_BRACEMATCH(int pos, int maxReStyle)
+

SCI_BRACEMATCH(int pos, int maxReStyle) → position
The SCI_BRACEMATCH message finds a corresponding matching brace given - pos, the position of one brace. The brace characters handled are '(', ')', '[', + pos, the position of one brace. The brace characters handled are '(', ')', '[', ']', '{', '}', '<', and '>'. The search is forwards from an opening brace and backwards from a closing brace. If the character at position is not a brace character, or a matching brace cannot be found, the return value is -1. Otherwise, the return value is the position of @@ -3638,7 +3616,7 @@ struct Sci_TextToFind {

A match only occurs if the style of the matching brace is the same as the starting brace or the matching brace is beyond the end of styling. Nested braces are handled correctly. The - maxReStyle parameter must currently be 0 - it may be used in the future to limit + maxReStyle parameter must currently be 0 - it may be used in the future to limit the length of brace searches.

Tabs and Indentation Guides

@@ -3657,40 +3635,39 @@ struct Sci_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_GETTABWIDTH
+ SCI_SETTABWIDTH(int tabWidth)
+ SCI_GETTABWIDTH → int
SCI_CLEARTABSTOPS(int line)
SCI_ADDTABSTOP(int line, int x)
- SCI_GETNEXTTABSTOP(int line, int x)
+ SCI_GETNEXTTABSTOP(int line, int x) → int
SCI_SETUSETABS(bool useTabs)
- SCI_GETUSETABS
- SCI_SETINDENT(int widthInChars)
- SCI_GETINDENT
+ SCI_GETUSETABS → bool
+ SCI_SETINDENT(int indentSize)
+ SCI_GETINDENT → int
SCI_SETTABINDENTS(bool tabIndents)
- SCI_GETTABINDENTS
+ SCI_GETTABINDENTS → bool
SCI_SETBACKSPACEUNINDENTS(bool bsUnIndents)
- SCI_GETBACKSPACEUNINDENTS
+ SCI_GETBACKSPACEUNINDENTS → bool
SCI_SETLINEINDENTATION(int line, int indentation)
- SCI_GETLINEINDENTATION(int line)
- SCI_GETLINEINDENTPOSITION(int - line)
+ SCI_GETLINEINDENTATION(int line) → int
+ SCI_GETLINEINDENTPOSITION(int line) → position
SCI_SETINDENTATIONGUIDES(int indentView)
- SCI_GETINDENTATIONGUIDES
+ SCI_GETINDENTATIONGUIDES → int
SCI_SETHIGHLIGHTGUIDE(int column)
- SCI_GETHIGHLIGHTGUIDE
+ SCI_GETHIGHLIGHTGUIDE → int
 -

SCI_SETTABWIDTH(int widthInChars)
- SCI_GETTABWIDTH
+

SCI_SETTABWIDTH(int tabWidth)
+ SCI_GETTABWIDTH → int
SCI_SETTABWIDTH sets the size of a tab as a multiple of the size of a space character in STYLE_DEFAULT. The default tab width is 8 characters. There are no limits on tab sizes, but values less than 1 or large values may have undesirable effects.

SCI_CLEARTABSTOPS(int line)
SCI_ADDTABSTOP(int line, int x)
- SCI_GETNEXTTABSTOP(int line, int x)
+ SCI_GETNEXTTABSTOP(int line, int x) → int
SCI_CLEARTABSTOPS clears explicit tabstops on a line. SCI_ADDTABSTOP adds an explicit tabstop at the specified distance from the left (in pixels), and SCI_GETNEXTTABSTOP gets the next explicit tabstop position set after the given x position, @@ -3699,14 +3676,14 @@ struct Sci_TextToFind {

SCI_SETUSETABS(bool useTabs)
- SCI_GETUSETABS
+ SCI_GETUSETABS → bool
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 + 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_SETINDENT(int widthInChars)
- SCI_GETINDENT
+

SCI_SETINDENT(int indentSize)
+ SCI_GETINDENT → int
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 @@ -3714,9 +3691,9 @@ struct Sci_TextToFind {

SCI_SETTABINDENTS(bool tabIndents)
- SCI_GETTABINDENTS
+ SCI_GETTABINDENTS → bool
SCI_SETBACKSPACEUNINDENTS(bool bsUnIndents)
- SCI_GETBACKSPACEUNINDENTS
+ SCI_GETBACKSPACEUNINDENTS → bool

Inside indentation white space, the tab and backspace keys can be made to indent and @@ -3724,16 +3701,16 @@ struct Sci_TextToFind { SCI_SETTABINDENTS and SCI_SETBACKSPACEUNINDENTS functions.

SCI_SETLINEINDENTATION(int line, int indentation)
- SCI_GETLINEINDENTATION(int line)
+ SCI_GETLINEINDENTATION(int line) → int
The amount of indentation on a line can be discovered and set with SCI_GETLINEINDENTATION and SCI_SETLINEINDENTATION. The indentation is measured in character columns, which correspond to the width of space characters.

-

SCI_GETLINEINDENTPOSITION(int line)
+

SCI_GETLINEINDENTPOSITION(int line) → position
This returns the position at the end of indentation of a line.

SCI_SETINDENTATIONGUIDES(int indentView)
- SCI_GETINDENTATIONGUIDES
+ SCI_GETINDENTATIONGUIDES → int
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

SCI_SETHIGHLIGHTGUIDE(int column)
- SCI_GETHIGHLIGHTGUIDE
+ SCI_GETHIGHLIGHTGUIDE → int
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 + href="#StyleDefinition">STYLE_BRACELIGHT (34). Set column to 0 to cancel this highlight.

Markers

@@ -3804,41 +3781,36 @@ struct Sci_TextToFind { their line moves. When a line is deleted, its markers are combined, by an OR operation, with the markers of the next line.

SCI_MARKERDEFINE(int markerNumber, int - markerSymbols)
+ markerSymbol)
SCI_MARKERDEFINEPIXMAP(int markerNumber, - const char *xpm)
+ const char *pixmap)
SCI_RGBAIMAGESETWIDTH(int width)
SCI_RGBAIMAGESETHEIGHT(int height)
SCI_RGBAIMAGESETSCALE(int scalePercent)
SCI_MARKERDEFINERGBAIMAGE(int markerNumber, const char *pixels)
- SCI_MARKERSYMBOLDEFINED(int markerNumber) -
- SCI_MARKERSETFORE(int markerNumber, int - colour)
- SCI_MARKERSETBACK(int markerNumber, int - colour)
- SCI_MARKERSETBACKSELECTED(int markerNumber, int - colour)
+ SCI_MARKERSYMBOLDEFINED(int markerNumber) → int
+ SCI_MARKERSETFORE(int markerNumber, colour + fore)
+ SCI_MARKERSETBACK(int markerNumber, colour + back)
+ SCI_MARKERSETBACKSELECTED(int markerNumber, colour + back)
SCI_MARKERENABLEHIGHLIGHT(bool enabled)
- SCI_MARKERSETALPHA(int markerNumber, int - alpha)
- SCI_MARKERADD(int line, int markerNumber)
- SCI_MARKERADDSET(int line, int markerMask)
+ SCI_MARKERSETALPHA(int markerNumber, alpha alpha)
+ SCI_MARKERADD(int line, int markerNumber) → int
+ SCI_MARKERADDSET(int line, int markerSet)
SCI_MARKERDELETE(int line, int markerNumber)
SCI_MARKERDELETEALL(int markerNumber)
- SCI_MARKERGET(int line)
- SCI_MARKERNEXT(int lineStart, int - markerMask)
- SCI_MARKERPREVIOUS(int lineStart, int - markerMask)
- SCI_MARKERLINEFROMHANDLE(int - handle)
- SCI_MARKERDELETEHANDLE(int handle)
+ SCI_MARKERGET(int line) → int
+ SCI_MARKERNEXT(int lineStart, int markerMask) → int
+ SCI_MARKERPREVIOUS(int lineStart, int markerMask) → int
+ SCI_MARKERLINEFROMHANDLE(int markerHandle) → int
+ SCI_MARKERDELETEHANDLE(int markerHandle)
 -

SCI_MARKERDEFINE(int markerNumber, int markerSymbols)
+

SCI_MARKERDEFINE(int markerNumber, int markerSymbol)
This message associates a marker number in the range 0 to 31 with one of the marker symbols or an ASCII character. The general-purpose marker symbols currently available are:
SC_MARK_CIRCLE, @@ -4010,7 +3982,7 @@ struct Sci_TextToFind {

Marker samples

SCI_MARKERDEFINEPIXMAP(int markerNumber, const char - *xpm)
+ *pixmap)
Markers can be set to pixmaps with this message. The XPM format is used for the pixmap. Pixmaps use the SC_MARK_PIXMAP marker symbol.

@@ -4029,38 +4001,35 @@ struct Sci_TextToFind { The default scale, 100, will stretch each image pixel to cover 4 screen pixels on a retina display.

Pixmaps use the SC_MARK_RGBAIMAGE marker symbol.

-

SCI_MARKERSYMBOLDEFINED(int markerNumber)
+

SCI_MARKERSYMBOLDEFINED(int markerNumber) → int
Returns the symbol defined for a markerNumber with SCI_MARKERDEFINE or SC_MARK_PIXMAP if defined with SCI_MARKERDEFINEPIXMAP or SC_MARK_RGBAIMAGE if defined with SCI_MARKERDEFINERGBAIMAGE.

-

SCI_MARKERSETFORE(int markerNumber, int colour)
- SCI_MARKERSETBACK(int markerNumber, int colour)
+

SCI_MARKERSETFORE(int markerNumber, colour fore)
+ SCI_MARKERSETBACK(int markerNumber, colour back)
These two messages set the foreground and background colour of a marker number.
- SCI_MARKERSETBACKSELECTED(int markerNumber, int colour)
+ SCI_MARKERSETBACKSELECTED(int markerNumber, colour back)
This message sets the highlight background colour of a marker number when its folding block is selected. The default colour is #FF0000.

SCI_MARKERENABLEHIGHLIGHT(bool enabled)
This message allows to enable/disable the highlight folding block when it is selected. (i.e. block that contains the caret)

-

SCI_MARKERSETALPHA(int markerNumber, int alpha)
+

SCI_MARKERSETALPHA(int markerNumber, + alpha alpha)
When markers are drawn in the content area, either because there is no margin for them or they are of SC_MARK_BACKGROUND or SC_MARK_UNDERLINE types, they may be drawn translucently by setting an alpha value.

-

SCI_MARKERADD(int line, int markerNumber)
- This message adds marker number markerNumber to a line. The message returns -1 if +

SCI_MARKERADD(int line, int markerNumber) → int
+ 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 the value of markerNumber, nor does it check if the line already contains the marker.

-

SCI_MARKERADDSET(int line, int markerMask)
+

SCI_MARKERADDSET(int line, int markerSet)
This message can add one or more markers to a line with a single call, specified in the same "one-bit-per-marker" 32-bit integer format returned by SCI_MARKERGET (and used by the mask-based marker search functions @@ -4080,28 +4049,28 @@ struct Sci_TextToFind { This removes markers of the given number from all lines. If markerNumber is -1, it deletes all markers from all lines.

-

SCI_MARKERGET(int line)
+

SCI_MARKERGET(int line) → int
This returns a 32-bit integer that indicates which markers were present on the line. Bit 0 is set if marker 0 is present, bit 1 for marker 1 and so on.

-

SCI_MARKERNEXT(int lineStart, int markerMask)
- SCI_MARKERPREVIOUS(int lineStart, int markerMask)
+

SCI_MARKERNEXT(int lineStart, int markerMask) → int
+ SCI_MARKERPREVIOUS(int lineStart, int markerMask) → int
These messages search efficiently for lines that include a given set of markers. The search - starts at line number lineStart and continues forwards to the end of the file + starts at line number lineStart and continues forwards to the end of the file (SCI_MARKERNEXT) or backwards to the start of the file - (SCI_MARKERPREVIOUS). The markerMask argument should have one bit set + (SCI_MARKERPREVIOUS). The markerMask argument should have one bit set for each marker you wish to find. Set bit 0 to find marker 0, bit 1 for marker 1 and so on. The message returns the line number of the first line that contains one of the markers in - markerMask or -1 if no marker is found.

+ markerMask or -1 if no marker is found.

-

SCI_MARKERLINEFROMHANDLE(int markerHandle)
- The markerHandle argument is an identifier for a marker returned by SCI_MARKERLINEFROMHANDLE(int markerHandle) → int
+ 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.

SCI_MARKERDELETEHANDLE(int markerHandle)
- The markerHandle argument is an identifier for a marker returned by 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.

@@ -4119,7 +4088,7 @@ struct Sci_TextToFind { They may also be invisible when used to track pieces of content for the application as INDIC_HIDDEN.

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 INDIC_MAX(35) + indicators. They all use an indicator argument in the range 0 to INDIC_MAX(35) to set the indicator to style. To prevent interference the set of indicators is divided up into a range for use by lexers (0..7) a range for use by containers (8=INDIC_CONTAINER .. 31=INDIC_IME-1) @@ -4128,7 +4097,7 @@ struct Sci_TextToFind {

Indicators are stored in a format similar to run length encoding which is efficient in both speed and storage for sparse information.

An indicator may store different values for each range but normally all values are drawn the same. - The SCI_INDICSETFLAGS + The SCI_INDICSETFLAGS API may be used to display different colours for different values.

Originally, Scintilla used a different technique for indicators but this @@ -4137,47 +4106,47 @@ struct Sci_TextToFind { While both techniques were supported, the term "modern indicators" was used for the newer implementation.

- SCI_INDICSETSTYLE(int indicatorNumber, int + SCI_INDICSETSTYLE(int indicator, int indicatorStyle)
- SCI_INDICGETSTYLE(int indicatorNumber)
- SCI_INDICSETFORE(int indicatorNumber, int - colour)
- SCI_INDICGETFORE(int indicatorNumber)
- SCI_INDICSETALPHA(int indicatorNumber, int alpha)
- SCI_INDICGETALPHA(int indicatorNumber)
- SCI_INDICSETOUTLINEALPHA(int indicatorNumber, int alpha)
- SCI_INDICGETOUTLINEALPHA(int indicatorNumber)
- SCI_INDICSETUNDER(int indicatorNumber, bool under)
- SCI_INDICGETUNDER(int indicatorNumber)
- SCI_INDICSETHOVERSTYLE(int indicatorNumber, int + SCI_INDICGETSTYLE(int indicator) → int
+ SCI_INDICSETFORE(int indicator, colour + fore)
+ SCI_INDICGETFORE(int indicator) → colour
+ SCI_INDICSETALPHA(int indicator, alpha alpha)
+ SCI_INDICGETALPHA(int indicator) → int
+ SCI_INDICSETOUTLINEALPHA(int indicator, alpha alpha)
+ SCI_INDICGETOUTLINEALPHA(int indicator) → int
+ SCI_INDICSETUNDER(int indicator, bool under)
+ SCI_INDICGETUNDER(int indicator) → bool
+ SCI_INDICSETHOVERSTYLE(int indicator, int indicatorStyle)
- SCI_INDICGETHOVERSTYLE(int indicatorNumber)
- SCI_INDICSETHOVERFORE(int indicatorNumber, int - colour)
- SCI_INDICGETHOVERFORE(int indicatorNumber)
- SCI_INDICSETFLAGS(int indicatorNumber, int flags)
- SCI_INDICGETFLAGS(int indicatorNumber)
+ SCI_INDICGETHOVERSTYLE(int indicator) → int
+ SCI_INDICSETHOVERFORE(int indicator, colour + fore)
+ SCI_INDICGETHOVERFORE(int indicator) → colour
+ SCI_INDICSETFLAGS(int indicator, int flags)
+ SCI_INDICGETFLAGS(int indicator) → int

SCI_SETINDICATORCURRENT(int indicator)
- SCI_GETINDICATORCURRENT
+ SCI_GETINDICATORCURRENT → int
SCI_SETINDICATORVALUE(int value)
- SCI_GETINDICATORVALUE
- SCI_INDICATORFILLRANGE(int position, int fillLength)
- SCI_INDICATORCLEARRANGE(int position, int clearLength)
- SCI_INDICATORALLONFOR(int position)
- SCI_INDICATORVALUEAT(int indicator, int position)
- SCI_INDICATORSTART(int indicator, int position)
- SCI_INDICATOREND(int indicator, int position)
+ SCI_GETINDICATORVALUE → int
+ SCI_INDICATORFILLRANGE(int start, int lengthFill)
+ SCI_INDICATORCLEARRANGE(int start, int lengthClear)
+ SCI_INDICATORALLONFOR(int pos) → int
+ SCI_INDICATORVALUEAT(int indicator, int pos) → int
+ SCI_INDICATORSTART(int indicator, int pos) → int
+ SCI_INDICATOREND(int indicator, int pos) → int
SCI_FINDINDICATORSHOW(int start, int end)
SCI_FINDINDICATORFLASH(int start, int end)
SCI_FINDINDICATORHIDE
 -

SCI_INDICSETSTYLE(int indicatorNumber, int +

SCI_INDICSETSTYLE(int indicator, int indicatorStyle)
- SCI_INDICGETSTYLE(int indicatorNumber)
+ SCI_INDICGETSTYLE(int indicator) → int
These two messages set and get the style for a particular indicator. The indicator styles currently available are:
@@ -4258,8 +4227,8 @@ struct Sci_TextToFind {

@@ -4270,8 +4239,8 @@ struct Sci_TextToFind { @@ -4318,8 +4287,8 @@ struct Sci_TextToFind { @@ -4371,94 +4340,94 @@ struct Sci_TextToFind { SCI_INDICSETSTYLE(1, INDIC_TT);
SCI_INDICSETSTYLE(2, INDIC_PLAIN);

-

SCI_INDICSETFORE(int indicatorNumber, int colour)
- SCI_INDICGETFORE(int indicatorNumber)
+

SCI_INDICSETFORE(int indicator, colour fore)
+ SCI_INDICGETFORE(int indicator) → colour
These two messages set and get the colour used to draw an indicator. The default indicator colours are equivalent to:
SCI_INDICSETFORE(0, 0x007f00); (dark green)
SCI_INDICSETFORE(1, 0xff0000); (light blue)
SCI_INDICSETFORE(2, 0x0000ff); (light red)

-

SCI_INDICSETALPHA(int indicatorNumber, int alpha)
- SCI_INDICGETALPHA(int indicatorNumber)
+

SCI_INDICSETALPHA(int indicator, alpha alpha)
+ SCI_INDICGETALPHA(int indicator) → int
These two messages set and get the alpha transparency used for drawing the fill colour of the INDIC_ROUNDBOX and INDIC_STRAIGHTBOX rectangle. The alpha value can range from 0 (completely transparent) to 255 (no transparency).

-

SCI_INDICSETOUTLINEALPHA(int indicatorNumber, int alpha)
- SCI_INDICGETOUTLINEALPHA(int indicatorNumber)
+

SCI_INDICSETOUTLINEALPHA(int indicator, alpha alpha)
+ SCI_INDICGETOUTLINEALPHA(int indicator) → int
These two messages set and get the alpha transparency used for drawing the outline colour of the INDIC_ROUNDBOX and INDIC_STRAIGHTBOX rectangle. The alpha value can range from 0 (completely transparent) to 255 (no transparency).

-

SCI_INDICSETUNDER(int indicatorNumber, bool under)
- SCI_INDICGETUNDER(int indicatorNumber)
+

SCI_INDICSETUNDER(int indicator, bool under)
+ SCI_INDICGETUNDER(int indicator) → bool
These two messages set and get whether an indicator is drawn under text or over(default). Drawing under text works only for indicators when two phase drawing is enabled.

-

SCI_INDICSETHOVERSTYLE(int indicatorNumber, int +

SCI_INDICSETHOVERSTYLE(int indicator, int indicatorStyle)
- SCI_INDICGETHOVERSTYLE(int indicatorNumber)
- SCI_INDICSETHOVERFORE(int indicatorNumber, int colour)
- SCI_INDICGETHOVERFORE(int indicatorNumber)
+ SCI_INDICGETHOVERSTYLE(int indicator) → int
+ SCI_INDICSETHOVERFORE(int indicator, colour fore)
+ SCI_INDICGETHOVERFORE(int indicator) → colour
These messages set and get the colour and style used to draw indicators when the mouse is over them or the caret moved into them. The mouse cursor also changes when an indicator is drawn in hover style. The default is for the hover appearance to be the same as the normal appearance and calling - SCI_INDICSETFORE or - SCI_INDICSETSTYLE will + SCI_INDICSETFORE or + SCI_INDICSETSTYLE will also reset the hover attribute.

-

SCI_INDICSETFLAGS(int indicatorNumber, int flags)
- SCI_INDICGETFLAGS(int indicatorNumber)
+

SCI_INDICSETFLAGS(int indicator, int flags)
+ SCI_INDICGETFLAGS(int indicator) → int
These messages set and get the flags associated with an indicator. There is currently one flag defined, SC_INDICFLAG_VALUEFORE: when this flag is set the colour used by the indicator is not from the indicator's fore setting but instead from the value of the indicator at that point in the file. This allows many colours to be displayed for a single indicator. The value is an RGB integer colour that has been ored with SC_INDICVALUEBIT(0x1000000) - when calling SCI_SETINDICATORVALUE. + when calling SCI_SETINDICATORVALUE. To find the colour from the value, and the value with SC_INDICVALUEMASK(0xFFFFFF).

SCI_SETINDICATORCURRENT(int indicator)
- SCI_GETINDICATORCURRENT
+ SCI_GETINDICATORCURRENT → int
These two messages set and get the indicator that will be affected by calls to - SCI_INDICATORFILLRANGE(int position, int fillLength) and - SCI_INDICATORCLEARRANGE(int position, int clearLength). + SCI_INDICATORFILLRANGE(int start, int lengthFill) and + SCI_INDICATORCLEARRANGE(int start, int lengthClear).

SCI_SETINDICATORVALUE(int value)
- SCI_GETINDICATORVALUE
+ SCI_GETINDICATORVALUE → int
These two messages set and get the value that will be set by calls to - SCI_INDICATORFILLRANGE. + SCI_INDICATORFILLRANGE.

- SCI_INDICATORFILLRANGE(int position, int fillLength)
- SCI_INDICATORCLEARRANGE(int position, int clearLength)
+ SCI_INDICATORFILLRANGE(int start, int lengthFill)
+ SCI_INDICATORCLEARRANGE(int start, int lengthClear)
These two messages fill or clear a range for the current indicator. SCI_INDICATORFILLRANGE fills with the the current value.

- SCI_INDICATORALLONFOR(int position)
+ SCI_INDICATORALLONFOR(int pos) → int
Retrieve a bitmap value representing which indicators are non-zero at a position. Only the first 32 indicators are represented in the result so no IME indicators are included.

- SCI_INDICATORVALUEAT(int indicator, int position)
+ SCI_INDICATORVALUEAT(int indicator, int pos) → int
Retrieve the value of a particular indicator at a position.

- SCI_INDICATORSTART(int indicator, int position)
- SCI_INDICATOREND(int indicator, int position)
+ SCI_INDICATORSTART(int indicator, int pos) → int
+ SCI_INDICATOREND(int indicator, int pos) → int
Find the start or end of a range with one value from a position within the range. Can be used to iterate through the document to discover all the indicator positions.

@@ -4512,58 +4481,57 @@ struct Sci_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 - *list)
+ SCI_AUTOCSHOW(int lengthEntered, const char + *itemList)
SCI_AUTOCCANCEL
- SCI_AUTOCACTIVE
- SCI_AUTOCPOSSTART
+ SCI_AUTOCACTIVE → bool
+ SCI_AUTOCPOSSTART → position
SCI_AUTOCCOMPLETE
SCI_AUTOCSTOPS(<unused>, const char - *chars)
- SCI_AUTOCSETSEPARATOR(char - separator)
- SCI_AUTOCGETSEPARATOR
+ *characterSet)
+ SCI_AUTOCSETSEPARATOR(int + separatorCharacter)
+ SCI_AUTOCGETSEPARATOR → int
SCI_AUTOCSELECT(<unused>, const char *select)
- SCI_AUTOCGETCURRENT
- SCI_AUTOCGETCURRENTTEXT(<unused>, - char *text)
+ SCI_AUTOCGETCURRENT → int
+ SCI_AUTOCGETCURRENTTEXT(<unused>, char *text) → int
SCI_AUTOCSETCANCELATSTART(bool cancel)
- SCI_AUTOCGETCANCELATSTART
+ SCI_AUTOCGETCANCELATSTART → bool
SCI_AUTOCSETFILLUPS(<unused>, const char - *chars)
+ *characterSet)
SCI_AUTOCSETCHOOSESINGLE(bool chooseSingle)
- SCI_AUTOCGETCHOOSESINGLE
+ SCI_AUTOCGETCHOOSESINGLE → bool
SCI_AUTOCSETIGNORECASE(bool ignoreCase)
- SCI_AUTOCGETIGNORECASE
+ SCI_AUTOCGETIGNORECASE → bool
SCI_AUTOCSETCASEINSENSITIVEBEHAVIOUR(int behaviour)
- SCI_AUTOCGETCASEINSENSITIVEBEHAVIOUR
+ SCI_AUTOCGETCASEINSENSITIVEBEHAVIOUR → int
SCI_AUTOCSETMULTI(int multi)
- SCI_AUTOCGETMULTI
+ SCI_AUTOCGETMULTI → int
SCI_AUTOCSETORDER(int order)
- SCI_AUTOCGETORDER
+ SCI_AUTOCGETORDER → int
SCI_AUTOCSETAUTOHIDE(bool autoHide)
- SCI_AUTOCGETAUTOHIDE
+ SCI_AUTOCGETAUTOHIDE → bool
SCI_AUTOCSETDROPRESTOFWORD(bool dropRestOfWord)
- SCI_AUTOCGETDROPRESTOFWORD
+ SCI_AUTOCGETDROPRESTOFWORD → bool
SCI_REGISTERIMAGE(int type, const char *xpmData)
SCI_REGISTERRGBAIMAGE(int type, const char *pixels)
SCI_CLEARREGISTEREDIMAGES
- SCI_AUTOCSETTYPESEPARATOR(char separatorCharacter)
- SCI_AUTOCGETTYPESEPARATOR
+ SCI_AUTOCSETTYPESEPARATOR(int separatorCharacter)
+ SCI_AUTOCGETTYPESEPARATOR → int
SCI_AUTOCSETMAXHEIGHT(int rowCount)
- SCI_AUTOCGETMAXHEIGHT
+ SCI_AUTOCGETMAXHEIGHT → int
SCI_AUTOCSETMAXWIDTH(int characterCount)
- SCI_AUTOCGETMAXWIDTH
+ SCI_AUTOCGETMAXWIDTH → int
 -

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 +

SCI_AUTOCSHOW(int lengthEntered, const char *itemList)
+ This message causes a list to be displayed. lengthEntered is the number of + characters of the word already entered and itemList 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_AUTOCSETORDER + Alternative handling of list order may be specified with SCI_AUTOCSETORDER

SCI_AUTOCCANCEL
@@ -4584,90 +4552,90 @@ struct Sci_TextToFind { autocompletion can be specified with SCI_AUTOCSTOPS.

-

SCI_AUTOCACTIVE
+

SCI_AUTOCACTIVE → bool
This message returns non-zero if there is an active autocompletion list and zero if there is not.

-

SCI_AUTOCPOSSTART
+

SCI_AUTOCPOSSTART → position
This returns the value of the current position when SCI_AUTOCSHOW started display of the list.

SCI_AUTOCCOMPLETE
This message triggers autocompletion. This has the same effect as the tab key.

-

SCI_AUTOCSTOPS(<unused>, const char *chars)
- The chars argument is a string containing a list of characters that will +

SCI_AUTOCSTOPS(<unused>, const char *characterSet)
+ The characterSet argument is a string containing a list of characters that will automatically cancel the autocompletion list. When you start the editor, this list is empty.

-

SCI_AUTOCSETSEPARATOR(char separator)
- SCI_AUTOCGETSEPARATOR
+

SCI_AUTOCSETSEPARATOR(int separatorCharacter)
+ SCI_AUTOCGETSEPARATOR → int
These two messages set and get the separator character used to separate words in the SCI_AUTOCSHOW list. The default is the space character.

SCI_AUTOCSELECT(<unused>, const char *select)
- SCI_AUTOCGETCURRENT
+ SCI_AUTOCGETCURRENT → int
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 + 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 + 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).
The current selection index can be retrieved with SCI_AUTOCGETCURRENT.

-

SCI_AUTOCGETCURRENTTEXT(<unused>, char *text NUL-terminated)
+

SCI_AUTOCGETCURRENTTEXT(<unused>, char *text NUL-terminated) → int
This message retrieves the current selected text in the autocompletion list. Normally the SCN_AUTOCSELECTION notification is used instead.

-

The value is copied to the text buffer, returning the length (not including the +

The value is copied to the text buffer, returning the length (not including the terminating 0). If not found, an empty string is copied to the buffer and 0 is returned.

If the value argument is 0 then the length that should be allocated to store the value is returned; again, the terminating 0 is not included.

SCI_AUTOCSETCANCELATSTART(bool cancel)
- SCI_AUTOCGETCANCELATSTART
+ SCI_AUTOCGETCANCELATSTART → bool
The default behaviour is for the list to be cancelled if the caret moves to the location it was at when the list was displayed. By calling this message with a false argument, the list is not cancelled until the caret moves at least one character before the word being completed.

-

SCI_AUTOCSETFILLUPS(<unused>, const char *chars)
+

SCI_AUTOCSETFILLUPS(<unused>, const char *characterSet)
If a fillup character is typed with an autocompletion list active, the currently selected item in the list is added into the document, then the fillup character is added. Common fillup characters are '(', '[' and '.' but others are possible depending on the language. By default, no fillup characters are set.

SCI_AUTOCSETCHOOSESINGLE(bool chooseSingle)
- SCI_AUTOCGETCHOOSESINGLE
+ SCI_AUTOCGETCHOOSESINGLE → bool
If you use SCI_AUTOCSETCHOOSESINGLE(1) and a list has only one item, it is automatically added and no list is displayed. The default is to display the list even if there is only a single item.

SCI_AUTOCSETIGNORECASE(bool ignoreCase)
- SCI_AUTOCGETIGNORECASE
+ SCI_AUTOCGETIGNORECASE → bool
By default, matching of characters to list members is case sensitive. These messages let you set and get case sensitivity.

SCI_AUTOCSETCASEINSENSITIVEBEHAVIOUR(int behaviour)
- SCI_AUTOCGETCASEINSENSITIVEBEHAVIOUR
+ SCI_AUTOCGETCASEINSENSITIVEBEHAVIOUR → int
When autocompletion is set to ignore case (SCI_AUTOCSETIGNORECASE), by default it will nonetheless select the first list member that matches in a case sensitive way to entered characters. This corresponds to a behaviour property of SC_CASEINSENSITIVEBEHAVIOUR_RESPECTCASE (0). If you want autocompletion to ignore case at all, choose SC_CASEINSENSITIVEBEHAVIOUR_IGNORECASE (1).

SCI_AUTOCSETMULTI(int multi)
- SCI_AUTOCGETMULTI
+ SCI_AUTOCGETMULTI → int
When autocompleting with multiple selections present, the autocompleted text can go into just the main selection with SC_MULTIAUTOC_ONCE (0) or into each selection with SC_MULTIAUTOC_EACH (1). The default is SC_MULTIAUTOC_ONCE.

SCI_AUTOCSETORDER(int order)
- SCI_AUTOCGETORDER
+ SCI_AUTOCGETORDER → int
The default setting SC_ORDER_PRESORTED (0) requires that the list be provided in alphabetical sorted order.

Sorting the list can be done by Scintilla instead of the application with SC_ORDER_PERFORMSORT (1). @@ -4675,29 +4643,29 @@ struct Sci_TextToFind {

Applications that wish to prioritize some values and show the list in order of priority instead of alphabetical order can use SC_ORDER_CUSTOM (2). - This requires extra processing in SCI_AUTOCSHOW to create a sorted index. + This requires extra processing in SCI_AUTOCSHOW to create a sorted index.

-

Setting the order should be done before calling SCI_AUTOCSHOW. +

Setting the order should be done before calling SCI_AUTOCSHOW.

SCI_AUTOCSETAUTOHIDE(bool autoHide)
- SCI_AUTOCGETAUTOHIDE
+ SCI_AUTOCGETAUTOHIDE → bool
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 autoHide to false. This also effects SCI_AUTOCSELECT.

SCI_AUTOCSETDROPRESTOFWORD(bool dropRestOfWord)
- SCI_AUTOCGETDROPRESTOFWORD
+ SCI_AUTOCGETDROPRESTOFWORD → bool
When an item is selected, any word characters following the caret are first erased if - dropRestOfWord is set true. The default is false.

+ dropRestOfWord is set true. The default is false.

SCI_REGISTERIMAGE(int type, const char *xpmData)
SCI_REGISTERRGBAIMAGE(int type, const char *pixels)
SCI_CLEARREGISTEREDIMAGES
- SCI_AUTOCSETTYPESEPARATOR(char separatorCharacter)
- SCI_AUTOCGETTYPESEPARATOR
+ SCI_AUTOCSETTYPESEPARATOR(int separatorCharacter)
+ SCI_AUTOCGETTYPESEPARATOR → int
Autocompletion list items may display an image as well as text. Each image is first registered with an integer type. Then this integer is included in the text of the list separated by a '?' from the text. For example, @@ -4713,7 +4681,7 @@ struct Sci_TextToFind {

SCI_AUTOCSETMAXHEIGHT(int rowCount)
- SCI_AUTOCGETMAXHEIGHT
+ SCI_AUTOCGETMAXHEIGHT → int
Get or set the maximum number of rows that will be visible in an autocompletion list. If there are more rows in the list, then a vertical scrollbar is shown. The default is 5. @@ -4721,7 +4689,7 @@ struct Sci_TextToFind {

SCI_AUTOCSETMAXWIDTH(int characterCount)
- SCI_AUTOCGETMAXWIDTH
+ SCI_AUTOCGETMAXWIDTH → int
Get or set the maximum width of an autocompletion list expressed as the number of characters in the longest item that will be totally visible. If zero (the default) then the list's width is calculated to fit the item with the most characters. Any items that cannot be fully displayed within @@ -4734,6 +4702,8 @@ struct Sci_TextToFind { listed for autocompletion work on them; you cannot display a user list at the same time as an autocompletion list is active. They differ in the following respects:

+ SCI_USERLISTSHOW(int listType, const char *itemList)
 +

o The SCI_AUTOCSETCHOOSESINGLE message has no effect.
@@ -4746,12 +4716,12 @@ struct Sci_TextToFind { with the user list, and may result in items being selected or the user list cancelled due to the user typing into the editor.

-

SCI_USERLISTSHOW(int listType, const char *list)
- The listType parameter is returned to the container as the wParam +

SCI_USERLISTSHOW(int listType, const char *itemList)
+ 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 + buffers and a list of macros, you can use listType to tell which one has returned a selection.

Call tips

@@ -4762,7 +4732,7 @@ struct Sci_TextToFind { STYLE_DEFAULT. You can choose to use STYLE_CALLTIP to define the facename, size, foreground and background colours and character set with - SCI_CALLTIPUSESTYLE. + SCI_CALLTIPUSESTYLE. This also enables support for Tab characters. There is some interaction between call tips and autocompletion lists in that showing a @@ -4789,34 +4759,34 @@ struct Sci_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 pos, const char *definition)
SCI_CALLTIPCANCEL
- SCI_CALLTIPACTIVE
- SCI_CALLTIPPOSSTART
+ SCI_CALLTIPACTIVE → bool
+ SCI_CALLTIPPOSSTART → position
SCI_CALLTIPSETPOSSTART(int posStart)
SCI_CALLTIPSETHLT(int highlightStart, int highlightEnd)
- SCI_CALLTIPSETBACK(int colour)
- SCI_CALLTIPSETFORE(int colour)
- SCI_CALLTIPSETFOREHLT(int colour)
- SCI_CALLTIPUSESTYLE(int tabsize)
+ SCI_CALLTIPSETBACK(colour back)
+ SCI_CALLTIPSETFORE(colour fore)
+ SCI_CALLTIPSETFOREHLT(colour fore)
+ SCI_CALLTIPUSESTYLE(int tabSize)
SCI_CALLTIPSETPOSITION(bool above)
 -

SCI_CALLTIPSHOW(int posStart, const char *definition)
+

SCI_CALLTIPSHOW(int pos, const char *definition)
This message starts the process by displaying the call tip window. If a call tip is already active, this has no effect.
- posStart is the position in the document at which to align the call tip. The call + pos is the position in the document at which to align the call tip. The call tip text is aligned to start 1 line below this character unless you have included up and/or down arrows in the call tip text in which case the tip is aligned to the right-hand edge of the rightmost arrow. The assumption is that you will start the text with something like "\001 1 of 3 \002".
- definition is the call tip text. This can contain multiple lines separated by + definition is the call tip text. This can contain multiple lines separated by '\n' (Line Feed, ASCII code 10) characters. Do not include '\r' (Carriage Return, ASCII code 13), as this will most likely print as an empty box. '\t' (Tab, ASCII code 9) is supported if you set a tabsize with - SCI_CALLTIPUSESTYLE.
+ SCI_CALLTIPUSESTYLE.
The position of the caret is remembered here so that the call tip can be cancelled automatically if subsequent deletion moves the caret before this position.

@@ -4826,19 +4796,20 @@ struct Sci_TextToFind { function. Call tips are cancelled if you delete back past the position where the caret was when the tip was triggered.

-

SCI_CALLTIPACTIVE
+

SCI_CALLTIPACTIVE → bool
This returns 1 if a call tip is active and 0 if it is not active.

-

SCI_CALLTIPPOSSTART
+

SCI_CALLTIPPOSSTART → position
SCI_CALLTIPSETPOSSTART(int posStart)
This message returns or sets the value of the current position when SCI_CALLTIPSHOW started to display the tip.

-

SCI_CALLTIPSETHLT(int hlStart, int hlEnd)
+

SCI_CALLTIPSETHLT(int highlightStart, int highlightEnd)
This sets the region of the call tips text to display in a highlighted style. - hlStart is the zero-based index into the string of the first character to - highlight and hlEnd is the index of the first character after the highlight. - hlEnd must be greater than hlStart; hlEnd-hlStart is the + highlightStart is the zero-based index into the string of the first character to + highlight and highlightEnd is the index of the first character after the highlight. + highlightEnd must be greater than highlightStart; + highlightEnd-highlightStart is the number of characters to highlight. Highlights can extend over line ends if this is required.

@@ -4849,23 +4820,23 @@ struct Sci_TextToFind { SCI_CALLTIPSETFOREHLT.

-

SCI_CALLTIPSETBACK(int colour)
+

SCI_CALLTIPSETBACK(colour back)
The background colour of call tips can be set with this message; the default colour is white. It is not a good idea to set a dark colour as the background as the default colour for normal calltip text is mid grey and the default colour for highlighted text is dark blue. This also sets the background colour of STYLE_CALLTIP.

-

SCI_CALLTIPSETFORE(int colour)
+

SCI_CALLTIPSETFORE(colour fore)
The colour of call tip text can be set with this message; the default colour is mid grey. This also sets the foreground colour of STYLE_CALLTIP.

-

SCI_CALLTIPSETFOREHLT(int colour)
+

SCI_CALLTIPSETFOREHLT(colour fore)
The colour of highlighted call tip text can be set with this message; the default colour is dark blue.

-

SCI_CALLTIPUSESTYLE(int tabsize)
+

SCI_CALLTIPUSESTYLE(int tabSize)
This message changes the style used for call tips from STYLE_DEFAULT to - STYLE_CALLTIP and sets a tab size in screen pixels. If tabsize is + STYLE_CALLTIP and sets a tab size in screen pixels. If tabsize is less than 1, Tab characters are not treated specially. Once this call has been used, the call tip foreground and background colours are also taken from the style.

@@ -5201,7 +5172,7 @@ struct Sci_TextToFind {

SCI_ASSIGNCMDKEY(int keyDefinition, int sciCommand)
This assigns the given key definition to a Scintilla command identified by - sciCommand. sciCommand can be any SCI_* command that has + sciCommand. sciCommand can be any SCI_* command that has no arguments.

SCI_CLEARCMDKEY(int Popup edit menu -

SCI_USEPOPUP(bool bEnablePopup)
+ SCI_USEPOPUP(bool allowPopUp)
+ + +

SCI_USEPOPUP(bool allowPopUp)
Clicking the wrong button on the mouse pops up a short default editing menu. This may be turned off with SCI_USEPOPUP(0). If you turn it off, context menu commands (in Windows, WM_CONTEXTMENU) will not be handled by Scintilla, so the parent of the @@ -5232,6 +5206,10 @@ struct Sci_TextToFind { notifications. It is then up to the container to record these actions for future replay.

+ SCI_STARTRECORD
+ SCI_STOPRECORD
+ +

SCI_STARTRECORD
SCI_STOPRECORD
These two messages turn macro recording on and off.

@@ -5247,25 +5225,24 @@ struct Sci_TextToFind { HDCs., on GTK+ 3.x cairo_t *, and on Cocoa CGContextRef is used.

- SCI_FORMATRANGE(bool bDraw, Sci_RangeToFormat - *pfr)
+ SCI_FORMATRANGE(bool draw, Sci_RangeToFormat *fr) → position
SCI_SETPRINTMAGNIFICATION(int magnification)
- SCI_GETPRINTMAGNIFICATION
+ SCI_GETPRINTMAGNIFICATION → int
SCI_SETPRINTCOLOURMODE(int mode)
- SCI_GETPRINTCOLOURMODE
- SCI_SETPRINTWRAPMODE
- SCI_GETPRINTWRAPMODE
+ SCI_GETPRINTCOLOURMODE → int
+ SCI_SETPRINTWRAPMODE(int wrapMode)
+ SCI_GETPRINTWRAPMODE → int
 -

SCI_FORMATRANGE(bool bDraw, Sci_RangeToFormat *pfr)
+

SCI_FORMATRANGE(bool draw, Sci_RangeToFormat *fr) → position
This call renders a range of text into a device context. If you use this for printing, you will probably want to arrange a page header and footer; Scintilla does not do this for you. See SciTEWin::Print() in SciTEWinDlg.cxx for an example. Each use of this message renders a range of text into a rectangular area and returns the position in the document of the next character to print.

-

bDraw controls if any output is done. Set this to false if you are paginating +

draw controls if any output is done. Set this to false if you are paginating (for example, if you use this with MFC you will need to paginate in OnBeginPrinting() before you output each page.

@@ -5291,9 +5268,9 @@ struct Sci_RangeToFormat {
      chrg.cpMin and chrg.cpMax define the start position and maximum
     position of characters to output. All of each line within this character range is drawn.

 
-    
On Cocoa, the surface IDs for printing (bDraw=1) should be the graphics port of the current context
+    
On Cocoa, the surface IDs for printing (draw=1) should be the graphics port of the current context
     ((CGContextRef) [[NSGraphicsContext currentContext] graphicsPort]) when the view's drawRect method is called.
-    The Surface IDs are not really used for measurement (bDraw=0) but can be set
+    The Surface IDs are not really used for measurement (draw=0) but can be set
     to a bitmap context (created with CGBitmapContextCreate) to avoid runtime warnings.

 
     
On GTK+, the surface IDs to use can be found from the printing context with
@@ -5309,14 +5286,14 @@ struct Sci_RangeToFormat {
     area, header and footer code.

 
     
SCI_SETPRINTMAGNIFICATION(int magnification)

-     SCI_GETPRINTMAGNIFICATION

+     SCI_GETPRINTMAGNIFICATION → int

      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. 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.

 
     
SCI_SETPRINTCOLOURMODE(int mode)

-     SCI_GETPRINTCOLOURMODE

+     SCI_GETPRINTCOLOURMODE → int

      These two messages set and get the method used to render coloured text on a printer that is
     probably using white paper. It is especially important to consider the treatment of colour if
     you use a dark or black screen background. Printing white on black uses up toner and ink very
@@ -5379,8 +5356,8 @@ struct Sci_RangeToFormat {
A rectangle with rounded corners around the text using translucent drawing with the interior usually more transparent than the border. You can use - SCI_INDICSETALPHA and - SCI_INDICSETOUTLINEALPHA + SCI_INDICSETALPHA and + SCI_INDICSETOUTLINEALPHA to control the alpha transparency values. The default alpha values are 30 for fill colour and 50 for outline colour.
A rectangle around the text using translucent drawing with the interior usually more transparent than the border. You can use - SCI_INDICSETALPHA and - SCI_INDICSETOUTLINEALPHA + SCI_INDICSETALPHA and + SCI_INDICSETOUTLINEALPHA to control the alpha transparency values. The default alpha values are 30 for fill colour and 50 for outline colour. This indicator does not colour the top pixel of the line so that indicators on contiguous lines are visually distinct and disconnected.A dotted rectangle around the text using translucent drawing. Translucency alternates between the alpha and outline alpha settings with the top-left pixel using the alpha setting. - SCI_INDICSETALPHA and - SCI_INDICSETOUTLINEALPHA + SCI_INDICSETALPHA and + SCI_INDICSETOUTLINEALPHA control the alpha transparency values. The default values are 30 for alpha and 50 for outline alpha. To avoid excessive memory allocation the maximum width of a dotted box is 4000 pixels.

SCI_SETPRINTWRAPMODE(int wrapMode)
- SCI_GETPRINTWRAPMODE
- These two functions get and set the printer wrap mode. wrapMode can be + SCI_GETPRINTWRAPMODE → int
+ These two functions get and set the printer wrap mode. wrapMode can be set to SC_WRAP_NONE (0), SC_WRAP_WORD (1) or SC_WRAP_CHAR (2). The default is SC_WRAP_WORD, which wraps printed output so that all characters fit @@ -5394,11 +5371,11 @@ struct Sci_RangeToFormat { between words.

Direct access

- SCI_GETDIRECTFUNCTION
- SCI_GETDIRECTPOINTER
- SCI_GETCHARACTERPOINTER
- SCI_GETRANGEPOINTER(int position, int rangeLength)
- SCI_GETGAPPOSITION
+ SCI_GETDIRECTFUNCTION → int
+ SCI_GETDIRECTPOINTER → int
+ SCI_GETCHARACTERPOINTER → int
+ SCI_GETRANGEPOINTER(int start, int lengthRange) → int
+ SCI_GETGAPPOSITION → position

On Windows, the message-passing scheme used to communicate between the container and @@ -5418,7 +5395,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SciFnDirect, sptr_t and uptr_t are declared in - Scintilla.h. hSciWnd is the window handle returned when you created + Scintilla.h. hSciWnd is the window handle returned when you created the Scintilla window.

While faster, this direct calling will cause problems if performed from a different thread @@ -5433,19 +5410,19 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETDIRECTFUNCTION and the need to call Scintilla indirectly via the function pointer.

-

SCI_GETDIRECTFUNCTION
+

SCI_GETDIRECTFUNCTION → int
This message returns the address of the function to call to handle Scintilla messages without the overhead of passing through the Windows messaging system. You need only call this once, regardless of the number of Scintilla windows you create.

-

SCI_GETDIRECTPOINTER
+

SCI_GETDIRECTPOINTER → int
This returns a pointer to data that identifies which Scintilla window is in use. You must call this once for each Scintilla window you create. When you call the direct function, you must pass in the direct pointer associated with the target window.

-

SCI_GETCHARACTERPOINTER
- SCI_GETRANGEPOINTER(int position, int rangeLength)
- SCI_GETGAPPOSITION
+

SCI_GETCHARACTERPOINTER → int
+ SCI_GETRANGEPOINTER(int start, int lengthRange) → int
+ SCI_GETGAPPOSITION → position
Grant temporary direct read-only access to the memory used by Scintilla to store the document.

SCI_GETCHARACTERPOINTER moves the gap within Scintilla so that the @@ -5486,35 +5463,35 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ documents in a single Scintilla window and so you can display a single document in multiple windows (for use with splitter windows).

-

Although these messages use document *pDoc, to ensure compatibility with future - releases of Scintilla you should treat pDoc as an opaque void*. That +

Although these messages use document *doc, to ensure compatibility with future + releases of Scintilla you should treat doc 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 → document *
SCI_SETDOCPOINTER(<unused>, document - *pDoc)
- SCI_CREATEDOCUMENT
+ *doc)
+ SCI_CREATEDOCUMENT → document *
SCI_ADDREFDOCUMENT(<unused>, document - *pDoc)
+ *doc)
SCI_RELEASEDOCUMENT(<unused>, document - *pDoc)
+ *doc)
 -

SCI_GETDOCPOINTER
+

SCI_GETDOCPOINTER → document *
This returns a pointer to the document currently in use by the window. It has no other effect.

-

SCI_SETDOCPOINTER(<unused>, document *pDoc)
+

SCI_SETDOCPOINTER(<unused>, document *doc)
This message does the following:
1. It removes the current window from the list held by the current document.
2. It reduces the reference count of the current document by 1.
3. If the reference count reaches 0, the document is deleted.
- 4. pDoc is set as the new document for the window.
- 5. If pDoc was 0, a new, empty document is created and attached to the + 4. doc is set as the new document for the window.
+ 5. If doc was 0, a new, empty document is created and attached to the window.
- 6. If pDoc was not 0, its reference count is increased by 1.

+ 6. If doc was not 0, its reference count is increased by 1.

-

SCI_CREATEDOCUMENT
+

SCI_CREATEDOCUMENT → document *
This message creates a new, empty document and returns a pointer to it. This document is not selected into the editor and starts with a reference count of 1. This means that you have ownership of it and must either reduce its reference count by 1 after using @@ -5522,18 +5499,18 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ you reduce the reference count by 1 with SCI_RELEASEDOCUMENT before you close the application to avoid memory leaks.

-

SCI_ADDREFDOCUMENT(<unused>, document *pDoc)
+

SCI_ADDREFDOCUMENT(<unused>, document *doc)
This increases the reference count of a document by 1. If you want to replace the current document in the Scintilla window and take ownership of the current document, for example if you are editing many documents in one window, do the following:
1. Use SCI_GETDOCPOINTER to get a pointer to the document, - pDoc.
- 2. Use SCI_ADDREFDOCUMENT(0, pDoc) to increment the reference count.
- 3. Use SCI_SETDOCPOINTER(0, pNewDoc) to set a different document or + doc.
+ 2. Use SCI_ADDREFDOCUMENT(0, doc) to increment the reference count.
+ 3. Use SCI_SETDOCPOINTER(0, docNew) to set a different document or SCI_SETDOCPOINTER(0, 0) to set a new, empty document.

-

SCI_RELEASEDOCUMENT(<unused>, document *pDoc)
- This message reduces the reference count of the document identified by pDoc. pDoc +

SCI_RELEASEDOCUMENT(<unused>, document *doc)
+ This message reduces the reference count of the document identified by doc. doc must be the result of SCI_GETDOCPOINTER or SCI_CREATEDOCUMENT and must point at a document that still exists. If you call this on a document with a reference count of 1 that is still attached to a Scintilla window, bad things will happen. To keep the @@ -5547,16 +5524,19 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

Loading in the background

+ SCI_CREATELOADER(int bytes) → int
+ +

An application can load all of a file into a buffer it allocates on a background thread and then add the data in that buffer into a Scintilla document on the user interface thread. That technique uses extra memory to store a complete copy of the file and also means that the time that Scintilla takes to perform initial line end discovery blocks the user interface.

To avoid these issues, a loader object may be created and used to load the file. The loader object supports the ILoader interface.

-

SCI_CREATELOADER(int bytes)
+

SCI_CREATELOADER(int bytes) → int
Create an object that supports the ILoader interface which can be used to load data and then be turned into a Scintilla document object for attachment to a view object. - The bytes argument determines the initial memory allocation for the document as it is more efficient + The bytes argument determines the initial memory allocation for the document as it is more efficient to allocate once rather than rely on the buffer growing as data is added. If SCI_CREATELOADER fails then 0 is returned.

@@ -5578,14 +5558,14 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ the Release call. When the whole file has been read, the ConvertToDocument method should be called to produce a Scintilla document pointer which can be used in the same way as a document pointer returned from - SCI_CREATEDOCUMENT. + SCI_CREATEDOCUMENT. There is no need to call Release after ConvertToDocument.

Saving in the background

An application that wants to save in the background should lock the document with SCI_SETREADONLY(1) to prevent modifications and retrieve a pointer to the unified document contents with - SCI_GETCHARACTERPOINTER. + SCI_GETCHARACTERPOINTER. The buffer of a locked document will not move so the pointer is valid until the application calls SCI_SETREADONLY(0).

If the user tries to performs a modification while the document is locked then a "fold" property should be set to "1" with SCI_SETPROPERTY("fold", "1") to enable folding.

- SCI_VISIBLEFROMDOCLINE(int - docLine)
- SCI_DOCLINEFROMVISIBLE(int - displayLine)
+ SCI_VISIBLEFROMDOCLINE(int docLine) → int
+ SCI_DOCLINEFROMVISIBLE(int displayLine) → int
SCI_SHOWLINES(int lineStart, int lineEnd)
SCI_HIDELINES(int lineStart, int lineEnd)
- SCI_GETLINEVISIBLE(int line)
- SCI_GETALLLINESVISIBLE
+ SCI_GETLINEVISIBLE(int line) → bool
+ SCI_GETALLLINESVISIBLE → bool
SCI_SETFOLDLEVEL(int line, int level)
- SCI_GETFOLDLEVEL(int line)
+ SCI_GETFOLDLEVEL(int line) → int
SCI_SETAUTOMATICFOLD(int automaticFold)
- SCI_GETAUTOMATICFOLD
+ SCI_GETAUTOMATICFOLD → int
SCI_SETFOLDFLAGS(int flags)
- SCI_GETLASTCHILD(int line, int level)
- SCI_GETFOLDPARENT(int line)
+ SCI_GETLASTCHILD(int line, int level) → int
+ SCI_GETFOLDPARENT(int line) → int
SCI_SETFOLDEXPANDED(int line, bool expanded)
- SCI_GETFOLDEXPANDED(int line)
- SCI_CONTRACTEDFOLDNEXT(int lineStart)
+ SCI_GETFOLDEXPANDED(int line) → bool
+ SCI_CONTRACTEDFOLDNEXT(int lineStart) → int
SCI_TOGGLEFOLD(int line)
SCI_FOLDLINE(int line, int action)
SCI_FOLDCHILDREN(int line, int action)
@@ -5639,30 +5617,30 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ line)
 -

SCI_VISIBLEFROMDOCLINE(int docLine)
+

SCI_VISIBLEFROMDOCLINE(int docLine) → int
When some lines are hidden and/or annotations are displayed, then a particular line in the document may be displayed at a different position to its document position. If no lines are hidden and there are no annotations, this message returns - docLine. Otherwise, this returns the display line (counting the very first visible + docLine. Otherwise, this returns the display line (counting the very first visible line as 0). The display line of an invisible line is the same as the previous visible line. The display line number of the first line in the document is 0. If lines are hidden and - docLine is outside the range of lines in the document, the return value is -1. + docLine is outside the range of lines in the document, the return value is -1. Lines can occupy more than one display line if they wrap.

-

SCI_DOCLINEFROMVISIBLE(int displayLine)
+

SCI_DOCLINEFROMVISIBLE(int displayLine) → int
When some lines are hidden and/or annotations are displayed, then a particular line in the document may be displayed at a different position to its document position. This message returns the document line number that corresponds to a display line (counting the display line of the first line in the document as - 0). If displayLine is less than or equal to 0, the result is 0. If - displayLine is greater than or equal to the number of displayed lines, the result + 0). If displayLine is less than or equal to 0, the result is 0. If + displayLine is greater than or equal to the number of displayed lines, the result is the number of lines in the document.

SCI_SHOWLINES(int lineStart, int lineEnd)
SCI_HIDELINES(int lineStart, int lineEnd)
- SCI_GETLINEVISIBLE(int line)
- SCI_GETALLLINESVISIBLE
+ SCI_GETLINEVISIBLE(int line) → bool
+ SCI_GETALLLINESVISIBLE → bool
The first two messages mark a range of lines as visible or invisible and then redraw the display. SCI_GETLINEVISIBLE reports on the visible state of a line and returns 1 if it is @@ -5673,11 +5651,11 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ flags. The first line can not be hidden.

SCI_SETFOLDLEVEL(int line, int level)
- SCI_GETFOLDLEVEL(int line)
+ SCI_GETFOLDLEVEL(int line) → int
These two messages set and get a 32-bit value that contains the fold level of a line and some flags associated with folding. The fold level is a number in the range 0 to - SC_FOLDLEVELNUMBERMASK (4095). However, the initial fold level is set to - SC_FOLDLEVELBASE (1024) to allow unsigned arithmetic on folding levels. There are + SC_FOLDLEVELNUMBERMASK (0x0FFF). However, the initial fold level is set to + SC_FOLDLEVELBASE (0x400) to allow unsigned arithmetic on folding levels. There are two addition flag bits. SC_FOLDLEVELWHITEFLAG indicates that the line is blank and allows it to be treated slightly different then its level may indicate. For example, blank lines should generally not be fold points and will be considered part of the preceding section even though @@ -5699,7 +5677,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ 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:
+ flags determine where folding lines are drawn:

@@ -5766,18 +5744,18 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

This message causes the display to redraw.

-

SCI_GETLASTCHILD(int startLine, int level)
- This message searches for the next line after startLine, that has a folding level - that is less than or equal to level and then returns the previous line number. If - you set level to -1, level is set to the folding level of line - startLine. If from is a fold point, SCI_GETLASTCHILD(from, +

SCI_GETLASTCHILD(int line, int level) → int
+ This message searches for the next line after line, that has a folding level + that is less than or equal to level and then returns the previous line number. If + you set level to -1, level is set to the folding level of line + line. If from is a fold point, SCI_GETLASTCHILD(from, -1) returns the last line that would be in made visible or hidden by toggling the fold state.

-

SCI_GETFOLDPARENT(int startLine)
- This message returns the line number of the first line before startLine that is +

SCI_GETFOLDPARENT(int line) → int
+ This message returns the line number of the first line before line that is marked as a fold point with SC_FOLDLEVELHEADERFLAG and has a fold level less than - the startLine. If no line is found, or if the header flags and fold levels are + the line. If no line is found, or if the header flags and fold levels are inconsistent, the return value is -1.

SCI_TOGGLEFOLD(int line)
@@ -5787,7 +5765,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ all the lines that depend on the line. The display updates after this message.

SCI_SETFOLDEXPANDED(int line, bool expanded)
- SCI_GETFOLDEXPANDED(int line)
+ SCI_GETFOLDEXPANDED(int line) → bool
These messages set and get the expanded state of a single line. The set message has no effect on the visible state of the line or any lines that depend on it. It does change the markers in the folding margin. If you ask for the expansion state of a line that is outside the document, @@ -5849,9 +5827,9 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETAUTOMATICFOLD(int automaticFold)
- SCI_GETAUTOMATICFOLD
+ SCI_GETAUTOMATICFOLD → int
Instead of implementing all the logic for handling folding in the container, Scintilla can provide behaviour - that is adequate for many applications. The automaticFold argument is a bit set defining + that is adequate for many applications. The automaticFold argument is a bit set defining which of the 3 pieces of folding implementation should be enabled. Most applications should be able to use the SC_AUTOMATICFOLD_SHOW and SC_AUTOMATICFOLD_CHANGE flags unless they wish to implement quite different behaviour such as defining their own fold structure. @@ -5894,11 +5872,11 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

-

SCI_CONTRACTEDFOLDNEXT(int lineStart)
+

SCI_CONTRACTEDFOLDNEXT(int lineStart) → int
Search efficiently for lines that are contracted fold headers. This is useful when saving the user's folding when switching documents or saving folding with a file. - The search starts at line number lineStart and continues forwards to the end of the file. - lineStart is returned if it is a contracted fold header otherwise the next contracted + The search starts at line number lineStart and continues forwards to the end of the file. + lineStart is returned if it is a contracted fold header otherwise the next contracted fold header is returned. If there are no more contracted fold headers then -1 is returned.

SCI_ENSUREVISIBLE(int line)
@@ -5912,22 +5890,22 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

Line wrapping

SCI_SETWRAPMODE(int wrapMode)
- SCI_GETWRAPMODE
+ SCI_GETWRAPMODE → int
SCI_SETWRAPVISUALFLAGS(int wrapVisualFlags)
- SCI_GETWRAPVISUALFLAGS
+ SCI_GETWRAPVISUALFLAGS → int
SCI_SETWRAPVISUALFLAGSLOCATION(int wrapVisualFlagsLocation)
- SCI_GETWRAPVISUALFLAGSLOCATION
- SCI_SETWRAPINDENTMODE(int indentMode)
- SCI_GETWRAPINDENTMODE
+ SCI_GETWRAPVISUALFLAGSLOCATION → int
+ SCI_SETWRAPINDENTMODE(int wrapIndentMode)
+ SCI_GETWRAPINDENTMODE → int
SCI_SETWRAPSTARTINDENT(int indent)
- SCI_GETWRAPSTARTINDENT
+ SCI_GETWRAPSTARTINDENT → int
SCI_SETLAYOUTCACHE(int cacheMode)
- SCI_GETLAYOUTCACHE
+ SCI_GETLAYOUTCACHE → int
SCI_SETPOSITIONCACHE(int size)
- SCI_GETPOSITIONCACHE
+ SCI_GETPOSITIONCACHE → int
SCI_LINESSPLIT(int pixelWidth)
SCI_LINESJOIN
- SCI_WRAPCOUNT(int docLine)
+ SCI_WRAPCOUNT(int docLine) → int

By default, Scintilla does not wrap lines of text. If you enable line wrapping, lines wider @@ -5961,7 +5939,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCN_PAINTED notification.

SCI_SETWRAPMODE(int wrapMode)
- SCI_GETWRAPMODE
+ SCI_GETWRAPMODE → int
Set wrapMode to SC_WRAP_WORD (1) to enable wrapping on word or style boundaries, SC_WRAP_CHAR (2) to enable wrapping between any characters, SC_WRAP_WHITESPACE (3) to enable @@ -5972,7 +5950,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETWRAPVISUALFLAGS(int wrapVisualFlags)
- SCI_GETWRAPVISUALFLAGS
+ SCI_GETWRAPVISUALFLAGS → int
You can enable the drawing of visual flags to indicate a line is wrapped. Bits set in wrapVisualFlags determine which visual flags are drawn.

@@ -6015,7 +5993,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETWRAPVISUALFLAGSLOCATION(int wrapVisualFlagsLocation)
- SCI_GETWRAPVISUALFLAGSLOCATION
+ SCI_GETWRAPVISUALFLAGSLOCATION → int
You can set whether the visual flags to indicate a line is wrapped are drawn near the border or near the text. Bits set in wrapVisualFlagsLocation set the location to near the text for the corresponding visual flag.

@@ -6050,8 +6028,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ -

SCI_SETWRAPINDENTMODE(int indentMode)
- SCI_GETWRAPINDENTMODE
+

SCI_SETWRAPINDENTMODE(int wrapIndentMode)
+ SCI_GETWRAPINDENTMODE → int
Wrapped sublines can be indented to the position of their first subline or one more indent level. The default is SC_WRAPINDENT_FIXED. The modes are: @@ -6071,7 +6049,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SC_WRAPINDENT_FIXED 0 Wrapped sublines aligned to left of window plus amount set by - SCI_SETWRAPSTARTINDENT + SCI_SETWRAPSTARTINDENT @@ -6089,7 +6067,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETWRAPSTARTINDENT(int indent)
- SCI_GETWRAPSTARTINDENT
+ SCI_GETWRAPSTARTINDENT → int
SCI_SETWRAPSTARTINDENT sets the size of indentation of sublines for wrapped lines in terms of the average character width in STYLE_DEFAULT. @@ -6100,8 +6078,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETLAYOUTCACHE(int cacheMode)
- SCI_GETLAYOUTCACHE
- You can set cacheMode to one of the symbols in the table:

+ SCI_GETLAYOUTCACHE → int
+ You can set cacheMode to one of the symbols in the table:

@@ -6150,7 +6128,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETPOSITIONCACHE(int size)
- SCI_GETPOSITIONCACHE
+ SCI_GETPOSITIONCACHE → int
The position cache stores position information for short runs of text so that their layout can be determined more quickly if the run recurs. The size in entries of this cache can be set with SCI_SETPOSITIONCACHE.

@@ -6158,7 +6136,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_LINESSPLIT(int pixelWidth)
Split a range of lines indicated by the target into lines that are at most pixelWidth wide. Splitting occurs on word boundaries wherever possible in a similar manner to line wrapping. - When pixelWidth is 0 then the width of the window is used. + When pixelWidth is 0 then the width of the window is used.

SCI_LINESJOIN
@@ -6167,7 +6145,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ Where this would lead to no space between words, an extra space is inserted.

-

SCI_WRAPCOUNT(int docLine)
+

SCI_WRAPCOUNT(int docLine) → int
Document lines can occupy more than one display line if they wrap and this returns the number of display lines needed to wrap a document line.

@@ -6179,7 +6157,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_ZOOMIN
SCI_ZOOMOUT
SCI_SETZOOM(int zoomInPoints)
- SCI_GETZOOM
+ SCI_GETZOOM → int

SCI_ZOOMIN
@@ -6189,7 +6167,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ current zoom factor is greater than -10 points.

SCI_SETZOOM(int zoomInPoints)
- SCI_GETZOOM
+ SCI_GETZOOM → int
These messages let you set and get the zoom factor directly. There is no limit set on the factors you can set, so limiting yourself to -10 to +20 to match the incremental zoom functions is a good idea.

@@ -6198,19 +6176,19 @@ 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_GETEDGEMODE
+ SCI_SETEDGEMODE(int edgeMode)
+ SCI_GETEDGEMODE → int
SCI_SETEDGECOLUMN(int column)
- SCI_GETEDGECOLUMN
- SCI_SETEDGECOLOUR(int colour)
- SCI_GETEDGECOLOUR
+ SCI_GETEDGECOLUMN → int
+ SCI_SETEDGECOLOUR(colour edgeColour)
+ SCI_GETEDGECOLOUR → colour

- SCI_MULTIEDGEADDLINE(int column, int colour)
+ SCI_MULTIEDGEADDLINE(int column, colour edgeColour)
SCI_MULTIEDGECLEARALL

SCI_SETEDGEMODE(int edgeMode)
- SCI_GETEDGEMODE
+ SCI_GETEDGEMODE → int
These two messages set and get the mode used to display long lines. You can set one of the values in the table:

@@ -6270,20 +6248,19 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETEDGECOLUMN(int column)
- SCI_GETEDGECOLUMN
+ SCI_GETEDGECOLUMN → int
These messages set and get the column number at which to display the long line marker. When drawing lines, the column sets a position in units of the width of a space character in STYLE_DEFAULT. When setting the background colour, the column is a character count (allowing for tabs) into the line.

-

SCI_SETEDGECOLOUR(int colour)
- SCI_GETEDGECOLOUR
+

SCI_SETEDGECOLOUR(colour edgeColour)
+ SCI_GETEDGECOLOUR → colour
These messages set and get the colour of the marker used to show that a line has exceeded the length set by SCI_SETEDGECOLUMN.

-

SCI_MULTIEDGEADDLINE(int column, int colour)
+

SCI_MULTIEDGEADDLINE(int column, + colour edgeColour)
SCI_MULTIEDGECLEARALL
SCI_MULTIEDGEADDLINE adds a new vertical edge to the view. The edge will be displayed at the given column number. The resulting edge position depends on the metric @@ -6302,38 +6279,38 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ functions: GetLexerCount, GetLexerName, and GetLexerFactory. See externalLexer.cxx for more.

SCI_SETLEXER(int lexer)
- SCI_GETLEXER
+ SCI_GETLEXER → int
SCI_SETLEXERLANGUAGE(<unused>, const char - *name)
- SCI_GETLEXERLANGUAGE(<unused>, char - *name)
+ *language)
+ SCI_GETLEXERLANGUAGE(<unused>, char *language) → int
SCI_LOADLEXERLIBRARY(<unused>, const char *path)
SCI_COLOURISE(int start, int end)
- SCI_CHANGELEXERSTATE(int start, int end)
- SCI_PROPERTYNAMES(<unused>, char *names)
- SCI_PROPERTYTYPE(const char *name)
- SCI_DESCRIBEPROPERTY(const char *name, char *description)
+ SCI_CHANGELEXERSTATE(int start, int end) → int
+ SCI_PROPERTYNAMES(<unused>, char *names) → int
+ SCI_PROPERTYTYPE(const char *name) → int
+ SCI_DESCRIBEPROPERTY(const char *name, char *description) → int
SCI_SETPROPERTY(const char *key, const char *value)
- SCI_GETPROPERTY(const char *key, char *value)
- SCI_GETPROPERTYEXPANDED(const char *key, char *value)
- SCI_GETPROPERTYINT(const char *key, int default)
- SCI_DESCRIBEKEYWORDSETS(<unused>, char *descriptions)
+ SCI_GETPROPERTY(const char *key, char *value) → int
+ SCI_GETPROPERTYEXPANDED(const char *key, char *value) → int
+ SCI_GETPROPERTYINT(const char *key, int defaultValue) → int
+ SCI_DESCRIBEKEYWORDSETS(<unused>, char *descriptions) → int
SCI_SETKEYWORDS(int keyWordSet, const char - *keyWordList)
+ *keyWords)
- SCI_GETSUBSTYLEBASES(<unused>, char *styles)
- SCI_DISTANCETOSECONDARYSTYLES
- SCI_ALLOCATESUBSTYLES(int styleBase, int numberStyles)
+ SCI_GETSUBSTYLEBASES(<unused>, char *styles) → int
+ SCI_DISTANCETOSECONDARYSTYLES → int
+ SCI_ALLOCATESUBSTYLES(int styleBase, int numberStyles) → int
SCI_FREESUBSTYLES
- SCI_GETSUBSTYLESSTART(int styleBase)
- SCI_GETSUBSTYLESLENGTH(int styleBase)
- SCI_GETSTYLEFROMSUBSTYLE(int subStyle)
- SCI_GETPRIMARYSTYLEFROMSTYLE(int style)
+ SCI_GETSUBSTYLESSTART(int styleBase) → int
+ SCI_GETSUBSTYLESLENGTH(int styleBase) → int
+ SCI_GETSTYLEFROMSUBSTYLE(int subStyle) → int
+ SCI_GETPRIMARYSTYLEFROMSTYLE(int style) → int
SCI_SETIDENTIFIERS(int style, const char *identifiers)
+ SCI_PRIVATELEXERCALL(int operation, int pointer) → int

SCI_SETLEXER(int lexer)
- SCI_GETLEXER
+ SCI_GETLEXER → int
You can select the lexer to use with an integer code from the SCLEX_* enumeration in Scintilla.h. There are two codes in this sequence that do not use lexers: SCLEX_NULL to select no lexing action and SCLEX_CONTAINER which sends @@ -6342,11 +6319,11 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCLEX_AUTOMATIC value; this identifies additional external lexers that Scintilla assigns unused lexer numbers to.

-

SCI_SETLEXERLANGUAGE(<unused>, const char *name)
- SCI_GETLEXERLANGUAGE(<unused>, char *name NUL-terminated)
+

SCI_SETLEXERLANGUAGE(<unused>, const char *language)
+ SCI_GETLEXERLANGUAGE(<unused>, char *language NUL-terminated) → int
SCI_SETLEXERLANGUAGE lets you select a lexer by name, and is the only method if you are using an external lexer or if you have written a lexer module for a language of your own and do not wish - to assign it an explicit lexer number. To select an existing lexer, set name to + to assign it an explicit lexer number. To select an existing lexer, set language to match the (case sensitive) name given to the module, for example "ada" or "python", not "Ada" or "Python". To locate the name for the built-in lexers, open the relevant Lex*.cxx file and search for LexerModule. The third argument in the @@ -6362,21 +6339,21 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ Load a lexer implemented in a shared library. This is a .so file on GTK+/Linux or a .DLL file on Windows.

-

SCI_COLOURISE(int startPos, int endPos)
+

SCI_COLOURISE(int start, int end)
This requests the current lexer or the container (if the lexer is set to - SCLEX_CONTAINER) to style the document between startPos and - endPos. If endPos is -1, the document is styled from - startPos to the end. If the "fold" property is set to + SCLEX_CONTAINER) to style the document between start and + end. If end is -1, the document is styled from + start to the end. If the "fold" property is set to "1" and your lexer or container supports folding, fold levels are also set. This message causes a redraw.

-

SCI_CHANGELEXERSTATE(int startPos, int endPos)
+

SCI_CHANGELEXERSTATE(int start, int end) → int
Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.

-

SCI_PROPERTYNAMES(<unused>, char *names NUL-terminated)
- SCI_PROPERTYTYPE(const char *name)
- SCI_DESCRIBEPROPERTY(const char *name, char *description NUL-terminated)
+

SCI_PROPERTYNAMES(<unused>, char *names NUL-terminated) → int
+ SCI_PROPERTYTYPE(const char *name) → int
+ SCI_DESCRIBEPROPERTY(const char *name, char *description NUL-terminated) → int
Information may be retrieved about the properties that can be set for the current lexer. This information is only available for newer lexers. SCI_PROPERTYNAMES returns a string with all of the valid properties separated by "\n". @@ -6387,14 +6364,14 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

SCI_SETPROPERTY(const char *key, const char *value)
You can communicate settings to lexers with keyword:value string pairs. There is no limit to - the number of keyword pairs you can set, other than available memory. key is a - case sensitive keyword, value is a string that is associated with the keyword. If + the number of keyword pairs you can set, other than available memory. key is a + case sensitive keyword, value is a string that is associated with the keyword. If there is already a value string associated with the keyword, it is replaced. If you pass a zero - length string, the message does nothing. Both key and value are used - without modification; extra spaces at the beginning or end of key are + length string, the message does nothing. Both key and value are used + without modification; extra spaces at the beginning or end of key are significant.

-

The value string can refer to other keywords. For example, +

The value string can refer to other keywords. For example, SCI_SETPROPERTY("foldTimes10", "$(fold)0") stores the string "$(fold)0", but when this is accessed, the $(fold) is replaced by the value of the "fold" keyword (or by nothing if this keyword does not exist).

@@ -6415,7 +6392,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ Documentation for the property may be located above the call as a multi-line comment starting with
// property <property-name>

-

SCI_GETPROPERTY(const char *key, char *value NUL-terminated)
+

SCI_GETPROPERTY(const char *key, char *value NUL-terminated) → int
Lookup a keyword:value pair using the specified key; if found, copy the value to the user-supplied buffer and return the length (not including the terminating 0). If not found, copy an empty string to the buffer and return 0.

@@ -6426,7 +6403,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

If the value argument is 0 then the length that should be allocated to store the value is returned; again, the terminating 0 is not included.

-

SCI_GETPROPERTYEXPANDED(const char *key, char *value)
+

SCI_GETPROPERTYEXPANDED(const char *key, char *value) → int
Lookup a keyword:value pair using the specified key; if found, copy the value to the user-supplied buffer and return the length (not including the terminating 0). If not found, copy an empty string to the buffer and return 0.

@@ -6437,7 +6414,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

If the value argument is 0 then the length that should be allocated to store the value (including any indicated keyword replacement) is returned; again, the terminating 0 is not included.

-

SCI_GETPROPERTYINT(const char *key, int default)
+

SCI_GETPROPERTYINT(const char *key, int defaultValue) → int
Lookup a keyword:value pair using the specified key; if found, interpret the value as an integer and return it. If not found (or the value is an empty string) then return the supplied default. If the keyword:value pair is found but is not a number, then return 0.

@@ -6445,10 +6422,10 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

Note that "keyword replacement" as described in SCI_SETPROPERTY will be performed before any numeric interpretation.

-

SCI_SETKEYWORDS(int keyWordSet, const char *keyWordList)
+

SCI_SETKEYWORDS(int keyWordSet, const char *keyWords)
You can set up to 9 lists of keywords for use by the current lexer. - keyWordSet can be 0 to 8 (actually 0 to KEYWORDSET_MAX) - and selects which keyword list to replace. keyWordList is a list of keywords + keyWordSet can be 0 to 8 (actually 0 to KEYWORDSET_MAX) + and selects which keyword list to replace. keyWords is a list of keywords separated by spaces, tabs, "\n" or "\r" or any combination of these. It is expected that the keywords will be composed of standard ASCII printing characters, but there is nothing to stop you using any non-separator character codes from 1 to 255 @@ -6467,7 +6444,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ There is nothing to stop you building your own keyword lists into the lexer, but this means that the lexer must be rebuilt if more keywords are added.

-

SCI_DESCRIBEKEYWORDSETS(<unused>, char *descriptions NUL-terminated)
+

SCI_DESCRIBEKEYWORDSETS(<unused>, char *descriptions NUL-terminated) → int
A description of all of the keyword sets separated by "\n" is returned by SCI_DESCRIBEKEYWORDSETS.

Substyles

@@ -6478,33 +6455,36 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ each purpose. Lexers have to explicitly support this feature by implementing the methods in ILexerWithSubStyles.

-

SCI_GETSUBSTYLEBASES(<unused>, char *styles NUL-terminated)
- Fill styles with a byte for each style that can be split into substyles.

+

SCI_GETSUBSTYLEBASES(<unused>, char *styles NUL-terminated) → int
+ Fill styles with a byte for each style that can be split into substyles.

-

SCI_DISTANCETOSECONDARYSTYLES
+

SCI_DISTANCETOSECONDARYSTYLES → int
Returns the distance between a primary style and its corresponding secondary style.

-

SCI_ALLOCATESUBSTYLES(int styleBase, int numberStyles)
+

SCI_ALLOCATESUBSTYLES(int styleBase, int numberStyles) → int
Allocate some number of substyles for a particular base style returning the first substyle number allocated. Substyles are allocated contiguously.

SCI_FREESUBSTYLES
Free all allocated substyles.

-

SCI_GETSUBSTYLESSTART(int styleBase)
- SCI_GETSUBSTYLESLENGTH(int styleBase)
+

SCI_GETSUBSTYLESSTART(int styleBase) → int
+ SCI_GETSUBSTYLESLENGTH(int styleBase) → int
Return the start and length of the substyles allocated for a base style.

-

SCI_GETSTYLEFROMSUBSTYLE(int subStyle)
+

SCI_GETSTYLEFROMSUBSTYLE(int subStyle) → int
For a sub style, return the base style, else return the argument.

-

SCI_GETPRIMARYSTYLEFROMSTYLE(int style)
+

SCI_GETPRIMARYSTYLEFROMSTYLE(int style) → int
For a secondary style, return the primary style, else return the argument.

SCI_SETIDENTIFIERS(int style, const char *identifiers)
Similar to SCI_SETKEYWORDS but for substyles. The prefix feature available with SCI_SETKEYWORDS is not implemented for SCI_SETIDENTIFIERS.

+

SCI_PRIVATELEXERCALL(int operation, int pointer) → int
+ Call into a lexer in a way not understood by Scintilla.

+

Lexer Objects

Lexers are programmed as objects that implement the ILexer interface and that interact @@ -6673,7 +6653,7 @@ returning INVALID_POSITION for movement beyond the start and end of conversion from UTF-8 bytes to a UTF-32 character or from DBCS to a 16 bit value. Bytes in invalid UTF-8 are reported individually with values 0xDC80+byteValue, which are not valid Unicode code points. -The pWidth argument can be NULL if the caller does not need to know the number of +The pWidth argument can be NULL if the caller does not need to know the number of bytes in the character.

@@ -6790,11 +6770,11 @@ struct SCNotification {

The following SCI_* messages are associated with these notifications:

SCI_SETMODEVENTMASK(int eventMask)
- SCI_GETMODEVENTMASK
- SCI_SETMOUSEDWELLTIME(int milliseconds)
- SCI_GETMOUSEDWELLTIME
+ SCI_GETMODEVENTMASK → int
+ SCI_SETMOUSEDWELLTIME(int periodMilliseconds)
+ SCI_GETMOUSEDWELLTIME → int
SCI_SETIDENTIFIER(int identifier)
- SCI_GETIDENTIFIER
+ SCI_GETIDENTIFIER → int

The following additional notifications are sent using a secondary "command" method and should @@ -6811,7 +6791,7 @@ struct SCNotification {

SCI_SETIDENTIFIER(int identifier)
- SCI_GETIDENTIFIER
+ SCI_GETIDENTIFIER → int
These two messages set and get the identifier of the Scintilla instance which is included in notifications as the idFrom field. When an application creates multiple Scintilla widgets, this allows the source of each notification to be found. @@ -6826,14 +6806,14 @@ struct SCNotification { href="#SCI_SETLEXER">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 + returned by SCI_GETENDSTYLED up to the position passed in SCNotification.position. Symbolically, you need code of the form:

-    startPos = SCI_GETENDSTYLED()
-    lineNumber = SCI_GETENDSTYLED()
+    lineNumber = SCI_LINEFROMPOSITION(startPos);
-    startPos = SCI_POSITIONFROMLINE(lineNumber);
     MyStyleRoutine(startPos, SCNotification.position);
@@ -7158,7 +7138,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); 0x8000 - A line state has changed because SCI_SETLINESTATE + A line state has changed because SCI_SETLINESTATE was called. line @@ -7169,8 +7149,8 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); 0x200000 - The explicit tab stops on a line have changed because SCI_CLEARTABSTOPS or - SCI_ADDTABSTOP was called. + The explicit tab stops on a line have changed because SCI_CLEARTABSTOPS or + SCI_ADDTABSTOP was called. line @@ -7211,7 +7191,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); 0x100000 Text is about to be inserted. The handler may change the text being inserted by calling - SCI_CHANGEINSERTION. + SCI_CHANGEINSERTION. No other modifications may be made in this handler. position, length, text @@ -7278,7 +7258,7 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber); href="#SCI_SETMODEVENTMASK">SCI_SETMODEVENTMASK.

SCI_SETMODEVENTMASK(int eventMask)
- SCI_GETMODEVENTMASK
+ SCI_GETMODEVENTMASK → int
These messages set and get an event mask that determines which document change events are notified to the container with SCN_MODIFIED and
-

SCI_SETMOUSEDWELLTIME(int milliseconds)
- SCI_GETMOUSEDWELLTIME
+

SCI_SETMOUSEDWELLTIME(int periodMilliseconds)
+ SCI_GETMOUSEDWELLTIME → int
These two messages set and get the time the mouse must sit still, in milliseconds, to generate a SCN_DWELLSTART notification. If set to SC_TIME_FOREVER, the default, no dwell events are generated.

SCN_ZOOM
This notification is generated when the user zooms the display using the keyboard or the - SCI_SETZOOM method is called. This + SCI_SETZOOM method is called. This notification can be used to recalculate positions, such as the width of the line number margin to maintain sizes in terms of characters rather than pixels. SCNotification has no additional information.

@@ -7638,7 +7618,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next The - SCI_AUTOCSELECT message + SCI_AUTOCSELECT message triggered the completion. ch is 0. @@ -7729,7 +7709,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next

void scintilla_set_id(ScintillaObject *sci, uptr_t id)
Set the control ID which will be used in the idFrom field of the NotifyHeader structure of all notifications for this instance. - This is equivalent to SCI_SETIDENTIFIER.

+ This is equivalent to SCI_SETIDENTIFIER.

sptr_t scintilla_send_message(ScintillaObject *sci,unsigned int iMessage, uptr_t wParam, sptr_t lParam)
The main entry point allows sending any of the messages described in this document.

@@ -7747,7 +7727,7 @@ for line = lineStart to lineEnd do SCI_ENSUREVISIBLE(line) next

There are currently no provisional messages. The SC_TECHNOLOGY_DIRECTWRITERETAIN and SC_TECHNOLOGY_DIRECTWRITEDC values for - SCI_SETTECHNOLOGY are provisional.

+ SCI_SETTECHNOLOGY are provisional.

Some developers may want to only use features that are stable and have graduated from provisional status. To avoid using provisional messages compile with the symbol @@ -7806,25 +7786,34 @@ EM_FORMATRANGE INCLUDE_DEPRECATED_FEATURES in Scintilla.h. To ensure future compatibility you should change them as indicated.

+ SCI_SETUSEPALETTE(bool usePalette)
+ SCI_GETUSEPALETTE → bool
+ SCI_SETKEYSUNICODE(bool keysUnicode)
+ SCI_GETKEYSUNICODE → bool
+ SCI_SETSTYLEBITS(int bits)
+ SCI_GETSTYLEBITS → int
+ SCI_GETSTYLEBITSNEEDED → int
+ +

SC_CP_DBCS Deprecated
This was used to set a DBCS (Double Byte Character Set) mode on GTK+. - An explicit DBCS code page should be used when calling SCI_SETCODEPAGE

+ An explicit DBCS code page should be used when calling SCI_SETCODEPAGE

-

SCI_SETUSEPALETTE(bool allowPaletteUse) Deprecated
- SCI_GETUSEPALETTE Deprecated
+

SCI_SETUSEPALETTE(bool usePalette) Deprecated
+ SCI_GETUSEPALETTE → bool Deprecated
Scintilla no longer supports palette mode. The last version to support palettes was 2.29. Any calls to these methods should be removed.

SCI_SETKEYSUNICODE(bool keysUnicode) Deprecated
- SCI_GETKEYSUNICODE Deprecated
+ SCI_GETKEYSUNICODE → bool Deprecated
On Windows, Scintilla no longer supports narrow character windows so input is always treated as Unicode.

The following are features that should be removed from calling code but are still defined to avoid breaking callers.

SCI_SETSTYLEBITS(int bits) Deprecated
- SCI_GETSTYLEBITS Deprecated
- SCI_GETSTYLEBITSNEEDED Deprecated
+ SCI_GETSTYLEBITS → int Deprecated
+ SCI_GETSTYLEBITSNEEDED → int Deprecated
INDIC0_MASK, INDIC1_MASK, INDIC2_MASK, INDICS_MASK Deprecated
Scintilla no longer supports style byte indicators. The last version to support style byte indicators was 3.4.2. Any use of these symbols should be removed and replaced with standard indicators. diff --git a/include/Scintilla.iface b/include/Scintilla.iface index 7aa00c201..de0d88142 100644 --- a/include/Scintilla.iface +++ b/include/Scintilla.iface @@ -105,7 +105,7 @@ fun void ChangeInsertion=2672(int length, string text) fun void ClearAll=2004(,) # Delete a range of text in the document. -fun void DeleteRange=2645(position pos, int deleteLength) +fun void DeleteRange=2645(position start, int lengthDelete) # Set all style bytes to 0, remove all folding information. fun void ClearDocumentStyle=2005(,) @@ -147,10 +147,10 @@ fun int GetStyledText=2015(, textrange tr) fun bool CanRedo=2016(,) # Retrieve the line number at which a particular marker is located. -fun int MarkerLineFromHandle=2017(int handle,) +fun int MarkerLineFromHandle=2017(int markerHandle,) # Delete a marker. -fun void MarkerDeleteHandle=2018(int handle,) +fun void MarkerDeleteHandle=2018(int markerHandle,) # Is undo history being collected? get bool GetUndoCollection=2019(,) @@ -179,11 +179,11 @@ fun position PositionFromPointClose=2023(int x, int y) fun void GotoLine=2024(int line,) # Set caret to a position and ensure it is visible. -fun void GotoPos=2025(position pos,) +fun void GotoPos=2025(position caret,) # Set the selection anchor to a position. The anchor is the opposite # end of the selection from the caret. -set void SetAnchor=2026(position posAnchor,) +set void SetAnchor=2026(position anchor,) # Retrieve the text of the line containing the caret. # Returns the index of the caret on the line. @@ -207,9 +207,9 @@ get int GetEOLMode=2030(,) # Set the current end of line mode. set void SetEOLMode=2031(int eolMode,) -# Set the current styling position to pos and the styling mask to mask. -# The styling mask can be used to protect some bits in each styling byte from modification. -fun void StartStyling=2032(position pos, int mask) +# Set the current styling position to start. +# The unused parameter is no longer used and should be set to 0. +fun void StartStyling=2032(position start, int unused) # Change style from current styling position for length characters to a style # and move the current styling position to after this newly styled segment. @@ -346,7 +346,7 @@ fun int MarkerPrevious=2048(int lineStart, int markerMask) fun void MarkerDefinePixmap=2049(int markerNumber, string pixmap) # Add a set of markers to a line. -fun void MarkerAddSet=2466(int line, int set) +fun void MarkerAddSet=2466(int line, int markerSet) # Set the alpha used for a marker that is drawn in the text area, not the margin. set void MarkerSetAlpha=2476(int markerNumber, int alpha) @@ -465,7 +465,7 @@ set void StyleSetSize=2055(int style, int sizePoints) set void StyleSetFont=2056(int style, string fontName) # Set a style to have its end of line filled or not. -set void StyleSetEOLFilled=2057(int style, bool filled) +set void StyleSetEOLFilled=2057(int style, bool eolFilled) # Reset the default style to its state at startup fun void StyleResetDefault=2058(,) @@ -522,12 +522,12 @@ get bool StyleGetChangeable=2492(int style,) get bool StyleGetHotSpot=2493(int style,) # Set a style to be mixed case, or to force upper or lower case. -set void StyleSetCase=2060(int style, int caseForce) +set void StyleSetCase=2060(int style, int caseVisible) val SC_FONT_SIZE_MULTIPLIER=100 # Set the size of characters of a style. Size is in points multiplied by 100. -set void StyleSetSizeFractional=2061(int style, int caseForce) +set void StyleSetSizeFractional=2061(int style, int sizeHundredthPoints) # Get the size of characters of a style in points multiplied by 100 get int StyleGetSizeFractional=2062(int style,) @@ -570,11 +570,11 @@ set void SetSelEOLFilled=2480(bool filled,) # Set the foreground colour of the caret. set void SetCaretFore=2069(colour fore,) -# When key+modifier combination km is pressed perform msg. -fun void AssignCmdKey=2070(keymod km, int msg) +# When key+modifier combination keyDefinition is pressed perform sciCommand. +fun void AssignCmdKey=2070(keymod keyDefinition, int sciCommand) -# When key+modifier combination km is pressed do nothing. -fun void ClearCmdKey=2071(keymod km,) +# When key+modifier combination keyDefinition is pressed do nothing. +fun void ClearCmdKey=2071(keymod keyDefinition,) # Drop all key mappings. fun void ClearAllCmdKeys=2072(,) @@ -636,34 +636,34 @@ val INDIC2_MASK=0x80 val INDICS_MASK=0xE0 # Set an indicator to plain, squiggle or TT. -set void IndicSetStyle=2080(int indic, int style) +set void IndicSetStyle=2080(int indicator, int indicatorStyle) # Retrieve the style of an indicator. -get int IndicGetStyle=2081(int indic,) +get int IndicGetStyle=2081(int indicator,) # Set the foreground colour of an indicator. -set void IndicSetFore=2082(int indic, colour fore) +set void IndicSetFore=2082(int indicator, colour fore) # Retrieve the foreground colour of an indicator. -get colour IndicGetFore=2083(int indic,) +get colour IndicGetFore=2083(int indicator,) # Set an indicator to draw under text or over(default). -set void IndicSetUnder=2510(int indic, bool under) +set void IndicSetUnder=2510(int indicator, bool under) # Retrieve whether indicator drawn under or over text. -get bool IndicGetUnder=2511(int indic,) +get bool IndicGetUnder=2511(int indicator,) # Set a hover indicator to plain, squiggle or TT. -set void IndicSetHoverStyle=2680(int indic, int style) +set void IndicSetHoverStyle=2680(int indicator, int indicatorStyle) # Retrieve the hover style of an indicator. -get int IndicGetHoverStyle=2681(int indic,) +get int IndicGetHoverStyle=2681(int indicator,) # Set the foreground hover colour of an indicator. -set void IndicSetHoverFore=2682(int indic, colour fore) +set void IndicSetHoverFore=2682(int indicator, colour fore) # Retrieve the foreground hover colour of an indicator. -get colour IndicGetHoverFore=2683(int indic,) +get colour IndicGetHoverFore=2683(int indicator,) val SC_INDICVALUEBIT=0x1000000 val SC_INDICVALUEMASK=0xFFFFFF @@ -672,10 +672,10 @@ enu IndicFlag=SC_INDICFLAG_ val SC_INDICFLAG_VALUEFORE=1 # Set the attributes of an indicator. -set void IndicSetFlags=2684(int indic, int flags) +set void IndicSetFlags=2684(int indicator, int flags) # Retrieve the attributes of an indicator. -get int IndicGetFlags=2685(int indic,) +get int IndicGetFlags=2685(int indicator,) # Set the foreground colour of all whitespace and whether to use this setting. fun void SetWhitespaceFore=2084(bool useSetting, colour fore) @@ -723,9 +723,9 @@ set void SetCaretLineBack=2098(colour back,) set void StyleSetChangeable=2099(int style, bool changeable) # Display a auto-completion list. -# The lenEntered parameter indicates how many characters before +# The lengthEntered parameter indicates how many characters before # the caret should be used to provide context. -fun void AutoCShow=2100(int lenEntered, string itemList) +fun void AutoCShow=2100(int lengthEntered, string itemList) # Remove the auto-completion list from the screen. fun void AutoCCancel=2101(,) @@ -750,7 +750,7 @@ set void AutoCSetSeparator=2106(int separatorCharacter,) get int AutoCGetSeparator=2107(,) # Select the item in the auto-completion list that starts with a string. -fun void AutoCSelect=2108(, string text) +fun void AutoCSelect=2108(, string select) # Should the auto-completion list be cancelled if the user backspaces to a # position before where the box was created. @@ -833,7 +833,7 @@ set void SetUseTabs=2124(bool useTabs,) get bool GetUseTabs=2125(,) # Change the indentation of a line to a number of columns. -set void SetLineIndentation=2126(int line, int indentSize) +set void SetLineIndentation=2126(int line, int indentation) # Retrieve the number of columns that a line is indented. get int GetLineIndentation=2127(int line,) @@ -845,10 +845,10 @@ get position GetLineIndentPosition=2128(int line,) get int GetColumn=2129(position pos,) # Count characters between two positions. -fun int CountCharacters=2633(int startPos, int endPos) +fun int CountCharacters=2633(position start, position end) # Show or hide the horizontal scroll bar. -set void SetHScrollBar=2130(bool show,) +set void SetHScrollBar=2130(bool visible,) # Is the horizontal scroll bar visible? get bool GetHScrollBar=2131(,) @@ -884,22 +884,22 @@ get colour GetCaretFore=2138(,) get bool GetReadOnly=2140(,) # Sets the position of the caret. -set void SetCurrentPos=2141(position pos,) +set void SetCurrentPos=2141(position caret,) # Sets the position that starts the selection - this becomes the anchor. -set void SetSelectionStart=2142(position pos,) +set void SetSelectionStart=2142(position anchor,) # Returns the position at the start of the selection. get position GetSelectionStart=2143(,) -# Sets the position that ends the selection - this becomes the currentPosition. -set void SetSelectionEnd=2144(position pos,) +# Sets the position that ends the selection - this becomes the caret. +set void SetSelectionEnd=2144(position caret,) # Returns the position at the end of the selection. get position GetSelectionEnd=2145(,) # Set caret to a position, while removing any existing selection. -fun void SetEmptySelection=2556(position pos,) +fun void SetEmptySelection=2556(position caret,) # Sets the print magnification added to the point size of each style for printing. set void SetPrintMagnification=2146(int magnification,) @@ -934,7 +934,7 @@ val SCFIND_POSIX=0x00400000 val SCFIND_CXX11REGEX=0x00800000 # Find some text in the document. -fun position FindText=2150(int flags, findtext ft) +fun position FindText=2150(int searchFlags, findtext ft) # On Windows, will draw the document into a display context such as a printer. fun position FormatRange=2151(bool draw, formatrange fr) @@ -965,7 +965,7 @@ get int GetMarginRight=2158(,) get bool GetModify=2159(,) # Select a range of text. -fun void SetSel=2160(position start, position end) +fun void SetSel=2160(position anchor, position caret) # Retrieve the selected text. # Return the length of the text. @@ -977,7 +977,7 @@ fun int GetSelText=2161(, stringresult text) fun int GetTextRange=2162(, textrange tr) # Draw the selection in normal style or with selection highlighted. -fun void HideSelection=2163(bool normal,) +fun void HideSelection=2163(bool hide,) # Retrieve the x value of the point in the window where a position is displayed. fun int PointXFromPosition=2164(, position pos) @@ -1054,7 +1054,7 @@ get int GetDirectFunction=2184(,) get int GetDirectPointer=2185(,) # Set to overtype (true) or insert mode. -set void SetOvertype=2186(bool overtype,) +set void SetOvertype=2186(bool overType,) # Returns true if overtype mode is active otherwise false is returned. get bool GetOvertype=2187(,) @@ -1067,14 +1067,14 @@ get int GetCaretWidth=2189(,) # Sets the position that starts the target which is used for updating the # document without affecting the scroll position. -set void SetTargetStart=2190(position pos,) +set void SetTargetStart=2190(position start,) # Get the position that starts the target. get position GetTargetStart=2191(,) # Sets the position that ends the target which is used for updating the # document without affecting the scroll position. -set void SetTargetEnd=2192(position pos,) +set void SetTargetEnd=2192(position end,) # Get the position that ends the target. get position GetTargetEnd=2193(,) @@ -1083,7 +1083,7 @@ get position GetTargetEnd=2193(,) fun void SetTargetRange=2686(position start, position end) # Retrieve the text in the target. -get int GetTargetText=2687(, stringresult characters) +get int GetTargetText=2687(, stringresult text) # Make the target range start and end be the same as the selection range start and end. fun void TargetFromSelection=2287(,) @@ -1110,7 +1110,7 @@ fun int ReplaceTargetRE=2195(int length, string text) fun int SearchInTarget=2197(int length, string text) # Set the search flags used by SearchInTarget. -set void SetSearchFlags=2198(int flags,) +set void SetSearchFlags=2198(int searchFlags,) # Get the search flags used by SearchInTarget. get int GetSearchFlags=2199(,) @@ -1131,7 +1131,7 @@ fun position CallTipPosStart=2203(,) set void CallTipSetPosStart=2214(int posStart,) # Highlight a segment of the definition. -fun void CallTipSetHlt=2204(int start, int end) +fun void CallTipSetHlt=2204(int highlightStart, int highlightEnd) # Set the background colour for the call tip. set void CallTipSetBack=2205(colour back,) @@ -1149,13 +1149,13 @@ set void CallTipUseStyle=2212(int tabSize,) set void CallTipSetPosition=2213(bool above,) # Find the display line of a document line taking hidden lines into account. -fun int VisibleFromDocLine=2220(int line,) +fun int VisibleFromDocLine=2220(int docLine,) # Find the document line of a display line taking hidden lines into account. -fun int DocLineFromVisible=2221(int lineDisplay,) +fun int DocLineFromVisible=2221(int displayLine,) # The number of display lines needed to wrap a document line -fun int WrapCount=2235(int line,) +fun int WrapCount=2235(int docLine,) enu FoldLevel=SC_FOLDLEVEL val SC_FOLDLEVELBASE=0x400 @@ -1292,7 +1292,7 @@ val SC_WRAP_CHAR=2 val SC_WRAP_WHITESPACE=3 # Sets whether text is word wrapped. -set void SetWrapMode=2268(int mode,) +set void SetWrapMode=2268(int wrapMode,) # Retrieve whether text is word wrapped. get int GetWrapMode=2269(,) @@ -1332,7 +1332,7 @@ val SC_WRAPINDENT_SAME=1 val SC_WRAPINDENT_INDENT=2 # Sets how wrapped sublines are placed. Default is fixed. -set void SetWrapIndentMode=2472(int mode,) +set void SetWrapIndentMode=2472(int wrapIndentMode,) # Retrieve how wrapped sublines are placed. Default is fixed. get int GetWrapIndentMode=2473(,) @@ -1344,7 +1344,7 @@ val SC_CACHE_PAGE=2 val SC_CACHE_DOCUMENT=3 # Sets the degree of caching of layout information. -set void SetLayoutCache=2272(int mode,) +set void SetLayoutCache=2272(int cacheMode,) # Retrieve the degree of caching of layout information. get int GetLayoutCache=2273(,) @@ -1379,7 +1379,7 @@ get bool GetEndAtLastLine=2278(,) fun int TextHeight=2279(int line,) # Show or hide the vertical scroll bar. -set void SetVScrollBar=2280(bool show,) +set void SetVScrollBar=2280(bool visible,) # Is the vertical scroll bar visible? get bool GetVScrollBar=2281(,) @@ -1424,7 +1424,7 @@ set void SetFontQuality=2611(int fontQuality,) get int GetFontQuality=2612(,) # Scroll so that a display line is at the top of the display. -set void SetFirstVisibleLine=2613(int lineDisplay,) +set void SetFirstVisibleLine=2613(int displayLine,) enu MultiPaste=SC_MULTIPASTE_ val SC_MULTIPASTE_ONCE=0 @@ -1647,19 +1647,20 @@ fun void MoveCaretInsideView=2401(,) fun int LineLength=2350(int line,) # Highlight the characters at two positions. -fun void BraceHighlight=2351(position pos1, position pos2) +fun void BraceHighlight=2351(position posA, position posB) # Use specified indicator to highlight matching braces instead of changing their style. -fun void BraceHighlightIndicator=2498(bool useBraceHighlightIndicator, int indicator) +fun void BraceHighlightIndicator=2498(bool useSetting, int indicator) # Highlight the character at a position indicating there is no matching brace. fun void BraceBadLight=2352(position pos,) # Use specified indicator to highlight non matching brace instead of changing its style. -fun void BraceBadLightIndicator=2499(bool useBraceBadLightIndicator, int indicator) +fun void BraceBadLightIndicator=2499(bool useSetting, int indicator) # Find the position of a matching brace or INVALID_POSITION if no match. -fun position BraceMatch=2353(position pos,) +# The maxReStyle must be 0 for now. It may be defined in a future release. +fun position BraceMatch=2353(position pos, int maxReStyle) # Are the end of line characters visible? get bool GetViewEOL=2355(,) @@ -1671,10 +1672,10 @@ set void SetViewEOL=2356(bool visible,) get int GetDocPointer=2357(,) # Change the document object used. -set void SetDocPointer=2358(, int pointer) +set void SetDocPointer=2358(, int doc) # Set which document modification events are sent to the container. -set void SetModEventMask=2359(int mask,) +set void SetModEventMask=2359(int eventMask,) enu EdgeVisualStyle=EDGE_ val EDGE_NONE=0 @@ -1694,7 +1695,7 @@ get int GetEdgeMode=2362(,) # The edge may be displayed by a line (EDGE_LINE/EDGE_MULTILINE) or by highlighting text that # goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE). -set void SetEdgeMode=2363(int mode,) +set void SetEdgeMode=2363(int edgeMode,) # Retrieve the colour used in edge indication. get colour GetEdgeColour=2364(,) @@ -1713,11 +1714,11 @@ fun void SearchAnchor=2366(,) # Find some text starting at the search anchor. # Does not ensure the selection is visible. -fun int SearchNext=2367(int flags, string text) +fun int SearchNext=2367(int searchFlags, string text) # Find some text starting at the search anchor and moving backwards. # Does not ensure the selection is visible. -fun int SearchPrev=2368(int flags, string text) +fun int SearchPrev=2368(int searchFlags, string text) # Retrieves the number of lines completely visible. get int LinesOnScreen=2370(,) @@ -1731,7 +1732,7 @@ get bool SelectionIsRectangle=2372(,) # Set the zoom level. This number of points is added to the size of all fonts. # It may be positive to magnify or negative to reduce. -set void SetZoom=2373(int zoom,) +set void SetZoom=2373(int zoomInPoints,) # Retrieve the zoom level. get int GetZoom=2374(,) @@ -1759,7 +1760,7 @@ val SC_STATUS_WARN_START=1000 val SC_STATUS_WARN_REGEX=1001 # Change error status - 0 = OK. -set void SetStatus=2382(int statusCode,) +set void SetStatus=2382(int status,) # Get error status. get int GetStatus=2383(,) @@ -1814,7 +1815,7 @@ fun void DelLineLeft=2395(,) fun void DelLineRight=2396(,) # Get and Set the xOffset (ie, horizontal scroll position). -set void SetXOffset=2397(int newOffset,) +set void SetXOffset=2397(int xOffset,) get int GetXOffset=2398(,) # Set the last x chosen value to be the caret x position. @@ -1856,7 +1857,7 @@ fun void SetXCaretPolicy=2402(int caretPolicy, int caretSlop) fun void SetYCaretPolicy=2403(int caretPolicy, int caretSlop) # Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE). -set void SetPrintWrapMode=2406(int mode,) +set void SetPrintWrapMode=2406(int wrapMode,) # Is printing line wrapped? get int GetPrintWrapMode=2407(,) @@ -1920,7 +1921,7 @@ val SC_SEL_THIN=3 # Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE/SC_SEL_THIN) or # by lines (SC_SEL_LINES). -set void SetSelectionMode=2422(int mode,) +set void SetSelectionMode=2422(int selectionMode,) # Get the mode of the current selection. get int GetSelectionMode=2423(,) @@ -2010,7 +2011,7 @@ get int AutoCGetCurrent=2445(,) # Get currently selected item text in the auto-completion list # Returns the length of the item text # Result is NUL-terminated. -get int AutoCGetCurrentText=2610(, stringresult s) +get int AutoCGetCurrentText=2610(, stringresult text) enu CaseInsensitiveBehaviour=SC_CASEINSENSITIVEBEHAVIOUR_ val SC_CASEINSENSITIVEBEHAVIOUR_RESPECTCASE=0 @@ -2120,22 +2121,22 @@ set void SetIndicatorValue=2502(int value,) get int GetIndicatorValue=2503(,) # Turn a indicator on over a range. -fun void IndicatorFillRange=2504(int position, int fillLength) +fun void IndicatorFillRange=2504(position start, int lengthFill) # Turn a indicator off over a range. -fun void IndicatorClearRange=2505(int position, int clearLength) +fun void IndicatorClearRange=2505(position start, int lengthClear) -# Are any indicators present at position? -fun int IndicatorAllOnFor=2506(int position,) +# Are any indicators present at pos? +fun int IndicatorAllOnFor=2506(position pos,) -# What value does a particular indicator have at at a position? -fun int IndicatorValueAt=2507(int indicator, int position) +# What value does a particular indicator have at a position? +fun int IndicatorValueAt=2507(int indicator, position pos) # Where does a particular indicator start? -fun int IndicatorStart=2508(int indicator, int position) +fun int IndicatorStart=2508(int indicator, position pos) # Where does a particular indicator end? -fun int IndicatorEnd=2509(int indicator, int position) +fun int IndicatorEnd=2509(int indicator, position pos) # Set number of entries in position cache set void SetPositionCache=2514(int size,) @@ -2152,8 +2153,8 @@ get int GetCharacterPointer=2520(,) # Return a read-only pointer to a range of characters in the document. # May move the gap so that the range is contiguous, but will only move up -# to rangeLength bytes. -get int GetRangePointer=2643(int position, int rangeLength) +# to lengthRange bytes. +get int GetRangePointer=2643(position start, int lengthRange) # Return a position which, to avoid performance costs, should not be within # the range of a call to GetRangePointer. @@ -2308,7 +2309,7 @@ set void SetAdditionalCaretsBlink=2567(bool additionalCaretsBlink,) get bool GetAdditionalCaretsBlink=2568(,) # Set whether additional carets are visible -set void SetAdditionalCaretsVisible=2608(bool additionalCaretsBlink,) +set void SetAdditionalCaretsVisible=2608(bool additionalCaretsVisible,) # Whether additional carets are visible get bool GetAdditionalCaretsVisible=2609(,) @@ -2323,10 +2324,10 @@ get bool GetSelectionEmpty=2650(,) fun void ClearSelections=2571(,) # Set a simple selection -fun int SetSelection=2572(int caret, int anchor) +fun int SetSelection=2572(position caret, position anchor) # Add a selection -fun int AddSelection=2573(int caret, int anchor) +fun int AddSelection=2573(position caret, position anchor) # Drop one selection fun void DropSelectionN=2671(int selection,) @@ -2338,11 +2339,11 @@ set void SetMainSelection=2574(int selection,) get int GetMainSelection=2575(,) # Set the caret position of the nth selection. -set void SetSelectionNCaret=2576(int selection, position pos) +set void SetSelectionNCaret=2576(int selection, position caret) # Return the caret position of the nth selection. get position GetSelectionNCaret=2577(int selection,) # Set the anchor position of the nth selection. -set void SetSelectionNAnchor=2578(int selection, position posAnchor) +set void SetSelectionNAnchor=2578(int selection, position anchor) # Return the anchor position of the nth selection. get position GetSelectionNAnchor=2579(int selection,) # Set the virtual space of the caret of the nth selection. @@ -2355,23 +2356,23 @@ set void SetSelectionNAnchorVirtualSpace=2582(int selection, int space) get int GetSelectionNAnchorVirtualSpace=2583(int selection,) # Sets the position that starts the selection - this becomes the anchor. -set void SetSelectionNStart=2584(int selection, position pos) +set void SetSelectionNStart=2584(int selection, position anchor) # Returns the position at the start of the selection. get position GetSelectionNStart=2585(int selection,) # Sets the position that ends the selection - this becomes the currentPosition. -set void SetSelectionNEnd=2586(int selection, position pos) +set void SetSelectionNEnd=2586(int selection, position caret) # Returns the position at the end of the selection. get position GetSelectionNEnd=2587(int selection,) # Set the caret position of the rectangular selection. -set void SetRectangularSelectionCaret=2588(position pos,) +set void SetRectangularSelectionCaret=2588(position caret,) # Return the caret position of the rectangular selection. get position GetRectangularSelectionCaret=2589(,) # Set the anchor position of the rectangular selection. -set void SetRectangularSelectionAnchor=2590(position posAnchor,) +set void SetRectangularSelectionAnchor=2590(position anchor,) # Return the anchor position of the rectangular selection. get position GetRectangularSelectionAnchor=2591(,) # Set the virtual space of the caret of the rectangular selection. @@ -2568,7 +2569,7 @@ set void SetProperty=4004(string key, string value) val KEYWORDSET_MAX=8 # Set up the key words used by the lexer. -set void SetKeyWords=4005(int keywordSet, string keyWords) +set void SetKeyWords=4005(int keyWordSet, string keyWords) # Set the lexing language of the document based on string name. set void SetLexerLanguage=4006(, string language) @@ -2578,16 +2579,16 @@ fun void LoadLexerLibrary=4007(, string path) # Retrieve a "property" value previously set with SetProperty. # Result is NUL-terminated. -get int GetProperty=4008(string key, stringresult buf) +get int GetProperty=4008(string key, stringresult value) # Retrieve a "property" value previously set with SetProperty, # with "$()" variable replacement on returned buffer. # Result is NUL-terminated. -get int GetPropertyExpanded=4009(string key, stringresult buf) +get int GetPropertyExpanded=4009(string key, stringresult value) # Retrieve a "property" value previously set with SetProperty, # interpreted as an int AFTER any "$()" variable replacement. -get int GetPropertyInt=4010(string key,) +get int GetPropertyInt=4010(string key, int defaultValue) # Retrieve the number of bits the current lexer needs for styling. get int GetStyleBitsNeeded=4011(,) @@ -2595,7 +2596,7 @@ get int GetStyleBitsNeeded=4011(,) # Retrieve the name of the lexer. # Return the length of the text. # Result is NUL-terminated. -get int GetLexerLanguage=4012(, stringresult text) +get int GetLexerLanguage=4012(, stringresult language) # For private communication between an application and a known lexer. fun int PrivateLexerCall=4013(int operation, int pointer) -- cgit v1.2.3