From aa32bc4b3a402b068e48db4d387ba62eeaefee90 Mon Sep 17 00:00:00 2001 From: Neil Date: Tue, 18 Jun 2019 10:08:28 +1000 Subject: Feature [feature-requests:#1297] 2: Use position and line more in documentation. --- doc/ScintillaDoc.html | 654 ++++++++++++++++++++++++++------------------------ 1 file changed, 334 insertions(+), 320 deletions(-) (limited to 'doc/ScintillaDoc.html') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 8c01e866a..fc7ebe424 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -119,7 +119,7 @@

Scintilla Documentation

-

Last edited 6 June 2018 NH

+

Last edited 18 June 2019 NH

There is an overview of the internal design of Scintilla.
@@ -194,6 +194,20 @@ Equivalent to intptr_t. + + position + + Positions and lengths in document. + Equivalent to intptr_t. + + + + line + + A line number in the document. + Equivalent to intptr_t. + + const char * @@ -439,35 +453,35 @@ 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) → int
+ SCI_GETTEXT(position length, char *text) → position
SCI_SETTEXT(<unused>, const char *text)
SCI_SETSAVEPOINT
- SCI_GETLINE(int line, char *text) → int
+ SCI_GETLINE(line line, char *text) → position
SCI_REPLACESEL(<unused>, const char *text)
SCI_SETREADONLY(bool readOnly)
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_GETTEXTRANGE(<unused>, Sci_TextRange *tr) → position
+ SCI_ALLOCATE(position bytes)
+ SCI_ADDTEXT(position length, const char *text)
+ SCI_ADDSTYLEDTEXT(position length, cell *c)
+ SCI_APPENDTEXT(position length, const char *text)
+ SCI_INSERTTEXT(position pos, const char *text)
+ SCI_CHANGEINSERTION(position length, const char *text)
SCI_CLEARALL
- SCI_DELETERANGE(int start, int lengthDelete)
+ SCI_DELETERANGE(position start, position lengthDelete)
SCI_CLEARDOCUMENTSTYLE
- SCI_GETCHARAT(int pos) → int
- SCI_GETSTYLEAT(int pos) → int
- SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr) → int
+ SCI_GETCHARAT(position pos) → int
+ SCI_GETSTYLEAT(position pos) → int
+ SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr) → position
SCI_RELEASEALLEXTENDEDSTYLES
SCI_ALLOCATEEXTENDEDSTYLES(int numberStyles) → int
- SCI_TARGETASUTF8(<unused>, char *s) → int
- SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → int
- SCI_SETLENGTHFORENCODE(int bytes)
+ SCI_TARGETASUTF8(<unused>, char *s) → position
+ SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → position
+ SCI_SETLENGTHFORENCODE(position bytes)
 -

SCI_GETTEXT(int length, char *text NUL-terminated) → int
+

SCI_GETTEXT(position length, char *text NUL-terminated) → position
This returns at most length-1 characters of text from the start of the document plus one terminating 0 character. When length-1 is beyond document length, it returns document length. To collect all the text in a document, use SCI_GETLENGTH @@ -501,11 +515,11 @@

See also: SCI_EMPTYUNDOBUFFER, SCI_GETMODIFY

-

SCI_GETLINE(int line, char *text) → int
+

SCI_GETLINE(line line, char *text) → position
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 SCI_LINELENGTH(int line). The returned value is the + href="#SCI_LINELENGTH">SCI_LINELENGTH(line line). The returned value is the number of characters copied to the buffer. The returned text includes any end of line characters. If you ask for a line number outside the range of lines in the document, 0 characters are copied. If the text argument is 0 then the length that should be allocated @@ -529,7 +543,7 @@ only, attempts to modify the text cause the SCN_MODIFYATTEMPTRO notification.

-

SCI_GETTEXTRANGE(<unused>, Sci_TextRange *tr) → int
+

SCI_GETTEXTRANGE(<unused>, Sci_TextRange *tr) → position
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 @@ -543,7 +557,7 @@ SCI_GETSTYLEDTEXT, SCI_GETTEXT

-

SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr) → int
+

SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr) → position
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 @@ -559,40 +573,40 @@ SCI_GETTEXTRANGE, SCI_GETTEXT

-

SCI_ALLOCATE(int bytes)
+

SCI_ALLOCATE(position 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 *text)
+

SCI_ADDTEXT(position 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 *c)
+

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

-

SCI_APPENDTEXT(int length, const char *text)
+

SCI_APPENDTEXT(position 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)
+

