diff options
| author | Neil <nyamatongwe@gmail.com> | 2025-01-25 08:40:06 +1100 |
|---|---|---|
| committer | Neil <nyamatongwe@gmail.com> | 2025-01-25 08:40:06 +1100 |
| commit | f2bc1988dba5ca23692020017aa6f9ee2b4d71cf (patch) | |
| tree | d4a01f6ce4ad7fd5afa7a2b65b6a68c1cf932f96 /doc | |
| parent | 3de9d37c7b8f4501558d309ada718dc52533e94c (diff) | |
| download | scintilla-mirror-f2bc1988dba5ca23692020017aa6f9ee2b4d71cf.tar.gz | |
Bug [#1224]. Use enum for undo selection history and make API names more
consistent as 'undo selection' instead of 'selection undo' as more closely
associated with undo than selection.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ScintillaDoc.html | 33 | ||||
| -rw-r--r-- | doc/ScintillaHistory.html | 2 |
2 files changed, 28 insertions, 7 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 44df71562..3bc5acd90 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -1938,8 +1938,8 @@ struct Sci_TextToFindFull { <a class="message" href="#SCI_ENDUNDOACTION">SCI_ENDUNDOACTION</a><br /> <a class="message" href="#SCI_GETUNDOSEQUENCE">SCI_GETUNDOSEQUENCE → int</a><br /> <a class="message" href="#SCI_ADDUNDOACTION">SCI_ADDUNDOACTION(int token, int flags)</a><br /> - <a class="message" href="#SCI_SETSELECTIONUNDOHISTORY">SCI_SETSELECTIONUNDOHISTORY(bool selectionUndoHistory)</a><br /> - <a class="message" href="#SCI_GETSELECTIONUNDOHISTORY">SCI_GETSELECTIONUNDOHISTORY → bool</a><br /> + <a class="message" href="#SCI_SETUNDOSELECTIONHISTORY">SCI_SETUNDOSELECTIONHISTORY(int undoSelectionHistory)</a><br /> + <a class="message" href="#SCI_GETUNDOSELECTIONHISTORY">SCI_GETUNDOSELECTIONHISTORY → int</a><br /> </code> <p><b id="SCI_UNDO">SCI_UNDO</b><br /> @@ -2018,14 +2018,35 @@ struct Sci_TextToFindFull { look like typing or deletions that look like multiple uses of the Backspace or Delete keys. </p> - <p><b id="SCI_SETSELECTIONUNDOHISTORY">SCI_SETSELECTIONUNDOHISTORY(bool selectionUndoHistory)</b><br /> - <b id="SCI_GETSELECTIONUNDOHISTORY">SCI_GETSELECTIONUNDOHISTORY → bool</b><br /> + <p><b id="SCI_SETUNDOSELECTIONHISTORY">SCI_SETUNDOSELECTIONHISTORY(int undoSelectionHistory)</b><br /> + <b id="SCI_GETUNDOSELECTIONHISTORY">SCI_GETUNDOSELECTIONHISTORY → int</b><br /> The selection for each action can be saved and then restored when undo or redo is performed. - <code>SCI_SETSELECTIONUNDOHISTORY</code> controls this. - The current <code>bool</code> argument may change to a set of flags. + <code>SCI_SETUNDOSELECTIONHISTORY</code> controls this. There is a memory cost for this feature with a minimum of 150 bytes for each of undo and redo for each recorded action. Recording may be turned on at any time.</p> + <p>The <code class="parameter">undoSelectionHistory</code> argument can be:</p> + <table class="standard" summary="Undo selection history state"> + <tbody valign="top"> + <tr> + <th align="left"><code>SC_UNDO_SELECTION_HISTORY_DISABLED</code></th> + + <td>0</td> + + <td>The default: undo selection history turned off.</td> + </tr> + + <tr> + <th align="left"><code>SC_UNDO_SELECTION_HISTORY_ENABLED</code></th> + + <td>1</td> + + <td>Restore selection for each undo and redo.</td> + </tr> + + </tbody> + </table> + <h2 id="UndoSaveRestore">Undo Save and Restore</h2> <p>This feature is unfinished and has limitations. diff --git a/doc/ScintillaHistory.html b/doc/ScintillaHistory.html index 5f28aae36..7cb5ebcee 100644 --- a/doc/ScintillaHistory.html +++ b/doc/ScintillaHistory.html @@ -595,7 +595,7 @@ Released 18 December 2024. </li> <li> - Remember selection with undo and redo. Controlled with SCI_SETSELECTIONUNDOHISTORY. + Remember selection with undo and redo. Controlled with SCI_SETUNDOSELECTIONHISTORY. <a href="https://sourceforge.net/p/scintilla/feature-requests/1273/">Feature #1273</a>, <a href="https://sourceforge.net/p/scintilla/bugs/1479/">Bug #1479</a>, <a href="https://sourceforge.net/p/scintilla/bugs/1224/">Bug #1224</a>. |