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

[Egmont Koblinger <egmontkob src gnome org>]

commit 04c8f7fa0f11cfc14158e81fe8de047b528e0823
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         | 9 +++++++++
 2 files changed, 10 insertions(+), 1 deletion(-)
---
diff --git a/src/vte/vteterminal.h b/src/vte/vteterminal.h
index 708a9a82..3599a579 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 63fc193a..17da05d2 100644
--- a/src/vtegtk.cc
+++ b/src/vtegtk.cc
@@ -2973,6 +2973,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 *
@@ -3003,6 +3006,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.
@@ -3035,6 +3041,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 *