TextView - Rename Line to Paragraph.
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / internal / controls / text-view / text-processor.h
index cc2fd60..6324805 100644 (file)
@@ -34,27 +34,27 @@ namespace TextProcessor
 {
 
 /**
- * Splits the given text in lines.
+ * Splits the given text in paragraphs.
  *
  * @note Assumes the StyledTextArray has 1 Character per Text element. (which is the case for text in TextInput, but
  * not necessarily the case for text in TextView)
  *
  * @param [in] text The given text.
- * @param [out] lines The text split in lines.
+ * @param [out] paragraphs The text split in paragraphs.
  */
-void SplitInLines( const MarkupProcessor::StyledTextArray& text,
-                   std::vector<MarkupProcessor::StyledTextArray>& lines );
+void SplitInParagraphs( const MarkupProcessor::StyledTextArray& text,
+                        std::vector<MarkupProcessor::StyledTextArray>& paragraphs );
 
 /**
- * Splits the given line in words.
+ * Splits the given paragraph in words.
  *
  * @note Assumes the StyledTextArray has 1 Character per Text element. (which is the case for text in TextInput, but
  * not necessarily the case for text in TextView)
  *
- * @param [in] line The given line.
- * @param [out] words The line split in words.
+ * @param [in] paragraph The given paragraph.
+ * @param [out] words The paragraph split in words.
  */
-void SplitInWords( const MarkupProcessor::StyledTextArray& line,
+void SplitInWords( const MarkupProcessor::StyledTextArray& paragraph,
                    std::vector<MarkupProcessor::StyledTextArray>& words );
 
 /**
@@ -85,12 +85,12 @@ bool ContainsRightToLeftCharacter( const MarkupProcessor::StyledTextArray& text
  * Convert the text as specified by the Unicode Bidirectional Algorithm.
  * The text is converted only if it is bidirectional.
  * @param[in] line The line of text to be converted.
- * @param[out] convertedText The text converted. Text is grouped in chunks which only have one direction.
+ * @param[out] convertedText The text converted.
  * @param[out] logicalToVisualMap The character position map from the logical input text to the visual output text.
  * @param[out] visualToLogicalMap The character position map from the visual output text to the logical input text.
  */
  void ConvertBidirectionalText( const MarkupProcessor::StyledTextArray& line,
-                                std::vector<MarkupProcessor::StyledTextArray>& convertedText,
+                                MarkupProcessor::StyledTextArray& convertedText,
                                 std::vector<int>& logicalToVisualMap,
                                 std::vector<int>& visualToLogicalMap );