From 5d0f00f0ce3cda283149f0ed71fb195fcd5060d8 Mon Sep 17 00:00:00 2001 From: Neil Date: Sun, 31 Jul 2022 22:47:09 +1000 Subject: Add image of change history and explain more. --- doc/ScintillaDoc.html | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'doc/ScintillaDoc.html') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index d4c38902b..38a0434d9 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -1338,6 +1338,18 @@ struct Sci_TextToFindFull {

Scintilla can display document changes (modified, saved, ...) in the margin or in the text.

+

Change history markers and indicators.

+ +

The image shows the default visuals which can be altered by the application. + In the text, inserted characters appear with coloured underlines and points where characters were deleted are shown with small triangles. + The margin shows a block indicating the overall state of the line, prioritising the more consequential modified states. + The states are + modified (orange), + saved (green), + saved then reverted to modified (green-yellow), + and saved then reverted to original (cyan). +

+

This feature uses a moderate amount of memory proportional to the amount of modifications made. On huge documents, this could be significant so could be disabled when it would cause excessive memory use.

@@ -1348,8 +1360,12 @@ struct Sci_TextToFindFull {

SCI_SETCHANGEHISTORY(int changeHistory)
SCI_GETCHANGEHISTORY → int
SCI_SETCHANGEHISTORY turns this feature on and off and determines whether changes are visible in - the margin or text or both. - The changeHistory argument can be a combination of:

+ the margin or text or both.

+

Change history depends on the undo history and can only be enabled when undo history is enabled and empty. + It should be enabled once when a file is loaded after calling + SCI_SETUNDOCOLLECTION(true) and + SCI_SETSAVEPOINT.

+

The changeHistory argument can be a combination of:

-- cgit v1.2.3