From f997170c3eb0afa64d10b39b86799bad67dc5c02 Mon Sep 17 00:00:00 2001
From: Neil <nyamatongwe@gmail.com>
Date: Thu, 3 Jun 2021 20:24:44 +1000
Subject: Add APIs for setting appearance (traditional blob or plain text) and
 colour of representations and support setting a representation for the "\r\n"
 line end sequence.

---
 doc/ScintillaDoc.html     | 54 ++++++++++++++++++++++++++++++++++++++++++++++-
 doc/ScintillaHistory.html |  4 ++++
 2 files changed, 57 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 14969616e..bae44931d 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -3842,7 +3842,12 @@ struct Sci_TextToFind {
      <a class="message" href="#SCI_SETREPRESENTATION">SCI_SETREPRESENTATION(const char *encodedCharacter, const char *representation)</a><br />
      <a class="message" href="#SCI_GETREPRESENTATION">SCI_GETREPRESENTATION(const char *encodedCharacter, char *representation) &rarr; int</a><br />
      <a class="message" href="#SCI_CLEARREPRESENTATION">SCI_CLEARREPRESENTATION(const char *encodedCharacter)</a><br />
-    <a class="message" href="#SCI_SETCONTROLCHARSYMBOL">SCI_SETCONTROLCHARSYMBOL(int symbol)</a><br />
+     <a class="message" href="#SCI_CLEARALLREPRESENTATIONS">SCI_CLEARALLREPRESENTATIONS</a><br />
+     <a class="message" href="#SCI_SETREPRESENTATIONAPPEARANCE">SCI_SETREPRESENTATIONAPPEARANCE(const char *encodedCharacter, int appearance)</a><br />
+     <a class="message" href="#SCI_GETREPRESENTATIONAPPEARANCE">SCI_GETREPRESENTATIONAPPEARANCE(const char *encodedCharacter) &rarr; int</a><br />
+     <a class="message" href="#SCI_SETREPRESENTATIONCOLOUR">SCI_SETREPRESENTATIONCOLOUR(const char *encodedCharacter, colouralpha colour)</a><br />
+     <a class="message" href="#SCI_GETREPRESENTATIONCOLOUR">SCI_GETREPRESENTATIONCOLOUR(const char *encodedCharacter) &rarr; colouralpha</a><br />
+     <a class="message" href="#SCI_SETCONTROLCHARSYMBOL">SCI_SETCONTROLCHARSYMBOL(int symbol)</a><br />
      <a class="message" href="#SCI_GETCONTROLCHARSYMBOL">SCI_GETCONTROLCHARSYMBOL &rarr; int</a><br />
     </code>
 
@@ -3859,9 +3864,56 @@ struct Sci_TextToFind {
     <p>The encodedCharacter parameter is a NUL-terminated string of the bytes for one character in the
     current encoding. This can not be used to set a representation for multiple-character strings. </p>
 
+    <p>One exception to the single character restriction is that the two character sequence "\r\n" (Carriage Return + Line Feed)
+    can have a representation that is visible in line end viewing (<a class="seealso" href="#SCI_SETVIEWEOL">SCI_SETVIEWEOL</a>) mode.
+    If there is no representation for "\r\n" then the individual '\r' and '\n' representations will be seen.</p>
+
     <p>The NUL (0) character is a special case since the encodedCharacter parameter is NUL terminated, the NUL
     character is specified as an empty string.</p>
 
+    <p><b id="SCI_CLEARALLREPRESENTATIONS">SCI_CLEARALLREPRESENTATIONS</b><br />
+    Reset representations to defaults with <code>SCI_CLEARALLREPRESENTATIONS</code>.</p>
+
+    <p><b id="SCI_SETREPRESENTATIONAPPEARANCE">SCI_SETREPRESENTATIONAPPEARANCE(const char *encodedCharacter, int appearance)</b><br />
+     <b id="SCI_GETREPRESENTATIONAPPEARANCE">SCI_GETREPRESENTATIONAPPEARANCE(const char *encodedCharacter) &rarr; int</b><br />
+    The appearance may be changed using these flags. If a colour is set and the appearance is set without
+    <code>SC_REPRESENTATION_COLOUR</code> then the representation will show in the colour of the underlying text.</p>
+
+    <table class="standard" summary="Layer">
+      <tbody valign="top">
+        <tr>
+          <th align="left"><code>SC_REPRESENTATION_PLAIN</code></th>
+
+          <td>0</td>
+
+          <td>Draw the representation text with no decorations.</td>
+        </tr>
+
+        <tr>
+          <th align="left"><code>SC_REPRESENTATION_BLOB</code></th>
+
+          <td>1</td>
+
+          <td>Draw the representation text inverted in a rounded rectangle. This is the default appearance.</td>
+        </tr>
+
+        <tr class="section">
+          <th align="left"><code>SC_REPRESENTATION_COLOUR</code></th>
+
+          <td>0x10</td>
+
+          <td>Draw the representation in the colour set with <a class="seealso" href="#SCI_SETREPRESENTATIONCOLOUR">SCI_SETREPRESENTATIONCOLOUR</a>
+	  instead of in the colour of the style of the text being represented.</td>
+        </tr>
+
+      </tbody>
+    </table>
+
+
+    <p><b id="SCI_SETREPRESENTATIONCOLOUR">SCI_SETREPRESENTATIONCOLOUR(const char *encodedCharacter, colouralpha colour)</b><br />
+     <b id="SCI_GETREPRESENTATIONCOLOUR">SCI_GETREPRESENTATIONCOLOUR(const char *encodedCharacter) &rarr; colouralpha</b><br />
+    The colour and translucency of a representation may be set.</p>
+
     <p><b id="SCI_SETCONTROLCHARSYMBOL">SCI_SETCONTROLCHARSYMBOL(int symbol)</b><br />
      <b id="SCI_GETCONTROLCHARSYMBOL">SCI_GETCONTROLCHARSYMBOL &rarr; int</b><br />
     The mnemonics may be replaced by a nominated symbol with an ASCII code in the
diff --git a/doc/ScintillaHistory.html b/doc/ScintillaHistory.html
index 19ba6ca78..30008fc85 100644
--- a/doc/ScintillaHistory.html
+++ b/doc/ScintillaHistory.html
@@ -581,6 +581,10 @@
 	Released 2 June 2021.
 	</li>
 	<li>
+	Add APIs for setting appearance (traditional blob or plain text) and colour of representations
+	and support setting a representation for the "\r\n" line end sequence.
+	</li>
+	<li>
 	Fixed bug with SCI_GETLASTCHILD.
 	<a href="https://sourceforge.net/p/scintilla/bugs/2260/">Bug #2260</a>.
 	</li>
-- 
cgit v1.2.3