#define DALI_TOOLKIT_TEXT_MODEL_INTERFACE_H
/*
- * Copyright (c) 2022 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 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.
*
* @return A pointer to the vector with the laid-out lines.
*/
- virtual const LineRun* const GetLines() const = 0;
+ virtual const LineRun* GetLines() const = 0;
/**
* @brief Retrieves the number of script runs.
*
* @return A pointer to the vector with the runs of characters with the same script..
*/
- virtual const ScriptRun* const GetScriptRuns() const = 0;
+ virtual const ScriptRun* GetScriptRuns() const = 0;
+
+ /**
+ * @brief Retrieves number of characters.
+ *
+ * @return The number of characters.
+ */
+ virtual Length GetNumberOfCharacters() const = 0;
/**
* @brief Retrieves the number of laid-out glyphs.
*
* @return A pointer to the vector with the laid-out glyphs.
*/
- virtual const GlyphInfo* const GetGlyphs() const = 0;
+ virtual const GlyphInfo* GetGlyphs() const = 0;
/**
* @brief Retrieves the text layout.
*
* @return A pointer to the vector with the positions for each glyph.
*/
- virtual const Vector2* const GetLayout() const = 0;
+ virtual const Vector2* GetLayout() const = 0;
/**
* @brief Retrieves the vector of colors.
*
* @return Pointer to the vector of colors.
*/
- virtual const Vector4* const GetColors() const = 0;
+ virtual const Vector4* GetColors() const = 0;
/**
* @brief Retrieves the vector of indices to the vector of colors.
*
* @return Pointer to a vector which stores for each glyph the index to the vector of colors.
*/
- virtual const ColorIndex* const GetColorIndices() const = 0;
+ virtual const ColorIndex* GetColorIndices() const = 0;
/**
* @brief Retrieves the vector of background colors.
*
* @return Pointer to the vector of background colors.
*/
- virtual const Vector4* const GetBackgroundColors() const = 0;
+ virtual const Vector4* GetBackgroundColors() const = 0;
/**
* @brief Retrieves the vector of indices to the vector of background colors.
*
* @return Pointer to a vector which stores for each glyph the index to the vector of background colors.
*/
- virtual const ColorIndex* const GetBackgroundColorIndices() const = 0;
+ virtual const ColorIndex* GetBackgroundColorIndices() const = 0;
/**
* @brief checks if there is background colors set using markup.
*
* @return boolean if there is background colors set using markup .
*/
- virtual bool const IsMarkupBackgroundColorSet() const = 0;
+ virtual bool IsMarkupBackgroundColorSet() const = 0;
/**
* @brief Retrieves the text's default color.
*
* @return boolean if there is underline set using markup.
*/
- virtual bool const IsMarkupUnderlineSet() const = 0;
+ virtual bool IsMarkupUnderlineSet() const = 0;
/**
* @brief Retrieves the underline height override
virtual void GetUnderlineRuns(UnderlinedGlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const = 0;
/**
+ * @brief Retrieves the outline offset.
+ *
+ * @return The outline offset.
+ */
+ virtual const Vector2& GetOutlineOffset() const = 0;
+
+ /**
* @brief Retrieve the outline color.
*
* @return The outline color.
virtual uint16_t GetOutlineWidth() const = 0;
/**
+ * @brief Retrieve the outline blur radius.
+ *
+ * @return The outline blur radius.
+ */
+ virtual const float& GetOutlineBlurRadius() const = 0;
+
+ /**
* @brief Retrieves the background color.
*
* @return The background color.
*
* @return boolean if there is strikethrough set using markup.
*/
- virtual bool const IsMarkupStrikethroughSet() const = 0;
+ virtual bool IsMarkupStrikethroughSet() const = 0;
/**
* @brief Retrieves the strikethrough height override
*
* @return The character spacing.
*/
- virtual const float GetCharacterSpacing() const = 0;
+ virtual float GetCharacterSpacing() const = 0;
/**
* @brief Retrieves the text buffer.
* @return The reference for font description runs.
*/
virtual const Vector<FontDescriptionRun>& GetFontDescriptionRuns() const = 0;
+
+ /**
+ * @brief Retrieves the remove front inset is enabled or not.
+ *
+ * @return boolean if it is enabled.
+ */
+ virtual bool IsRemoveFrontInset() const = 0;
+
+ /**
+ * @brief Retrieves the remove back inset is enabled or not.
+ *
+ * @return boolean if it is enabled.
+ */
+ virtual bool IsRemoveBackInset() const = 0;
+
+ /**
+ * @brief Retrieves the cutout is enabled or not.
+ *
+ * @return boolean if it is enabled.
+ */
+ virtual bool IsCutoutEnabled() const = 0;
+
+ /**
+ * @brief Retrieves the background with cutout is enabled or not.
+ *
+ * @return boolean if it is enabled.
+ */
+ virtual const bool IsBackgroundWithCutoutEnabled() const = 0;
+
+ /**
+ * @brief Retrieves the color of the background with cutout.
+ *
+ * @return The color of the background with cutout.
+ */
+ virtual const Vector4& GetBackgroundColorWithCutout() const = 0;
};
} // namespace Text