dali-toolkit/internal/text/embedded-item.h

   1 #ifndef DALI_TOOLKIT_TEXT_EMBEDDED_ITEM_H
   2 #define DALI_TOOLKIT_TEXT_EMBEDDED_ITEM_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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/internal/text/text-definitions.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Text
  31 {
  32
  33 /**
  34  * @brief An embedded item within the text.
  35  *
  36  * The @e url of the image is optional. If there is no image
  37  * the layout engine will use the @e width and @e height to
  38  * create a space inside the text. This gap can be filled later.
  39  *
  40  * A color blending mode can be set. The default is NONE, the
  41  * image will use its own color. If MULTIPLY is set, the color
  42  * of the image will be multiplied by the color of the text.
  43  */
  44 struct EmbeddedItem
  45 {
  46   CharacterIndex    characterIndex;    ///< The character's index of the embedded item within the string.
  47   char*             url;               ///< The url path of the image.
  48   Length            urlLength;         ///< The length of the url.
  49   unsigned int      width;             ///< The width of the item.
  50   unsigned int      height;            ///< The height of the item.
  51   ColorBlendingMode colorBlendingMode; ///< Whether the color of the image is multiplied by the color of the text.
  52 };
  53
  54 } // namespace Text
  55
  56 } // namespace Toolkit
  57
  58 } // namespace Dali
  59
  60 #endif // DALI_TOOLKIT_TEXT_EMBEDDED_ITEM_H