TextView - Rename Line to Paragraph.

[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / internal / controls / text-view / text-processor.h

diff --git a/base/dali-toolkit/internal/controls/text-view/text-processor.h b/base/dali-toolkit/internal/controls/text-view/text-processor.h
index 269b8ce..6324805 100644 (file)
--- a/base/dali-toolkit/internal/controls/text-view/text-processor.h
+++ b/base/dali-toolkit/internal/controls/text-view/text-processor.h
@@ -1,21 +1,22 @@
 #ifndef __DALI_TOOLKIT_TEXT_PROCESSOR_H__
 #define __DALI_TOOLKIT_TEXT_PROCESSOR_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/markup-processor/markup-processor.h>
@@ -33,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 );
 
 /**
@@ -84,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 );