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 | 63c0fcd4f77b98f5c167f50876329e407aef84dc (patch) | |
| tree | 57e0af5965ca00b38823b59b3fc1c9a6b08d4e4c /doc | |
| parent | 2770554d11acab2ae8969fe266f43c766303c27e (diff) | |
| download | scintilla-mirror-63c0fcd4f77b98f5c167f50876329e407aef84dc.tar.gz | |
Backport: Document style metadata APIs.
Backport of changeset 6405:0849bae316da.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ScintillaDoc.html | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index b3170a148..42242c606 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -6617,6 +6617,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 /> @@ -6794,6 +6798,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 ILexer interface and that interact |