Bidirectional conversion table for multiline.

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / logical-model-impl.h

diff --git a/dali-toolkit/internal/text/logical-model-impl.h b/dali-toolkit/internal/text/logical-model-impl.h
index 6ff820d..9f2fa31 100644 (file)
--- a/dali-toolkit/internal/text/logical-model-impl.h
+++ b/dali-toolkit/internal/text/logical-model-impl.h
@@ -91,6 +91,9 @@ public:
   /**
    * @brief Retrieves the logical cursor index for the given visual cursor index.
    *
+   * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
+   *      then the character is not in a bidirectional line and the result will be invalid.
+   *
    * @param[in] visualCursorIndex The visual cursor index.
    *
    * @return The logical cursor index.
@@ -100,6 +103,9 @@ public:
   /**
    * @brief Retrieves the logical character index for the given visual character index.
    *
+   * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
+   *      then the character is not in a bidirectional line and the result will be invalid.
+   *
    * @param[in] visualCharacterIndex The visual character index.
    *
    * @return The logical character index.