aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/ScintillaDoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ScintillaDoc.html')
-rw-r--r--doc/ScintillaDoc.html55
1 files changed, 43 insertions, 12 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index e91c80783..380a8e81d 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -128,7 +128,7 @@
<h1>Scintilla Documentation</h1>
- <p>Last edited 11 May 2021 NH</p>
+ <p>Last edited 13 May 2021 NH</p>
<p style="background:#90F0C0">Scintilla 5 has moved the lexers from Scintilla into a new
<a href="Lexilla.html">Lexilla</a> project.<br />
@@ -2302,9 +2302,10 @@ struct Sci_TextToFind {
<code><a class="message" href="#SCI_SETVIEWWS">SCI_SETVIEWWS(int viewWS)</a><br />
<a class="message" href="#SCI_GETVIEWWS">SCI_GETVIEWWS &rarr; int</a><br />
<a class="element" href="#SC_ELEMENT_WHITE_SPACE">SC_ELEMENT_WHITE_SPACE : colouralpha</a><br />
- <a class="message" href="#SCI_SETWHITESPACEFORE">SCI_SETWHITESPACEFORE(bool
+ <a class="discouraged message" href="#SCI_SETWHITESPACEFORE">SCI_SETWHITESPACEFORE(bool
useSetting, colour fore)</a><br />
- <a class="message" href="#SCI_SETWHITESPACEBACK">SCI_SETWHITESPACEBACK(bool
+ <a class="element" href="#SC_ELEMENT_WHITE_SPACE_BACK">SC_ELEMENT_WHITE_SPACE_BACK : colouralpha</a><br />
+ <a class="discouraged message" href="#SCI_SETWHITESPACEBACK">SCI_SETWHITESPACEBACK(bool
useSetting, colour back)</a><br />
<a class="message" href="#SCI_SETWHITESPACESIZE">SCI_SETWHITESPACESIZE(int
size)</a><br />
@@ -2368,13 +2369,16 @@ struct Sci_TextToFind {
<p>
<b id="SC_ELEMENT_WHITE_SPACE">SC_ELEMENT_WHITE_SPACE : colouralpha</b><br />
<b id="SCI_SETWHITESPACEFORE">SCI_SETWHITESPACEFORE(bool useSetting, <a class="jump" href="#colour">colour</a> fore)</b><br />
+ <b id="SC_ELEMENT_WHITE_SPACE_BACK">SC_ELEMENT_WHITE_SPACE_BACK : colouralpha</b><br />
<b id="SCI_SETWHITESPACEBACK">SCI_SETWHITESPACEBACK(bool useSetting, <a class="jump" href="#colour">colour</a> back)</b><br />
By default, the colour of visible white space is determined by the lexer in use. The
foreground and/or background colour of all visible white space can be set globally, overriding
- the lexer's colours with <a href="#SCI_SETELEMENTCOLOUR"><code>SC_ELEMENT_WHITE_SPACE</code></a> and
- <code>SCI_SETWHITESPACEBACK</code>.<br />
- <code>SCI_SETWHITESPACEFORE</code> also changes the white space colour but <code>SC_ELEMENT_WHITE_SPACE</code>
- is preferred and allows setting translucency.</p>
+ the lexer's colours with <a href="#SCI_SETELEMENTCOLOUR"><code>SC_ELEMENT_WHITE_SPACE</code></a>
+ and <a href="#SCI_SETELEMENTCOLOUR"><code>SC_ELEMENT_WHITE_SPACE_BACK</code></a>.
+ .<br />
+ <code>SCI_SETWHITESPACEFORE</code> and <code>SCI_SETWHITESPACEBACK</code> also
+ change the white space colours but the element APIs are preferred with <code>SC_ELEMENT_WHITE_SPACE</code>
+ allowing translucency.</p>
<p><b id="SCI_SETWHITESPACESIZE">SCI_SETWHITESPACESIZE(int size)</b><br />
<b id="SCI_GETWHITESPACESIZE">SCI_GETWHITESPACESIZE &rarr; int</b><br />
@@ -3288,8 +3292,8 @@ struct Sci_TextToFind {
When undefined the return value is 0 which is equivalent to completely transparent black.
These colours may be useful when defining styles with similarities such as synthesizing dark
mode styles that use the same colours as the system</p>
- <p>On Win32, autocompletion list colours like <code>SC_ELEMENT_LIST</code> are currently available.
- On Cocoa, selection background colours like <code>SC_ELEMENT_SELECTION_BACK</code> are currently available.
+ <p>On Win32, autocompletion list colours like <code>SC_ELEMENT_LIST</code> are currently provided by the platform layer and
+ on Cocoa, selection background colours like <code>SC_ELEMENT_SELECTION_BACK</code> are provided.
</p>
<table class="standard" summary="Elements">
@@ -3301,7 +3305,9 @@ struct Sci_TextToFind {
<th>Translucent?</th>
- <th>Platforms</th>
+ <th>Active</th>
+
+ <th>Base</th>
<th>Description</th>
</tr>
@@ -3312,6 +3318,7 @@ struct Sci_TextToFind {
<td>0</td>
<td>Opaque</td>
<td>Win32</td>
+ <td>Win32</td>
<td>Text colour in autocompletion lists</td>
</tr>
<tr>
@@ -3319,6 +3326,7 @@ struct Sci_TextToFind {
<td>1</td>
<td>Opaque</td>
<td>Win32</td>
+ <td>Win32</td>
<td>Background colour of autocompletion lists</td>
</tr>
<tr>
@@ -3326,6 +3334,7 @@ struct Sci_TextToFind {
<td>2</td>
<td>Opaque</td>
<td>Win32</td>
+ <td>Win32</td>
<td>Text colour of selected item in autocompletion lists</td>
</tr>
<tr>
@@ -3333,6 +3342,7 @@ struct Sci_TextToFind {
<td>3</td>
<td>Opaque</td>
<td>Win32</td>
+ <td>Win32</td>
<td>Background colour of selected item in autocompletion lists</td>
</tr>
<tr class="section">
@@ -3340,6 +3350,7 @@ struct Sci_TextToFind {
<td>10</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Text colour of main selection</td>
</tr>
<tr>
@@ -3347,6 +3358,7 @@ struct Sci_TextToFind {
<td>11</td>
<td>Translucent</td>
<td>All</td>
+ <td>Cocoa</td>
<td>Background colour of main selection</td>
</tr>
<tr>
@@ -3354,6 +3366,7 @@ struct Sci_TextToFind {
<td>12</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Text colour of additional selections</td>
</tr>
<tr>
@@ -3361,6 +3374,7 @@ struct Sci_TextToFind {
<td>13</td>
<td>Translucent</td>
<td>All</td>
+ <td>Cocoa</td>
<td>Background colour of additional selections</td>
</tr>
<tr>
@@ -3368,6 +3382,7 @@ struct Sci_TextToFind {
<td>14</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Text colour of selections when another window contains the primary selection</td>
</tr>
<tr>
@@ -3375,6 +3390,7 @@ struct Sci_TextToFind {
<td>15</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Background colour of selections when another window contains the primary selection</td>
</tr>
<tr>
@@ -3382,6 +3398,7 @@ struct Sci_TextToFind {
<td>16</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Text colour of selections when another window has focus</td>
</tr>
<tr>
@@ -3389,6 +3406,7 @@ struct Sci_TextToFind {
<td>17</td>
<td>Translucent</td>
<td>All</td>
+ <td>Cocoa</td>
<td>Background colour of selections when another window has focus</td>
</tr>
<tr class="section">
@@ -3396,6 +3414,7 @@ struct Sci_TextToFind {
<td>40</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Colour of caret for main selection</td>
</tr>
<tr>
@@ -3403,6 +3422,7 @@ struct Sci_TextToFind {
<td>41</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Colour of caret for additional selections</td>
</tr>
<tr>
@@ -3410,22 +3430,33 @@ struct Sci_TextToFind {
<td>42</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Colour of carets when another window has focus</td>
</tr>
- <tr>
+ <tr class="section">
<th align="left"><code>SC_ELEMENT_CARET_LINE_BACK</code></th>
<td>50</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Colour of caret line background</td>
</tr>
- <tr>
+ <tr class="section">
<th align="left"><code>SC_ELEMENT_WHITE_SPACE</code></th>
<td>60</td>
<td>Translucent</td>
<td>All</td>
+ <td></td>
<td>Colour of visible white space</td>
</tr>
+ <tr>
+ <th align="left"><code>SC_ELEMENT_WHITE_SPACE_BACK</code></th>
+ <td>61</td>
+ <td>Opaque</td>
+ <td>All</td>
+ <td></td>
+ <td>Colour of visible white space background</td>
+ </tr>
</tbody>
</table>
generated by cgit v1.2.3 (git 2.25.1) at 2025-10-13 12:49:49 +0000