X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Ftext-controls%2Ftext-label-impl.h;h=31167d8d19143abedc023e7446fd10f943045aea;hb=HEAD;hp=c72c9c5206e53afee3f4f5e441e9ca0462bd12a5;hpb=e979409480340033e0154a43bb1cbeeeb8d1c6a3;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/controls/text-controls/text-label-impl.h b/dali-toolkit/internal/controls/text-controls/text-label-impl.h index c72c9c5..ddd6e48 100644 --- a/dali-toolkit/internal/controls/text-controls/text-label-impl.h +++ b/dali-toolkit/internal/controls/text-controls/text-label-impl.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__ -#define __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__ +#ifndef DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H +#define DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 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. @@ -18,32 +18,43 @@ * */ +// EXTERNAL INCLUDES +#include +#include +#include +#include + // INTERNAL INCLUDES +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include #include #include -#include -#include - namespace Dali { - namespace Toolkit { - namespace Internal { - /** * @brief A control which renders a short text string. */ -class TextLabel : public Control, public Text::ControlInterface +class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface, public Text::AsyncTextInterface { public: - /** * @copydoc Dali::Toollkit::TextLabel::New() + * @param[in] additionalBehaviour custom behavior flags for this TextLabel. Default is CONTROL_BEHAVIOUR_DEFAULT */ - static Toolkit::TextLabel New(); + static Toolkit::TextLabel New(ControlBehaviour additionalBehaviour = ControlBehaviour::CONTROL_BEHAVIOUR_DEFAULT); // Properties @@ -54,7 +65,7 @@ public: * @param[in] index The property index. * @param[in] value The new property value. */ - static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value ); + static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value); /** * @brief Called to retrieve a property of an object of this type. @@ -63,41 +74,325 @@ public: * @param[in] index The property index. * @return The current value of the property. */ - static Property::Value GetProperty( BaseObject* object, Property::Index index ); + static Property::Value GetProperty(BaseObject* object, Property::Index index); -private: // From Control + /** + * @copydoc Dali::Toollkit::TextLabel::AnchorClickedSignal() + */ + DevelTextLabel::AnchorClickedSignalType& AnchorClickedSignal(); /** - * @copydoc Control::OnInitialize() + * @copydoc Dali::Toollkit::TextLabel::TextFitChangedSignal() + */ + 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. + * @param[in] signalName The signal to connect to. + * @param[in] functor A newly allocated FunctorDelegate. + * @return True if the signal was connected. + * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor. + */ + static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor); + + /** + * @brief Gets text controller + * + * @return The text controller + */ + Text::ControllerPtr GetTextController(); + + /** + * @brief Get the rendered size of a specific text range. + * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line. + * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction. + * + * @param[in] startIndex start index of the text requested to calculate size for. + * @param[in] endIndex end index(included) of the text requested to calculate size for. + * @return list of sizes of the reuested text. + */ + Vector GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const; + + /** + * @brief Get the top/left rendered position of a specific text range. + * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line. + * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction. + * + * @param[in] startIndex start index of the text requested to get position to. + * @param[in] endIndex end index(included) of the text requested to get position to. + * @return list of positions of the requested text. + */ + Vector GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const; + + /** + * @brief Get the line bounding rectangle. + * if the requested index is out of range or the line is not yet rendered, a rect of {0, 0, 0, 0} is returned. + * + * @param[in] lineIndex line index to which we want to calculate the geometry for. + * @return bounding rectangle. + */ + Rect 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 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& fitOptions); + + /** + * @brief Get the text fit array of text label. + * + * @return list of the fit options. + */ + std::vector& 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. */ - virtual void OnInitialize(); + 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() */ - virtual void OnRelayout( const Vector2& size, ActorSizeContainer& container ); + void OnInitialize() override; + + /** + * @copydoc Toolkit::Internal::Control::CreateAccessibleObject() + */ + DevelControl::ControlAccessible* CreateAccessibleObject() override; + + /** + * @copydoc Control::OnStyleChange() + */ + void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override; + + /** + * @copydoc Control::OnRelayout() + */ + void OnRelayout(const Vector2& size, RelayoutContainer& container) override; + + /** + * @copydoc Control::OnTap() + */ + void OnTap(const TapGesture& tap) override; /** * @copydoc Control::GetNaturalSize() */ - virtual Vector3 GetNaturalSize(); + Vector3 GetNaturalSize() override; /** * @copydoc Control::GetHeightForWidth() */ - virtual float GetHeightForWidth( float width ); + float GetHeightForWidth(float width) override; + + /** + * @copydoc Control::OnPropertySet() + */ + void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override; + + /** + * @copydoc Control::OnSceneConnection() + */ + void OnSceneConnection(int depth) override; + + /** + * @copydoc Control::OnSceneDisconnection() + */ + void OnSceneDisconnection() override; + + // From ControlInterface /** * @copydoc Text::ControlInterface::RequestTextRelayout() */ - virtual void RequestTextRelayout(); + void RequestTextRelayout() override; -private: // Implementation +private: // from TextScroller + /** + * @copydoc Text::ScrollerInterface::ScrollingFinished() + */ + void ScrollingFinished() override; + +public: // From AnchorControlInterface + /** + * @copydoc Text::AnchorControlInterface::AnchorClicked() + */ + 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. + * + * @param[in] additionalBehaviour additional behaviour flags for this TextLabel */ - TextLabel(); + TextLabel(ControlBehaviour additionalBehaviour); /** * A reference counted object may only be deleted by calling Unreference() @@ -105,25 +400,143 @@ private: // Implementation virtual ~TextLabel(); private: - // Undefined copy constructor and assignment operators TextLabel(const 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(); + + /** + * Creates a text-scroller if one has not been created. + * @return The text scroller. + */ + Text::TextScrollerPtr GetTextScroller() + { + if(!mTextScroller) + { + mTextScroller = Text::TextScroller::New(*this); + } + return mTextScroller; + } + + /** + * @brief Callback function for when the layout is changed. + * @param[in] actor The actor whose layoutDirection is changed. + * @param[in] type The layoutDirection. + */ + 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 + Text::ControllerPtr mController; + Text::TextScrollerPtr mTextScroller; + + Toolkit::Visual::Base mVisual; + + std::vector mAnchorActors; - Text::ControllerPtr mController; - Text::RendererPtr mRenderer; - RenderableActor mRenderableActor; + // Signals + Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal; + Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal; + Toolkit::DevelTextLabel::AsyncTextRenderedSignalType mAsyncTextRenderedSignal; + Toolkit::DevelTextLabel::AsyncNaturalSizeComputedSignalType mAsyncNaturalSizeComputedSignal; + Toolkit::DevelTextLabel::AsyncHeightForWidthComputedSignalType mAsyncHeightForWidthComputedSignal; - int mRenderingBackend; + + std::string mLocale; + Vector2 mSize; + + int mRenderingBackend; + 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: + /** + * @brief This structure is to connect TextLabel with Accessible functions. + */ + class TextLabelAccessible : public TextControlAccessible + { + public: + using TextControlAccessible::TextControlAccessible; + + /** + * @copydoc Dali::Accessibility::Text::GetNameRaw() + */ + std::string GetNameRaw() const override; + + /** + * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex() + */ + Property::Index GetNamePropertyIndex() override; + + protected: + /** + * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors() + */ + const std::vector& GetTextAnchors() const override; + + /** + * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController() + */ + Toolkit::Text::ControllerPtr GetTextController() const override; + }; }; } // namespace Internal // Helpers for public-api forwarding methods -inline Toolkit::Internal::TextLabel& GetImpl( Toolkit::TextLabel& textLabel ) +inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel) { DALI_ASSERT_ALWAYS(textLabel); @@ -132,7 +545,7 @@ inline Toolkit::Internal::TextLabel& GetImpl( Toolkit::TextLabel& textLabel ) return static_cast(handle); } -inline const Toolkit::Internal::TextLabel& GetImpl( const Toolkit::TextLabel& textLabel ) +inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel) { DALI_ASSERT_ALWAYS(textLabel); @@ -145,4 +558,4 @@ inline const Toolkit::Internal::TextLabel& GetImpl( const Toolkit::TextLabel& te } // namespace Dali -#endif // __DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H__ +#endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H