X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Ftext-controls%2Ftext-label-impl.h;h=31167d8d19143abedc023e7446fd10f943045aea;hp=01e003b231161eb2e14f8458e4c7192ec8ab991e;hb=HEAD;hpb=b039ecfd6a5a2ab3529b8ea36c23fde8b2e847f5 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 01e003b..5730cc5 100644 --- a/dali-toolkit/internal/controls/text-controls/text-label-impl.h +++ b/dali-toolkit/internal/controls/text-controls/text-label-impl.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H /* - * Copyright (c) 2021 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. @@ -19,20 +19,24 @@ */ // EXTERNAL INCLUDES +#include +#include +#include #include // INTERNAL INCLUDES +#include #include +#include +#include #include #include #include -#include #include #include #include #include #include - namespace Dali { namespace Toolkit @@ -47,8 +51,9 @@ class TextLabel : public Control, public Text::ControlInterface, public Text::Sc 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 @@ -76,6 +81,11 @@ public: DevelTextLabel::AnchorClickedSignalType& AnchorClickedSignal(); /** + * @copydoc Dali::Toollkit::TextLabel::TextFitChangedSignal() + */ + DevelTextLabel::TextFitChangedSignalType& TextFitChangedSignal(); + + /** * 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. @@ -93,6 +103,129 @@ public: */ 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; + private: // From Control /** * @copydoc Control::OnInitialize() @@ -100,6 +233,11 @@ private: // From Control void OnInitialize() override; /** + * @copydoc Toolkit::Internal::Control::CreateAccessibleObject() + */ + DevelControl::ControlAccessible* CreateAccessibleObject() override; + + /** * @copydoc Control::OnStyleChange() */ void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override; @@ -129,6 +267,16 @@ private: // From Control */ 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 /** @@ -151,8 +299,10 @@ public: // From AnchorControlInterface 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() @@ -189,76 +339,65 @@ private: */ 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(); + void OnAccessibilityStatusChanged(); + private: // Data Text::ControllerPtr mController; Text::TextScrollerPtr mTextScroller; Toolkit::Visual::Base mVisual; + std::vector mAnchorActors; + // Signals - Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal; + Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal; + Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal; + + std::string mLocale; int mRenderingBackend; bool mTextUpdateNeeded : 1; + bool mLastAutoScrollEnabled : 1; protected: /** * @brief This structure is to connect TextLabel with Accessible functions. */ - struct AccessibleImpl : public DevelControl::AccessibleImpl, - public virtual Dali::Accessibility::Text + class TextLabelAccessible : public TextControlAccessible { - using DevelControl::AccessibleImpl::AccessibleImpl; - - /** - * @copydoc Dali::Accessibility::Text::GetText() - */ - std::string GetText(size_t startOffset, size_t endOffset) override; - - /** - * @copydoc Dali::Accessibility::Text::GetCharacterCount() - */ - size_t GetCharacterCount() override; - - /** - * @copydoc Dali::Accessibility::Text::GetCursorOffset() - */ - size_t GetCursorOffset() override; - - /** - * @copydoc Dali::Accessibility::Text::SetCursorOffset() - */ - bool SetCursorOffset(size_t offset) override; - - /** - * @copydoc Dali::Accessibility::Text::GetTextAtOffset() - */ - Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override; - - /** - * @copydoc Dali::Accessibility::Text::GetRangeOfSelection() - */ - Accessibility::Range GetRangeOfSelection(size_t selectionIndex) override; + public: + using TextControlAccessible::TextControlAccessible; /** - * @copydoc Dali::Accessibility::Text::RemoveSelection() + * @copydoc Dali::Accessibility::Text::GetNameRaw() */ - bool RemoveSelection(size_t selectionIndex) override; + std::string GetNameRaw() const override; /** - * @copydoc Dali::Accessibility::Text::SetRangeOfSelection() + * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex() */ - bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override; + Property::Index GetNamePropertyIndex() override; + protected: /** - * @copydoc Dali::Accessibility::Text::GetNameRaw() + * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors() */ - std::string GetNameRaw() override; + const std::vector& GetTextAnchors() const override; /** - * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex() + * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController() */ - Property::Index GetNamePropertyIndex() override; + Toolkit::Text::ControllerPtr GetTextController() const override; }; };