diff options
Diffstat (limited to 'doc/ScintillaDoc.html')
| -rw-r--r-- | doc/ScintillaDoc.html | 42 |
1 files changed, 35 insertions, 7 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index c2303c609..f9bc4259e 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -119,7 +119,7 @@ <h1>Scintilla Documentation</h1> - <p>Last edited 31 January 2018 NH</p> + <p>Last edited 1 February 2018 NH</p> <p>There is <a class="jump" href="Design.html">an overview of the internal design of Scintilla</a>.<br /> @@ -5743,9 +5743,38 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ to allocate once rather than rely on the buffer growing as data is added. If <code>SCI_CREATEDOCUMENT</code> fails then 0 is returned.</p> - <p>The <code class="parameter">documentOption</code> argument may be used in future versions - to choose between different document capabilities which affect memory allocation and performance. - The only valid value for now is <code>SC_DOCUMENTOPTION_DEFAULT</code> (0).</p> + <p id="documentOption">The <code class="parameter">documentOption</code> argument + chooses between different document capabilities which affect memory allocation and performance with + <code>SC_DOCUMENTOPTION_DEFAULT</code> (0) choosing standard options. + <code>SC_DOCUMENTOPTION_STYLES_NONE</code> (1) stops allocation of memory to style characters + which saves significant memory, often 40% with the whole document treated as being style 0. + Lexers may still produce visual styling by using indicators.</p> + + <table class="standard" summary="Document options"> + <tbody> + <tr> + <th align="left">Symbol</th> + <th align="left">Value</th> + <th align="left">Effect</th> + </tr> + </tbody> + + <tbody valign="top"> + + <tr> + <td align="left">SC_DOCUMENTOPTION_DEFAULT</td> + <td align="left">0</td> + <td align="left">Standard behaviour</td> + </tr> + + <tr> + <td align="left">SC_DOCUMENTOPTION_STYLES_NONE</td> + <td align="left">1</td> + <td align="left">Stop allocation of memory for styles and treat all text as style 0.</td> + </tr> + + </tbody> + </table> <p><b id="SCI_ADDREFDOCUMENT">SCI_ADDREFDOCUMENT(<unused>, document *doc)</b><br /> This increases the reference count of a document by 1. If you want to replace the current @@ -5788,9 +5817,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){ to allocate once rather than rely on the buffer growing as data is added. If <code>SCI_CREATELOADER</code> fails then 0 is returned.</p> - <p>The <code class="parameter">documentOption</code> argument may be used in future versions - to choose between different document capabilities which affect memory allocation and performance. - The only valid value for now is <code>SC_DOCUMENTOPTION_DEFAULT</code> (0).</p> + <p>The <code class="parameter">documentOption</code> argument + is described in the <a class="seealso" href="#documentOption"><code>SCI_CREATEDOCUMENT</code></a> section.</p> <h4>ILoader</h4> |