From 854030bd0888760a982ed7fc56c45962dc0714b7 Mon Sep 17 00:00:00 2001 From: Mitchell Foral Date: Mon, 1 Mar 2021 20:58:34 +1100 Subject: Change CARETSTYLE section to use a table for the bit fields. --- doc/ScintillaDoc.html | 51 ++++++++++++++++++++++++++++++++++++++++----------- 1 file 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 @@

Scintilla Documentation

-

Last edited 9 September 2020 NH

+

Last edited 1 March 2021 NH

There is an overview of the internal design of Scintilla.
@@ -3314,16 +3314,45 @@ struct Sci_TextToFind {

SCI_SETCARETSTYLE(int caretStyle)
SCI_GETCARETSTYLE → int
- The style of the caret can be set with SCI_SETCARETSTYLE 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 SCI_GETCARETSTYLE.

- -

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).

+ The style of the caret can be set with SCI_SETCARETSTYLE. + There are separate styles for insert mode (lower 4-bits, CARETSTYLE_INS_MASK) and + overtype mode (bit 4). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CARETSTYLE_INVISIBLE0Carets are not drawn at all.
CARETSTYLE_LINE1Draws insertion carets as lines. This is the default.
CARETSTYLE_BLOCK2Draws insertion carets as blocks.
CARETSTYLE_OVERSTRIKE_BAR0Draws an overstrike caret as a bar. This is the default.
CARETSTYLE_OVERSTRIKE_BLOCK16Draws an overstrike caret as a block. This should be ored with one of the first three styles.
CARETSTYLE_BLOCK_AFTER256When 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 CARETSTYLE_BLOCK or CARETSTYLE_CURSES.

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 -- cgit v1.2.3