Remove alignment from text controller.

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / cursor-helper-functions.h

diff --git a/dali-toolkit/internal/text/cursor-helper-functions.h b/dali-toolkit/internal/text/cursor-helper-functions.h
index 7ce02bf..08c21a3 100644 (file)
--- a/dali-toolkit/internal/text/cursor-helper-functions.h
+++ b/dali-toolkit/internal/text/cursor-helper-functions.h
@@ -47,8 +47,8 @@ struct CursorInfo
   ~CursorInfo()
   {}
 
-  Vector2 primaryPosition;       ///< The primary cursor's position.
-  Vector2 secondaryPosition;     ///< The secondary cursor's position.
+  Vector2 primaryPosition;       ///< The primary cursor's position (in text's coords).
+  Vector2 secondaryPosition;     ///< The secondary cursor's position (in text's coords).
   float   lineOffset;            ///< The vertical offset where the line containing the cursor starts.
   float   lineHeight;            ///< The height of the line where the cursor is placed.
   float   primaryCursorHeight;   ///< The primary cursor's height.
@@ -61,6 +61,9 @@ struct CursorInfo
  *
  * It returns the first line if the touch point is above the text and the last line if the touch point is below.
  *
+ * @param[in] visualModel The visual model.
+ * @param[in] visualY The touch point 'y' in text's coords.
+ *
  * @return A line index.
  */
 LineIndex GetClosestLine( VisualModelPtr visualModel,
@@ -72,8 +75,8 @@ LineIndex GetClosestLine( VisualModelPtr visualModel,
  * @param[in] visualModel The visual model.
  * @param[in] logicalModel The logical model.
  * @param[in] metrics A wrapper around FontClient used to get metrics.
- * @param[in] visualX The touch point x.
- * @param[in] visualY The touch point y.
+ * @param[in] visualX The touch point 'x' in text's coords.
+ * @param[in] visualY The touch point 'y' in text's coords.
  *
  * @return The logical cursor position (in characters). 0 is just before the first character, a value equal to the number of characters is just after the last character.
  */
@@ -90,6 +93,9 @@ CharacterIndex GetClosestCursorIndex( VisualModelPtr visualModel,
  * It retrieves as well the line's height and the cursor's height and
  * if there is a valid alternative cursor, its position and height.
  *
+ * @param[in] visualModel The visual model.
+ * @param[in] logicalModel The logical model.
+ * @param[in] metrics A wrapper around FontClient used to get metrics.
  * @param[in] logical The logical cursor position (in characters). 0 is just before the first character, a value equal to the number of characters is just after the last character.
  * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
  */
@@ -100,7 +106,15 @@ void GetCursorPosition( VisualModelPtr visualModel,
                         CursorInfo& cursorInfo );
 
 /**
+ * @brief Find the indices to the first and last characters of a word for the given touch point.
  *
+ * @param[in] visualModel The visual model.
+ * @param[in] logicalModel The logical model.
+ * @param[in] metrics A wrapper around FontClient used to get metrics.
+ * @param[in] visualX The touch point 'x' in text's coords.
+ * @param[in] visualY The touch point 'y' in text's coords.
+ * @param[out] startIndex Index to the first character of the selected word.
+ * @param[out] endIndex Index to the last character of the selected word.
  */
 void FindSelectionIndices( VisualModelPtr visualModel,
                            LogicalModelPtr logicalModel,