dali-toolkit/internal/text/segmentation.h

   1 #ifndef DALI_TOOLKIT_TEXT_SEGMENTATION_H
   2 #define DALI_TOOLKIT_TEXT_SEGMENTATION_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-vector.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/text/text-definitions.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Text
  34 {
  35
  36 class LogicalModel;
  37
  38 /**
  39  * Sets line break info.
  40  *
  41  * Possible values for LineBreakInfo are:
  42  *
  43  *  - 0 is a LINE_MUST_BREAK.  Text must be broken into a new line.
  44  *  - 1 is a LINE_ALLOW_BREAK. Is possible to break the text into a new line.
  45  *  - 2 is a LINE_NO_BREAK.    Text can't be broken into a new line.
  46  *
  47  * @param[in] text Vector of UTF-32 characters.
  48  * @param[in] startIndex The character from where the break info is set.
  49  * @param[in] numberOfCharacters The number of characters.
  50  * @param[out] lineBreakInfo The line break info
  51  */
  52 void SetLineBreakInfo( const Vector<Character>& text,
  53                        CharacterIndex startIndex,
  54                        Length numberOfCharacters,
  55                        Vector<LineBreakInfo>& lineBreakInfo );
  56
  57 /**
  58  * Sets word break info.
  59  *
  60  * - 0 is a WORD_BREAK.    Text can be broken into a new word.
  61  * - 1 is a WORD_NO_BREAK. Text can't be broken into a new word.
  62  *
  63  * @param[in] text Vector of UTF-32 characters.
  64  * @param[in] startIndex The character from where the break info is set.
  65  * @param[in] numberOfCharacters The number of characters.
  66  * @param[out] wordBreakInfo The word break info.
  67  */
  68 void SetWordBreakInfo( const Vector<Character>& text,
  69                        CharacterIndex startIndex,
  70                        Length numberOfCharacters,
  71                        Vector<WordBreakInfo>& wordBreakInfo );
  72
  73 } // namespace Text
  74
  75 } // namespace Toolkit
  76
  77 } // namespace Dali
  78
  79 #endif // DALI_TOOLKIT_TEXT_SEGMENTATION_H