SCI_INSERTTEXT(position 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 then it is moved along with its surrounding text but no scrolling is performed.

-

SCI_CHANGEINSERTION(int length, const char *text)
+

SCI_CHANGEINSERTION(position length, const char *text)
This may only be called from a SC_MOD_INSERTCHECK notification handler and will change the text being inserted to that provided.

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

-

SCI_DELETERANGE(int start, int lengthDelete)
+

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

SCI_CLEARDOCUMENTSTYLE
@@ -600,11 +614,11 @@ SCI_CLEARDOCUMENTSTYLE can be used to clear all styling information and reset the folding state.

-

SCI_GETCHARAT(int pos) → int
+

SCI_GETCHARAT(position 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) → int
+

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

@@ -642,7 +656,7 @@ struct Sci_TextRange {

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

-

SCI_TARGETASUTF8(<unused>, char *s) → int
+

SCI_TARGETASUTF8(<unused>, char *s) → position
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. @@ -650,8 +664,8 @@ struct Sci_TextRange { more complex work of transcoding from the various encodings supported.

-

SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → int
- SCI_SETLENGTHFORENCODE(int bytes)
+

SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → position
+ SCI_SETLENGTHFORENCODE(position 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 a string of bytes that can be searched for in the document. Since the text can contain nul bytes, @@ -689,27 +703,27 @@ 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 start)
+ SCI_SETTARGETSTART(position start)
SCI_GETTARGETSTART → position
- SCI_SETTARGETEND(int end)
+ SCI_SETTARGETEND(position end)
SCI_GETTARGETEND → position
- SCI_SETTARGETRANGE(int start, int end)
+ SCI_SETTARGETRANGE(position start, position end)
SCI_TARGETFROMSELECTION
SCI_TARGETWHOLEDOCUMENT
SCI_SETSEARCHFLAGS(int searchFlags)
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_SEARCHINTARGET(position length, const char *text) → position
+ SCI_GETTARGETTEXT(<unused>, char *text) → position
+ SCI_REPLACETARGET(position length, const char *text) → position
+ SCI_REPLACETARGETRE(position length, const char *text) → position
SCI_GETTAG(int tagNumber, char *tagValue) → int
 -

SCI_SETTARGETSTART(int start)
+

SCI_SETTARGETSTART(position start)
SCI_GETTARGETSTART → position
- SCI_SETTARGETEND(int end)
+ SCI_SETTARGETEND(position end)
SCI_GETTARGETEND → position
- SCI_SETTARGETRANGE(int start, int end)
+ SCI_SETTARGETRANGE(position start, position 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 target rather than the first matching text. The target is also set by a successful @@ -727,7 +741,7 @@ struct Sci_TextRange { SCI_SEARCHINTARGET. There are several option flags including a simple regular expression search.

-

SCI_SEARCHINTARGET(int length, const char *text) → int
+

SCI_SEARCHINTARGET(position length, const char *text) → position
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 @@ -735,10 +749,10 @@ struct Sci_TextRange { 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) → int
+

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

-

SCI_REPLACETARGET(int length, const char *text) → int
+

SCI_REPLACETARGET(position length, const char *text) → position
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. @@ -747,7 +761,7 @@ struct Sci_TextRange { 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) → int
+

SCI_REPLACETARGETRE(position length, const char *text) → position
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 @@ -917,8 +931,8 @@ struct Sci_TextRange { SCI_FINDTEXT(int searchFlags, Sci_TextToFind *ft) → position
SCI_SEARCHANCHOR
- SCI_SEARCHNEXT(int searchFlags, const char *text) → int
- SCI_SEARCHPREV(int searchFlags, const char *text) → int
+ SCI_SEARCHNEXT(int searchFlags, const char *text) → position
+ SCI_SEARCHPREV(int searchFlags, const char *text) → position

SCI_FINDTEXT(int searchFlags, Sci_TextToFind *ft) → position
@@ -957,8 +971,8 @@ struct Sci_TextToFind {

SCI_SEARCHANCHOR
- SCI_SEARCHNEXT(int searchFlags, const char *text) → int
- SCI_SEARCHPREV(int searchFlags, const char *text) → int
+ SCI_SEARCHNEXT(int searchFlags, const char *text) → position
+ SCI_SEARCHPREV(int searchFlags, const char *text) → position
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_PASTE
SCI_CLEAR
SCI_CANPASTE → bool
- SCI_COPYRANGE(int start, int end)
- SCI_COPYTEXT(int length, const char *text)
+ SCI_COPYRANGE(position start, position end)
+ SCI_COPYTEXT(position length, const char *text)
SCI_COPYALLOWLINE
SCI_SETPASTECONVERTENDINGS(bool convert)
SCI_GETPASTECONVERTENDINGS → bool
@@ -1035,8 +1049,8 @@ struct Sci_TextToFind { is added to the clipboard which is then used in SCI_PASTE to paste the whole line before the current line.

- SCI_COPYRANGE(int start, int end)
- SCI_COPYTEXT(int length, const char *text)
+ SCI_COPYRANGE(position start, position end)
+ SCI_COPYTEXT(position length, const char *text)

SCI_COPYRANGE copies a range of text from the document to the system clipboard and SCI_COPYTEXT copies a supplied piece of text to the system clipboard.

@@ -1191,50 +1205,50 @@ 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 → int
- SCI_GETLENGTH → int
- SCI_GETLINECOUNT → int
- SCI_LINESONSCREEN → int
+ SCI_GETTEXTLENGTH → position
+ SCI_GETLENGTH → position
+ SCI_GETLINECOUNT → line
+ SCI_LINESONSCREEN → line
SCI_GETMODIFY → bool
- SCI_SETSEL(int anchor, int caret)
- SCI_GOTOPOS(int caret)
- SCI_GOTOLINE(int line)
- SCI_SETCURRENTPOS(int caret)
+ SCI_SETSEL(position anchor, position caret)
+ SCI_GOTOPOS(position caret)
+ SCI_GOTOLINE(line line)
+ SCI_SETCURRENTPOS(position caret)
SCI_GETCURRENTPOS → position
- SCI_SETANCHOR(int anchor)
+ SCI_SETANCHOR(position anchor)
SCI_GETANCHOR → position
- SCI_SETSELECTIONSTART(int anchor)
+ SCI_SETSELECTIONSTART(position anchor)
SCI_GETSELECTIONSTART → position
- SCI_SETSELECTIONEND(int caret)
+ SCI_SETSELECTIONEND(position caret)
SCI_GETSELECTIONEND → position
- SCI_SETEMPTYSELECTION(int caret)
+ SCI_SETEMPTYSELECTION(position caret)
SCI_SELECTALL
- 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_LINEFROMPOSITION(position pos) → line
+ SCI_POSITIONFROMLINE(line line) → position
+ SCI_GETLINEENDPOSITION(line line) → position
+ SCI_LINELENGTH(line line) → position
+ SCI_GETCOLUMN(position pos) → position
+ SCI_FINDCOLUMN(line line, position column) → position
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_POINTXFROMPOSITION(<unused>, position pos) → int
+ SCI_POINTYFROMPOSITION(<unused>, position pos) → int
SCI_HIDESELECTION(bool hide)
- SCI_GETSELTEXT(<unused>, char *text) → int
- SCI_GETCURLINE(int length, char *text) → int
+ SCI_GETSELTEXT(<unused>, char *text) → position
+ SCI_GETCURLINE(position length, char *text) → position
SCI_SELECTIONISRECTANGLE → bool
SCI_SETSELECTIONMODE(int selectionMode)
SCI_GETSELECTIONMODE → int
SCI_GETMOVEEXTENDSSELECTION → bool
- SCI_GETLINESELSTARTPOSITION(int line) → position
- SCI_GETLINESELENDPOSITION(int line) → position
+ SCI_GETLINESELSTARTPOSITION(line line) → position
+ SCI_GETLINESELENDPOSITION(line line) → position
SCI_MOVECARETINSIDEVIEW
- SCI_POSITIONBEFORE(int pos) → position
- SCI_POSITIONAFTER(int pos) → position
+ SCI_POSITIONBEFORE(position pos) → position
+ SCI_POSITIONAFTER(position pos) → position
SCI_TEXTWIDTH(int style, const char *text) → int
- SCI_TEXTHEIGHT(int line) → int
+ SCI_TEXTHEIGHT(line line) → int
SCI_CHOOSECARETX
SCI_MOVESELECTEDLINESUP
SCI_MOVESELECTEDLINESDOWN
@@ -1242,15 +1256,15 @@ struct Sci_TextToFind { SCI_GETMOUSESELECTIONRECTANGULARSWITCH → bool
 -

SCI_GETTEXTLENGTH → int
- SCI_GETLENGTH → int
+

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

-

SCI_GETLINECOUNT → int
+

SCI_GETLINECOUNT → line
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 → int
+

SCI_LINESONSCREEN → line
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 @@ -1268,25 +1282,25 @@ struct Sci_TextToFind { href="#SCN_SAVEPOINTLEFT">SCN_SAVEPOINTLEFT notification messages.

-

SCI_SETSEL(int anchor, int caret)
+

SCI_SETSEL(position anchor, position 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 caret)
+

SCI_GOTOPOS(position 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(caret, caret). The anchor position is set the same as the current position.

-

SCI_GOTOLINE(int line)
+

SCI_GOTOLINE(line 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), the line set is the first or last.

-

SCI_SETCURRENTPOS(int caret)
+

SCI_SETCURRENTPOS(position caret)
This sets the current position and creates a selection between the anchor and the current position. The caret is not scrolled into view.

@@ -1295,7 +1309,7 @@ struct Sci_TextToFind {

SCI_GETCURRENTPOS → position
This returns the current position.

-

SCI_SETANCHOR(int anchor)
+

SCI_SETANCHOR(position 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.

@@ -1304,8 +1318,8 @@ struct Sci_TextToFind {

SCI_GETANCHOR → position
This returns the current anchor position.

-

SCI_SETSELECTIONSTART(int anchor)
- SCI_SETSELECTIONEND(int caret)
+

SCI_SETSELECTIONSTART(position anchor)
+ SCI_SETSELECTIONEND(position 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.

@@ -1351,38 +1365,38 @@ struct Sci_TextToFind { current position or the anchor position. SCI_GETSELECTIONEND returns the larger of the two values.

-

SCI_SETEMPTYSELECTION(int caret)
+

SCI_SETEMPTYSELECTION(position 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) → int
+

SCI_LINEFROMPOSITION(position pos) → line
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) → position
+

SCI_POSITIONFROMLINE(line 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 last line), the return value is the end of the document.

-

SCI_GETLINEENDPOSITION(int line) → position
+

SCI_GETLINEENDPOSITION(line 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.

-

SCI_LINELENGTH(int line) → int
+

SCI_LINELENGTH(line line) → position
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) → int
+

SCI_GETSELTEXT(<unused>, char *text NUL-terminated) → position
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). @@ -1397,7 +1411,7 @@ struct Sci_TextToFind { SCI_GETTEXTRANGE

-

SCI_GETCURLINE(int length, char *text NUL-terminated) → int
+

SCI_GETCURLINE(position length, char *text NUL-terminated) → position
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. @@ -1433,8 +1447,8 @@ struct Sci_TextToFind { This returns 1 if regular caret moves will extend or reduce the selection, 0 if not. SCI_SETSELECTIONMODE toggles this setting between on and off.

-

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

SCI_GETLINESELSTARTPOSITION(line line) → position
+ SCI_GETLINESELENDPOSITION(line 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.

@@ -1442,8 +1456,8 @@ 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 pos) → position
- SCI_POSITIONAFTER(int pos) → position
+

SCI_POSITIONBEFORE(position pos) → position
+ SCI_POSITIONAFTER(position 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. @@ -1455,11 +1469,11 @@ struct Sci_TextToFind { 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) → int
+

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

-

SCI_GETCOLUMN(int pos) → int
+

SCI_GETCOLUMN(position pos) → position
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 @@ -1467,7 +1481,7 @@ struct Sci_TextToFind { 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) → int
+

SCI_FINDCOLUMN(line line, position column) → position
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.

@@ -1485,8 +1499,8 @@ struct Sci_TextToFind { 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) → int
- SCI_POINTYFROMPOSITION(<unused>, int pos) → int
+

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

@@ -1529,28 +1543,28 @@ struct Sci_TextToFind { but this may be sped up in some cases by indexing the line starts by character or code unit.

- SCI_POSITIONRELATIVE(int pos, int relative) → position
- SCI_POSITIONRELATIVECODEUNITS(int pos, int relative) → position
- SCI_COUNTCHARACTERS(int start, int end) → int
- SCI_COUNTCODEUNITS(int start, int end) → int
+ SCI_POSITIONRELATIVE(position pos, position relative) → position
+ SCI_POSITIONRELATIVECODEUNITS(position pos, position relative) → position
+ SCI_COUNTCHARACTERS(position start, position end) → position
+ SCI_COUNTCODEUNITS(position start, position end) → position
SCI_GETLINECHARACTERINDEX → int
SCI_ALLOCATELINECHARACTERINDEX(int lineCharacterIndex)
SCI_RELEASELINECHARACTERINDEX(int lineCharacterIndex)
- SCI_LINEFROMINDEXPOSITION(int pos, int lineCharacterIndex) → int
- SCI_INDEXPOSITIONFROMLINE(int line, int lineCharacterIndex) → position
+ SCI_LINEFROMINDEXPOSITION(position pos, int lineCharacterIndex) → line
+ SCI_INDEXPOSITIONFROMLINE(line line, int lineCharacterIndex) → position
 -

SCI_POSITIONRELATIVE(int pos, int relative) → position
+

SCI_POSITIONRELATIVE(position pos, position 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 start, int end) → int
+

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

-

SCI_POSITIONRELATIVECODEUNITS(int pos, int relative) → position
- SCI_COUNTCODEUNITS(int start, int end) → int
+

SCI_POSITIONRELATIVECODEUNITS(position pos, position relative) → position
+ SCI_COUNTCODEUNITS(position start, position end) → position
These are the UTF-16 versions of SCI_POSITIONRELATIVE and SCI_COUNTCHARACTERS working in terms of UTF-16 code units.

@@ -1568,8 +1582,8 @@ struct Sci_TextToFind { Scintilla may also allocate indexes to support features like accessibility or input method editors. Only one index of each type is created for a document at a time.

-

SCI_LINEFROMINDEXPOSITION(int pos, int lineCharacterIndex) → int
- SCI_INDEXPOSITIONFROMLINE(int line, int lineCharacterIndex) → position
+

SCI_LINEFROMINDEXPOSITION(position pos, int lineCharacterIndex) → line
+ SCI_INDEXPOSITIONFROMLINE(line line, int lineCharacterIndex) → position
The document line of a particular character or code unit may be found by calling SCI_LINEFROMINDEXPOSITION with one of SC_LINECHARACTERINDEX_UTF32(1) or SC_LINECHARACTERINDEX_UTF16(2). The inverse action, finds the starting position of a document line either in characters or code units from the document start by calling @@ -1593,35 +1607,35 @@ struct Sci_TextToFind { SCI_GETSELECTIONS → int
SCI_GETSELECTIONEMPTY → bool
SCI_CLEARSELECTIONS
- SCI_SETSELECTION(int caret, int anchor)
- SCI_ADDSELECTION(int caret, int anchor)
+ SCI_SETSELECTION(position caret, position anchor)
+ SCI_ADDSELECTION(position caret, position anchor)
SCI_DROPSELECTIONN(int selection)
SCI_SETMAINSELECTION(int selection)
SCI_GETMAINSELECTION → int

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

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

SCI_SETADDITIONALSELALPHA(alpha alpha)
@@ -1724,11 +1738,11 @@ struct Sci_TextToFind { Set a single empty selection at 0 as the only selection.

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

- SCI_ADDSELECTION(int caret, int anchor)
+ SCI_ADDSELECTION(position caret, position anchor)
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 @@ -1748,33 +1762,33 @@ struct Sci_TextToFind { Only an already existing selection can be made main.

- SCI_SETSELECTIONNCARET(int selection, int caret)
+ SCI_SETSELECTIONNCARET(int selection, position caret)
SCI_GETSELECTIONNCARET(int selection) → position
- SCI_SETSELECTIONNCARETVIRTUALSPACE(int selection, int space)
- SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection) → int
- SCI_SETSELECTIONNANCHOR(int selection, int anchor)
+ SCI_SETSELECTIONNCARETVIRTUALSPACE(int selection, position space)
+ SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection) → position
+ SCI_SETSELECTIONNANCHOR(int selection, position anchor)
SCI_GETSELECTIONNANCHOR(int selection) → position
- SCI_SETSELECTIONNANCHORVIRTUALSPACE(int selection, int space)
- SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection) → int
+ SCI_SETSELECTIONNANCHORVIRTUALSPACE(int selection, position space)
+ SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection) → position
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 anchor)
+ SCI_SETSELECTIONNSTART(int selection, position anchor)
SCI_GETSELECTIONNSTART(int selection) → position
- SCI_SETSELECTIONNEND(int selection, int caret)
+ SCI_SETSELECTIONNEND(int selection, position 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 caret)
+ SCI_SETRECTANGULARSELECTIONCARET(position caret)
SCI_GETRECTANGULARSELECTIONCARET → position
- SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE(int space)
- SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE → int
- SCI_SETRECTANGULARSELECTIONANCHOR(int anchor)
+ SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE(position space)
+ SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE → position
+ SCI_SETRECTANGULARSELECTIONANCHOR(position anchor)
SCI_GETRECTANGULARSELECTIONANCHOR → position
- SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE(int space)
- SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → int
+ SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE(position space)
+ SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → position
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.

@@ -1830,13 +1844,13 @@ struct Sci_TextToFind {

Scrolling and automatic scrolling

- SCI_SETFIRSTVISIBLELINE(int displayLine)
- SCI_GETFIRSTVISIBLELINE → int
+ SCI_SETFIRSTVISIBLELINE(line displayLine)
+ SCI_GETFIRSTVISIBLELINE → line
SCI_SETXOFFSET(int xOffset)
SCI_GETXOFFSET → int
- SCI_LINESCROLL(int columns, int lines)
+ SCI_LINESCROLL(int columns, line lines)
SCI_SCROLLCARET
- SCI_SCROLLRANGE(int secondary, int primary)
+ SCI_SCROLLRANGE(position secondary, position primary)
SCI_SETXCARETPOLICY(int caretPolicy, int caretSlop)
SCI_SETYCARETPOLICY(int caretPolicy, int @@ -1856,8 +1870,8 @@ struct Sci_TextToFind { SCI_GETENDATLASTLINE → bool
 -

SCI_SETFIRSTVISIBLELINE(int displayLine)
- SCI_GETFIRSTVISIBLELINE → int
+

SCI_SETFIRSTVISIBLELINE(line displayLine)
+ SCI_GETFIRSTVISIBLELINE → line
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.

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

-

SCI_LINESCROLL(int columns, int lines)
+

SCI_LINESCROLL(int columns, line 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.

@@ -1882,7 +1896,7 @@ struct Sci_TextToFind { If the current position (this is the caret if there is no selection) is not visible, the view is scrolled to make it visible according to the current caret policy.

-

SCI_SCROLLRANGE(int secondary, int primary)
+

SCI_SCROLLRANGE(position secondary, position primary)
Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position. The behaviour is similar to SCI_SCROLLCARET @@ -2459,9 +2473,9 @@ struct Sci_TextToFind { SCI_WORDPARTRIGHTEXTEND.

- SCI_WORDENDPOSITION(int pos, bool onlyWordCharacters) → int
- SCI_WORDSTARTPOSITION(int pos, bool onlyWordCharacters) → int
- SCI_ISRANGEWORD(int start, int end) → bool
+ SCI_WORDENDPOSITION(position pos, bool onlyWordCharacters) → position
+ SCI_WORDSTARTPOSITION(position pos, bool onlyWordCharacters) → position
+ SCI_ISRANGEWORD(position start, position end) → bool
SCI_SETWORDCHARS(<unused>, const char *characters)
SCI_GETWORDCHARS(<unused>, char *characters) → int
@@ -2473,19 +2487,19 @@ struct Sci_TextToFind { SCI_SETCHARACTERCATEGORYOPTIMIZATION(int countCharacters)
SCI_GETCHARACTERCATEGORYOPTIMIZATION → int
-

SCI_WORDENDPOSITION(int pos, bool onlyWordCharacters) → int
- SCI_WORDSTARTPOSITION(int pos, bool onlyWordCharacters) → int
+

SCI_WORDENDPOSITION(position pos, bool onlyWordCharacters) → position
+ SCI_WORDSTARTPOSITION(position pos, bool onlyWordCharacters) → position
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) → bool
+

SCI_ISRANGEWORD(position start, position 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) → bool
+ SCI_ISRANGEWORD(position start, position end) → bool

Set onlyWordCharacters to true (1) to stop searching at the first non-word character in the search direction. If onlyWordCharacters is @@ -2640,14 +2654,14 @@ struct Sci_TextToFind { use the styling commands to mark errors detected by a compiler. The following commands can be used.

SCI_GETENDSTYLED → position
- SCI_STARTSTYLING(int start, int unused)
- SCI_SETSTYLING(int length, int style)
- SCI_SETSTYLINGEX(int length, const char + SCI_STARTSTYLING(position start, int unused)
+ SCI_SETSTYLING(position length, int style)
+ SCI_SETSTYLINGEX(position length, const char *styles)
SCI_SETIDLESTYLING(int idleStyling)
SCI_GETIDLESTYLING → int
- SCI_SETLINESTATE(int line, int state)
- SCI_GETLINESTATE(int line) → int
+ SCI_SETLINESTATE(line line, int state)
+ SCI_GETLINESTATE(line line) → int
SCI_GETMAXLINESTATE → int
 @@ -2660,20 +2674,20 @@ 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 start, int unused)
+

SCI_STARTSTYLING(position 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)
+

SCI_SETSTYLING(position 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. SCI_STARTSTYLING should be called before the first call to this.

-

SCI_SETSTYLINGEX(int length, const char *styles)
+

SCI_SETSTYLINGEX(position 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 @@ -2698,8 +2712,8 @@ struct Sci_TextToFind { the document is displayed wrapped.

-

SCI_SETLINESTATE(int line, int state)
- SCI_GETLINESTATE(int line) → int
+

SCI_SETLINESTATE(line line, int state)
+ SCI_GETLINESTATE(line 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 @@ -3385,12 +3399,12 @@ struct Sci_TextToFind { 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) → int
- SCI_MARGINSETSTYLES(int line, const char *styles)
- SCI_MARGINGETSTYLES(int line, char *styles) → int
+ SCI_MARGINSETTEXT(line line, const char *text)
+ SCI_MARGINGETTEXT(line line, char *text) → int
+ SCI_MARGINSETSTYLE(line line, int style)
+ SCI_MARGINGETSTYLE(line line) → int
+ SCI_MARGINSETSTYLES(line line, const char *styles)
+ SCI_MARGINGETSTYLES(line line, char *styles) → int
SCI_MARGINTEXTCLEARALL
SCI_MARGINSETSTYLEOFFSET(int style)
SCI_MARGINGETSTYLEOFFSET → int
@@ -3488,12 +3502,12 @@ struct Sci_TextToFind { colour to ::GetSysColor(COLOR_3DHIGHLIGHT).

- SCI_MARGINSETTEXT(int line, const char *text)
- SCI_MARGINGETTEXT(int line, char *text) → int
- SCI_MARGINSETSTYLE(int line, int style)
- SCI_MARGINGETSTYLE(int line) → int
- SCI_MARGINSETSTYLES(int line, const char *styles)
- SCI_MARGINGETSTYLES(int line, char *styles) → int
+ SCI_MARGINSETTEXT(line line, const char *text)
+ SCI_MARGINGETTEXT(line line, char *text) → int
+ SCI_MARGINSETSTYLE(line line, int style)
+ SCI_MARGINGETSTYLE(line line) → int
+ SCI_MARGINSETSTYLES(line line, const char *styles)
+ SCI_MARGINGETSTYLES(line 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. @@ -3543,13 +3557,13 @@ struct Sci_TextToFind {

Annotations used for inline diagnostics

- SCI_ANNOTATIONSETTEXT(int line, const char *text)
- SCI_ANNOTATIONGETTEXT(int line, char *text) → int
- SCI_ANNOTATIONSETSTYLE(int line, int style)
- 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_ANNOTATIONSETTEXT(line line, const char *text)
+ SCI_ANNOTATIONGETTEXT(line line, char *text) → int
+ SCI_ANNOTATIONSETSTYLE(line line, int style)
+ SCI_ANNOTATIONGETSTYLE(line line) → int
+ SCI_ANNOTATIONSETSTYLES(line line, const char *styles)
+ SCI_ANNOTATIONGETSTYLES(line line, char *styles) → int
+ SCI_ANNOTATIONGETLINES(line line) → int
SCI_ANNOTATIONCLEARALL
SCI_ANNOTATIONSETVISIBLE(int visible)
SCI_ANNOTATIONGETVISIBLE → int
@@ -3558,13 +3572,13 @@ struct Sci_TextToFind {

- SCI_ANNOTATIONSETTEXT(int line, const char *text)
- SCI_ANNOTATIONGETTEXT(int line, char *text) → int
- SCI_ANNOTATIONSETSTYLE(int line, int style)
- 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_ANNOTATIONSETTEXT(line line, const char *text)
+ SCI_ANNOTATIONGETTEXT(line line, char *text) → int
+ SCI_ANNOTATIONSETSTYLE(line line, int style)
+ SCI_ANNOTATIONGETSTYLE(line line) → int
+ SCI_ANNOTATIONSETSTYLES(line line, const char *styles)
+ SCI_ANNOTATIONGETSTYLES(line line, char *styles) → int
+ SCI_ANNOTATIONGETLINES(line 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. @@ -3822,15 +3836,15 @@ struct Sci_TextToFind { but with the need to indicate that Scintilla has the logical focus.

Brace highlighting

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

SCI_BRACEHIGHLIGHT(int posA, int posB)
+

SCI_BRACEHIGHLIGHT(position posA, position 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 @@ -3838,7 +3852,7 @@ struct Sci_TextToFind { href="#SCI_GETCOLUMN">SCI_GETCOLUMN and highlight the indent with SCI_SETHIGHLIGHTGUIDE.

-

SCI_BRACEBADLIGHT(int pos)
+

SCI_BRACEBADLIGHT(position 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 @@ -3850,7 +3864,7 @@ struct Sci_TextToFind {

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) → position
+

SCI_BRACEMATCH(position 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 '(', ')', '[', ']', '{', '}', '<', and '>'. The search is forwards from an opening brace and backwards @@ -3881,9 +3895,9 @@ struct Sci_TextToFind { you to generate code.

SCI_SETTABWIDTH(int tabWidth)
SCI_GETTABWIDTH → int
- SCI_CLEARTABSTOPS(int line)
- SCI_ADDTABSTOP(int line, int x)
- SCI_GETNEXTTABSTOP(int line, int x) → int
+ SCI_CLEARTABSTOPS(line line)
+ SCI_ADDTABSTOP(line line, int x)
+ SCI_GETNEXTTABSTOP(line line, int x) → int
SCI_SETUSETABS(bool useTabs)
SCI_GETUSETABS → bool
SCI_SETINDENT(int indentSize)
@@ -3893,14 +3907,14 @@ struct Sci_TextToFind { SCI_SETBACKSPACEUNINDENTS(bool bsUnIndents)
SCI_GETBACKSPACEUNINDENTS → bool
- SCI_SETLINEINDENTATION(int line, int + SCI_SETLINEINDENTATION(line line, int indentation)
- SCI_GETLINEINDENTATION(int line) → int
- SCI_GETLINEINDENTPOSITION(int line) → position
+ SCI_GETLINEINDENTATION(line line) → int
+ SCI_GETLINEINDENTPOSITION(line line) → position
SCI_SETINDENTATIONGUIDES(int indentView)
SCI_GETINDENTATIONGUIDES → int
- SCI_SETHIGHLIGHTGUIDE(int column)
- SCI_GETHIGHLIGHTGUIDE → int
+ SCI_SETHIGHLIGHTGUIDE(position column)
+ SCI_GETHIGHLIGHTGUIDE → position

SCI_SETTABWIDTH(int tabWidth)
@@ -3909,9 +3923,9 @@ struct Sci_TextToFind { 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) → int
+

SCI_CLEARTABSTOPS(line line)
+ SCI_ADDTABSTOP(line line, int x)
+ SCI_GETNEXTTABSTOP(line 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, @@ -3944,13 +3958,13 @@ struct Sci_TextToFind { unindent rather than insert a tab character or delete a character with the SCI_SETTABINDENTS and SCI_SETBACKSPACEUNINDENTS functions.

-

SCI_SETLINEINDENTATION(int line, int indentation)
- SCI_GETLINEINDENTATION(int line) → int
+

SCI_SETLINEINDENTATION(line line, int indentation)
+ SCI_GETLINEINDENTATION(line 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) → position
+

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

SCI_SETINDENTATIONGUIDES(int indentView)
@@ -3994,8 +4008,8 @@ struct Sci_TextToFind { -

SCI_SETHIGHLIGHTGUIDE(int column)
- SCI_GETHIGHLIGHTGUIDE → int
+

SCI_SETHIGHLIGHTGUIDE(position column)
+ SCI_GETHIGHLIGHTGUIDE → position
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 @@ -4042,14 +4056,14 @@ struct Sci_TextToFind { back)
SCI_MARKERENABLEHIGHLIGHT(bool enabled)
SCI_MARKERSETALPHA(int markerNumber, alpha alpha)
- SCI_MARKERADD(int line, int markerNumber) → int
- SCI_MARKERADDSET(int line, int markerSet)
- SCI_MARKERDELETE(int line, int + SCI_MARKERADD(line line, int markerNumber) → int
+ SCI_MARKERADDSET(line line, int markerSet)
+ SCI_MARKERDELETE(line line, int markerNumber)
SCI_MARKERDELETEALL(int markerNumber)
- SCI_MARKERGET(int line) → int
- SCI_MARKERNEXT(int lineStart, int markerMask) → int
- SCI_MARKERPREVIOUS(int lineStart, int markerMask) → int
+ SCI_MARKERGET(line line) → int
+ SCI_MARKERNEXT(line lineStart, int markerMask) → line
+ SCI_MARKERPREVIOUS(line lineStart, int markerMask) → line
SCI_MARKERLINEFROMHANDLE(int markerHandle) → int
SCI_MARKERDELETEHANDLE(int markerHandle)
 @@ -4264,7 +4278,7 @@ struct Sci_TextToFind { 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) → int
+

SCI_MARKERADD(line 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_MARKERADDSET(int line, int markerSet)
+

SCI_MARKERADDSET(line 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 @@ -4284,7 +4298,7 @@ struct Sci_TextToFind { SCI_MARKERADD, no check is made to see if any of the markers are already present on the targeted line.

-

SCI_MARKERDELETE(int line, int markerNumber)
+

SCI_MARKERDELETE(line line, int markerNumber)
This searches the given line number for the given marker number and deletes it if it is present. If you added the same marker more than once to the line, this will delete one copy each time it is used. If you pass in a marker number of -1, all markers are deleted from the @@ -4294,12 +4308,12 @@ 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) → int
+

SCI_MARKERGET(line 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) → int
- SCI_MARKERPREVIOUS(int lineStart, int markerMask) → int
+

SCI_MARKERNEXT(line lineStart, int markerMask) → line
+ SCI_MARKERPREVIOUS(line lineStart, int markerMask) → line
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 (SCI_MARKERNEXT) or backwards to the start of the file @@ -4377,15 +4391,15 @@ struct Sci_TextToFind { SCI_GETINDICATORCURRENT → int
SCI_SETINDICATORVALUE(int value)
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_INDICATORFILLRANGE(position start, position lengthFill)
+ SCI_INDICATORCLEARRANGE(position start, position lengthClear)
+ SCI_INDICATORALLONFOR(position pos) → int
+ SCI_INDICATORVALUEAT(int indicator, position pos) → int
+ SCI_INDICATORSTART(int indicator, position pos) → int
+ SCI_INDICATOREND(int indicator, position pos) → int
+ + SCI_FINDINDICATORSHOW(position start, position end)
+ SCI_FINDINDICATORFLASH(position start, position end)
SCI_FINDINDICATORHIDE
 @@ -4673,8 +4687,8 @@ struct Sci_TextToFind { SCI_SETINDICATORCURRENT(int indicator)
SCI_GETINDICATORCURRENT → int
These two messages set and get the indicator that will be affected by calls to - SCI_INDICATORFILLRANGE(int start, int lengthFill) and - SCI_INDICATORCLEARRANGE(int start, int lengthClear). + SCI_INDICATORFILLRANGE(position start, position lengthFill) and + SCI_INDICATORCLEARRANGE(position start, position lengthClear).

@@ -4685,27 +4699,27 @@ struct Sci_TextToFind {

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

- SCI_INDICATORALLONFOR(int pos) → int
+ SCI_INDICATORALLONFOR(position 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 pos) → int
+ SCI_INDICATORVALUEAT(int indicator, position pos) → int
Retrieve the value of a particular indicator at a position.

- SCI_INDICATORSTART(int indicator, int pos) → int
- SCI_INDICATOREND(int indicator, int pos) → int
+ SCI_INDICATORSTART(int indicator, position pos) → int
+ SCI_INDICATOREND(int indicator, position 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.

@@ -4717,8 +4731,8 @@ struct Sci_TextToFind { While this feature is currently only implemented on OS X, it may be implemented on other platforms in the future.

-

SCI_FINDINDICATORSHOW(int start, int end)
- SCI_FINDINDICATORFLASH(int start, int end)
+

SCI_FINDINDICATORSHOW(position start, position end)
+ SCI_FINDINDICATORFLASH(position start, position end)
These two messages show and animate the find indicator. The indicator remains visible with SCI_FINDINDICATORSHOW and fades out after showing for half a second with SCI_FINDINDICATORFLASH. @@ -4759,7 +4773,7 @@ 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 lengthEntered, const char + SCI_AUTOCSHOW(position lengthEntered, const char *itemList)
SCI_AUTOCCANCEL
SCI_AUTOCACTIVE → bool
@@ -4807,7 +4821,7 @@ struct Sci_TextToFind { SCI_AUTOCGETMAXWIDTH → int
 -

SCI_AUTOCSHOW(int lengthEntered, const char *itemList)
+

SCI_AUTOCSHOW(position 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 @@ -5035,12 +5049,12 @@ 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 pos, const char + SCI_CALLTIPSHOW(position pos, const char *definition)
SCI_CALLTIPCANCEL
SCI_CALLTIPACTIVE → bool
SCI_CALLTIPPOSSTART → position
- SCI_CALLTIPSETPOSSTART(int posStart)
+ SCI_CALLTIPSETPOSSTART(position posStart)
SCI_CALLTIPSETHLT(int highlightStart, int highlightEnd)
SCI_CALLTIPSETBACK(colour back)
@@ -5050,7 +5064,7 @@ struct Sci_TextToFind { SCI_CALLTIPSETPOSITION(bool above)
 -

SCI_CALLTIPSHOW(int pos, const char *definition)
+

SCI_CALLTIPSHOW(position 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.
pos is the position in the document at which to align the call tip. The call @@ -5076,7 +5090,7 @@ struct Sci_TextToFind { This returns 1 if a call tip is active and 0 if it is not active.

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

@@ -5710,7 +5724,7 @@ struct Sci_RangeToFormat { SCI_GETDIRECTFUNCTION → int
SCI_GETDIRECTPOINTER → int
SCI_GETCHARACTERPOINTER → int
- SCI_GETRANGEPOINTER(int start, int lengthRange) → int
+ SCI_GETRANGEPOINTER(position start, position lengthRange) → int
SCI_GETGAPPOSITION → position
 @@ -5757,7 +5771,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ pass in the direct pointer associated with the target window.

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

@@ -5806,7 +5820,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETDOCPOINTER → document *
SCI_SETDOCPOINTER(<unused>, document *doc)
- SCI_CREATEDOCUMENT(int bytes, int documentOptions) → document *
+ SCI_CREATEDOCUMENT(position bytes, int documentOptions) → document *
SCI_ADDREFDOCUMENT(<unused>, document *doc)
SCI_RELEASEDOCUMENT(<unused>, document @@ -5828,7 +5842,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ window.
6. If doc was not 0, its reference count is increased by 1.

-

SCI_CREATEDOCUMENT(int bytes, int documentOptions) → document *
+

SCI_CREATEDOCUMENT(position bytes, int documentOptions) → 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 @@ -5923,7 +5937,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

Loading in the background

- SCI_CREATELOADER(int bytes, int documentOptions) → int
+ SCI_CREATELOADER(position bytes, int documentOptions) → 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 @@ -5932,7 +5946,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

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, int documentOptions) → int
+

SCI_CREATELOADER(position bytes, int documentOptions) → 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 @@ -5993,39 +6007,39 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ markers and a folding margin to complete your folding implementation. The "fold" property should be set to "1" with SCI_SETPROPERTY("fold", "1") to enable folding.

- 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) → bool
+ SCI_VISIBLEFROMDOCLINE(line docLine) → line
+ SCI_DOCLINEFROMVISIBLE(line displayLine) → line
+ SCI_SHOWLINES(line lineStart, line lineEnd)
+ SCI_HIDELINES(line lineStart, line lineEnd)
+ SCI_GETLINEVISIBLE(line line) → bool
SCI_GETALLLINESVISIBLE → bool
- SCI_SETFOLDLEVEL(int line, int level)
- SCI_GETFOLDLEVEL(int line) → int
+ SCI_SETFOLDLEVEL(line line, int level)
+ SCI_GETFOLDLEVEL(line line) → int
SCI_SETAUTOMATICFOLD(int automaticFold)
SCI_GETAUTOMATICFOLD → int
SCI_SETFOLDFLAGS(int flags)
- SCI_GETLASTCHILD(int line, int level) → int
- SCI_GETFOLDPARENT(int line) → int
- SCI_SETFOLDEXPANDED(int line, bool + SCI_GETLASTCHILD(line line, int level) → line
+ SCI_GETFOLDPARENT(line line) → line
+ SCI_SETFOLDEXPANDED(line line, bool expanded)
- SCI_GETFOLDEXPANDED(int line) → bool
- SCI_CONTRACTEDFOLDNEXT(int lineStart) → int
- SCI_TOGGLEFOLD(int line)
- SCI_TOGGLEFOLDSHOWTEXT(int line, const char *text)
+ SCI_GETFOLDEXPANDED(line line) → bool
+ SCI_CONTRACTEDFOLDNEXT(line lineStart) → line
+ SCI_TOGGLEFOLD(line line)
+ SCI_TOGGLEFOLDSHOWTEXT(line line, const char *text)
SCI_FOLDDISPLAYTEXTSETSTYLE(int style)
SCI_FOLDDISPLAYTEXTGETSTYLE → int
SCI_SETDEFAULTFOLDDISPLAYTEXT(<unused>, const char *text)
SCI_GETDEFAULTFOLDDISPLAYTEXT(<unused>, char *text) → int
- SCI_FOLDLINE(int line, int action)
- SCI_FOLDCHILDREN(int line, int action)
+ SCI_FOLDLINE(line line, int action)
+ SCI_FOLDCHILDREN(line line, int action)
SCI_FOLDALL(int action)
- SCI_EXPANDCHILDREN(int line, int level)
- SCI_ENSUREVISIBLE(int line)
- SCI_ENSUREVISIBLEENFORCEPOLICY(int + SCI_EXPANDCHILDREN(line line, int level)
+ SCI_ENSUREVISIBLE(line line)
+ SCI_ENSUREVISIBLEENFORCEPOLICY(line line)
 -

SCI_VISIBLEFROMDOCLINE(int docLine) → int
+

SCI_VISIBLEFROMDOCLINE(line docLine) → line
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, @@ -6036,7 +6050,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ 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) → int
+

SCI_DOCLINEFROMVISIBLE(line displayLine) → line
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 @@ -6045,9 +6059,9 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ 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) → bool
+

SCI_SHOWLINES(line lineStart, line lineEnd)
+ SCI_HIDELINES(line lineStart, line lineEnd)
+ SCI_GETLINEVISIBLE(line line) → bool
SCI_GETALLLINESVISIBLE → bool
The first two messages mark a range of lines as visible or invisible and then redraw the display. @@ -6058,8 +6072,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ These messages have no effect on fold levels or fold flags. The first line can not be hidden.

-

SCI_SETFOLDLEVEL(int line, int level)
- SCI_GETFOLDLEVEL(int line) → int
+

SCI_SETFOLDLEVEL(line line, int level)
+ SCI_GETFOLDLEVEL(line 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 (0x0FFF). However, the initial fold level is set to @@ -6152,7 +6166,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

This message causes the display to redraw.

-

SCI_GETLASTCHILD(int line, int level) → int
+

SCI_GETLASTCHILD(line line, int level) → line
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 @@ -6160,14 +6174,14 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ -1) returns the last line that would be in made visible or hidden by toggling the fold state.

-

SCI_GETFOLDPARENT(int line) → int
+

SCI_GETFOLDPARENT(line line) → line
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 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)
- SCI_TOGGLEFOLDSHOWTEXT(int line, const char *text)
+

SCI_TOGGLEFOLD(line line)
+ SCI_TOGGLEFOLDSHOWTEXT(line line, const char *text)
Each fold point may be either expanded, displaying all its child lines, or contracted, hiding all the child lines. These messages toggle the folding state of the given line as long as it has the SC_FOLDLEVELHEADERFLAG set. These messages take care of folding or expanding @@ -6217,8 +6231,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETDEFAULTFOLDDISPLAYTEXT(<unused>, char *text) → int
These messages set and get the default text displayed at the right of the folded text.

-

SCI_SETFOLDEXPANDED(int line, bool expanded)
- SCI_GETFOLDEXPANDED(int line) → bool
+

SCI_SETFOLDEXPANDED(line line, bool expanded)
+ SCI_GETFOLDEXPANDED(line 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, @@ -6230,8 +6244,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ until you had finished. See SciTEBase::FoldAll() and SciTEBase::Expand() for examples of the use of these messages.

-

SCI_FOLDLINE(int line, int action)
- SCI_FOLDCHILDREN(int line, int action)
+

SCI_FOLDLINE(line line, int action)
+ SCI_FOLDCHILDREN(line line, int action)
SCI_FOLDALL(int action)
These messages provide a higher-level approach to folding instead of setting expanded flags and showing or hiding individual lines.

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

SCI_EXPANDCHILDREN(int line, int level)
+

SCI_EXPANDCHILDREN(line line, int level)
This is used to respond to a change to a line causing its fold level or whether it is a header to change, perhaps when adding or removing a '{'.

By the time the container has received the notification that the line has changed, @@ -6325,15 +6339,15 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ -

SCI_CONTRACTEDFOLDNEXT(int lineStart) → int
+

SCI_CONTRACTEDFOLDNEXT(line lineStart) → line
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 fold header is returned. If there are no more contracted fold headers then -1 is returned.

-

SCI_ENSUREVISIBLE(int line)
- SCI_ENSUREVISIBLEENFORCEPOLICY(int line)
+

SCI_ENSUREVISIBLE(line line)
+ SCI_ENSUREVISIBLEENFORCEPOLICY(line line)
A line may be hidden because more than one of its parent lines is contracted. Both these message travels up the fold hierarchy, expanding any contracted folds until they reach the top level. The line will then be visible. If you use SCI_ENSUREVISIBLEENFORCEPOLICY, @@ -6358,7 +6372,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETPOSITIONCACHE → int
SCI_LINESSPLIT(int pixelWidth)
SCI_LINESJOIN
- SCI_WRAPCOUNT(int docLine) → int
+ SCI_WRAPCOUNT(line docLine) → line

By default, Scintilla does not wrap lines of text. If you enable line wrapping, lines wider @@ -6606,7 +6620,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) → int
+

SCI_WRAPCOUNT(line docLine) → line
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.

@@ -6639,12 +6653,12 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ colouring the background of characters that exceed the set length.

SCI_SETEDGEMODE(int edgeMode)
SCI_GETEDGEMODE → int
- SCI_SETEDGECOLUMN(int column)
- SCI_GETEDGECOLUMN → int
+ SCI_SETEDGECOLUMN(position column)
+ SCI_GETEDGECOLUMN → position
SCI_SETEDGECOLOUR(colour edgeColour)
SCI_GETEDGECOLOUR → colour

- SCI_MULTIEDGEADDLINE(int column, colour edgeColour)
+ SCI_MULTIEDGEADDLINE(position column, colour edgeColour)
SCI_MULTIEDGECLEARALL
 @@ -6708,8 +6722,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ -

SCI_SETEDGECOLUMN(int column)
- SCI_GETEDGECOLUMN → int
+

SCI_SETEDGECOLUMN(position column)
+ SCI_GETEDGECOLUMN → position
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 @@ -6720,7 +6734,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ 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, +

SCI_MULTIEDGEADDLINE(position column, colour edgeColour)
SCI_MULTIEDGECLEARALL
SCI_MULTIEDGEADDLINE adds a new vertical edge to the view. The edge will be @@ -6800,8 +6814,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETLEXERLANGUAGE(<unused>, char *language) → int
SCI_LOADLEXERLIBRARY(<unused>, const char *path)
- SCI_COLOURISE(int start, int end)
- SCI_CHANGELEXERSTATE(int start, int end) → int
+ SCI_COLOURISE(position start, position end)
+ SCI_CHANGELEXERSTATE(position start, position end) → int
SCI_PROPERTYNAMES(<unused>, char *names) → int
SCI_PROPERTYTYPE(const char *name) → int
SCI_DESCRIBEPROPERTY(const char *name, char *description) → int
@@ -6858,7 +6872,7 @@ 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 start, int end)
+

SCI_COLOURISE(position start, position end)
This requests the current lexer or the container (if the lexer is set to SCLEX_CONTAINER) to style the document between start and end. If end is -1, the document is styled from @@ -6866,7 +6880,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ "1" and your lexer or container supports folding, fold levels are also set. This message causes a redraw.

-

SCI_CHANGELEXERSTATE(int start, int end) → int
+

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

-- cgit v1.2.3