From 002dc0e7fca8824a03bc0a11ac6e5c3aef6a54bf Mon Sep 17 00:00:00 2001
From: johnsonj <unknown>
Date: Fri, 12 May 2023 17:31:19 +1000
Subject: Bug [#2240]. Add documentation about IME support.

---
 doc/ScintillaDoc.html | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 68 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index 38fe334d9..b445891b9 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -4879,7 +4879,74 @@ struct Sci_TextToFindFull {
      A windowed IME <code>SC_IME_WINDOWED</code> (0) may be more similar in appearance and
      behaviour to the IME in other applications.
      An inline IME <code>SC_IME_INLINE</code> (1) may work better with some Scintilla features such as
-     rectangular and multiple selection.</p>
+     rectangular and multiple selection, with IME interactions such as retrieve-surrounding or reconversion feature.</p>
+
+    <table class="standard" summary="IME input method">
+      <caption>IME input method support (O=present, X=absent)</caption>
+      <thead align="left">
+        <tr>
+          <th>IME input method</th>
+          <th>Windows</th>
+          <th>Gtk</th>
+          <th>Qt</th>
+          <th>macOS</th>
+        </tr>
+      </thead>
+      <tbody valign="top">
+        <tr>
+          <th align="left"><code>SC_IME_WINDOWED</code></th>
+          <td>O</td>
+          <td>O</td>
+          <td>X</td>
+          <td>X</td>
+        </tr>
+        <tr>
+          <th align="left"><code>SC_IME_INLINE</code></th>
+          <td>O</td>
+          <td>O</td>
+          <td>O</td>
+          <td>O</td>
+       </tr>
+      </tbody>
+    </table>
+    <p></p>
+
+    <table class="standard" summary="IME interaction">
+      <caption>IME interaction support</caption>
+      <thead align="left">
+        <tr>
+          <th>IME interaction</th>
+          <th>Windows</th>
+          <th>Gtk</th>
+          <th>Qt</th>
+          <th>macOS</th>
+        </tr>
+      </thead>
+      <tbody valign="top">
+        <tr>
+          <th align="left">Retrieve Surrounding</th>
+          <td>O</td>
+          <td>O</td>
+          <td>O</td>
+          <td>O</td>
+        </tr>
+        <tr>
+          <th align="left">Reconversion</th>
+          <td>O</td>
+          <td>O</td>
+          <td>O</td>
+          <td>O</td>
+        </tr>
+        <tr>
+          <th align="left">Delete Surrounding</th>
+          <td>O</td>
+          <td>O</td>
+          <td>X</td>
+          <td>O</td>
+        </tr>
+      </tbody>
+    </table>
+
      <p>The windowed behaviour can be chosen with <code>SCI_SETIMEINTERACTION(SC_IME_WINDOWED)</code>
      and the inline behaviour with <code>SCI_SETIMEINTERACTION(SC_IME_INLINE)</code>.
      Scintilla may ignore this call in some cases. For example, the inline behaviour might only be supported for some languages.</p>
-- 
cgit v1.2.3