From 195686c3c4088437a74582189b529e4a58e8225d Mon Sep 17 00:00:00 2001 From: Neil Date: Mon, 23 Oct 2017 09:19:11 +1100 Subject: Document style metadata APIs. --- doc/ScintillaDoc.html | 21 +++++++++++++++++++++ include/Scintilla.iface | 6 +++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 867efae36..91eca2c99 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -6615,6 +6615,10 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ SCI_GETPRIMARYSTYLEFROMSTYLE(int style) → int
SCI_SETIDENTIFIERS(int style, const char *identifiers)
SCI_PRIVATELEXERCALL(int operation, int pointer) → int
+ SCI_GETNAMEDSTYLES → int
+ SCI_NAMEOFSTYLE(int style, char *name) → int
+ SCI_TAGSOFSTYLE(int style, char *tags) → int
+ SCI_DESCRIPTIONOFSTYLE(int style, char *description) → int

SCI_SETLEXER(int lexer)
SCI_GETLEXER → int
@@ -6792,6 +6796,23 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){

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

+

Style Metadata

+

Lexers may provide information on the styles they use. + Lexers have to explicitly support this feature by implementing particular methods.

+ +

SCI_GETNAMEDSTYLES → int
+ Retrieve the number of named styles for the lexer.

+ +

SCI_NAMEOFSTYLE(int style, char *name) → int
+ Retrieve the name of a style. This is a C preprocessor symbol like "SCE_C_COMMENTDOC".

+ +

SCI_TAGSOFSTYLE(int style, char *tags) → int
+ Retrieve the tags of a style. This is a space-separated set of words like "comment documentation".

+ +

SCI_DESCRIPTIONOFSTYLE(int style, char *description) → int
+ Retrieve an English-language description of a style which may be suitable for display in a user interface. + This looks like "Doc comment: block comments beginning with /** or /*!".

+

Lexer Objects

Lexers are programmed as objects that implement the ILexer4 interface and that interact diff --git a/include/Scintilla.iface b/include/Scintilla.iface index 69139158a..1060b2dd1 100644 --- a/include/Scintilla.iface +++ b/include/Scintilla.iface @@ -2696,15 +2696,15 @@ get int GetNamedStyles=4029(,) # Retrieve the name of a style. # Result is NUL-terminated. -fun int NameOfStyle=4030(int style, stringresult names) +fun int NameOfStyle=4030(int style, stringresult name) # Retrieve a ' ' separated list of style tags like "literal quoted string". # Result is NUL-terminated. -fun int TagsOfStyle=4031(int style, stringresult names) +fun int TagsOfStyle=4031(int style, stringresult tags) # Retrieve a description of a style. # Result is NUL-terminated. -fun int DescriptionOfStyle=4032(int style, stringresult names) +fun int DescriptionOfStyle=4032(int style, stringresult description) # Notifications # Type of modification and the action which caused the modification. -- cgit v1.2.3