diff options
| author | Neil <nyamatongwe@gmail.com> | 2017-10-23 09:19:11 +1100 |
|---|---|---|
| committer | Neil <nyamatongwe@gmail.com> | 2017-10-23 09:19:11 +1100 |
| commit | 195686c3c4088437a74582189b529e4a58e8225d (patch) | |
| tree | 54a67286bd4584e622662bcc4856224e613758ce | |
| parent | fd2e17925861e2b3573f2bfe559f47192fcb1986 (diff) | |
| download | scintilla-mirror-195686c3c4088437a74582189b529e4a58e8225d.tar.gz | |
Document style metadata APIs.
| -rw-r--r-- | doc/ScintillaDoc.html | 21 | ||||
| -rw-r--r-- | 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){ <a class="message" href="#SCI_GETPRIMARYSTYLEFROMSTYLE">SCI_GETPRIMARYSTYLEFROMSTYLE(int style) → int</a><br /> <a class="message" href="#SCI_SETIDENTIFIERS">SCI_SETIDENTIFIERS(int style, const char *identifiers)</a><br /> <a class="message" href="#SCI_PRIVATELEXERCALL">SCI_PRIVATELEXERCALL(int operation, int pointer) → int</a><br /> + <a class="message" href="#SCI_GETNAMEDSTYLES">SCI_GETNAMEDSTYLES → int</a><br /> + <a class="message" href="#SCI_NAMEOFSTYLE">SCI_NAMEOFSTYLE(int style, char *name) → int</a><br /> + <a class="message" href="#SCI_TAGSOFSTYLE">SCI_TAGSOFSTYLE(int style, char *tags) → int</a><br /> + <a class="message" href="#SCI_DESCRIPTIONOFSTYLE">SCI_DESCRIPTIONOFSTYLE(int style, char *description) → int</a><br /> <p><b id="SCI_SETLEXER">SCI_SETLEXER(int lexer)</b><br /> <b id="SCI_GETLEXER">SCI_GETLEXER → int</b><br /> @@ -6792,6 +6796,23 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ <p><b id="SCI_PRIVATELEXERCALL">SCI_PRIVATELEXERCALL(int operation, int pointer) → int</b><br /> Call into a lexer in a way not understood by Scintilla.</p> + <h3 id="StyleMetadata">Style Metadata</h3> + <p>Lexers may provide information on the styles they use. + Lexers have to explicitly support this feature by implementing particular methods.</p> + + <p><b id="SCI_GETNAMEDSTYLES">SCI_GETNAMEDSTYLES → int</b><br /> + Retrieve the number of named styles for the lexer.</p> + + <p><b id="SCI_NAMEOFSTYLE">SCI_NAMEOFSTYLE(int style, char *name) → int</b><br /> + Retrieve the name of a style. This is a C preprocessor symbol like "SCE_C_COMMENTDOC".</p> + + <p><b id="SCI_TAGSOFSTYLE">SCI_TAGSOFSTYLE(int style, char *tags) → int</b><br /> + Retrieve the tags of a style. This is a space-separated set of words like "comment documentation".</p> + + <p><b id="SCI_DESCRIPTIONOFSTYLE">SCI_DESCRIPTIONOFSTYLE(int style, char *description) → int</b><br /> + 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 /*!".</p> + <h2 id="LexerObjects">Lexer Objects</h2> <p>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. |