diff options
Diffstat (limited to 'doc/ScintillaDoc.html')
| -rw-r--r-- | doc/ScintillaDoc.html | 53 |
1 files changed, 34 insertions, 19 deletions
diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index 2b3a33e3a..351a3d9ab 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -1338,11 +1338,17 @@ struct Sci_TextToFindFull { <p>Scintilla can display document changes (modified, saved, ...) in the margin or in the text.</p> + <p>The main states are original text that has not been modified, modified, and modified then saved. + As it is possible to undo to before the save point, there are additional states for reverted from save and + reverted back to original from save. + The reverted states are different to the saved document on disk so some applications may want to + display these states just like the main modified state.</p> + <p><img src="ChangeHistory.png" alt="Change history markers and indicators." /></p> <p>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 margin shows a block indicating the overall state of the line, prioritizing the more consequential modified states. The states are modified (<span style="color:#FF8000">orange</span>), saved (<span style="color:#00A000">green</span>), @@ -1353,6 +1359,9 @@ struct Sci_TextToFindFull { <p>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.</p> + <p>If the applications wants to display a simplified set of visuals without differentiating between modifications + that have been reverted then assign the same attributes to multiple markers and indicators.</p> + <code><a class="message" href="#SCI_SETCHANGEHISTORY">SCI_SETCHANGEHISTORY(int changeHistory)</a><br /> <a class="message" href="#SCI_GETCHANGEHISTORY">SCI_GETCHANGEHISTORY → int</a><br /> </code> @@ -1414,8 +1423,8 @@ struct Sci_TextToFindFull { <td>21</td> - <td>A change was made to this line and saved but then reverted to its original state. - This line is different to its state on disk.</td> + <td>A change was made to this line and saved but then reverted to its original state.</td> + <td>This line is different to its state on disk.</td> </tr> <tr> @@ -1423,7 +1432,8 @@ struct Sci_TextToFindFull { <td>22</td> - <td>This line was modified and saved. This line is the same as its state on disk.</td> + <td>This line was modified and saved.</td> + <td>This line is the same as its state on disk.</td> </tr> <tr> @@ -1431,7 +1441,8 @@ struct Sci_TextToFindFull { <td>23</td> - <td>This line was modified but not yet saved. This line is different to its state on disk.</td> + <td>This line was modified but not yet saved.</td> + <td>This line is different to its state on disk.</td> </tr> <tr> @@ -1439,8 +1450,8 @@ struct Sci_TextToFindFull { <td>24</td> - <td>A change was made to this line and saved but then reverted but not to its original state. - This line is different to its state on disk.</td> + <td>A change was made to this line and saved but then reverted but not to its original state.</td> + <td>This line is different to its state on disk.</td> </tr> </tbody> </table> @@ -1452,50 +1463,54 @@ struct Sci_TextToFindFull { <tr> <th align="left"><code>INDICATOR_HISTORY_REVERTED_TO_ORIGIN_INSERTION</code></th> <td>36</td> - <td>Text was deleted and saved but then reverted to its original state. - This text is not present on disk.</td> + <td>Text was deleted and saved but then reverted to its original state.</td> + <td>This text has not been saved to disk.</td> </tr> <tr> <th align="left"><code>INDICATOR_HISTORY_REVERTED_TO_ORIGIN_DELETION</code></th> <td>37</td> - <td>Text was inserted and saved but then reverted to its original state. - This range is different to its state on disk.</td> + <td>Text was inserted and saved but then reverted to its original state.</td> + <td>There is text on disk that is missing.</td> </tr> <tr> <th align="left"><code>INDICATOR_HISTORY_SAVED_INSERTION</code></th> <td>38</td> - <td>Text was inserted and saved. This text is the same as on disk.</td> + <td>Text was inserted and saved.</td> + <td>This text is the same as on disk.</td> </tr> <tr> <th align="left"><code>INDICATOR_HISTORY_SAVED_DELETION</code></th> <td>39</td> - <td>Text was deleted and saved. This range is the same as on disk.</td> + <td>Text was deleted and saved.</td> + <td>This range is the same as on disk.</td> </tr> <tr> <th align="left"><code>INDICATOR_HISTORY_MODIFIED_INSERTION</code></th> <td>40</td> - <td>Text was inserted but not yet saved. This text is not present on disk.</td> + <td>Text was inserted but not yet saved.</td> + <td>This text has not been saved to disk.</td> </tr> <tr> <th align="left"><code>INDICATOR_HISTORY_MODIFIED_DELETION</code></th> <td>41</td> - <td>Text was deleted but not yet saved. This range is different to its state on disk.</td> + <td>Text was deleted but not yet saved.</td> + <td>There is text on disk that is missing.</td> </tr> <tr> <th align="left"><code>INDICATOR_HISTORY_REVERTED_TO_MODIFIED_INSERTION</code></th> <td>42</td> - <td>Text was deleted and saved but then reverted but not to its original state. - This text is not present on disk.</td> + <td>Text was deleted and saved but then reverted but not to its original state.</td> + <td>This text has not been saved to disk.</td> </tr> <tr> <th align="left"><code>INDICATOR_HISTORY_REVERTED_TO_MODIFIED_DELETION</code></th> <td>43</td> - <td>Text was inserted and saved but then reverted but not to its original state. - This range is different to its state on disk.</td> + <td>Text was inserted and saved but then reverted but not to its original state.</td> + <td>There is text on disk that is missing.</td> </tr> </tbody> </table> |