From 9c377f7ef51248855a3c8b6182d092f0ea725874 Mon Sep 17 00:00:00 2001 From: Neil Date: Sun, 29 Mar 2020 10:24:29 +1100 Subject: Update documentation to match changes in Scintilla.iface. --- doc/ScintillaDoc.html | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'doc/ScintillaDoc.html') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 82ba26a3c..8afdbbe98 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -119,7 +119,7 @@

Scintilla Documentation

-

Last edited 3 January 2020 NH

+

Last edited 29 March 2020 NH

There is an overview of the internal design of Scintilla.
@@ -4145,7 +4145,7 @@ struct Sci_TextToFind { SCI_MARKERGET(line line) → int
SCI_MARKERNEXT(line lineStart, int markerMask) → line
SCI_MARKERPREVIOUS(line lineStart, int markerMask) → line
- SCI_MARKERLINEFROMHANDLE(int markerHandle) → int
+ SCI_MARKERLINEFROMHANDLE(int markerHandle) → line
SCI_MARKERDELETEHANDLE(int markerHandle)
@@ -4403,7 +4403,7 @@ struct Sci_TextToFind { message returns the line number of the first line that contains one of the markers in markerMask or -1 if no marker is found.

-

SCI_MARKERLINEFROMHANDLE(int markerHandle) → int
+

SCI_MARKERLINEFROMHANDLE(int markerHandle) → line
The markerHandle argument is an identifier for a marker returned by SCI_MARKERADD. This function searches the document for the marker with this handle and returns the line number that contains it or -1 @@ -4481,8 +4481,8 @@ struct Sci_TextToFind { SCI_INDICATORCLEARRANGE(position start, position lengthClear)
SCI_INDICATORALLONFOR(position pos) → int
SCI_INDICATORVALUEAT(int indicator, position pos) → int
- SCI_INDICATORSTART(int indicator, position pos) → int
- SCI_INDICATOREND(int indicator, position pos) → int
+ SCI_INDICATORSTART(int indicator, position pos) → position
+ SCI_INDICATOREND(int indicator, position pos) → position
SCI_FINDINDICATORSHOW(position start, position end)
SCI_FINDINDICATORFLASH(position start, position end)
@@ -4804,8 +4804,8 @@ struct Sci_TextToFind {

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

@@ -5141,7 +5141,7 @@ struct Sci_TextToFind { SCI_CALLTIPACTIVE → bool
SCI_CALLTIPPOSSTART → position
SCI_CALLTIPSETPOSSTART(position posStart)
- SCI_CALLTIPSETHLT(int highlightStart, int + SCI_CALLTIPSETHLT(position highlightStart, position highlightEnd)
SCI_CALLTIPSETBACK(colour back)
SCI_CALLTIPSETFORE(colour fore)
@@ -5180,7 +5180,7 @@ struct Sci_TextToFind { This message returns or sets the value of the current position when SCI_CALLTIPSHOW started to display the tip.

-

SCI_CALLTIPSETHLT(int highlightStart, int highlightEnd)
+

SCI_CALLTIPSETHLT(position highlightStart, position highlightEnd)
This sets the region of the call tips text to display in a highlighted style. highlightStart is the zero-based index into the string of the first character to highlight and highlightEnd is the index of the first character after the highlight. @@ -6904,7 +6904,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_SETLEXERLANGUAGE(<unused>, const char *language)
SCI_GETLEXERLANGUAGE(<unused>, char *language) → int
- SCI_SETILEXER(<unused>, pointer lexer)
+ SCI_SETILEXER(<unused>, pointer ilexer)
SCI_LOADLEXERLIBRARY(<unused>, const char *path)
SCI_COLOURISE(position start, position end)
@@ -6955,11 +6955,11 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ Lex*.cxx file and search for LexerModule. The third argument in the LexerModule constructor is the name to use.

-

SCI_SETILEXER(<unused>, pointer lexer)
+

SCI_SETILEXER(<unused>, pointer ilexer)
SCI_SETILEXER allows setting a lexer as an ILexer5*. The lexer may be implemented by an application or a shared library such as Lexilla.

-

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

@@ -7238,12 +7238,12 @@ A set of common tags and conventions for combining them is GetName and GetIdentifier may be called to discover the identity of a lexer and be used to implement -SCI_GETLEXERLANGUAGE and -SCI_GETLEXER.

+SCI_GETLEXERLANGUAGE and +SCI_GETLEXER.

PropertyGet may be called to discover the value of a property stored by a lexer and be used to implement -SCI_GETPROPERTY.

+SCI_GETPROPERTY.

IDocument

-- cgit v1.2.3