dali-toolkit/internal/text/characters-helper-functions.h

   1 #ifndef DALI_TOOLKIT_TEXT_CHARACTERS_HELPER_FUNCTIONS_H
   2 #define DALI_TOOLKIT_TEXT_CHARACTERS_HELPER_FUNCTIONS_H
   3
   4 /*
   5  * Copyright (c) 2022 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/internal/text/character-run.h>
  23 #include <dali-toolkit/internal/text/text-definitions.h>
  24 #include <dali-toolkit/internal/text/text-model.h>
  25
  26 namespace Dali
  27 {
  28 namespace Toolkit
  29 {
  30 namespace Text
  31 {
  32 /**
  33  * @brief Retrieve the clustered consecutive characters that contains current character index.
  34  * Found the first index of clustered characters and number of characters.
  35  *
  36  * @param[in] visualModel The visual model.
  37  * @param[in] logicalModel The logical model.
  38  * @param[in] characterIndex The character index.
  39  *
  40  * @return CharacterRun for the clustered characters contains character Index
  41  */
  42 CharacterRun RetrieveClusteredCharactersOfCharacterIndex(const VisualModelPtr&  visualModel,
  43                                                          const LogicalModelPtr& logicalModel,
  44                                                          const CharacterIndex&  characterIndex);
  45
  46 } // namespace Text
  47
  48 } // namespace Toolkit
  49
  50 } // namespace Dali
  51
  52 #endif // DALI_TOOLKIT_TEXT_CHARACTERS_HELPER_FUNCTIONS_H