#include <dali/public-api/object/property-map.h>
// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/text/spanned.h>
#include <dali-toolkit/internal/controls/control/control-data-impl.h>
#include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
+#include <dali-toolkit/internal/text/async-text/async-text-loader.h>
+#include <dali-toolkit/internal/text/controller/text-controller.h>
#include <dali-toolkit/internal/text/rendering/text-renderer.h>
#include <dali-toolkit/internal/text/text-anchor-control-interface.h>
#include <dali-toolkit/internal/text/text-control-interface.h>
-#include <dali-toolkit/internal/text/controller/text-controller.h>
#include <dali-toolkit/internal/text/text-scroller-interface.h>
#include <dali-toolkit/internal/text/text-scroller.h>
#include <dali-toolkit/internal/visuals/text/text-visual.h>
#include <dali-toolkit/public-api/controls/control-impl.h>
#include <dali-toolkit/public-api/controls/text-controls/text-label.h>
-
namespace Dali
{
namespace Toolkit
/**
* @brief A control which renders a short text string.
*/
-class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface
+class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface, public Text::AsyncTextInterface
{
public:
/**
DevelTextLabel::TextFitChangedSignalType& TextFitChangedSignal();
/**
+ * @copydoc Dali::Toollkit::TextLabel::AsyncTextRenderedSignal()
+ */
+ DevelTextLabel::AsyncTextRenderedSignalType& AsyncTextRenderedSignal();
+
+ /**
+ * @copydoc Dali::Toollkit::TextLabel::AsyncNaturalSizeComputedSignal()
+ */
+ DevelTextLabel::AsyncNaturalSizeComputedSignalType& AsyncNaturalSizeComputedSignal();
+
+ /**
+ * @copydoc Dali::Toollkit::TextLabel::AsyncHeightForWidthComputedSignal()
+ */
+ DevelTextLabel::AsyncHeightForWidthComputedSignalType& AsyncHeightForWidthComputedSignal();
+
+ /**
* Connects a callback function with the object's signals.
* @param[in] object The object providing the signal.
* @param[in] tracker Used to disconnect the signal.
*/
Rect<float> GetLineBoundingRectangle(const uint32_t lineIndex) const;
+ /**
+ * @brief Get the character bounding rectangle.
+ * If the text is not yet rendered or the index > text.Count(); a rect of {0, 0, 0, 0} is returned.
+ *
+ * @param[in] charIndex character index to which we want to calculate the geometry for.
+ * @return bounding rectangle.
+ */
+ Rect<float> GetCharacterBoundingRectangle(const uint32_t charIndex) const;
+
+ /**
+ * @brief Get the character index.
+ * If the text is not yet rendered or the textis empty, -1 is returned.
+ *
+ * @param[in] visualX visual x position.
+ * @param[in] visualY visual y position.
+ * @return character index.
+ */
+ int GetCharacterIndexAtPosition(float visualX, float visualY) const;
+
+ /**
+ * @brief Gets the bounding box of a specific text range.
+ *
+ * @param[in] startIndex start index of the text requested to get bounding box to.
+ * @param[in] endIndex end index(included) of the text requested to get bounding box to.
+ * @return bounding box of the requested text.
+ */
+ Rect<> GetTextBoundingRectangle(uint32_t startIndex, uint32_t endIndex) const;
+
+ /**
+ * @brief Set the @p spannedText into current textLabel
+ * the spanned text contains content (text) and format (spans with ranges)
+ * the text is copied into text-controller and the spans are applied on ranges
+ *
+ * @param[in] spannedText the text with spans.
+ */
+ void SetSpannedText(const Text::Spanned& spannedText);
+
+ /**
+ * @brief Set text fit array to text label.
+ *
+ * @param[in] enable Whether the text fit array is enabled or not.
+ * @param[in] fitOptions list of the fit options.
+ */
+ void SetTextFitArray(const bool enable, std::vector<Toolkit::DevelTextLabel::FitOption>& fitOptions);
+
+ /**
+ * @brief Get the text fit array of text label.
+ *
+ * @return list of the fit options.
+ */
+ std::vector<Toolkit::DevelTextLabel::FitOption>& GetTextFitArray();
+
+ /**
+ * @brief Whether the text fit array is enabled or not.
+ *
+ * @return True if the text fit array is enabled.
+ */
+ bool IsTextFitArrayEnabled() const;
+
+ /**
+ * @brief Gets the locale.
+ */
+ std::string GetLocale();
+
+ /**
+ * @brief Set removing front inset to text label.
+ *
+ * @param[in] remove Whether front inset of text label has to be removed or not.
+ */
+ void SetRemoveFrontInset(const bool remove);
+
+ /**
+ * @brief Whether front inset of text label is removed or not.
+ *
+ * @return True if the front inset of text label is removed.
+ */
+ bool IsRemoveFrontInset() const;
+
+ /**
+ * @brief Set removing back inset to text label.
+ *
+ * @param[in] remove Whether back inset of text label has to be removed or not.
+ */
+ void SetRemoveBackInset(const bool remove);
+
+ /**
+ * @brief Whether back inset of text label is removed or not.
+ *
+ * @return True if the back inset of text label is removed.
+ */
+ bool IsRemoveBackInset() const;
+
+ /**
+ * @brief Enable control's background
+ *
+ * @param[in] enable Whether to enable the background of control.
+ */
+ void EnableControlBackground(const bool enable);
+
+ /**
+ * @brief A method that requests asynchronous rendering of text with a fixed size.
+ *
+ * @param[in] width The width of text to render.
+ * @param[in] height The height of text to render.
+ */
+ void RequestAsyncRenderWithFixedSize(float width, float height);
+
+ /**
+ * @brief Requests asynchronous text rendering with a fixed width.
+ * The height is determined by the content of the text when rendered with the given width.
+ * The result will be the same as the height returned by GetHeightForWidth.
+ * If the heightConstraint is given, the maximum height will be the heightConstraint.
+ *
+ * @param[in] width The width of text to render.
+ * @param[in] heightConstraint The maximum available height of text to render.
+ */
+ void RequestAsyncRenderWithFixedWidth(float width, float heightConstraint);
+
+ /**
+ * @brief Requests asynchronous rendering with the maximum available width using the given widthConstraint.
+ *
+ * If the width of the text content is smaller than the widthConstraint, the width will be determined by the width of the text.
+ * If the width of the text content is larger than the widthConstraint, the width will be determined by the widthConstraint.
+ * The height is determined by the content of the text when rendered with the given width.
+ * In this case, the result will be the same as the height returned by GetHeightForWidth.
+ * If the heightConstraint is given, the maximum height will be the heightConstraint.
+ *
+ * @param[in] widthConstraint The maximum available width of text to render.
+ */
+ void RequestAsyncRenderWithConstraint(float widthConstraint, float heightConstraint);
+
+ /**
+ * @brief Requests asynchronous text natural size computation.
+ */
+ void RequestAsyncNaturalSize();
+
+ /**
+ * @brief Requests asynchronous computation of the height of the text based on the given width.
+ * @param[in] width The width of text to compute.
+ */
+ void RequestAsyncHeightForWidth(float width);
+
+
private: // From Control
/**
* @copydoc Control::OnInitialize()
*/
void AnchorClicked(const std::string& href) override;
+private: // from AsyncTextInterface
+
+ /**
+ * @copydoc Text::AsyncTextInterface::AsyncSetupAutoScroll()
+ */
+ void AsyncSetupAutoScroll(Text::AsyncTextRenderInfo renderInfo) override;
+
+ /**
+ * @copydoc Text::AsyncTextInterface::AsyncTextFitChanged()
+ */
+ void AsyncTextFitChanged(float pointSize) override;
+
+ /**
+ * @copydoc Text::AsyncTextInterface::AsyncLoadComplete()
+ */
+ void AsyncLoadComplete(Text::AsyncTextRenderInfo renderInfo);
+
+ /**
+ * @copydoc Text::AsyncTextInterface::AsyncSizeComputed()
+ */
+ void AsyncSizeComputed(Text::AsyncTextRenderInfo renderInfo);
+
+
private: // Implementation
/**
* Construct a new TextLabel.
TextLabel& operator=(const TextLabel& rhs);
/**
+ * @brief Get the AsyncTextParameters
+ * All properties of the text label needed to render the text are stored and returned in the parameter.
+ *
+ * @param[in] requestType Type to request asynchronous computation.
+ * @param[in] contentSize The size of the text content requested by relayout excluding padding.
+ * @param[in] padding The size of the label's padding.
+ * @param[in] layoutDirection The layout direction.
+ * @return The parameters for async text render.
+ */
+ Text::AsyncTextParameters GetAsyncTextParameters(const Text::Async::RequestType requestType, const Vector2& contentSize, const Extents& padding, const Dali::LayoutDirection::Type layoutDirection);
+
+ /**
* @brief Set up Autoscrolling
*/
void SetUpAutoScrolling();
void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
/**
+ * @brief Callback function for when the locale is changed.
+ * @param[in] locale The new system locale.
+ */
+ void OnLocaleChanged(std::string locale);
+
+ /**
* @brief Emits TextFitChanged signal.
*/
void EmitTextFitChangedSignal();
+
+ /**
+ * @brief Emits AsyncTextRendered signal.
+ */
+ void EmitAsyncTextRenderedSignal(float width, float height);
+
+ /**
+ * @brief Emits AsyncNaturalSizeComputed signal.
+ */
+ void EmitAsyncNaturalSizeComputedSignal(float width, float height);
+
+ /**
+ * @brief Emits AsyncHeightForWidthComputed signal.
+ */
+ void EmitAsyncHeightForWidthComputedSignal(float width, float height);
+
void OnAccessibilityStatusChanged();
private: // Data
// Signals
Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal;
Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal;
+ Toolkit::DevelTextLabel::AsyncTextRenderedSignalType mAsyncTextRenderedSignal;
+ Toolkit::DevelTextLabel::AsyncNaturalSizeComputedSignalType mAsyncNaturalSizeComputedSignal;
+ Toolkit::DevelTextLabel::AsyncHeightForWidthComputedSignalType mAsyncHeightForWidthComputedSignal;
+
+
+ std::string mLocale;
+ Vector2 mSize;
int mRenderingBackend;
- bool mTextUpdateNeeded : 1;
- bool mLastAutoScrollEnabled : 1;
+ int mAsyncLineCount;
+ bool mTextUpdateNeeded : 1;
+ bool mLastAutoScrollEnabled : 1;
+ bool mControlBackgroundEnabeld : 1;
+
+ bool mIsAsyncRenderNeeded : 1; // true if a render request is required in ASYNC_AUTO mode, otherwise false.
+ bool mIsSizeChanged : 1; // whether the size has been changed or not.
+ bool mIsManualRender : 1; // whether an async manual render has been requested, returns false when completed.
+ bool mIsManualRendered : 1; // whether an async manual render has been completed, returns false on the next relayout.
+ bool mManualRendered : 1;
protected:
/**
projects / platform / core / uifw / dali-toolkit.git / blobdiff