diff options
Diffstat (limited to 'doc/ScintillaDoc.html')
| -rw-r--r-- | doc/ScintillaDoc.html | 51 |
1 files changed, 40 insertions, 11 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 1110f7e46..5f482ec82 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -119,7 +119,7 @@ <h1>Scintilla Documentation</h1> - <p>Last edited 9 September 2020 NH</p> + <p>Last edited 1 March 2021 NH</p> <p>There is <a class="jump" href="Design.html">an overview of the internal design of Scintilla</a>.<br /> @@ -3314,16 +3314,45 @@ struct Sci_TextToFind { <p><b id="SCI_SETCARETSTYLE">SCI_SETCARETSTYLE(int caretStyle)</b><br /> <b id="SCI_GETCARETSTYLE">SCI_GETCARETSTYLE → int</b><br /> - The style of the caret can be set with <code>SCI_SETCARETSTYLE</code> to be a line caret - (CARETSTYLE_LINE=1) or a block caret (CARETSTYLE_BLOCK=2) for insert mode (lower 4-bits, CARETSTYLE_INS_MASK) combined with - a bar caret (CARETSTYLE_OVERSTRIKE_BAR=0) or a block caret (CARETSTYLE_OVERSTRIKE_BLOCK=16) for overtype mode (bit 4), - or to not draw at all (CARETSTYLE_INVISIBLE=0). The default value for insert mode is the line caret (CARETSTYLE_LINE=1), - for overtype mode is the bar caret (CARETSTYLE_OVERSTRIKE_BAR=0). - You can determine the current caret style setting using <code>SCI_GETCARETSTYLE</code>.</p> - - <p>When the caret end of a range is at the end and a block caret style is chosen, the block is - drawn just inside the selection instead of after. - This can be switched with an option (CARETSTYLE_BLOCK_AFTER=256).</p> + The style of the caret can be set with <code>SCI_SETCARETSTYLE</code>. + There are separate styles for insert mode (lower 4-bits, CARETSTYLE_INS_MASK) and + overtype mode (bit 4). + + <table class="standard" summary="Caret Styles"> + <tbody valign="top"> + <tr> + <th align="left"><code>CARETSTYLE_INVISIBLE</code></th> + <td>0</td> + <td>Carets are not drawn at all.</td> + </tr> + <tr> + <th align="left"><code>CARETSTYLE_LINE</code></th> + <td>1</td> + <td>Draws insertion carets as lines. This is the default.</td> + </tr> + <tr> + <th align="left"><code>CARETSTYLE_BLOCK</code></th> + <td>2</td> + <td>Draws insertion carets as blocks.</td> + </tr> + <tr> + <th align="left"><code>CARETSTYLE_OVERSTRIKE_BAR</code></th> + <td>0</td> + <td>Draws an overstrike caret as a bar. This is the default.</td> + </tr> + <tr> + <th align="left"><code>CARETSTYLE_OVERSTRIKE_BLOCK</code></th> + <td>16</td> + <td>Draws an overstrike caret as a block. This should be ored with one of the first three styles.</td> + </tr> + <tr> + <th align="left"><code>CARETSTYLE_BLOCK_AFTER</code></th> + <td>256</td> + <td>When the caret end of a range is at the end and a block caret style is chosen, draws the block + outside the selection instead of inside. This can be ored with <code>CARETSTYLE_BLOCK</code> or <code>CARETSTYLE_CURSES</code>.</td> + </tr> + </tbody> + </table> <p>The block caret draws most combining and multibyte character sequences successfully, though some fonts like Thai Fonts (and possibly others) can sometimes appear strange when |