[vte/wip/egmont/bidi: 15/17] docs, bidi: Clarify the relation between get_text API methods and BiDi

[Egmont Koblinger <egmontkob src gnome org>]

commit d25f32a4f7cf5295197511070f0dd4e209ef609e
Author: Egmont Koblinger <egmont gmail com>
Date:   Thu Jun 6 00:42:56 2019 +0200

    docs,bidi: Clarify the relation between get_text API methods and BiDi

 src/vte/vteterminal.h |  2 +-
 src/vtegtk.cc         | 11 +++++++++++
 2 files changed, 12 insertions(+), 1 deletion(-)
---
diff --git a/src/vte/vteterminal.h b/src/vte/vteterminal.h
index 569dbc5b..18ac0714 100644
--- a/src/vte/vteterminal.h
+++ b/src/vte/vteterminal.h
@@ -113,7 +113,7 @@ struct _VteTerminalClass {
 /* The structure we return as the supplemental attributes for strings. */
 struct _VteCharAttributes {
         /*< private >*/
-       long row, column;
+        long row, column;  /* logical column */
        PangoColor fore, back;
        guint underline:1, strikethrough:1, columns:4;
 };
diff --git a/src/vtegtk.cc b/src/vtegtk.cc
index 3a1acf08..c18a178a 100644
--- a/src/vtegtk.cc
+++ b/src/vtegtk.cc
@@ -2533,6 +2533,8 @@ vte_terminal_unselect_all(VteTerminal *terminal)
  *
  * Reads the location of the insertion cursor and returns it.  The row
  * coordinate is absolute.
+ *
+ * This method is unaware of BiDi. The returned column is logical column.
  */
 void
 vte_terminal_get_cursor_position(VteTerminal *terminal,
@@ -2975,6 +2977,9 @@ warn_if_callback(VteSelectionFunc func)
  * is added to @attributes for each byte added to the returned string detailing
  * the character's position, colors, and other characteristics.
  *
+ * This method is unaware of BiDi. The columns returned in @attributes are
+ * logical columns.
+ *
  * Returns: (transfer full): a newly allocated text string, or %NULL.
  */
 char *
@@ -3005,6 +3010,9 @@ vte_terminal_get_text(VteTerminal *terminal,
  * is added to @attributes for each byte added to the returned string detailing
  * the character's position, colors, and other characteristics.
  *
+ * This method is unaware of BiDi. The columns returned in @attributes are
+ * logical columns.
+ *
  * Returns: (transfer full): a newly allocated text string, or %NULL.
  *
  * Deprecated: 0.56: Use vte_terminal_get_text() instead.
@@ -3037,6 +3045,9 @@ vte_terminal_get_text_include_trailing_spaces(VteTerminal *terminal,
  * entire scrollback buffer is scanned, so it is possible to read the entire
  * contents of the buffer using this function.
  *
+ * This method is unaware of BiDi. The columns passed in @start_col and @end_row,
+ * and returned in @attributes are logical columns.
+ *
  * Returns: (transfer full): a newly allocated text string, or %NULL.
  */
 char *