diff options
| -rw-r--r-- | doc/ScintillaDoc.html | 654 | ||||
| -rw-r--r-- | scripts/CheckMentioned.py | 19 |
2 files changed, 344 insertions, 329 deletions
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 @@ <h1>Scintilla Documentation</h1> - <p>Last edited 6 June 2018 NH</p> + <p>Last edited 18 June 2019 NH</p> <p>There is <a class="jump" href="Design.html">an overview of the internal design of Scintilla</a>.<br /> @@ -195,6 +195,20 @@ </tr> <tr> + <th align="left"><code>position</code></th> + + <td>Positions and lengths in document. + Equivalent to <code>intptr_t</code>.</td> + </tr> + + <tr> + <th align="left"><code>line</code></th> + + <td>A line number in the document. + Equivalent to <code>intptr_t</code>.</td> + </tr> + + <tr> <th align="left"><code>const char *</code></th> <td>Arguments point at text that is being passed to Scintilla but not modified. The text @@ -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.</p> - <code><a class="message" href="#SCI_GETTEXT">SCI_GETTEXT(int length, char *text) → int</a><br /> + <code><a class="message" href="#SCI_GETTEXT">SCI_GETTEXT(position length, char *text) → position</a><br /> <a class="message" href="#SCI_SETTEXT">SCI_SETTEXT(<unused>, const char *text)</a><br /> <a class="message" href="#SCI_SETSAVEPOINT">SCI_SETSAVEPOINT</a><br /> - <a class="message" href="#SCI_GETLINE">SCI_GETLINE(int line, char *text) → int</a><br /> + <a class="message" href="#SCI_GETLINE">SCI_GETLINE(line line, char *text) → position</a><br /> <a class="message" href="#SCI_REPLACESEL">SCI_REPLACESEL(<unused>, const char *text)</a><br /> <a class="message" href="#SCI_SETREADONLY">SCI_SETREADONLY(bool readOnly)</a><br /> <a class="message" href="#SCI_GETREADONLY">SCI_GETREADONLY → bool</a><br /> - <a class="message" href="#SCI_GETTEXTRANGE">SCI_GETTEXTRANGE(<unused>, Sci_TextRange *tr) → int</a><br /> - <a class="message" href="#SCI_ALLOCATE">SCI_ALLOCATE(int bytes)</a><br /> - <a class="message" href="#SCI_ADDTEXT">SCI_ADDTEXT(int length, const char *text)</a><br /> - <a class="message" href="#SCI_ADDSTYLEDTEXT">SCI_ADDSTYLEDTEXT(int length, cell *c)</a><br /> - <a class="message" href="#SCI_APPENDTEXT">SCI_APPENDTEXT(int length, const char *text)</a><br /> - <a class="message" href="#SCI_INSERTTEXT">SCI_INSERTTEXT(int pos, const char *text)</a><br /> - <a class="message" href="#SCI_CHANGEINSERTION">SCI_CHANGEINSERTION(int length, const char *text)</a><br /> + <a class="message" href="#SCI_GETTEXTRANGE">SCI_GETTEXTRANGE(<unused>, Sci_TextRange *tr) → position</a><br /> + <a class="message" href="#SCI_ALLOCATE">SCI_ALLOCATE(position bytes)</a><br /> + <a class="message" href="#SCI_ADDTEXT">SCI_ADDTEXT(position length, const char *text)</a><br /> + <a class="message" href="#SCI_ADDSTYLEDTEXT">SCI_ADDSTYLEDTEXT(position length, cell *c)</a><br /> + <a class="message" href="#SCI_APPENDTEXT">SCI_APPENDTEXT(position length, const char *text)</a><br /> + <a class="message" href="#SCI_INSERTTEXT">SCI_INSERTTEXT(position pos, const char *text)</a><br /> + <a class="message" href="#SCI_CHANGEINSERTION">SCI_CHANGEINSERTION(position length, const char *text)</a><br /> <a class="message" href="#SCI_CLEARALL">SCI_CLEARALL</a><br /> - <a class="message" href="#SCI_DELETERANGE">SCI_DELETERANGE(int start, int lengthDelete)</a><br /> + <a class="message" href="#SCI_DELETERANGE">SCI_DELETERANGE(position start, position lengthDelete)</a><br /> <a class="message" href="#SCI_CLEARDOCUMENTSTYLE">SCI_CLEARDOCUMENTSTYLE</a><br /> - <a class="message" href="#SCI_GETCHARAT">SCI_GETCHARAT(int pos) → int</a><br /> - <a class="message" href="#SCI_GETSTYLEAT">SCI_GETSTYLEAT(int pos) → int</a><br /> - <a class="message" href="#SCI_GETSTYLEDTEXT">SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr) → int</a><br /> + <a class="message" href="#SCI_GETCHARAT">SCI_GETCHARAT(position pos) → int</a><br /> + <a class="message" href="#SCI_GETSTYLEAT">SCI_GETSTYLEAT(position pos) → int</a><br /> + <a class="message" href="#SCI_GETSTYLEDTEXT">SCI_GETSTYLEDTEXT(<unused>, Sci_TextRange *tr) → position</a><br /> <a class="message" href="#SCI_RELEASEALLEXTENDEDSTYLES">SCI_RELEASEALLEXTENDEDSTYLES</a><br /> <a class="message" href="#SCI_ALLOCATEEXTENDEDSTYLES">SCI_ALLOCATEEXTENDEDSTYLES(int numberStyles) → int</a><br /> - <a class="message" href="#SCI_TARGETASUTF8">SCI_TARGETASUTF8(<unused>, char *s) → int</a><br /> - <a class="message" href="#SCI_ENCODEDFROMUTF8">SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → int</a><br /> - <a class="message" href="#SCI_SETLENGTHFORENCODE">SCI_SETLENGTHFORENCODE(int bytes)</a><br /> + <a class="message" href="#SCI_TARGETASUTF8">SCI_TARGETASUTF8(<unused>, char *s) → position</a><br /> + <a class="message" href="#SCI_ENCODEDFROMUTF8">SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → position</a><br /> + <a class="message" href="#SCI_SETLENGTHFORENCODE">SCI_SETLENGTHFORENCODE(position bytes)</a><br /> </code> - <p><b id="SCI_GETTEXT">SCI_GETTEXT(int length, char *text NUL-terminated) → int</b><br /> + <p><b id="SCI_GETTEXT">SCI_GETTEXT(position length, char *text NUL-terminated) → position</b><br /> This returns at most <code class="parameter">length</code>-1 characters of text from the start of the document plus one terminating 0 character. When <code class="parameter">length</code>-1 is beyond document length, it returns document length. To collect all the text in a document, use <code>SCI_GETLENGTH</code> @@ -501,11 +515,11 @@ <p>See also: <code><a class="message" href="#SCI_EMPTYUNDOBUFFER">SCI_EMPTYUNDOBUFFER</a>, <a class="message" href="#SCI_GETMODIFY">SCI_GETMODIFY</a></code></p> - <p><b id="SCI_GETLINE">SCI_GETLINE(int line, char *text) → int</b><br /> + <p><b id="SCI_GETLINE">SCI_GETLINE(line line, char *text) → position</b><br /> 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 <a class="message" - href="#SCI_LINELENGTH"><code>SCI_LINELENGTH(int line)</code></a>. The returned value is the + href="#SCI_LINELENGTH"><code>SCI_LINELENGTH(line line)</code></a>. 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 <a class="message" href="#SCN_MODIFYATTEMPTRO"><code>SCN_MODIFYATTEMPTRO</code></a> notification.</p> - <p><b id="SCI_GETTEXTRANGE">SCI_GETTEXTRANGE(<unused>, <a class="jump" href="#Sci_TextRange">Sci_TextRange</a> *tr) → int</b><br /> + <p><b id="SCI_GETTEXTRANGE">SCI_GETTEXTRANGE(<unused>, <a class="jump" href="#Sci_TextRange">Sci_TextRange</a> *tr) → position</b><br /> This collects the text between the positions <code>cpMin</code> and <code>cpMax</code> and copies it to <code>lpstrText</code> (see <code>struct Sci_TextRange</code> in <code>Scintilla.h</code>). If <code>cpMax</code> is -1, text is returned to the end of the @@ -543,7 +557,7 @@ <a class="seealso" href="#SCI_GETSTYLEDTEXT">SCI_GETSTYLEDTEXT</a>, <a class="seealso" href="#SCI_GETTEXT">SCI_GETTEXT</a></code></p> - <p><b id="SCI_GETSTYLEDTEXT">SCI_GETSTYLEDTEXT(<unused>, <a class="jump" href="#Sci_TextRange">Sci_TextRange</a> *tr) → int</b><br /> + <p><b id="SCI_GETSTYLEDTEXT">SCI_GETSTYLEDTEXT(<unused>, <a class="jump" href="#Sci_TextRange">Sci_TextRange</a> *tr) → position</b><br /> 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 <code>cpMin</code> and <code>cpMax</code> are copied to <code>lpstrText</code> (see @@ -559,40 +573,40 @@ <a class="seealso" href="#SCI_GETTEXTRANGE">SCI_GETTEXTRANGE</a>, <a class="seealso" href="#SCI_GETTEXT">SCI_GETTEXT</a></code></p> - <p><b id="SCI_ALLOCATE">SCI_ALLOCATE(int bytes)</b><br /> + <p><b id="SCI_ALLOCATE">SCI_ALLOCATE(position bytes)</b><br /> Allocate a document buffer large enough to store a given number of bytes. The document will not be made smaller than its current contents.</p> - <p><b id="SCI_ADDTEXT">SCI_ADDTEXT(int length, const char *text)</b><br /> + <p><b id="SCI_ADDTEXT">SCI_ADDTEXT(position length, const char *text)</b><br /> This inserts the first <code class="parameter">length</code> characters from the string <code class="parameter">text</code> 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.</p> - <p><b id="SCI_ADDSTYLEDTEXT">SCI_ADDSTYLEDTEXT(int length, cell *c)</b><br /> + <p><b id="SCI_ADDSTYLEDTEXT">SCI_ADDSTYLEDTEXT(position length, cell *c)</b><br /> This behaves just like <code>SCI_ADDTEXT</code>, but inserts styled text.</p> - <p><b id="SCI_APPENDTEXT">SCI_APPENDTEXT(int length, const char *text)</b><br /> + <p><b id="SCI_APPENDTEXT">SCI_APPENDTEXT(position length, const char *text)</b><br /> This adds the first <code class="parameter">length</code> characters from the string <code class="parameter">text</code> 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.</p> - <p><b id="SCI_INSERTTEXT">SCI_INSERTTEXT(int pos, const char *text)</b><br /> + <p><b id="SCI_INSERTTEXT">SCI_INSERTTEXT(position pos, const char *text)</b><br /> This inserts the zero terminated <code class="parameter">text</code> string at position <code class="parameter">pos</code> or at the current position if <code class="parameter">pos</code> 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.</p> - <p><b id="SCI_CHANGEINSERTION">SCI_CHANGEINSERTION(int length, const char *text)</b><br /> + <p><b id="SCI_CHANGEINSERTION">SCI_CHANGEINSERTION(position length, const char *text)</b><br /> This may only be called from a <a class="message" href="#SC_MOD_INSERTCHECK">SC_MOD_INSERTCHECK</a> notification handler and will change the text being inserted to that provided.</p> <p><b id="SCI_CLEARALL">SCI_CLEARALL</b><br /> Unless the document is read-only, this deletes all the text.</p> - <p><b id="SCI_DELETERANGE">SCI_DELETERANGE(int start, int lengthDelete)</b><br /> + <p><b id="SCI_DELETERANGE">SCI_DELETERANGE(position start, position lengthDelete)</b><br /> Deletes a range of text in the document.</p> <p><b id="SCI_CLEARDOCUMENTSTYLE">SCI_CLEARDOCUMENTSTYLE</b><br /> @@ -600,11 +614,11 @@ <code>SCI_CLEARDOCUMENTSTYLE</code> can be used to clear all styling information and reset the folding state.</p> - <p><b id="SCI_GETCHARAT">SCI_GETCHARAT(int pos) → int</b><br /> + <p><b id="SCI_GETCHARAT">SCI_GETCHARAT(position pos) → int</b><br /> This returns the character at <code class="parameter">pos</code> in the document or 0 if <code class="parameter">pos</code> is negative or past the end of the document.</p> - <p><b id="SCI_GETSTYLEAT">SCI_GETSTYLEAT(int pos) → int</b><br /> + <p><b id="SCI_GETSTYLEAT">SCI_GETSTYLEAT(position pos) → int</b><br /> This returns the style at <code class="parameter">pos</code> in the document, or 0 if <code class="parameter">pos</code> is negative or past the end of the document.</p> @@ -642,7 +656,7 @@ struct Sci_TextRange { <h3 id="EncodedAccess">Specific to GTK, Cocoa and Windows only: Access to encoded text</h3> - <p><b id="SCI_TARGETASUTF8">SCI_TARGETASUTF8(<unused>, char *s) → int</b><br /> + <p><b id="SCI_TARGETASUTF8">SCI_TARGETASUTF8(<unused>, char *s) → position</b><br /> 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. </p> - <p><b id="SCI_ENCODEDFROMUTF8">SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → int</b><br /> - <b id="SCI_SETLENGTHFORENCODE">SCI_SETLENGTHFORENCODE(int bytes)</b><br /> + <p><b id="SCI_ENCODEDFROMUTF8">SCI_ENCODEDFROMUTF8(const char *utf8, char *encoded) → position</b><br /> + <b id="SCI_SETLENGTHFORENCODE">SCI_SETLENGTHFORENCODE(position bytes)</b><br /> <code>SCI_ENCODEDFROMUTF8</code> 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 { <code>SCI_SEARCHINTARGET</code> such as <code>SCFIND_MATCHCASE</code>, <code>SCFIND_WHOLEWORD</code>, <code>SCFIND_WORDSTART</code>, and <code>SCFIND_REGEXP</code> can be set with <code>SCI_SETSEARCHFLAGS</code>.</p> - <code><a class="message" href="#SCI_SETTARGETSTART">SCI_SETTARGETSTART(int start)</a><br /> + <code><a class="message" href="#SCI_SETTARGETSTART">SCI_SETTARGETSTART(position start)</a><br /> <a class="message" href="#SCI_GETTARGETSTART">SCI_GETTARGETSTART → position</a><br /> - <a class="message" href="#SCI_SETTARGETEND">SCI_SETTARGETEND(int end)</a><br /> + <a class="message" href="#SCI_SETTARGETEND">SCI_SETTARGETEND(position end)</a><br /> <a class="message" href="#SCI_GETTARGETEND">SCI_GETTARGETEND → position</a><br /> - <a class="message" href="#SCI_SETTARGETRANGE">SCI_SETTARGETRANGE(int start, int end)</a><br /> + <a class="message" href="#SCI_SETTARGETRANGE">SCI_SETTARGETRANGE(position start, position end)</a><br /> <a class="message" href="#SCI_TARGETFROMSELECTION">SCI_TARGETFROMSELECTION</a><br /> <a class="message" href="#SCI_TARGETWHOLEDOCUMENT">SCI_TARGETWHOLEDOCUMENT</a><br /> <a class="message" href="#SCI_SETSEARCHFLAGS">SCI_SETSEARCHFLAGS(int searchFlags)</a><br /> <a class="message" href="#SCI_GETSEARCHFLAGS">SCI_GETSEARCHFLAGS → int</a><br /> - <a class="message" href="#SCI_SEARCHINTARGET">SCI_SEARCHINTARGET(int length, const char *text) → int</a><br /> - <a class="message" href="#SCI_GETTARGETTEXT">SCI_GETTARGETTEXT(<unused>, char *text) → int</a><br /> - <a class="message" href="#SCI_REPLACETARGET">SCI_REPLACETARGET(int length, const char *text) → int</a><br /> - <a class="message" href="#SCI_REPLACETARGETRE">SCI_REPLACETARGETRE(int length, const char *text) → int</a><br /> + <a class="message" href="#SCI_SEARCHINTARGET">SCI_SEARCHINTARGET(position length, const char *text) → position</a><br /> + <a class="message" href="#SCI_GETTARGETTEXT">SCI_GETTARGETTEXT(<unused>, char *text) → position</a><br /> + <a class="message" href="#SCI_REPLACETARGET">SCI_REPLACETARGET(position length, const char *text) → position</a><br /> + <a class="message" href="#SCI_REPLACETARGETRE">SCI_REPLACETARGETRE(position length, const char *text) → position</a><br /> <a class="message" href="#SCI_GETTAG">SCI_GETTAG(int tagNumber, char *tagValue) → int</a><br /> </code> - <p><b id="SCI_SETTARGETSTART">SCI_SETTARGETSTART(int start)</b><br /> + <p><b id="SCI_SETTARGETSTART">SCI_SETTARGETSTART(position start)</b><br /> <b id="SCI_GETTARGETSTART">SCI_GETTARGETSTART → position</b><br /> - <b id="SCI_SETTARGETEND">SCI_SETTARGETEND(int end)</b><br /> + <b id="SCI_SETTARGETEND">SCI_SETTARGETEND(position end)</b><br /> <b id="SCI_GETTARGETEND">SCI_GETTARGETEND → position</b><br /> - <b id="SCI_SETTARGETRANGE">SCI_SETTARGETRANGE(int start, int end)</b><br /> + <b id="SCI_SETTARGETRANGE">SCI_SETTARGETRANGE(position start, position end)</b><br /> 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 { <code>SCI_SEARCHINTARGET</code>. There are several option flags including a simple regular expression search.</p> - <p><b id="SCI_SEARCHINTARGET">SCI_SEARCHINTARGET(int length, const char *text) → int</b><br /> + <p><b id="SCI_SEARCHINTARGET">SCI_SEARCHINTARGET(position length, const char *text) → position</b><br /> This searches for the first occurrence of a text string in the target defined by <code>SCI_SETTARGETSTART</code> and <code>SCI_SETTARGETEND</code>. The text string is not zero terminated; the size is set by <code class="parameter">length</code>. 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.</p> - <p><b id="SCI_GETTARGETTEXT">SCI_GETTARGETTEXT(<unused>, char *text) → int</b><br /> + <p><b id="SCI_GETTARGETTEXT">SCI_GETTARGETTEXT(<unused>, char *text) → position</b><br /> Retrieve the value in the target.</p> - <p><b id="SCI_REPLACETARGET">SCI_REPLACETARGET(int length, const char *text) → int</b><br /> + <p><b id="SCI_REPLACETARGET">SCI_REPLACETARGET(position length, const char *text) → position</b><br /> If <code class="parameter">length</code> is -1, <code class="parameter">text</code> is a zero terminated string, otherwise <code class="parameter">length</code> 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.</p> - <p><b id="SCI_REPLACETARGETRE">SCI_REPLACETARGETRE(int length, const char *text) → int</b><br /> + <p><b id="SCI_REPLACETARGETRE">SCI_REPLACETARGETRE(position length, const char *text) → position</b><br /> This replaces the target using regular expressions. If <code class="parameter">length</code> is -1, <code class="parameter">text</code> is a zero terminated string, otherwise <code class="parameter">length</code> 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 { <code><a class="message" href="#SCI_FINDTEXT">SCI_FINDTEXT(int searchFlags, Sci_TextToFind *ft) → position</a><br /> <a class="message" href="#SCI_SEARCHANCHOR">SCI_SEARCHANCHOR</a><br /> - <a class="message" href="#SCI_SEARCHNEXT">SCI_SEARCHNEXT(int searchFlags, const char *text) → int</a><br /> - <a class="message" href="#SCI_SEARCHPREV">SCI_SEARCHPREV(int searchFlags, const char *text) → int</a><br /> + <a class="message" href="#SCI_SEARCHNEXT">SCI_SEARCHNEXT(int searchFlags, const char *text) → position</a><br /> + <a class="message" href="#SCI_SEARCHPREV">SCI_SEARCHPREV(int searchFlags, const char *text) → position</a><br /> </code> <p><b id="SCI_FINDTEXT">SCI_FINDTEXT(int searchFlags, <a class="jump" href="#Sci_TextToFind">Sci_TextToFind</a> *ft) → position</b><br /> @@ -957,8 +971,8 @@ struct Sci_TextToFind { </pre> <p><b id="SCI_SEARCHANCHOR">SCI_SEARCHANCHOR</b><br /> - <b id="SCI_SEARCHNEXT">SCI_SEARCHNEXT(int searchFlags, const char *text) → int</b><br /> - <b id="SCI_SEARCHPREV">SCI_SEARCHPREV(int searchFlags, const char *text) → int</b><br /> + <b id="SCI_SEARCHNEXT">SCI_SEARCHNEXT(int searchFlags, const char *text) → position</b><br /> + <b id="SCI_SEARCHPREV">SCI_SEARCHPREV(int searchFlags, const char *text) → position</b><br /> 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 <a class="message" @@ -1003,8 +1017,8 @@ struct Sci_TextToFind { <a class="message" href="#SCI_PASTE">SCI_PASTE</a><br /> <a class="message" href="#SCI_CLEAR">SCI_CLEAR</a><br /> <a class="message" href="#SCI_CANPASTE">SCI_CANPASTE → bool</a><br /> - <a class="message" href="#SCI_COPYRANGE">SCI_COPYRANGE(int start, int end)</a><br /> - <a class="message" href="#SCI_COPYTEXT">SCI_COPYTEXT(int length, const char *text)</a><br /> + <a class="message" href="#SCI_COPYRANGE">SCI_COPYRANGE(position start, position end)</a><br /> + <a class="message" href="#SCI_COPYTEXT">SCI_COPYTEXT(position length, const char *text)</a><br /> <a class="message" href="#SCI_COPYALLOWLINE">SCI_COPYALLOWLINE</a><br /> <a class="message" href="#SCI_SETPASTECONVERTENDINGS">SCI_SETPASTECONVERTENDINGS(bool convert)</a><br /> <a class="message" href="#SCI_GETPASTECONVERTENDINGS">SCI_GETPASTECONVERTENDINGS → bool</a><br /> @@ -1035,8 +1049,8 @@ struct Sci_TextToFind { is added to the clipboard which is then used in <code>SCI_PASTE</code> to paste the whole line before the current line.</p> - <b id="SCI_COPYRANGE">SCI_COPYRANGE(int start, int end)</b><br /> - <b id="SCI_COPYTEXT">SCI_COPYTEXT(int length, const char *text)</b><br /> + <b id="SCI_COPYRANGE">SCI_COPYRANGE(position start, position end)</b><br /> + <b id="SCI_COPYTEXT">SCI_COPYTEXT(position length, const char *text)</b><br /> <p><code>SCI_COPYRANGE</code> copies a range of text from the document to the system clipboard and <code>SCI_COPYTEXT</code> copies a supplied piece of text to the system clipboard.</p> @@ -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.</p> - <code><a class="message" href="#SCI_GETTEXTLENGTH">SCI_GETTEXTLENGTH → int</a><br /> - <a class="message" href="#SCI_GETLENGTH">SCI_GETLENGTH → int</a><br /> - <a class="message" href="#SCI_GETLINECOUNT">SCI_GETLINECOUNT → int</a><br /> - <a class="message" href="#SCI_LINESONSCREEN">SCI_LINESONSCREEN → int</a><br /> + <code><a class="message" href="#SCI_GETTEXTLENGTH">SCI_GETTEXTLENGTH → position</a><br /> + <a class="message" href="#SCI_GETLENGTH">SCI_GETLENGTH → position</a><br /> + <a class="message" href="#SCI_GETLINECOUNT">SCI_GETLINECOUNT → line</a><br /> + <a class="message" href="#SCI_LINESONSCREEN">SCI_LINESONSCREEN → line</a><br /> <a class="message" href="#SCI_GETMODIFY">SCI_GETMODIFY → bool</a><br /> - <a class="message" href="#SCI_SETSEL">SCI_SETSEL(int anchor, int caret)</a><br /> - <a class="message" href="#SCI_GOTOPOS">SCI_GOTOPOS(int caret)</a><br /> - <a class="message" href="#SCI_GOTOLINE">SCI_GOTOLINE(int line)</a><br /> - <a class="message" href="#SCI_SETCURRENTPOS">SCI_SETCURRENTPOS(int caret)</a><br /> + <a class="message" href="#SCI_SETSEL">SCI_SETSEL(position anchor, position caret)</a><br /> + <a class="message" href="#SCI_GOTOPOS">SCI_GOTOPOS(position caret)</a><br /> + <a class="message" href="#SCI_GOTOLINE">SCI_GOTOLINE(line line)</a><br /> + <a class="message" href="#SCI_SETCURRENTPOS">SCI_SETCURRENTPOS(position caret)</a><br /> <a class="message" href="#SCI_GETCURRENTPOS">SCI_GETCURRENTPOS → position</a><br /> - <a class="message" href="#SCI_SETANCHOR">SCI_SETANCHOR(int anchor)</a><br /> + <a class="message" href="#SCI_SETANCHOR">SCI_SETANCHOR(position anchor)</a><br /> <a class="message" href="#SCI_GETANCHOR">SCI_GETANCHOR → position</a><br /> - <a class="message" href="#SCI_SETSELECTIONSTART">SCI_SETSELECTIONSTART(int anchor)</a><br /> + <a class="message" href="#SCI_SETSELECTIONSTART">SCI_SETSELECTIONSTART(position anchor)</a><br /> <a class="message" href="#SCI_GETSELECTIONSTART">SCI_GETSELECTIONSTART → position</a><br /> - <a class="message" href="#SCI_SETSELECTIONEND">SCI_SETSELECTIONEND(int caret)</a><br /> + <a class="message" href="#SCI_SETSELECTIONEND">SCI_SETSELECTIONEND(position caret)</a><br /> <a class="message" href="#SCI_GETSELECTIONEND">SCI_GETSELECTIONEND → position</a><br /> - <a class="message" href="#SCI_SETEMPTYSELECTION">SCI_SETEMPTYSELECTION(int caret)</a><br /> + <a class="message" href="#SCI_SETEMPTYSELECTION">SCI_SETEMPTYSELECTION(position caret)</a><br /> <a class="message" href="#SCI_SELECTALL">SCI_SELECTALL</a><br /> - <a class="message" href="#SCI_LINEFROMPOSITION">SCI_LINEFROMPOSITION(int pos) → int</a><br /> - <a class="message" href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(int line) → position</a><br /> - <a class="message" href="#SCI_GETLINEENDPOSITION">SCI_GETLINEENDPOSITION(int line) → position</a><br /> - <a class="message" href="#SCI_LINELENGTH">SCI_LINELENGTH(int line) → int</a><br /> - <a class="message" href="#SCI_GETCOLUMN">SCI_GETCOLUMN(int pos) → int</a><br /> - <a class="message" href="#SCI_FINDCOLUMN">SCI_FINDCOLUMN(int line, int column) → int</a><br /> + <a class="message" href="#SCI_LINEFROMPOSITION">SCI_LINEFROMPOSITION(position pos) → line</a><br /> + <a class="message" href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(line line) → position</a><br /> + <a class="message" href="#SCI_GETLINEENDPOSITION">SCI_GETLINEENDPOSITION(line line) → position</a><br /> + <a class="message" href="#SCI_LINELENGTH">SCI_LINELENGTH(line line) → position</a><br /> + <a class="message" href="#SCI_GETCOLUMN">SCI_GETCOLUMN(position pos) → position</a><br /> + <a class="message" href="#SCI_FINDCOLUMN">SCI_FINDCOLUMN(line line, position column) → position</a><br /> <a class="message" href="#SCI_POSITIONFROMPOINT">SCI_POSITIONFROMPOINT(int x, int y) → position</a><br /> <a class="message" href="#SCI_POSITIONFROMPOINTCLOSE">SCI_POSITIONFROMPOINTCLOSE(int x, int y) → position</a><br /> <a class="message" href="#SCI_CHARPOSITIONFROMPOINT">SCI_CHARPOSITIONFROMPOINT(int x, int y) → position</a><br /> <a class="message" href="#SCI_CHARPOSITIONFROMPOINTCLOSE">SCI_CHARPOSITIONFROMPOINTCLOSE(int x, int y) → position</a><br /> - <a class="message" href="#SCI_POINTXFROMPOSITION">SCI_POINTXFROMPOSITION(<unused>, int pos) → int</a><br /> - <a class="message" href="#SCI_POINTYFROMPOSITION">SCI_POINTYFROMPOSITION(<unused>, int pos) → int</a><br /> + <a class="message" href="#SCI_POINTXFROMPOSITION">SCI_POINTXFROMPOSITION(<unused>, position pos) → int</a><br /> + <a class="message" href="#SCI_POINTYFROMPOSITION">SCI_POINTYFROMPOSITION(<unused>, position pos) → int</a><br /> <a class="message" href="#SCI_HIDESELECTION">SCI_HIDESELECTION(bool hide)</a><br /> - <a class="message" href="#SCI_GETSELTEXT">SCI_GETSELTEXT(<unused>, char *text) → int</a><br /> - <a class="message" href="#SCI_GETCURLINE">SCI_GETCURLINE(int length, char *text) → int</a><br /> + <a class="message" href="#SCI_GETSELTEXT">SCI_GETSELTEXT(<unused>, char *text) → position</a><br /> + <a class="message" href="#SCI_GETCURLINE">SCI_GETCURLINE(position length, char *text) → position</a><br /> <a class="message" href="#SCI_SELECTIONISRECTANGLE">SCI_SELECTIONISRECTANGLE → bool</a><br /> <a class="message" href="#SCI_SETSELECTIONMODE">SCI_SETSELECTIONMODE(int selectionMode)</a><br /> <a class="message" href="#SCI_GETSELECTIONMODE">SCI_GETSELECTIONMODE → int</a><br /> <a class="message" href="#SCI_GETMOVEEXTENDSSELECTION">SCI_GETMOVEEXTENDSSELECTION → bool</a><br /> - <a class="message" href="#SCI_GETLINESELSTARTPOSITION">SCI_GETLINESELSTARTPOSITION(int line) → position</a><br /> - <a class="message" href="#SCI_GETLINESELENDPOSITION">SCI_GETLINESELENDPOSITION(int line) → position</a><br /> + <a class="message" href="#SCI_GETLINESELSTARTPOSITION">SCI_GETLINESELSTARTPOSITION(line line) → position</a><br /> + <a class="message" href="#SCI_GETLINESELENDPOSITION">SCI_GETLINESELENDPOSITION(line line) → position</a><br /> <a class="message" href="#SCI_MOVECARETINSIDEVIEW">SCI_MOVECARETINSIDEVIEW</a><br /> - <a class="message" href="#SCI_POSITIONBEFORE">SCI_POSITIONBEFORE(int pos) → position</a><br /> - <a class="message" href="#SCI_POSITIONAFTER">SCI_POSITIONAFTER(int pos) → position</a><br /> + <a class="message" href="#SCI_POSITIONBEFORE">SCI_POSITIONBEFORE(position pos) → position</a><br /> + <a class="message" href="#SCI_POSITIONAFTER">SCI_POSITIONAFTER(position pos) → position</a><br /> <a class="message" href="#SCI_TEXTWIDTH">SCI_TEXTWIDTH(int style, const char *text) → int</a><br /> - <a class="message" href="#SCI_TEXTHEIGHT">SCI_TEXTHEIGHT(int line) → int</a><br /> + <a class="message" href="#SCI_TEXTHEIGHT">SCI_TEXTHEIGHT(line line) → int</a><br /> <a class="message" href="#SCI_CHOOSECARETX">SCI_CHOOSECARETX</a><br /> <a class="message" href="#SCI_MOVESELECTEDLINESUP">SCI_MOVESELECTEDLINESUP</a><br /> <a class="message" href="#SCI_MOVESELECTEDLINESDOWN">SCI_MOVESELECTEDLINESDOWN</a><br /> @@ -1242,15 +1256,15 @@ struct Sci_TextToFind { <a class="message" href="#SCI_GETMOUSESELECTIONRECTANGULARSWITCH">SCI_GETMOUSESELECTIONRECTANGULARSWITCH → bool</a><br /> </code> - <p><b id="SCI_GETTEXTLENGTH">SCI_GETTEXTLENGTH → int</b><br /> - <b id="SCI_GETLENGTH">SCI_GETLENGTH → int</b><br /> + <p><b id="SCI_GETTEXTLENGTH">SCI_GETTEXTLENGTH → position</b><br /> + <b id="SCI_GETLENGTH">SCI_GETLENGTH → position</b><br /> Both these messages return the length of the document in bytes.</p> - <p><b id="SCI_GETLINECOUNT">SCI_GETLINECOUNT → int</b><br /> + <p><b id="SCI_GETLINECOUNT">SCI_GETLINECOUNT → line</b><br /> 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.</p> - <p><b id="SCI_LINESONSCREEN">SCI_LINESONSCREEN → int</b><br /> + <p><b id="SCI_LINESONSCREEN">SCI_LINESONSCREEN → line</b><br /> 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"><code>SCN_SAVEPOINTLEFT</code></a> <a class="jump" href="#Notifications">notification messages</a>.</p> - <p><b id="SCI_SETSEL">SCI_SETSEL(int anchor, int caret)</b><br /> + <p><b id="SCI_SETSEL">SCI_SETSEL(position anchor, position caret)</b><br /> This message sets both the anchor and the current position. If <code class="parameter">caret</code> is negative, it means the end of the document. If <code class="parameter">anchor</code> is negative, it means remove any selection (i.e. set the anchor to the same position as <code class="parameter">caret</code>). The caret is scrolled into view after this operation.</p> - <p><b id="SCI_GOTOPOS">SCI_GOTOPOS(int caret)</b><br /> + <p><b id="SCI_GOTOPOS">SCI_GOTOPOS(position caret)</b><br /> This removes any selection, sets the caret at <code class="parameter">caret</code> and scrolls the view to make the caret visible, if necessary. It is equivalent to <code>SCI_SETSEL(caret, caret)</code>. The anchor position is set the same as the current position.</p> - <p><b id="SCI_GOTOLINE">SCI_GOTOLINE(int line)</b><br /> + <p><b id="SCI_GOTOLINE">SCI_GOTOLINE(line line)</b><br /> This removes any selection and sets the caret at the start of line number <code class="parameter">line</code> and scrolls the view (if needed) to make it visible. The anchor position is set the same as the current position. If <code class="parameter">line</code> is outside the lines in the document (first line is 0), the line set is the first or last.</p> - <p><b id="SCI_SETCURRENTPOS">SCI_SETCURRENTPOS(int caret)</b><br /> + <p><b id="SCI_SETCURRENTPOS">SCI_SETCURRENTPOS(position caret)</b><br /> This sets the current position and creates a selection between the anchor and the current position. The caret is not scrolled into view.</p> @@ -1295,7 +1309,7 @@ struct Sci_TextToFind { <p><b id="SCI_GETCURRENTPOS">SCI_GETCURRENTPOS → position</b><br /> This returns the current position.</p> - <p><b id="SCI_SETANCHOR">SCI_SETANCHOR(int anchor)</b><br /> + <p><b id="SCI_SETANCHOR">SCI_SETANCHOR(position anchor)</b><br /> This sets the anchor position and creates a selection between the anchor position and the current position. The caret is not scrolled into view.</p> @@ -1304,8 +1318,8 @@ struct Sci_TextToFind { <p><b id="SCI_GETANCHOR">SCI_GETANCHOR → position</b><br /> This returns the current anchor position.</p> - <p><b id="SCI_SETSELECTIONSTART">SCI_SETSELECTIONSTART(int anchor)</b><br /> - <b id="SCI_SETSELECTIONEND">SCI_SETSELECTIONEND(int caret)</b><br /> + <p><b id="SCI_SETSELECTIONSTART">SCI_SETSELECTIONSTART(position anchor)</b><br /> + <b id="SCI_SETSELECTIONEND">SCI_SETSELECTIONEND(position caret)</b><br /> 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.</p> @@ -1351,38 +1365,38 @@ struct Sci_TextToFind { current position or the anchor position. <code>SCI_GETSELECTIONEND</code> returns the larger of the two values.</p> - <p><b id="SCI_SETEMPTYSELECTION">SCI_SETEMPTYSELECTION(int caret)</b><br /> + <p><b id="SCI_SETEMPTYSELECTION">SCI_SETEMPTYSELECTION(position caret)</b><br /> This removes any selection and sets the caret at <code class="parameter">caret</code>. The caret is not scrolled into view.</p> <p><b id="SCI_SELECTALL">SCI_SELECTALL</b><br /> This selects all the text in the document. The current position is not scrolled into view.</p> - <p><b id="SCI_LINEFROMPOSITION">SCI_LINEFROMPOSITION(int pos) → int</b><br /> + <p><b id="SCI_LINEFROMPOSITION">SCI_LINEFROMPOSITION(position pos) → line</b><br /> This message returns the line that contains the position <code class="parameter">pos</code> in the document. The return value is 0 if <code class="parameter">pos</code> <= 0. The return value is the last line if <code class="parameter">pos</code> is beyond the end of the document.</p> - <p><b id="SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(int line) → position</b><br /> + <p><b id="SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(line line) → position</b><br /> This returns the document position that corresponds with the start of the line. If <code class="parameter">line</code> is negative, the position of the line holding the start of the selection is returned. If <code class="parameter">line</code> is greater than the lines in the document, the return value is -1. If <code class="parameter">line</code> 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.</p> - <p><b id="SCI_GETLINEENDPOSITION">SCI_GETLINEENDPOSITION(int line) → position</b><br /> + <p><b id="SCI_GETLINEENDPOSITION">SCI_GETLINEENDPOSITION(line line) → position</b><br /> This returns the position at the end of the line, before any line end characters. If <code class="parameter">line</code> 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 <code class="parameter">line</code> is negative the result is undefined.</p> - <p><b id="SCI_LINELENGTH">SCI_LINELENGTH(int line) → int</b><br /> + <p><b id="SCI_LINELENGTH">SCI_LINELENGTH(line line) → position</b><br /> This returns the length of the line, including any line end characters. If <code class="parameter">line</code> 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 <a class="message" href="#SCI_GETLINEENDPOSITION"><code>SCI_GETLINEENDPOSITION(line)</code></a> - <a class="message" href="#SCI_POSITIONFROMLINE"><code>SCI_POSITIONFROMLINE(line)</code></a>.</p> - <p><b id="SCI_GETSELTEXT">SCI_GETSELTEXT(<unused>, char *text NUL-terminated) → int</b><br /> + <p><b id="SCI_GETSELTEXT">SCI_GETSELTEXT(<unused>, char *text NUL-terminated) → position</b><br /> This copies the currently selected text and a terminating 0 byte to the <code class="parameter">text</code> buffer. The buffer size should be determined by calling with a NULL pointer for the <code class="parameter">text</code> argument <code>SCI_GETSELTEXT(0,0)</code>. @@ -1397,7 +1411,7 @@ struct Sci_TextToFind { <a class="seealso" href="#SCI_GETTEXTRANGE">SCI_GETTEXTRANGE</a> </code></p> - <p><b id="SCI_GETCURLINE">SCI_GETCURLINE(int length, char *text NUL-terminated) → int</b><br /> + <p><b id="SCI_GETCURLINE">SCI_GETCURLINE(position length, char *text NUL-terminated) → position</b><br /> This retrieves the text of the line containing the caret and returns the position within the line of the caret. Pass in <code>char* text</code> 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. <code>SCI_SETSELECTIONMODE</code> toggles this setting between on and off.</p> - <p><b id="SCI_GETLINESELSTARTPOSITION">SCI_GETLINESELSTARTPOSITION(int line) → position</b><br /> - <b id="SCI_GETLINESELENDPOSITION">SCI_GETLINESELENDPOSITION(int line) → position</b><br /> + <p><b id="SCI_GETLINESELSTARTPOSITION">SCI_GETLINESELSTARTPOSITION(line line) → position</b><br /> + <b id="SCI_GETLINESELENDPOSITION">SCI_GETLINESELENDPOSITION(line line) → position</b><br /> Retrieve the position of the start and end of the selection at the given line with <code>INVALID_POSITION</code> returned if no selection on this line.</p> @@ -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.</p> - <p><b id="SCI_POSITIONBEFORE">SCI_POSITIONBEFORE(int pos) → position</b><br /> - <b id="SCI_POSITIONAFTER">SCI_POSITIONAFTER(int pos) → position</b><br /> + <p><b id="SCI_POSITIONBEFORE">SCI_POSITIONBEFORE(position pos) → position</b><br /> + <b id="SCI_POSITIONAFTER">SCI_POSITIONAFTER(position pos) → position</b><br /> 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.</p> - <p><b id="SCI_TEXTHEIGHT">SCI_TEXTHEIGHT(int line) → int</b><br /> + <p><b id="SCI_TEXTHEIGHT">SCI_TEXTHEIGHT(line line) → int</b><br /> This returns the height in pixels of a particular line. Currently all lines are the same height.</p> - <p><b id="SCI_GETCOLUMN">SCI_GETCOLUMN(int pos) → int</b><br /> + <p><b id="SCI_GETCOLUMN">SCI_GETCOLUMN(position pos) → position</b><br /> This message returns the column number of a position <code class="parameter">pos</code> within the document taking the width of tabs into account. This returns the column number of the last tab on the line before <code class="parameter">pos</code>, 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.</p> - <p><b id="SCI_FINDCOLUMN">SCI_FINDCOLUMN(int line, int column) → int</b><br /> + <p><b id="SCI_FINDCOLUMN">SCI_FINDCOLUMN(line line, position column) → position</b><br /> This message returns the position of a <code class="parameter">column</code> on a <code class="parameter">line</code> taking the width of tabs into account. It treats a multi-byte character as a single column. Column numbers, like lines start at 0.</p> @@ -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.</p> - <p><b id="SCI_POINTXFROMPOSITION">SCI_POINTXFROMPOSITION(<unused>, int pos) → int</b><br /> - <b id="SCI_POINTYFROMPOSITION">SCI_POINTYFROMPOSITION(<unused>, int pos) → int</b><br /> + <p><b id="SCI_POINTXFROMPOSITION">SCI_POINTXFROMPOSITION(<unused>, position pos) → int</b><br /> + <b id="SCI_POINTYFROMPOSITION">SCI_POINTYFROMPOSITION(<unused>, position pos) → int</b><br /> These messages return the x and y display pixel location of text at position <code class="parameter">pos</code> in the document.</p> @@ -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.</p> <code> - <a class="message" href="#SCI_POSITIONRELATIVE">SCI_POSITIONRELATIVE(int pos, int relative) → position</a><br /> - <a class="message" href="#SCI_POSITIONRELATIVECODEUNITS">SCI_POSITIONRELATIVECODEUNITS(int pos, int relative) → position</a><br /> - <a class="message" href="#SCI_COUNTCHARACTERS">SCI_COUNTCHARACTERS(int start, int end) → int</a><br /> - <a class="message" href="#SCI_COUNTCODEUNITS">SCI_COUNTCODEUNITS(int start, int end) → int</a><br /> + <a class="message" href="#SCI_POSITIONRELATIVE">SCI_POSITIONRELATIVE(position pos, position relative) → position</a><br /> + <a class="message" href="#SCI_POSITIONRELATIVECODEUNITS">SCI_POSITIONRELATIVECODEUNITS(position pos, position relative) → position</a><br /> + <a class="message" href="#SCI_COUNTCHARACTERS">SCI_COUNTCHARACTERS(position start, position end) → position</a><br /> + <a class="message" href="#SCI_COUNTCODEUNITS">SCI_COUNTCODEUNITS(position start, position end) → position</a><br /> <a class="message" href="#SCI_GETLINECHARACTERINDEX">SCI_GETLINECHARACTERINDEX → int</a><br /> <a class="message" href="#SCI_ALLOCATELINECHARACTERINDEX">SCI_ALLOCATELINECHARACTERINDEX(int lineCharacterIndex)</a><br /> <a class="message" href="#SCI_RELEASELINECHARACTERINDEX">SCI_RELEASELINECHARACTERINDEX(int lineCharacterIndex)</a><br /> - <a class="message" href="#SCI_LINEFROMINDEXPOSITION">SCI_LINEFROMINDEXPOSITION(int pos, int lineCharacterIndex) → int</a><br /> - <a class="message" href="#SCI_INDEXPOSITIONFROMLINE">SCI_INDEXPOSITIONFROMLINE(int line, int lineCharacterIndex) → position</a><br /> + <a class="message" href="#SCI_LINEFROMINDEXPOSITION">SCI_LINEFROMINDEXPOSITION(position pos, int lineCharacterIndex) → line</a><br /> + <a class="message" href="#SCI_INDEXPOSITIONFROMLINE">SCI_INDEXPOSITIONFROMLINE(line line, int lineCharacterIndex) → position</a><br /> </code> - <p><b id="SCI_POSITIONRELATIVE">SCI_POSITIONRELATIVE(int pos, int relative) → position</b><br /> + <p><b id="SCI_POSITIONRELATIVE">SCI_POSITIONRELATIVE(position pos, position relative) → position</b><br /> 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. </p> - <p><b id="SCI_COUNTCHARACTERS">SCI_COUNTCHARACTERS(int start, int end) → int</b><br /> + <p><b id="SCI_COUNTCHARACTERS">SCI_COUNTCHARACTERS(position start, position end) → position</b><br /> Returns the number of whole characters between two positions.</p> - <p><b id="SCI_POSITIONRELATIVECODEUNITS">SCI_POSITIONRELATIVECODEUNITS(int pos, int relative) → position</b><br /> - <b id="SCI_COUNTCODEUNITS">SCI_COUNTCODEUNITS(int start, int end) → int</b><br /> + <p><b id="SCI_POSITIONRELATIVECODEUNITS">SCI_POSITIONRELATIVECODEUNITS(position pos, position relative) → position</b><br /> + <b id="SCI_COUNTCODEUNITS">SCI_COUNTCODEUNITS(position start, position end) → position</b><br /> These are the UTF-16 versions of <code>SCI_POSITIONRELATIVE</code> and <code>SCI_COUNTCHARACTERS</code> working in terms of UTF-16 code units.</p> @@ -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.</p> - <p><b id="SCI_LINEFROMINDEXPOSITION">SCI_LINEFROMINDEXPOSITION(int pos, int lineCharacterIndex) → int</b><br /> - <b id="SCI_INDEXPOSITIONFROMLINE">SCI_INDEXPOSITIONFROMLINE(int line, int lineCharacterIndex) → position</b><br /> + <p><b id="SCI_LINEFROMINDEXPOSITION">SCI_LINEFROMINDEXPOSITION(position pos, int lineCharacterIndex) → line</b><br /> + <b id="SCI_INDEXPOSITIONFROMLINE">SCI_INDEXPOSITIONFROMLINE(line line, int lineCharacterIndex) → position</b><br /> The document line of a particular character or code unit may be found by calling <code>SCI_LINEFROMINDEXPOSITION</code> with one of <code>SC_LINECHARACTERINDEX_UTF32(1)</code> or <code>SC_LINECHARACTERINDEX_UTF16(2)</code>. 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 { <a class="message" href="#SCI_GETSELECTIONS">SCI_GETSELECTIONS → int</a><br /> <a class="message" href="#SCI_GETSELECTIONEMPTY">SCI_GETSELECTIONEMPTY → bool</a><br /> <a class="message" href="#SCI_CLEARSELECTIONS">SCI_CLEARSELECTIONS</a><br /> - <a class="message" href="#SCI_SETSELECTION">SCI_SETSELECTION(int caret, int anchor)</a><br /> - <a class="message" href="#SCI_ADDSELECTION">SCI_ADDSELECTION(int caret, int anchor)</a><br /> + <a class="message" href="#SCI_SETSELECTION">SCI_SETSELECTION(position caret, position anchor)</a><br /> + <a class="message" href="#SCI_ADDSELECTION">SCI_ADDSELECTION(position caret, position anchor)</a><br /> <a class="message" href="#SCI_DROPSELECTIONN">SCI_DROPSELECTIONN(int selection)</a><br /> <a class="message" href="#SCI_SETMAINSELECTION">SCI_SETMAINSELECTION(int selection)</a><br /> <a class="message" href="#SCI_GETMAINSELECTION">SCI_GETMAINSELECTION → int</a><br /> <br /> - <a class="message" href="#SCI_SETSELECTIONNCARET">SCI_SETSELECTIONNCARET(int selection, int caret)</a><br /> + <a class="message" href="#SCI_SETSELECTIONNCARET">SCI_SETSELECTIONNCARET(int selection, position caret)</a><br /> <a class="message" href="#SCI_GETSELECTIONNCARET">SCI_GETSELECTIONNCARET(int selection) → position</a><br /> - <a class="message" href="#SCI_SETSELECTIONNCARETVIRTUALSPACE">SCI_SETSELECTIONNCARETVIRTUALSPACE(int selection, int space)</a><br /> - <a class="message" href="#SCI_GETSELECTIONNCARETVIRTUALSPACE">SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection) → int</a><br /> - <a class="message" href="#SCI_SETSELECTIONNANCHOR">SCI_SETSELECTIONNANCHOR(int selection, int anchor)</a><br /> + <a class="message" href="#SCI_SETSELECTIONNCARETVIRTUALSPACE">SCI_SETSELECTIONNCARETVIRTUALSPACE(int selection, position space)</a><br /> + <a class="message" href="#SCI_GETSELECTIONNCARETVIRTUALSPACE">SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection) → position</a><br /> + <a class="message" href="#SCI_SETSELECTIONNANCHOR">SCI_SETSELECTIONNANCHOR(int selection, position anchor)</a><br /> <a class="message" href="#SCI_GETSELECTIONNANCHOR">SCI_GETSELECTIONNANCHOR(int selection) → position</a><br /> - <a class="message" href="#SCI_SETSELECTIONNANCHORVIRTUALSPACE">SCI_SETSELECTIONNANCHORVIRTUALSPACE(int selection, int space)</a><br /> - <a class="message" href="#SCI_GETSELECTIONNANCHORVIRTUALSPACE">SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection) → int</a><br /> - <a class="message" href="#SCI_SETSELECTIONNSTART">SCI_SETSELECTIONNSTART(int selection, int anchor)</a><br /> + <a class="message" href="#SCI_SETSELECTIONNANCHORVIRTUALSPACE">SCI_SETSELECTIONNANCHORVIRTUALSPACE(int selection, position space)</a><br /> + <a class="message" href="#SCI_GETSELECTIONNANCHORVIRTUALSPACE">SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection) → position</a><br /> + <a class="message" href="#SCI_SETSELECTIONNSTART">SCI_SETSELECTIONNSTART(int selection, position anchor)</a><br /> <a class="message" href="#SCI_GETSELECTIONNSTART">SCI_GETSELECTIONNSTART(int selection) → position</a><br /> - <a class="message" href="#SCI_SETSELECTIONNEND">SCI_SETSELECTIONNEND(int selection, int caret)</a><br /> + <a class="message" href="#SCI_SETSELECTIONNEND">SCI_SETSELECTIONNEND(int selection, position caret)</a><br /> <a class="message" href="#SCI_GETSELECTIONNEND">SCI_GETSELECTIONNEND(int selection) → position</a><br /> <br /> - <a class="message" href="#SCI_SETRECTANGULARSELECTIONCARET">SCI_SETRECTANGULARSELECTIONCARET(int caret)</a><br /> + <a class="message" href="#SCI_SETRECTANGULARSELECTIONCARET">SCI_SETRECTANGULARSELECTIONCARET(position caret)</a><br /> <a class="message" href="#SCI_GETRECTANGULARSELECTIONCARET">SCI_GETRECTANGULARSELECTIONCARET → position</a><br /> - <a class="message" href="#SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE">SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE(int space)</a><br /> - <a class="message" href="#SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE → int</a><br /> - <a class="message" href="#SCI_SETRECTANGULARSELECTIONANCHOR">SCI_SETRECTANGULARSELECTIONANCHOR(int anchor)</a><br /> + <a class="message" href="#SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE">SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE(position space)</a><br /> + <a class="message" href="#SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE → position</a><br /> + <a class="message" href="#SCI_SETRECTANGULARSELECTIONANCHOR">SCI_SETRECTANGULARSELECTIONANCHOR(position anchor)</a><br /> <a class="message" href="#SCI_GETRECTANGULARSELECTIONANCHOR">SCI_GETRECTANGULARSELECTIONANCHOR → position</a><br /> - <a class="message" href="#SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE(int space)</a><br /> - <a class="message" href="#SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → int</a><br /> + <a class="message" href="#SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE(position space)</a><br /> + <a class="message" href="#SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → position</a><br /> <br /> <a class="message" href="#SCI_SETADDITIONALSELALPHA">SCI_SETADDITIONALSELALPHA(alpha alpha)</a><br /> @@ -1724,11 +1738,11 @@ struct Sci_TextToFind { Set a single empty selection at 0 as the only selection.</p> <p> - <b id="SCI_SETSELECTION">SCI_SETSELECTION(int caret, int anchor)</b><br /> + <b id="SCI_SETSELECTION">SCI_SETSELECTION(position caret, position anchor)</b><br /> Set a single selection from <code class="parameter">anchor</code> to <code class="parameter">caret</code> as the only selection.</p> <p> - <b id="SCI_ADDSELECTION">SCI_ADDSELECTION(int caret, int anchor)</b><br /> + <b id="SCI_ADDSELECTION">SCI_ADDSELECTION(position caret, position anchor)</b><br /> Add a new selection from <code class="parameter">anchor</code> to <code class="parameter">caret</code> 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.</p> <p> - <b id="SCI_SETSELECTIONNCARET">SCI_SETSELECTIONNCARET(int selection, int caret)</b><br /> + <b id="SCI_SETSELECTIONNCARET">SCI_SETSELECTIONNCARET(int selection, position caret)</b><br /> <b id="SCI_GETSELECTIONNCARET">SCI_GETSELECTIONNCARET(int selection) → position</b><br /> - <b id="SCI_SETSELECTIONNCARETVIRTUALSPACE">SCI_SETSELECTIONNCARETVIRTUALSPACE(int selection, int space)</b><br /> - <b id="SCI_GETSELECTIONNCARETVIRTUALSPACE">SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection) → int</b><br /> - <b id="SCI_SETSELECTIONNANCHOR">SCI_SETSELECTIONNANCHOR(int selection, int anchor)</b><br /> + <b id="SCI_SETSELECTIONNCARETVIRTUALSPACE">SCI_SETSELECTIONNCARETVIRTUALSPACE(int selection, position space)</b><br /> + <b id="SCI_GETSELECTIONNCARETVIRTUALSPACE">SCI_GETSELECTIONNCARETVIRTUALSPACE(int selection) → position</b><br /> + <b id="SCI_SETSELECTIONNANCHOR">SCI_SETSELECTIONNANCHOR(int selection, position anchor)</b><br /> <b id="SCI_GETSELECTIONNANCHOR">SCI_GETSELECTIONNANCHOR(int selection) → position</b><br /> - <b id="SCI_SETSELECTIONNANCHORVIRTUALSPACE">SCI_SETSELECTIONNANCHORVIRTUALSPACE(int selection, int space)</b><br /> - <b id="SCI_GETSELECTIONNANCHORVIRTUALSPACE">SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection) → int</b><br /> + <b id="SCI_SETSELECTIONNANCHORVIRTUALSPACE">SCI_SETSELECTIONNANCHORVIRTUALSPACE(int selection, position space)</b><br /> + <b id="SCI_GETSELECTIONNANCHORVIRTUALSPACE">SCI_GETSELECTIONNANCHORVIRTUALSPACE(int selection) → position</b><br /> Set or query the position and amount of virtual space for the caret and anchor of each already existing selection.</p> <p> - <b id="SCI_SETSELECTIONNSTART">SCI_SETSELECTIONNSTART(int selection, int anchor)</b><br /> + <b id="SCI_SETSELECTIONNSTART">SCI_SETSELECTIONNSTART(int selection, position anchor)</b><br /> <b id="SCI_GETSELECTIONNSTART">SCI_GETSELECTIONNSTART(int selection) → position</b><br /> - <b id="SCI_SETSELECTIONNEND">SCI_SETSELECTIONNEND(int selection, int caret)</b><br /> + <b id="SCI_SETSELECTIONNEND">SCI_SETSELECTIONNEND(int selection, position caret)</b><br /> <b id="SCI_GETSELECTIONNEND">SCI_GETSELECTIONNEND(int selection) → position</b><br /> 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. </p> <p> - <b id="SCI_SETRECTANGULARSELECTIONCARET">SCI_SETRECTANGULARSELECTIONCARET(int caret)</b><br /> + <b id="SCI_SETRECTANGULARSELECTIONCARET">SCI_SETRECTANGULARSELECTIONCARET(position caret)</b><br /> <b id="SCI_GETRECTANGULARSELECTIONCARET">SCI_GETRECTANGULARSELECTIONCARET → position</b><br /> - <b id="SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE">SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE(int space)</b><br /> - <b id="SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE → int</b><br /> - <b id="SCI_SETRECTANGULARSELECTIONANCHOR">SCI_SETRECTANGULARSELECTIONANCHOR(int anchor)</b><br /> + <b id="SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE">SCI_SETRECTANGULARSELECTIONCARETVIRTUALSPACE(position space)</b><br /> + <b id="SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONCARETVIRTUALSPACE → position</b><br /> + <b id="SCI_SETRECTANGULARSELECTIONANCHOR">SCI_SETRECTANGULARSELECTIONANCHOR(position anchor)</b><br /> <b id="SCI_GETRECTANGULARSELECTIONANCHOR">SCI_GETRECTANGULARSELECTIONANCHOR → position</b><br /> - <b id="SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE(int space)</b><br /> - <b id="SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → int</b><br /> + <b id="SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_SETRECTANGULARSELECTIONANCHORVIRTUALSPACE(position space)</b><br /> + <b id="SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE">SCI_GETRECTANGULARSELECTIONANCHORVIRTUALSPACE → position</b><br /> 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.</p> @@ -1830,13 +1844,13 @@ struct Sci_TextToFind { <h2 id="ScrollingAndAutomaticScrolling">Scrolling and automatic scrolling</h2> <code> - <a class="message" href="#SCI_SETFIRSTVISIBLELINE">SCI_SETFIRSTVISIBLELINE(int displayLine)</a><br /> - <a class="message" href="#SCI_GETFIRSTVISIBLELINE">SCI_GETFIRSTVISIBLELINE → int</a><br /> + <a class="message" href="#SCI_SETFIRSTVISIBLELINE">SCI_SETFIRSTVISIBLELINE(line displayLine)</a><br /> + <a class="message" href="#SCI_GETFIRSTVISIBLELINE">SCI_GETFIRSTVISIBLELINE → line</a><br /> <a class="message" href="#SCI_SETXOFFSET">SCI_SETXOFFSET(int xOffset)</a><br /> <a class="message" href="#SCI_GETXOFFSET">SCI_GETXOFFSET → int</a><br /> - <a class="message" href="#SCI_LINESCROLL">SCI_LINESCROLL(int columns, int lines)</a><br /> + <a class="message" href="#SCI_LINESCROLL">SCI_LINESCROLL(int columns, line lines)</a><br /> <a class="message" href="#SCI_SCROLLCARET">SCI_SCROLLCARET</a><br /> - <a class="message" href="#SCI_SCROLLRANGE">SCI_SCROLLRANGE(int secondary, int primary)</a><br /> + <a class="message" href="#SCI_SCROLLRANGE">SCI_SCROLLRANGE(position secondary, position primary)</a><br /> <a class="message" href="#SCI_SETXCARETPOLICY">SCI_SETXCARETPOLICY(int caretPolicy, int caretSlop)</a><br /> <a class="message" href="#SCI_SETYCARETPOLICY">SCI_SETYCARETPOLICY(int caretPolicy, int @@ -1856,8 +1870,8 @@ struct Sci_TextToFind { <a class="message" href="#SCI_GETENDATLASTLINE">SCI_GETENDATLASTLINE → bool</a><br /> </code> - <p><b id="SCI_SETFIRSTVISIBLELINE">SCI_SETFIRSTVISIBLELINE(int displayLine)</b><br /> - <b id="SCI_GETFIRSTVISIBLELINE">SCI_GETFIRSTVISIBLELINE → int</b><br /> + <p><b id="SCI_SETFIRSTVISIBLELINE">SCI_SETFIRSTVISIBLELINE(line displayLine)</b><br /> + <b id="SCI_GETFIRSTVISIBLELINE">SCI_GETFIRSTVISIBLELINE → line</b><br /> 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.</p> @@ -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.</p> - <p><b id="SCI_LINESCROLL">SCI_LINESCROLL(int columns, int lines)</b><br /> + <p><b id="SCI_LINESCROLL">SCI_LINESCROLL(int columns, line lines)</b><br /> 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.</p> @@ -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.</p> - <p><b id="SCI_SCROLLRANGE">SCI_SCROLLRANGE(int secondary, int primary)</b><br /> + <p><b id="SCI_SCROLLRANGE">SCI_SCROLLRANGE(position secondary, position primary)</b><br /> 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 <a class="message" href="#SCI_SCROLLCARET"><code>SCI_SCROLLCARET</code></a> @@ -2459,9 +2473,9 @@ struct Sci_TextToFind { <a class="message" href="#SCI_WORDPARTRIGHTEXTEND"><code>SCI_WORDPARTRIGHTEXTEND</code></a>. </p> - <a class="message" href="#SCI_WORDENDPOSITION">SCI_WORDENDPOSITION(int pos, bool onlyWordCharacters) → int</a><br /> - <a class="message" href="#SCI_WORDSTARTPOSITION">SCI_WORDSTARTPOSITION(int pos, bool onlyWordCharacters) → int</a><br /> - <a class="message" href="#SCI_ISRANGEWORD">SCI_ISRANGEWORD(int start, int end) → bool</a><br /> + <a class="message" href="#SCI_WORDENDPOSITION">SCI_WORDENDPOSITION(position pos, bool onlyWordCharacters) → position</a><br /> + <a class="message" href="#SCI_WORDSTARTPOSITION">SCI_WORDSTARTPOSITION(position pos, bool onlyWordCharacters) → position</a><br /> + <a class="message" href="#SCI_ISRANGEWORD">SCI_ISRANGEWORD(position start, position end) → bool</a><br /> <a class="message" href="#SCI_SETWORDCHARS">SCI_SETWORDCHARS(<unused>, const char *characters)</a><br /> <a class="message" href="#SCI_GETWORDCHARS">SCI_GETWORDCHARS(<unused>, char *characters) → int</a><br /> @@ -2473,19 +2487,19 @@ struct Sci_TextToFind { <a class="message" href="#SCI_SETCHARACTERCATEGORYOPTIMIZATION">SCI_SETCHARACTERCATEGORYOPTIMIZATION(int countCharacters)</a><br /> <a class="message" href="#SCI_GETCHARACTERCATEGORYOPTIMIZATION">SCI_GETCHARACTERCATEGORYOPTIMIZATION → int</a><br /> - <p><b id="SCI_WORDENDPOSITION">SCI_WORDENDPOSITION(int pos, bool onlyWordCharacters) → int</b><br /> - <b id="SCI_WORDSTARTPOSITION">SCI_WORDSTARTPOSITION(int pos, bool onlyWordCharacters) → int</b><br /> + <p><b id="SCI_WORDENDPOSITION">SCI_WORDENDPOSITION(position pos, bool onlyWordCharacters) → position</b><br /> + <b id="SCI_WORDSTARTPOSITION">SCI_WORDSTARTPOSITION(position pos, bool onlyWordCharacters) → position</b><br /> 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 <a class="message" href="#SCI_SETWORDCHARS"><code>SCI_SETWORDCHARS</code></a>. The position sets the start or the search, which is forwards when searching for the end and backwards when searching for the start.</p> - <p><b id="SCI_ISRANGEWORD">SCI_ISRANGEWORD(int start, int end) → bool</b><br /> + <p><b id="SCI_ISRANGEWORD">SCI_ISRANGEWORD(position start, position end) → bool</b><br /> 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.</p> - <a class="message" href="#SCI_ISRANGEWORD">SCI_ISRANGEWORD(int start, int end) → bool</a><br /> + <a class="message" href="#SCI_ISRANGEWORD">SCI_ISRANGEWORD(position start, position end) → bool</a><br /> <p>Set <code class="parameter">onlyWordCharacters</code> to <code>true</code> (1) to stop searching at the first non-word character in the search direction. If <code class="parameter">onlyWordCharacters</code> 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.</p> <code><a class="message" href="#SCI_GETENDSTYLED">SCI_GETENDSTYLED → position</a><br /> - <a class="message" href="#SCI_STARTSTYLING">SCI_STARTSTYLING(int start, int unused)</a><br /> - <a class="message" href="#SCI_SETSTYLING">SCI_SETSTYLING(int length, int style)</a><br /> - <a class="message" href="#SCI_SETSTYLINGEX">SCI_SETSTYLINGEX(int length, const char + <a class="message" href="#SCI_STARTSTYLING">SCI_STARTSTYLING(position start, int unused)</a><br /> + <a class="message" href="#SCI_SETSTYLING">SCI_SETSTYLING(position length, int style)</a><br /> + <a class="message" href="#SCI_SETSTYLINGEX">SCI_SETSTYLINGEX(position length, const char *styles)</a><br /> <a class="message" href="#SCI_SETIDLESTYLING">SCI_SETIDLESTYLING(int idleStyling)</a><br /> <a class="message" href="#SCI_GETIDLESTYLING">SCI_GETIDLESTYLING → int</a><br /> - <a class="message" href="#SCI_SETLINESTATE">SCI_SETLINESTATE(int line, int state)</a><br /> - <a class="message" href="#SCI_GETLINESTATE">SCI_GETLINESTATE(int line) → int</a><br /> + <a class="message" href="#SCI_SETLINESTATE">SCI_SETLINESTATE(line line, int state)</a><br /> + <a class="message" href="#SCI_GETLINESTATE">SCI_GETLINESTATE(line line) → int</a><br /> <a class="message" href="#SCI_GETMAXLINESTATE">SCI_GETMAXLINESTATE → int</a><br /> </code> @@ -2660,20 +2674,20 @@ struct Sci_TextToFind { container. The container can send <code>SCI_GETENDSTYLED</code> to work out where it needs to start styling. Scintilla will always ask to style whole lines.</p> - <p><b id="SCI_STARTSTYLING">SCI_STARTSTYLING(int start, int unused)</b><br /> + <p><b id="SCI_STARTSTYLING">SCI_STARTSTYLING(position start, int unused)</b><br /> This prepares for styling by setting the styling position <code class="parameter">start</code> to start at. The unused argument was used in earlier versions but is now ignored. After <code>SCI_STARTSTYLING</code>, send multiple <code>SCI_SETSTYLING</code> messages for each lexical entity to style or send <code>SCI_SETSTYLINGEX</code> to style in blocks.</p> - <p><b id="SCI_SETSTYLING">SCI_SETSTYLING(int length, int style)</b><br /> + <p><b id="SCI_SETSTYLING">SCI_SETSTYLING(position length, int style)</b><br /> This message sets the style of <code class="parameter">length</code> characters starting at the styling position and then increases the styling position by <code class="parameter">length</code>, ready for the next call. <code>SCI_STARTSTYLING</code> should be called before the first call to this. </p> - <p><b id="SCI_SETSTYLINGEX">SCI_SETSTYLINGEX(int length, const char *styles)</b><br /> + <p><b id="SCI_SETSTYLINGEX">SCI_SETSTYLINGEX(position length, const char *styles)</b><br /> As an alternative to <code>SCI_SETSTYLING</code>, which applies the same style to each byte, you can use this message which specifies the styles for each of <code class="parameter">length</code> bytes from the styling position and then increases the styling position by <code class="parameter">length</code>, ready for @@ -2698,8 +2712,8 @@ struct Sci_TextToFind { the document is displayed wrapped. </p> - <p><b id="SCI_SETLINESTATE">SCI_SETLINESTATE(int line, int state)</b><br /> - <b id="SCI_GETLINESTATE">SCI_GETLINESTATE(int line) → int</b><br /> + <p><b id="SCI_SETLINESTATE">SCI_SETLINESTATE(line line, int state)</b><br /> + <b id="SCI_GETLINESTATE">SCI_GETLINESTATE(line line) → int</b><br /> 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 <code>SCI_SETLINESTATE</code> to set the integer @@ -3385,12 +3399,12 @@ struct Sci_TextToFind { <a class="message" href="#SCI_GETMARGINRIGHT">SCI_GETMARGINRIGHT → int</a><br /> <a class="message" href="#SCI_SETFOLDMARGINCOLOUR">SCI_SETFOLDMARGINCOLOUR(bool useSetting, colour back)</a><br /> <a class="message" href="#SCI_SETFOLDMARGINHICOLOUR">SCI_SETFOLDMARGINHICOLOUR(bool useSetting, colour fore)</a><br /> - <a class="message" href="#SCI_MARGINSETTEXT">SCI_MARGINSETTEXT(int line, const char *text)</a><br /> - <a class="message" href="#SCI_MARGINGETTEXT">SCI_MARGINGETTEXT(int line, char *text) → int</a><br /> - <a class="message" href="#SCI_MARGINSETSTYLE">SCI_MARGINSETSTYLE(int line, int style)</a><br /> - <a class="message" href="#SCI_MARGINGETSTYLE">SCI_MARGINGETSTYLE(int line) → int</a><br /> - <a class="message" href="#SCI_MARGINSETSTYLES">SCI_MARGINSETSTYLES(int line, const char *styles)</a><br /> - <a class="message" href="#SCI_MARGINGETSTYLES">SCI_MARGINGETSTYLES(int line, char *styles) → int</a><br /> + <a class="message" href="#SCI_MARGINSETTEXT">SCI_MARGINSETTEXT(line line, const char *text)</a><br /> + <a class="message" href="#SCI_MARGINGETTEXT">SCI_MARGINGETTEXT(line line, char *text) → int</a><br /> + <a class="message" href="#SCI_MARGINSETSTYLE">SCI_MARGINSETSTYLE(line line, int style)</a><br /> + <a class="message" href="#SCI_MARGINGETSTYLE">SCI_MARGINGETSTYLE(line line) → int</a><br /> + <a class="message" href="#SCI_MARGINSETSTYLES">SCI_MARGINSETSTYLES(line line, const char *styles)</a><br /> + <a class="message" href="#SCI_MARGINGETSTYLES">SCI_MARGINGETSTYLES(line line, char *styles) → int</a><br /> <a class="message" href="#SCI_MARGINTEXTCLEARALL">SCI_MARGINTEXTCLEARALL</a><br /> <a class="message" href="#SCI_MARGINSETSTYLEOFFSET">SCI_MARGINSETSTYLEOFFSET(int style)</a><br /> <a class="message" href="#SCI_MARGINGETSTYLEOFFSET">SCI_MARGINGETSTYLEOFFSET → int</a><br /> @@ -3488,12 +3502,12 @@ struct Sci_TextToFind { colour to ::GetSysColor(COLOR_3DHIGHLIGHT).</p> <p> - <b id="SCI_MARGINSETTEXT">SCI_MARGINSETTEXT(int line, const char *text)</b><br /> - <b id="SCI_MARGINGETTEXT">SCI_MARGINGETTEXT(int line, char *text) → int</b><br /> - <b id="SCI_MARGINSETSTYLE">SCI_MARGINSETSTYLE(int line, int style)</b><br /> - <b id="SCI_MARGINGETSTYLE">SCI_MARGINGETSTYLE(int line) → int</b><br /> - <b id="SCI_MARGINSETSTYLES">SCI_MARGINSETSTYLES(int line, const char *styles)</b><br /> - <b id="SCI_MARGINGETSTYLES">SCI_MARGINGETSTYLES(int line, char *styles) → int</b><br /> + <b id="SCI_MARGINSETTEXT">SCI_MARGINSETTEXT(line line, const char *text)</b><br /> + <b id="SCI_MARGINGETTEXT">SCI_MARGINGETTEXT(line line, char *text) → int</b><br /> + <b id="SCI_MARGINSETSTYLE">SCI_MARGINSETSTYLE(line line, int style)</b><br /> + <b id="SCI_MARGINGETSTYLE">SCI_MARGINGETSTYLE(line line) → int</b><br /> + <b id="SCI_MARGINSETSTYLES">SCI_MARGINSETSTYLES(line line, const char *styles)</b><br /> + <b id="SCI_MARGINGETSTYLES">SCI_MARGINGETSTYLES(line line, char *styles) → int</b><br /> <b id="SCI_MARGINTEXTCLEARALL">SCI_MARGINTEXTCLEARALL</b><br /> Text margins are created with the type SC_MARGIN_TEXT or SC_MARGIN_RTEXT. A different string may be set for each line with <code>SCI_MARGINSETTEXT</code>. @@ -3543,13 +3557,13 @@ struct Sci_TextToFind { <p><img src="annotations.png" alt="Annotations used for inline diagnostics" /></p> <code> - <a class="message" href="#SCI_ANNOTATIONSETTEXT">SCI_ANNOTATIONSETTEXT(int line, const char *text)</a><br /> - <a class="message" href="#SCI_ANNOTATIONGETTEXT">SCI_ANNOTATIONGETTEXT(int line, char *text) → int</a><br /> - <a class="message" href="#SCI_ANNOTATIONSETSTYLE">SCI_ANNOTATIONSETSTYLE(int line, int style)</a><br /> - <a class="message" href="#SCI_ANNOTATIONGETSTYLE">SCI_ANNOTATIONGETSTYLE(int line) → int</a><br /> - <a class="message" href="#SCI_ANNOTATIONSETSTYLES">SCI_ANNOTATIONSETSTYLES(int line, const char *styles)</a><br /> - <a class="message" href="#SCI_ANNOTATIONGETSTYLES">SCI_ANNOTATIONGETSTYLES(int line, char *styles) → int</a><br /> - <a class="message" href="#SCI_ANNOTATIONGETLINES">SCI_ANNOTATIONGETLINES(int line) → int</a><br /> + <a class="message" href="#SCI_ANNOTATIONSETTEXT">SCI_ANNOTATIONSETTEXT(line line, const char *text)</a><br /> + <a class="message" href="#SCI_ANNOTATIONGETTEXT">SCI_ANNOTATIONGETTEXT(line line, char *text) → int</a><br /> + <a class="message" href="#SCI_ANNOTATIONSETSTYLE">SCI_ANNOTATIONSETSTYLE(line line, int style)</a><br /> + <a class="message" href="#SCI_ANNOTATIONGETSTYLE">SCI_ANNOTATIONGETSTYLE(line line) → int</a><br /> + <a class="message" href="#SCI_ANNOTATIONSETSTYLES">SCI_ANNOTATIONSETSTYLES(line line, const char *styles)</a><br /> + <a class="message" href="#SCI_ANNOTATIONGETSTYLES">SCI_ANNOTATIONGETSTYLES(line line, char *styles) → int</a><br /> + <a class="message" href="#SCI_ANNOTATIONGETLINES">SCI_ANNOTATIONGETLINES(line line) → int</a><br /> <a class="message" href="#SCI_ANNOTATIONCLEARALL">SCI_ANNOTATIONCLEARALL</a><br /> <a class="message" href="#SCI_ANNOTATIONSETVISIBLE">SCI_ANNOTATIONSETVISIBLE(int visible)</a><br /> <a class="message" href="#SCI_ANNOTATIONGETVISIBLE">SCI_ANNOTATIONGETVISIBLE → int</a><br /> @@ -3558,13 +3572,13 @@ struct Sci_TextToFind { </code> <p> - <b id="SCI_ANNOTATIONSETTEXT">SCI_ANNOTATIONSETTEXT(int line, const char *text)</b><br /> - <b id="SCI_ANNOTATIONGETTEXT">SCI_ANNOTATIONGETTEXT(int line, char *text) → int</b><br /> - <b id="SCI_ANNOTATIONSETSTYLE">SCI_ANNOTATIONSETSTYLE(int line, int style)</b><br /> - <b id="SCI_ANNOTATIONGETSTYLE">SCI_ANNOTATIONGETSTYLE(int line) → int</b><br /> - <b id="SCI_ANNOTATIONSETSTYLES">SCI_ANNOTATIONSETSTYLES(int line, const char *styles)</b><br /> - <b id="SCI_ANNOTATIONGETSTYLES">SCI_ANNOTATIONGETSTYLES(int line, char *styles) → int</b><br /> - <b id="SCI_ANNOTATIONGETLINES">SCI_ANNOTATIONGETLINES(int line) → int</b><br /> + <b id="SCI_ANNOTATIONSETTEXT">SCI_ANNOTATIONSETTEXT(line line, const char *text)</b><br /> + <b id="SCI_ANNOTATIONGETTEXT">SCI_ANNOTATIONGETTEXT(line line, char *text) → int</b><br /> + <b id="SCI_ANNOTATIONSETSTYLE">SCI_ANNOTATIONSETSTYLE(line line, int style)</b><br /> + <b id="SCI_ANNOTATIONGETSTYLE">SCI_ANNOTATIONGETSTYLE(line line) → int</b><br /> + <b id="SCI_ANNOTATIONSETSTYLES">SCI_ANNOTATIONSETSTYLES(line line, const char *styles)</b><br /> + <b id="SCI_ANNOTATIONGETSTYLES">SCI_ANNOTATIONGETSTYLES(line line, char *styles) → int</b><br /> + <b id="SCI_ANNOTATIONGETLINES">SCI_ANNOTATIONGETLINES(line line) → int</b><br /> <b id="SCI_ANNOTATIONCLEARALL">SCI_ANNOTATIONCLEARALL</b><br /> A different string may be set for each line with <code>SCI_ANNOTATIONSETTEXT</code>. To clear annotations call <code>SCI_ANNOTATIONSETTEXT</code> with a NULL pointer. @@ -3822,15 +3836,15 @@ struct Sci_TextToFind { but with the need to indicate that Scintilla has the logical focus.</p> <h2 id="BraceHighlighting">Brace highlighting</h2> - <code><a class="message" href="#SCI_BRACEHIGHLIGHT">SCI_BRACEHIGHLIGHT(int posA, int + <code><a class="message" href="#SCI_BRACEHIGHLIGHT">SCI_BRACEHIGHLIGHT(position posA, position posB)</a><br /> - <a class="message" href="#SCI_BRACEBADLIGHT">SCI_BRACEBADLIGHT(int pos)</a><br /> + <a class="message" href="#SCI_BRACEBADLIGHT">SCI_BRACEBADLIGHT(position pos)</a><br /> <a class="message" href="#SCI_BRACEHIGHLIGHTINDICATOR">SCI_BRACEHIGHLIGHTINDICATOR(bool useSetting, int indicator)</a><br /> <a class="message" href="#SCI_BRACEBADLIGHTINDICATOR">SCI_BRACEBADLIGHTINDICATOR(bool useSetting, int indicator)</a><br /> - <a class="message" href="#SCI_BRACEMATCH">SCI_BRACEMATCH(int pos, int maxReStyle) → position</a><br /> + <a class="message" href="#SCI_BRACEMATCH">SCI_BRACEMATCH(position pos, int maxReStyle) → position</a><br /> </code> - <p><b id="SCI_BRACEHIGHLIGHT">SCI_BRACEHIGHLIGHT(int posA, int posB)</b><br /> + <p><b id="SCI_BRACEHIGHLIGHT">SCI_BRACEHIGHLIGHT(position posA, position posB)</b><br /> Up to two characters can be highlighted in a 'brace highlighting style', which is defined as style number <a class="message" href="#StyleDefinition"><code>STYLE_BRACELIGHT</code></a> (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"><code>SCI_GETCOLUMN</code></a> and highlight the indent with <a class="message" href="#SCI_SETHIGHLIGHTGUIDE"><code>SCI_SETHIGHLIGHTGUIDE</code></a>.</p> - <p><b id="SCI_BRACEBADLIGHT">SCI_BRACEBADLIGHT(int pos)</b><br /> + <p><b id="SCI_BRACEBADLIGHT">SCI_BRACEBADLIGHT(position pos)</b><br /> If there is no matching brace then the <a class="jump" href="#StyleDefinition">brace badlighting style</a>, style <code>STYLE_BRACEBAD</code> (35), can be used to show the brace that is unmatched. Using a position of <code>INVALID_POSITION</code> (-1) removes the @@ -3850,7 +3864,7 @@ struct Sci_TextToFind { <p><b id="SCI_BRACEBADLIGHTINDICATOR">SCI_BRACEBADLIGHTINDICATOR(bool useSetting, int indicator)</b><br /> Use specified indicator to highlight non matching brace instead of changing its style.</p> - <p><b id="SCI_BRACEMATCH">SCI_BRACEMATCH(int pos, int maxReStyle) → position</b><br /> + <p><b id="SCI_BRACEMATCH">SCI_BRACEMATCH(position pos, int maxReStyle) → position</b><br /> The <code>SCI_BRACEMATCH</code> message finds a corresponding matching brace given <code class="parameter">pos</code>, 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.</p> <code><a class="message" href="#SCI_SETTABWIDTH">SCI_SETTABWIDTH(int tabWidth)</a><br /> <a class="message" href="#SCI_GETTABWIDTH">SCI_GETTABWIDTH → int</a><br /> - <a class="message" href="#SCI_CLEARTABSTOPS">SCI_CLEARTABSTOPS(int line)</a><br /> - <a class="message" href="#SCI_ADDTABSTOP">SCI_ADDTABSTOP(int line, int x)</a><br /> - <a class="message" href="#SCI_GETNEXTTABSTOP">SCI_GETNEXTTABSTOP(int line, int x) → int</a><br /> + <a class="message" href="#SCI_CLEARTABSTOPS">SCI_CLEARTABSTOPS(line line)</a><br /> + <a class="message" href="#SCI_ADDTABSTOP">SCI_ADDTABSTOP(line line, int x)</a><br /> + <a class="message" href="#SCI_GETNEXTTABSTOP">SCI_GETNEXTTABSTOP(line line, int x) → int</a><br /> <a class="message" href="#SCI_SETUSETABS">SCI_SETUSETABS(bool useTabs)</a><br /> <a class="message" href="#SCI_GETUSETABS">SCI_GETUSETABS → bool</a><br /> <a class="message" href="#SCI_SETINDENT">SCI_SETINDENT(int indentSize)</a><br /> @@ -3893,14 +3907,14 @@ struct Sci_TextToFind { <a class="message" href="#SCI_SETBACKSPACEUNINDENTS">SCI_SETBACKSPACEUNINDENTS(bool bsUnIndents)</a><br /> <a class="message" href="#SCI_GETBACKSPACEUNINDENTS">SCI_GETBACKSPACEUNINDENTS → bool</a><br /> - <a class="message" href="#SCI_SETLINEINDENTATION">SCI_SETLINEINDENTATION(int line, int + <a class="message" href="#SCI_SETLINEINDENTATION">SCI_SETLINEINDENTATION(line line, int indentation)</a><br /> - <a class="message" href="#SCI_GETLINEINDENTATION">SCI_GETLINEINDENTATION(int line) → int</a><br /> - <a class="message" href="#SCI_GETLINEINDENTPOSITION">SCI_GETLINEINDENTPOSITION(int line) → position</a><br /> + <a class="message" href="#SCI_GETLINEINDENTATION">SCI_GETLINEINDENTATION(line line) → int</a><br /> + <a class="message" href="#SCI_GETLINEINDENTPOSITION">SCI_GETLINEINDENTPOSITION(line line) → position</a><br /> <a class="message" href="#SCI_SETINDENTATIONGUIDES">SCI_SETINDENTATIONGUIDES(int indentView)</a><br /> <a class="message" href="#SCI_GETINDENTATIONGUIDES">SCI_GETINDENTATIONGUIDES → int</a><br /> - <a class="message" href="#SCI_SETHIGHLIGHTGUIDE">SCI_SETHIGHLIGHTGUIDE(int column)</a><br /> - <a class="message" href="#SCI_GETHIGHLIGHTGUIDE">SCI_GETHIGHLIGHTGUIDE → int</a><br /> + <a class="message" href="#SCI_SETHIGHLIGHTGUIDE">SCI_SETHIGHLIGHTGUIDE(position column)</a><br /> + <a class="message" href="#SCI_GETHIGHLIGHTGUIDE">SCI_GETHIGHLIGHTGUIDE → position</a><br /> </code> <p><b id="SCI_SETTABWIDTH">SCI_SETTABWIDTH(int tabWidth)</b><br /> @@ -3909,9 +3923,9 @@ struct Sci_TextToFind { character in <code>STYLE_DEFAULT</code>. 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.</p> - <p><b id="SCI_CLEARTABSTOPS">SCI_CLEARTABSTOPS(int line)</b><br /> - <b id="SCI_ADDTABSTOP">SCI_ADDTABSTOP(int line, int x)</b><br /> - <b id="SCI_GETNEXTTABSTOP">SCI_GETNEXTTABSTOP(int line, int x) → int</b><br /> + <p><b id="SCI_CLEARTABSTOPS">SCI_CLEARTABSTOPS(line line)</b><br /> + <b id="SCI_ADDTABSTOP">SCI_ADDTABSTOP(line line, int x)</b><br /> + <b id="SCI_GETNEXTTABSTOP">SCI_GETNEXTTABSTOP(line line, int x) → int</b><br /> <code>SCI_CLEARTABSTOPS</code> clears explicit tabstops on a line. <code>SCI_ADDTABSTOP</code> adds an explicit tabstop at the specified distance from the left (in pixels), and <code>SCI_GETNEXTTABSTOP</code> 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 <code>SCI_SETTABINDENTS</code> and <code>SCI_SETBACKSPACEUNINDENTS</code> functions.</p> - <p><b id="SCI_SETLINEINDENTATION">SCI_SETLINEINDENTATION(int line, int indentation)</b><br /> - <b id="SCI_GETLINEINDENTATION">SCI_GETLINEINDENTATION(int line) → int</b><br /> + <p><b id="SCI_SETLINEINDENTATION">SCI_SETLINEINDENTATION(line line, int indentation)</b><br /> + <b id="SCI_GETLINEINDENTATION">SCI_GETLINEINDENTATION(line line) → int</b><br /> The amount of indentation on a line can be discovered and set with <code>SCI_GETLINEINDENTATION</code> and <code>SCI_SETLINEINDENTATION</code>. The indentation is measured in character columns, which correspond to the width of space characters.</p> - <p><b id="SCI_GETLINEINDENTPOSITION">SCI_GETLINEINDENTPOSITION(int line) → position</b><br /> + <p><b id="SCI_GETLINEINDENTPOSITION">SCI_GETLINEINDENTPOSITION(line line) → position</b><br /> This returns the position at the end of indentation of a line.</p> <p><b id="SCI_SETINDENTATIONGUIDES">SCI_SETINDENTATIONGUIDES(int indentView)</b><br /> @@ -3994,8 +4008,8 @@ struct Sci_TextToFind { </tbody> </table> - <p><b id="SCI_SETHIGHLIGHTGUIDE">SCI_SETHIGHLIGHTGUIDE(int column)</b><br /> - <b id="SCI_GETHIGHLIGHTGUIDE">SCI_GETHIGHLIGHTGUIDE → int</b><br /> + <p><b id="SCI_SETHIGHLIGHTGUIDE">SCI_SETHIGHLIGHTGUIDE(position column)</b><br /> + <b id="SCI_GETHIGHLIGHTGUIDE">SCI_GETHIGHLIGHTGUIDE → position</b><br /> When brace highlighting occurs, the indentation guide corresponding to the braces may be highlighted with the brace highlighting style, <a class="message" href="#StyleDefinition"><code>STYLE_BRACELIGHT</code></a> (34). Set <code class="parameter">column</code> to 0 to @@ -4042,14 +4056,14 @@ struct Sci_TextToFind { back)</a><br /> <a class="message" href="#SCI_MARKERENABLEHIGHLIGHT">SCI_MARKERENABLEHIGHLIGHT(bool enabled)</a><br /> <a class="message" href="#SCI_MARKERSETALPHA">SCI_MARKERSETALPHA(int markerNumber, alpha alpha)</a><br /> - <a class="message" href="#SCI_MARKERADD">SCI_MARKERADD(int line, int markerNumber) → int</a><br /> - <a class="message" href="#SCI_MARKERADDSET">SCI_MARKERADDSET(int line, int markerSet)</a><br /> - <a class="message" href="#SCI_MARKERDELETE">SCI_MARKERDELETE(int line, int + <a class="message" href="#SCI_MARKERADD">SCI_MARKERADD(line line, int markerNumber) → int</a><br /> + <a class="message" href="#SCI_MARKERADDSET">SCI_MARKERADDSET(line line, int markerSet)</a><br /> + <a class="message" href="#SCI_MARKERDELETE">SCI_MARKERDELETE(line line, int markerNumber)</a><br /> <a class="message" href="#SCI_MARKERDELETEALL">SCI_MARKERDELETEALL(int markerNumber)</a><br /> - <a class="message" href="#SCI_MARKERGET">SCI_MARKERGET(int line) → int</a><br /> - <a class="message" href="#SCI_MARKERNEXT">SCI_MARKERNEXT(int lineStart, int markerMask) → int</a><br /> - <a class="message" href="#SCI_MARKERPREVIOUS">SCI_MARKERPREVIOUS(int lineStart, int markerMask) → int</a><br /> + <a class="message" href="#SCI_MARKERGET">SCI_MARKERGET(line line) → int</a><br /> + <a class="message" href="#SCI_MARKERNEXT">SCI_MARKERNEXT(line lineStart, int markerMask) → line</a><br /> + <a class="message" href="#SCI_MARKERPREVIOUS">SCI_MARKERPREVIOUS(line lineStart, int markerMask) → line</a><br /> <a class="message" href="#SCI_MARKERLINEFROMHANDLE">SCI_MARKERLINEFROMHANDLE(int markerHandle) → int</a><br /> <a class="message" href="#SCI_MARKERDELETEHANDLE">SCI_MARKERDELETEHANDLE(int markerHandle)</a><br /> </code> @@ -4264,7 +4278,7 @@ struct Sci_TextToFind { they are of <code>SC_MARK_BACKGROUND</code> or <code>SC_MARK_UNDERLINE</code> types, they may be drawn translucently by setting an alpha value.</p> - <p><b id="SCI_MARKERADD">SCI_MARKERADD(int line, int markerNumber) → int</b><br /> + <p><b id="SCI_MARKERADD">SCI_MARKERADD(line line, int markerNumber) → int</b><br /> This message adds marker number <code class="parameter">markerNumber</code> 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 <a class="seealso" @@ -4274,7 +4288,7 @@ struct Sci_TextToFind { based on its handle. The message does not check the value of markerNumber, nor does it check if the line already contains the marker.</p> - <p><b id="SCI_MARKERADDSET">SCI_MARKERADDSET(int line, int markerSet)</b><br /> + <p><b id="SCI_MARKERADDSET">SCI_MARKERADDSET(line line, int markerSet)</b><br /> 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 <a class="message" href="#SCI_MARKERGET"><code>SCI_MARKERGET</code></a> (and used by the mask-based marker search functions @@ -4284,7 +4298,7 @@ struct Sci_TextToFind { <a class="message" href="#SCI_MARKERADD"><code>SCI_MARKERADD</code></a>, no check is made to see if any of the markers are already present on the targeted line.</p> - <p><b id="SCI_MARKERDELETE">SCI_MARKERDELETE(int line, int markerNumber)</b><br /> + <p><b id="SCI_MARKERDELETE">SCI_MARKERDELETE(line line, int markerNumber)</b><br /> 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.</p> - <p><b id="SCI_MARKERGET">SCI_MARKERGET(int line) → int</b><br /> + <p><b id="SCI_MARKERGET">SCI_MARKERGET(line line) → int</b><br /> 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.</p> - <p><b id="SCI_MARKERNEXT">SCI_MARKERNEXT(int lineStart, int markerMask) → int</b><br /> - <b id="SCI_MARKERPREVIOUS">SCI_MARKERPREVIOUS(int lineStart, int markerMask) → int</b><br /> + <p><b id="SCI_MARKERNEXT">SCI_MARKERNEXT(line lineStart, int markerMask) → line</b><br /> + <b id="SCI_MARKERPREVIOUS">SCI_MARKERPREVIOUS(line lineStart, int markerMask) → line</b><br /> These messages search efficiently for lines that include a given set of markers. The search starts at line number <code class="parameter">lineStart</code> and continues forwards to the end of the file (<code>SCI_MARKERNEXT</code>) or backwards to the start of the file @@ -4377,15 +4391,15 @@ struct Sci_TextToFind { <a class="message" href="#SCI_GETINDICATORCURRENT">SCI_GETINDICATORCURRENT → int</a><br /> <a class="message" href="#SCI_SETINDICATORVALUE">SCI_SETINDICATORVALUE(int value)</a><br /> <a class="message" href="#SCI_GETINDICATORVALUE">SCI_GETINDICATORVALUE → int</a><br /> - <a class="message" href="#SCI_INDICATORFILLRANGE">SCI_INDICATORFILLRANGE(int start, int lengthFill)</a><br /> - <a class="message" href="#SCI_INDICATORCLEARRANGE">SCI_INDICATORCLEARRANGE(int start, int lengthClear)</a><br /> - <a class="message" href="#SCI_INDICATORALLONFOR">SCI_INDICATORALLONFOR(int pos) → int</a><br /> - <a class="message" href="#SCI_INDICATORVALUEAT">SCI_INDICATORVALUEAT(int indicator, int pos) → int</a><br /> - <a class="message" href="#SCI_INDICATORSTART">SCI_INDICATORSTART(int indicator, int pos) → int</a><br /> - <a class="message" href="#SCI_INDICATOREND">SCI_INDICATOREND(int indicator, int pos) → int</a><br /> - - <a class="message" href="#SCI_FINDINDICATORSHOW">SCI_FINDINDICATORSHOW(int start, int end)</a><br /> - <a class="message" href="#SCI_FINDINDICATORFLASH">SCI_FINDINDICATORFLASH(int start, int end)</a><br /> + <a class="message" href="#SCI_INDICATORFILLRANGE">SCI_INDICATORFILLRANGE(position start, position lengthFill)</a><br /> + <a class="message" href="#SCI_INDICATORCLEARRANGE">SCI_INDICATORCLEARRANGE(position start, position lengthClear)</a><br /> + <a class="message" href="#SCI_INDICATORALLONFOR">SCI_INDICATORALLONFOR(position pos) → int</a><br /> + <a class="message" href="#SCI_INDICATORVALUEAT">SCI_INDICATORVALUEAT(int indicator, position pos) → int</a><br /> + <a class="message" href="#SCI_INDICATORSTART">SCI_INDICATORSTART(int indicator, position pos) → int</a><br /> + <a class="message" href="#SCI_INDICATOREND">SCI_INDICATOREND(int indicator, position pos) → int</a><br /> + + <a class="message" href="#SCI_FINDINDICATORSHOW">SCI_FINDINDICATORSHOW(position start, position end)</a><br /> + <a class="message" href="#SCI_FINDINDICATORFLASH">SCI_FINDINDICATORFLASH(position start, position end)</a><br /> <a class="message" href="#SCI_FINDINDICATORHIDE">SCI_FINDINDICATORHIDE</a><br /> </code> @@ -4673,8 +4687,8 @@ struct Sci_TextToFind { <b id="SCI_SETINDICATORCURRENT">SCI_SETINDICATORCURRENT(int indicator)</b><br /> <b id="SCI_GETINDICATORCURRENT">SCI_GETINDICATORCURRENT → int</b><br /> These two messages set and get the indicator that will be affected by calls to - <a class="message" href="#SCI_INDICATORFILLRANGE">SCI_INDICATORFILLRANGE(int start, int lengthFill)</a> and - <a class="message" href="#SCI_INDICATORCLEARRANGE">SCI_INDICATORCLEARRANGE(int start, int lengthClear)</a>. + <a class="message" href="#SCI_INDICATORFILLRANGE">SCI_INDICATORFILLRANGE(position start, position lengthFill)</a> and + <a class="message" href="#SCI_INDICATORCLEARRANGE">SCI_INDICATORCLEARRANGE(position start, position lengthClear)</a>. </p> <p> @@ -4685,27 +4699,27 @@ struct Sci_TextToFind { </p> <p> - <b id="SCI_INDICATORFILLRANGE">SCI_INDICATORFILLRANGE(int start, int lengthFill)</b><br /> - <b id="SCI_INDICATORCLEARRANGE">SCI_INDICATORCLEARRANGE(int start, int lengthClear)</b><br /> + <b id="SCI_INDICATORFILLRANGE">SCI_INDICATORFILLRANGE(position start, position lengthFill)</b><br /> + <b id="SCI_INDICATORCLEARRANGE">SCI_INDICATORCLEARRANGE(position start, position lengthClear)</b><br /> These two messages fill or clear a range for the current indicator. <code>SCI_INDICATORFILLRANGE</code> fills with the the current value. </p> <p> - <b id="SCI_INDICATORALLONFOR">SCI_INDICATORALLONFOR(int pos) → int</b><br /> + <b id="SCI_INDICATORALLONFOR">SCI_INDICATORALLONFOR(position pos) → int</b><br /> 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. </p> <p> - <b id="SCI_INDICATORVALUEAT">SCI_INDICATORVALUEAT(int indicator, int pos) → int</b><br /> + <b id="SCI_INDICATORVALUEAT">SCI_INDICATORVALUEAT(int indicator, position pos) → int</b><br /> Retrieve the value of a particular indicator at a position. </p> <p> - <b id="SCI_INDICATORSTART">SCI_INDICATORSTART(int indicator, int pos) → int</b><br /> - <b id="SCI_INDICATOREND">SCI_INDICATOREND(int indicator, int pos) → int</b><br /> + <b id="SCI_INDICATORSTART">SCI_INDICATORSTART(int indicator, position pos) → int</b><br /> + <b id="SCI_INDICATOREND">SCI_INDICATOREND(int indicator, position pos) → int</b><br /> 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. </p> @@ -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.</p> - <p><b id="SCI_FINDINDICATORSHOW">SCI_FINDINDICATORSHOW(int start, int end)</b><br /> - <b id="SCI_FINDINDICATORFLASH">SCI_FINDINDICATORFLASH(int start, int end)</b><br /> + <p><b id="SCI_FINDINDICATORSHOW">SCI_FINDINDICATORSHOW(position start, position end)</b><br /> + <b id="SCI_FINDINDICATORFLASH">SCI_FINDINDICATORFLASH(position start, position end)</b><br /> These two messages show and animate the find indicator. The indicator remains visible with <code>SCI_FINDINDICATORSHOW</code> and fades out after showing for half a second with <code>SCI_FINDINDICATORFLASH</code>. @@ -4759,7 +4773,7 @@ struct Sci_TextToFind { <p>To make use of autocompletion you must monitor each character added to the document. See <code>SciTEBase::CharAdded()</code> in SciTEBase.cxx for an example of autocompletion.</p> - <code><a class="message" href="#SCI_AUTOCSHOW">SCI_AUTOCSHOW(int lengthEntered, const char + <code><a class="message" href="#SCI_AUTOCSHOW">SCI_AUTOCSHOW(position lengthEntered, const char *itemList)</a><br /> <a class="message" href="#SCI_AUTOCCANCEL">SCI_AUTOCCANCEL</a><br /> <a class="message" href="#SCI_AUTOCACTIVE">SCI_AUTOCACTIVE → bool</a><br /> @@ -4807,7 +4821,7 @@ struct Sci_TextToFind { <a class="message" href="#SCI_AUTOCGETMAXWIDTH">SCI_AUTOCGETMAXWIDTH → int</a><br /> </code> - <p><b id="SCI_AUTOCSHOW">SCI_AUTOCSHOW(int lengthEntered, const char *itemList)</b><br /> + <p><b id="SCI_AUTOCSHOW">SCI_AUTOCSHOW(position lengthEntered, const char *itemList)</b><br /> This message causes a list to be displayed. <code class="parameter">lengthEntered</code> is the number of characters of the word already entered and <code class="parameter">itemList</code> 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</a></code>. 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.</p> - <code><a class="message" href="#SCI_CALLTIPSHOW">SCI_CALLTIPSHOW(int pos, const char + <code><a class="message" href="#SCI_CALLTIPSHOW">SCI_CALLTIPSHOW(position pos, const char *definition)</a><br /> <a class="message" href="#SCI_CALLTIPCANCEL">SCI_CALLTIPCANCEL</a><br /> <a class="message" href="#SCI_CALLTIPACTIVE">SCI_CALLTIPACTIVE → bool</a><br /> <a class="message" href="#SCI_CALLTIPPOSSTART">SCI_CALLTIPPOSSTART → position</a><br /> - <a class="message" href="#SCI_CALLTIPSETPOSSTART">SCI_CALLTIPSETPOSSTART(int posStart)</a><br /> + <a class="message" href="#SCI_CALLTIPSETPOSSTART">SCI_CALLTIPSETPOSSTART(position posStart)</a><br /> <a class="message" href="#SCI_CALLTIPSETHLT">SCI_CALLTIPSETHLT(int highlightStart, int highlightEnd)</a><br /> <a class="message" href="#SCI_CALLTIPSETBACK">SCI_CALLTIPSETBACK(colour back)</a><br /> @@ -5050,7 +5064,7 @@ struct Sci_TextToFind { <a class="message" href="#SCI_CALLTIPSETPOSITION">SCI_CALLTIPSETPOSITION(bool above)</a><br /> </code> - <p><b id="SCI_CALLTIPSHOW">SCI_CALLTIPSHOW(int pos, const char *definition)</b><br /> + <p><b id="SCI_CALLTIPSHOW">SCI_CALLTIPSHOW(position pos, const char *definition)</b><br /> This message starts the process by displaying the call tip window. If a call tip is already active, this has no effect.<br /> <code class="parameter">pos</code> 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.</p> <p><b id="SCI_CALLTIPPOSSTART">SCI_CALLTIPPOSSTART → position</b><br /> - <b id="SCI_CALLTIPSETPOSSTART">SCI_CALLTIPSETPOSSTART(int posStart)</b><br /> + <b id="SCI_CALLTIPSETPOSSTART">SCI_CALLTIPSETPOSSTART(position posStart)</b><br /> This message returns or sets the value of the current position when <code>SCI_CALLTIPSHOW</code> started to display the tip.</p> @@ -5710,7 +5724,7 @@ struct Sci_RangeToFormat { <code><a class="message" href="#SCI_GETDIRECTFUNCTION">SCI_GETDIRECTFUNCTION → int</a><br /> <a class="message" href="#SCI_GETDIRECTPOINTER">SCI_GETDIRECTPOINTER → int</a><br /> <a class="message" href="#SCI_GETCHARACTERPOINTER">SCI_GETCHARACTERPOINTER → int</a><br /> - <a class="message" href="#SCI_GETRANGEPOINTER">SCI_GETRANGEPOINTER(int start, int lengthRange) → int</a><br /> + <a class="message" href="#SCI_GETRANGEPOINTER">SCI_GETRANGEPOINTER(position start, position lengthRange) → int</a><br /> <a class="message" href="#SCI_GETGAPPOSITION">SCI_GETGAPPOSITION → position</a><br /> </code> @@ -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.</p> <p><b id="SCI_GETCHARACTERPOINTER">SCI_GETCHARACTERPOINTER → int</b><br /> - <b id="SCI_GETRANGEPOINTER">SCI_GETRANGEPOINTER(int start, int lengthRange) → int</b><br /> + <b id="SCI_GETRANGEPOINTER">SCI_GETRANGEPOINTER(position start, position lengthRange) → int</b><br /> <b id="SCI_GETGAPPOSITION">SCI_GETGAPPOSITION → position</b><br /> Grant temporary direct read-only access to the memory used by Scintilla to store the document.</p> @@ -5806,7 +5820,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ <code><a class="message" href="#SCI_GETDOCPOINTER">SCI_GETDOCPOINTER → document *</a><br /> <a class="message" href="#SCI_SETDOCPOINTER">SCI_SETDOCPOINTER(<unused>, document *doc)</a><br /> - <a class="message" href="#SCI_CREATEDOCUMENT">SCI_CREATEDOCUMENT(int bytes, int documentOptions) → document *</a><br /> + <a class="message" href="#SCI_CREATEDOCUMENT">SCI_CREATEDOCUMENT(position bytes, int documentOptions) → document *</a><br /> <a class="message" href="#SCI_ADDREFDOCUMENT">SCI_ADDREFDOCUMENT(<unused>, document *doc)</a><br /> <a class="message" href="#SCI_RELEASEDOCUMENT">SCI_RELEASEDOCUMENT(<unused>, document @@ -5828,7 +5842,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ window.<br /> 6. If <code class="parameter">doc</code> was not 0, its reference count is increased by 1.</p> - <p><b id="SCI_CREATEDOCUMENT">SCI_CREATEDOCUMENT(int bytes, int documentOptions) → document *</b><br /> + <p><b id="SCI_CREATEDOCUMENT">SCI_CREATEDOCUMENT(position bytes, int documentOptions) → document *</b><br /> 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){ <h3 id="BackgroundLoad">Loading in the background</h3> - <code><a class="message" href="#SCI_CREATELOADER">SCI_CREATELOADER(int bytes, int documentOptions) → int</a><br /> + <code><a class="message" href="#SCI_CREATELOADER">SCI_CREATELOADER(position bytes, int documentOptions) → int</a><br /> </code> <p>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){ <p>To avoid these issues, a loader object may be created and used to load the file. The loader object supports the ILoader interface.</p> - <p><b id="SCI_CREATELOADER">SCI_CREATELOADER(int bytes, int documentOptions) → int</b><br /> + <p><b id="SCI_CREATELOADER">SCI_CREATELOADER(position bytes, int documentOptions) → int</b><br /> Create an object that supports the <code>ILoader</code> interface which can be used to load data and then be turned into a Scintilla document object for attachment to a view object. The <code class="parameter">bytes</code> 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 <code>"fold"</code> property should be set to <code>"1"</code> with <code>SCI_SETPROPERTY("fold", "1")</code> to enable folding. </p> - <code><a class="message" href="#SCI_VISIBLEFROMDOCLINE">SCI_VISIBLEFROMDOCLINE(int docLine) → int</a><br /> - <a class="message" href="#SCI_DOCLINEFROMVISIBLE">SCI_DOCLINEFROMVISIBLE(int displayLine) → int</a><br /> - <a class="message" href="#SCI_SHOWLINES">SCI_SHOWLINES(int lineStart, int lineEnd)</a><br /> - <a class="message" href="#SCI_HIDELINES">SCI_HIDELINES(int lineStart, int lineEnd)</a><br /> - <a class="message" href="#SCI_GETLINEVISIBLE">SCI_GETLINEVISIBLE(int line) → bool</a><br /> + <code><a class="message" href="#SCI_VISIBLEFROMDOCLINE">SCI_VISIBLEFROMDOCLINE(line docLine) → line</a><br /> + <a class="message" href="#SCI_DOCLINEFROMVISIBLE">SCI_DOCLINEFROMVISIBLE(line displayLine) → line</a><br /> + <a class="message" href="#SCI_SHOWLINES">SCI_SHOWLINES(line lineStart, line lineEnd)</a><br /> + <a class="message" href="#SCI_HIDELINES">SCI_HIDELINES(line lineStart, line lineEnd)</a><br /> + <a class="message" href="#SCI_GETLINEVISIBLE">SCI_GETLINEVISIBLE(line line) → bool</a><br /> <a class="message" href="#SCI_GETALLLINESVISIBLE">SCI_GETALLLINESVISIBLE → bool</a><br /> - <a class="message" href="#SCI_SETFOLDLEVEL">SCI_SETFOLDLEVEL(int line, int level)</a><br /> - <a class="message" href="#SCI_GETFOLDLEVEL">SCI_GETFOLDLEVEL(int line) → int</a><br /> + <a class="message" href="#SCI_SETFOLDLEVEL">SCI_SETFOLDLEVEL(line line, int level)</a><br /> + <a class="message" href="#SCI_GETFOLDLEVEL">SCI_GETFOLDLEVEL(line line) → int</a><br /> <a class="message" href="#SCI_SETAUTOMATICFOLD">SCI_SETAUTOMATICFOLD(int automaticFold)</a><br /> <a class="message" href="#SCI_GETAUTOMATICFOLD">SCI_GETAUTOMATICFOLD → int</a><br /> <a class="message" href="#SCI_SETFOLDFLAGS">SCI_SETFOLDFLAGS(int flags)</a><br /> - <a class="message" href="#SCI_GETLASTCHILD">SCI_GETLASTCHILD(int line, int level) → int</a><br /> - <a class="message" href="#SCI_GETFOLDPARENT">SCI_GETFOLDPARENT(int line) → int</a><br /> - <a class="message" href="#SCI_SETFOLDEXPANDED">SCI_SETFOLDEXPANDED(int line, bool + <a class="message" href="#SCI_GETLASTCHILD">SCI_GETLASTCHILD(line line, int level) → line</a><br /> + <a class="message" href="#SCI_GETFOLDPARENT">SCI_GETFOLDPARENT(line line) → line</a><br /> + <a class="message" href="#SCI_SETFOLDEXPANDED">SCI_SETFOLDEXPANDED(line line, bool expanded)</a><br /> - <a class="message" href="#SCI_GETFOLDEXPANDED">SCI_GETFOLDEXPANDED(int line) → bool</a><br /> - <a class="message" href="#SCI_CONTRACTEDFOLDNEXT">SCI_CONTRACTEDFOLDNEXT(int lineStart) → int</a><br /> - <a class="message" href="#SCI_TOGGLEFOLD">SCI_TOGGLEFOLD(int line)</a><br /> - <a class="message" href="#SCI_TOGGLEFOLDSHOWTEXT">SCI_TOGGLEFOLDSHOWTEXT(int line, const char *text)</a><br /> + <a class="message" href="#SCI_GETFOLDEXPANDED">SCI_GETFOLDEXPANDED(line line) → bool</a><br /> + <a class="message" href="#SCI_CONTRACTEDFOLDNEXT">SCI_CONTRACTEDFOLDNEXT(line lineStart) → line</a><br /> + <a class="message" href="#SCI_TOGGLEFOLD">SCI_TOGGLEFOLD(line line)</a><br /> + <a class="message" href="#SCI_TOGGLEFOLDSHOWTEXT">SCI_TOGGLEFOLDSHOWTEXT(line line, const char *text)</a><br /> <a class="message" href="#SCI_FOLDDISPLAYTEXTSETSTYLE">SCI_FOLDDISPLAYTEXTSETSTYLE(int style)</a><br /> <a class="message" href="#SCI_FOLDDISPLAYTEXTGETSTYLE">SCI_FOLDDISPLAYTEXTGETSTYLE → int</a><br /> <a class="message" href="#SCI_SETDEFAULTFOLDDISPLAYTEXT">SCI_SETDEFAULTFOLDDISPLAYTEXT(<unused>, const char *text)</a><br /> <a class="message" href="#SCI_GETDEFAULTFOLDDISPLAYTEXT">SCI_GETDEFAULTFOLDDISPLAYTEXT(<unused>, char *text) → int</a><br /> - <a class="message" href="#SCI_FOLDLINE">SCI_FOLDLINE(int line, int action)</a><br /> - <a class="message" href="#SCI_FOLDCHILDREN">SCI_FOLDCHILDREN(int line, int action)</a><br /> + <a class="message" href="#SCI_FOLDLINE">SCI_FOLDLINE(line line, int action)</a><br /> + <a class="message" href="#SCI_FOLDCHILDREN">SCI_FOLDCHILDREN(line line, int action)</a><br /> <a class="message" href="#SCI_FOLDALL">SCI_FOLDALL(int action)</a><br /> - <a class="message" href="#SCI_EXPANDCHILDREN">SCI_EXPANDCHILDREN(int line, int level)</a><br /> - <a class="message" href="#SCI_ENSUREVISIBLE">SCI_ENSUREVISIBLE(int line)</a><br /> - <a class="message" href="#SCI_ENSUREVISIBLEENFORCEPOLICY">SCI_ENSUREVISIBLEENFORCEPOLICY(int + <a class="message" href="#SCI_EXPANDCHILDREN">SCI_EXPANDCHILDREN(line line, int level)</a><br /> + <a class="message" href="#SCI_ENSUREVISIBLE">SCI_ENSUREVISIBLE(line line)</a><br /> + <a class="message" href="#SCI_ENSUREVISIBLEENFORCEPOLICY">SCI_ENSUREVISIBLEENFORCEPOLICY(line line)</a><br /> </code> - <p><b id="SCI_VISIBLEFROMDOCLINE">SCI_VISIBLEFROMDOCLINE(int docLine) → int</b><br /> + <p><b id="SCI_VISIBLEFROMDOCLINE">SCI_VISIBLEFROMDOCLINE(line docLine) → line</b><br /> 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){ <code class="parameter">docLine</code> 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.</p> - <p><b id="SCI_DOCLINEFROMVISIBLE">SCI_DOCLINEFROMVISIBLE(int displayLine) → int</b><br /> + <p><b id="SCI_DOCLINEFROMVISIBLE">SCI_DOCLINEFROMVISIBLE(line displayLine) → line</b><br /> 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){ <code class="parameter">displayLine</code> is greater than or equal to the number of displayed lines, the result is the number of lines in the document.</p> - <p><b id="SCI_SHOWLINES">SCI_SHOWLINES(int lineStart, int lineEnd)</b><br /> - <b id="SCI_HIDELINES">SCI_HIDELINES(int lineStart, int lineEnd)</b><br /> - <b id="SCI_GETLINEVISIBLE">SCI_GETLINEVISIBLE(int line) → bool</b><br /> + <p><b id="SCI_SHOWLINES">SCI_SHOWLINES(line lineStart, line lineEnd)</b><br /> + <b id="SCI_HIDELINES">SCI_HIDELINES(line lineStart, line lineEnd)</b><br /> + <b id="SCI_GETLINEVISIBLE">SCI_GETLINEVISIBLE(line line) → bool</b><br /> <b id="SCI_GETALLLINESVISIBLE">SCI_GETALLLINESVISIBLE → bool</b><br /> 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.</p> - <p><b id="SCI_SETFOLDLEVEL">SCI_SETFOLDLEVEL(int line, int level)</b><br /> - <b id="SCI_GETFOLDLEVEL">SCI_GETFOLDLEVEL(int line) → int</b><br /> + <p><b id="SCI_SETFOLDLEVEL">SCI_SETFOLDLEVEL(line line, int level)</b><br /> + <b id="SCI_GETFOLDLEVEL">SCI_GETFOLDLEVEL(line line) → int</b><br /> 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 <code>SC_FOLDLEVELNUMBERMASK</code> (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){ <p>This message causes the display to redraw.</p> - <p><b id="SCI_GETLASTCHILD">SCI_GETLASTCHILD(int line, int level) → int</b><br /> + <p><b id="SCI_GETLASTCHILD">SCI_GETLASTCHILD(line line, int level) → line</b><br /> This message searches for the next line after <code class="parameter">line</code>, that has a folding level that is less than or equal to <code class="parameter">level</code> and then returns the previous line number. If you set <code class="parameter">level</code> to -1, <code class="parameter">level</code> 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)</code> returns the last line that would be in made visible or hidden by toggling the fold state.</p> - <p><b id="SCI_GETFOLDPARENT">SCI_GETFOLDPARENT(int line) → int</b><br /> + <p><b id="SCI_GETFOLDPARENT">SCI_GETFOLDPARENT(line line) → line</b><br /> This message returns the line number of the first line before <code class="parameter">line</code> that is marked as a fold point with <code>SC_FOLDLEVELHEADERFLAG</code> and has a fold level less than the <code class="parameter">line</code>. If no line is found, or if the header flags and fold levels are inconsistent, the return value is -1.</p> - <p><b id="SCI_TOGGLEFOLD">SCI_TOGGLEFOLD(int line)</b><br /> - <b id="SCI_TOGGLEFOLDSHOWTEXT">SCI_TOGGLEFOLDSHOWTEXT(int line, const char *text)</b><br /> + <p><b id="SCI_TOGGLEFOLD">SCI_TOGGLEFOLD(line line)</b><br /> + <b id="SCI_TOGGLEFOLDSHOWTEXT">SCI_TOGGLEFOLDSHOWTEXT(line line, const char *text)</b><br /> 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 <code>SC_FOLDLEVELHEADERFLAG</code> 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){ <b id="SCI_GETDEFAULTFOLDDISPLAYTEXT">SCI_GETDEFAULTFOLDDISPLAYTEXT(<unused>, char *text) → int</b><br /> These messages set and get the default text displayed at the right of the folded text.</p> - <p><b id="SCI_SETFOLDEXPANDED">SCI_SETFOLDEXPANDED(int line, bool expanded)</b><br /> - <b id="SCI_GETFOLDEXPANDED">SCI_GETFOLDEXPANDED(int line) → bool</b><br /> + <p><b id="SCI_SETFOLDEXPANDED">SCI_SETFOLDEXPANDED(line line, bool expanded)</b><br /> + <b id="SCI_GETFOLDEXPANDED">SCI_GETFOLDEXPANDED(line line) → bool</b><br /> 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 <code>SciTEBase::FoldAll()</code> and <code>SciTEBase::Expand()</code> for examples of the use of these messages.</p> - <p><b id="SCI_FOLDLINE">SCI_FOLDLINE(int line, int action)</b><br /> - <b id="SCI_FOLDCHILDREN">SCI_FOLDCHILDREN(int line, int action)</b><br /> + <p><b id="SCI_FOLDLINE">SCI_FOLDLINE(line line, int action)</b><br /> + <b id="SCI_FOLDCHILDREN">SCI_FOLDCHILDREN(line line, int action)</b><br /> <b id="SCI_FOLDALL">SCI_FOLDALL(int action)</b><br /> These messages provide a higher-level approach to folding instead of setting expanded flags and showing or hiding individual lines.</p> @@ -6271,7 +6285,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ </tbody> </table> - <p><b id="SCI_EXPANDCHILDREN">SCI_EXPANDCHILDREN(int line, int level)</b><br /> + <p><b id="SCI_EXPANDCHILDREN">SCI_EXPANDCHILDREN(line line, int level)</b><br /> 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 '{'.</p> <p>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){ </tbody> </table> - <p><b id="SCI_CONTRACTEDFOLDNEXT">SCI_CONTRACTEDFOLDNEXT(int lineStart) → int</b><br /> + <p><b id="SCI_CONTRACTEDFOLDNEXT">SCI_CONTRACTEDFOLDNEXT(line lineStart) → line</b><br /> 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 <code class="parameter">lineStart</code> and continues forwards to the end of the file. <code class="parameter">lineStart</code> 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.</p> - <p><b id="SCI_ENSUREVISIBLE">SCI_ENSUREVISIBLE(int line)</b><br /> - <b id="SCI_ENSUREVISIBLEENFORCEPOLICY">SCI_ENSUREVISIBLEENFORCEPOLICY(int line)</b><br /> + <p><b id="SCI_ENSUREVISIBLE">SCI_ENSUREVISIBLE(line line)</b><br /> + <b id="SCI_ENSUREVISIBLEENFORCEPOLICY">SCI_ENSUREVISIBLEENFORCEPOLICY(line line)</b><br /> 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 <code>SCI_ENSUREVISIBLEENFORCEPOLICY</code>, @@ -6358,7 +6372,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ <a class="message" href="#SCI_GETPOSITIONCACHE">SCI_GETPOSITIONCACHE → int</a><br /> <a class="message" href="#SCI_LINESSPLIT">SCI_LINESSPLIT(int pixelWidth)</a><br /> <a class="message" href="#SCI_LINESJOIN">SCI_LINESJOIN</a><br /> - <a class="message" href="#SCI_WRAPCOUNT">SCI_WRAPCOUNT(int docLine) → int</a><br /> + <a class="message" href="#SCI_WRAPCOUNT">SCI_WRAPCOUNT(line docLine) → line</a><br /> </code> <p>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. </p> - <p><b id="SCI_WRAPCOUNT">SCI_WRAPCOUNT(int docLine) → int</b><br /> + <p><b id="SCI_WRAPCOUNT">SCI_WRAPCOUNT(line docLine) → line</b><br /> 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.</p> @@ -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.</p> <code><a class="message" href="#SCI_SETEDGEMODE">SCI_SETEDGEMODE(int edgeMode)</a><br /> <a class="message" href="#SCI_GETEDGEMODE">SCI_GETEDGEMODE → int</a><br /> - <a class="message" href="#SCI_SETEDGECOLUMN">SCI_SETEDGECOLUMN(int column)</a><br /> - <a class="message" href="#SCI_GETEDGECOLUMN">SCI_GETEDGECOLUMN → int</a><br /> + <a class="message" href="#SCI_SETEDGECOLUMN">SCI_SETEDGECOLUMN(position column)</a><br /> + <a class="message" href="#SCI_GETEDGECOLUMN">SCI_GETEDGECOLUMN → position</a><br /> <a class="message" href="#SCI_SETEDGECOLOUR">SCI_SETEDGECOLOUR(colour edgeColour)</a><br /> <a class="message" href="#SCI_GETEDGECOLOUR">SCI_GETEDGECOLOUR → colour</a><br /> <br /> - <a class="message" href="#SCI_MULTIEDGEADDLINE">SCI_MULTIEDGEADDLINE(int column, colour edgeColour)</a><br /> + <a class="message" href="#SCI_MULTIEDGEADDLINE">SCI_MULTIEDGEADDLINE(position column, colour edgeColour)</a><br /> <a class="message" href="#SCI_MULTIEDGECLEARALL">SCI_MULTIEDGECLEARALL</a><br /> </code> @@ -6708,8 +6722,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ </tbody> </table> - <p><b id="SCI_SETEDGECOLUMN">SCI_SETEDGECOLUMN(int column)</b><br /> - <b id="SCI_GETEDGECOLUMN">SCI_GETEDGECOLUMN → int</b><br /> + <p><b id="SCI_SETEDGECOLUMN">SCI_SETEDGECOLUMN(position column)</b><br /> + <b id="SCI_GETEDGECOLUMN">SCI_GETEDGECOLUMN → position</b><br /> 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 <code>STYLE_DEFAULT</code>. 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 <code>SCI_SETEDGECOLUMN</code>.</p> - <p><b id="SCI_MULTIEDGEADDLINE">SCI_MULTIEDGEADDLINE(int column, + <p><b id="SCI_MULTIEDGEADDLINE">SCI_MULTIEDGEADDLINE(position column, <a class="jump" href="#colour">colour</a> edgeColour)</b><br /> <b id="SCI_MULTIEDGECLEARALL">SCI_MULTIEDGECLEARALL</b><br /> <code>SCI_MULTIEDGEADDLINE</code> 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){ <a class="message" href="#SCI_GETLEXERLANGUAGE">SCI_GETLEXERLANGUAGE(<unused>, char *language) → int</a><br /> <a class="message" href="#SCI_LOADLEXERLIBRARY">SCI_LOADLEXERLIBRARY(<unused>, const char *path)</a><br /> - <a class="message" href="#SCI_COLOURISE">SCI_COLOURISE(int start, int end)</a><br /> - <a class="message" href="#SCI_CHANGELEXERSTATE">SCI_CHANGELEXERSTATE(int start, int end) → int</a><br /> + <a class="message" href="#SCI_COLOURISE">SCI_COLOURISE(position start, position end)</a><br /> + <a class="message" href="#SCI_CHANGELEXERSTATE">SCI_CHANGELEXERSTATE(position start, position end) → int</a><br /> <a class="message" href="#SCI_PROPERTYNAMES">SCI_PROPERTYNAMES(<unused>, char *names) → int</a><br /> <a class="message" href="#SCI_PROPERTYTYPE">SCI_PROPERTYTYPE(const char *name) → int</a><br /> <a class="message" href="#SCI_DESCRIBEPROPERTY">SCI_DESCRIBEPROPERTY(const char *name, char *description) → int</a><br /> @@ -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. </p> - <p><b id="SCI_COLOURISE">SCI_COLOURISE(int start, int end)</b><br /> + <p><b id="SCI_COLOURISE">SCI_COLOURISE(position start, position end)</b><br /> This requests the current lexer or the container (if the lexer is set to <code>SCLEX_CONTAINER</code>) to style the document between <code class="parameter">start</code> and <code class="parameter">end</code>. If <code class="parameter">end</code> is -1, the document is styled from @@ -6866,7 +6880,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ <code>"1"</code> and your lexer or container supports folding, fold levels are also set. This message causes a redraw.</p> - <p><b id="SCI_CHANGELEXERSTATE">SCI_CHANGELEXERSTATE(int start, int end) → int</b><br /> + <p><b id="SCI_CHANGELEXERSTATE">SCI_CHANGELEXERSTATE(position start, position end) → int</b><br /> Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.</p> diff --git a/scripts/CheckMentioned.py b/scripts/CheckMentioned.py index 5e6d1eefd..2694b7a49 100644 --- a/scripts/CheckMentioned.py +++ b/scripts/CheckMentioned.py @@ -51,9 +51,7 @@ with open(docFileName, "rt") as docFile: symbols[word] = 1 def convertIFaceTypeToC(t): - if t == "position": - return "int " - elif t == "keymod": + if t == "keymod": return "int " elif t == "string": return "const char *" @@ -129,12 +127,14 @@ def flattenSpaces(s): def printCtag(ident, path): print(ident.strip() + "\t" + path + "\t" + "/^" + ident + "$/") +showCTags = True + def checkDocumentation(): with open(docFileName, "rt") as docFile: docs = docFile.read() face, sciToFeature, sccToValue = retrieveFeatures() - + headers = {} definitions = {} @@ -152,9 +152,9 @@ def checkDocumentation(): name = sciToFeature[api] sigFromFace = api + makeSig(face.features[name]) if sigFlat != sigFromFace: - pass - print(sigFlat, sigFromFace) - #~ printCtag(api, docFileName) + print(sigFlat, "|", sigFromFace) + if showCTags: + printCtag(api, docFileName) #~ printCtag(" " + name, pathIface) if api != sigApi: print(sigApi, ";;", sig, ";;", api) @@ -183,8 +183,9 @@ def checkDocumentation(): name = sciToFeature[api] sigFromFace = api + makeSig(face.features[name]) if sigFlat != sigFromFace: - print(sigFlat, sigFromFace) - #~ printCtag('="' + api, docFileName) + print(sigFlat, "|", sigFromFace) + if showCTags: + printCtag('="' + api, docFileName) #~ printCtag(" " + name, pathIface) except KeyError: pass # Feature removed but still has documentation |