From a180e477ec3efd9d35a4cf32b63ab7354a03371f Mon Sep 17 00:00:00 2001 From: Neil Date: Sun, 1 Jun 2025 08:38:14 +1000 Subject: Add SCI_SCROLLVERTICAL API. --- doc/ScintillaDoc.html | 21 +++++++++++++++++++++ doc/ScintillaHistory.html | 3 +++ 2 files changed, 24 insertions(+) (limited to 'doc') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 6a75fd63f..a2af4f64f 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -2397,6 +2397,7 @@ struct Sci_TextToFindFull { SCI_GETFIRSTVISIBLELINE → line
SCI_SETXOFFSET(int xOffset)
SCI_GETXOFFSET → int
+ SCI_SCROLLVERTICAL(line docLine, line subLine)
SCI_LINESCROLL(position columns, line lines)
SCI_SCROLLCARET
SCI_SCROLLRANGE(position secondary, position primary)
@@ -2430,6 +2431,26 @@ struct Sci_TextToFindFull { view. A value of 0 is the normal position with the first text column visible at the left of the view.

+

SCI_SCROLLVERTICAL(line docLine, line subLine)
+ Sets the vertical scroll position to be the display line for the + subLine of the docLine, similar to
+ SCI_SETFIRSTVISIBLELINE(SCI_VISIBLEFROMDOCLINE(docLine) + subLine).

+ +

The subLine is capped to the maximum number of sublines + for that document line which may change because of styling and wrapping. It is ignored when line + wrapping is off.

+ +

If line wrapping is on, then that + docLine/subLine + is remembered and reapplied as lines are wrapped. + This ensures that when wrapping is completed, which may take some time, the line at the top of the view is that + requested by the application and the view range is stable during the wrapping process. + It is forgotten once the document is fully wrapped or the user + performs scrolling manually such as by dragging the scroll bar.

+ +

This method is a good way for applications to restore the user's positional context when re-selecting a + document as it is robust to changes in window width and styles.

+

SCI_LINESCROLL(position columns, line lines)
This will attempt to scroll the display by the number of columns and lines that you specify. Positive line values increase the line number at the top of the screen (i.e. they move the text diff --git a/doc/ScintillaHistory.html b/doc/ScintillaHistory.html index 5b636af5d..edf0b6344 100644 --- a/doc/ScintillaHistory.html +++ b/doc/ScintillaHistory.html @@ -601,6 +601,9 @@ Released 2 April 2025.

  • + Add SCI_SCROLLVERTICAL method to restore view position and maintain it while performing line wrapping. +
    • +
  • Add SC_UNDO_SELECTION_HISTORY_SCROLL flag to SCI_SETUNDOSELECTIONHISTORY which controls whether undo and redo restore vertical scroll position.
    • -- cgit v1.2.3