#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.
*/
// EXTERNAL INCLUDES
+#include <dali/devel-api/actors/actor-devel.h>
+#include <dali/devel-api/atspi-interfaces/hypertext.h>
+#include <dali/devel-api/atspi-interfaces/text.h>
#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/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/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
+class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface
{
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
*/
static Property::Value GetProperty(BaseObject* object, Property::Index index);
- Text::ControllerPtr getController();
+ /**
+ * @copydoc Dali::Toollkit::TextLabel::AnchorClickedSignal()
+ */
+ 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.
+ * @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<Vector2> 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<Vector2> 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<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;
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;
void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
/**
+ * @copydoc Control::OnTap()
+ */
+ void OnTap(const TapGesture& tap) override;
+
+ /**
* @copydoc Control::GetNaturalSize()
*/
Vector3 GetNaturalSize() override;
*/
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
/**
*/
void ScrollingFinished() override;
+public: // From AnchorControlInterface
+ /**
+ * @copydoc Text::AnchorControlInterface::AnchorClicked()
+ */
+ void AnchorClicked(const std::string& href) override;
+
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()
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();
+ void OnAccessibilityStatusChanged();
+
private: // Data
Text::ControllerPtr mController;
Text::TextScrollerPtr mTextScroller;
Toolkit::Visual::Base mVisual;
+ std::vector<Toolkit::TextAnchor> mAnchorActors;
+
+ // Signals
+ Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal;
+ Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal;
+
+ std::string mLocale;
+
int mRenderingBackend;
bool mTextUpdateNeeded : 1;
+ bool mLastAutoScrollEnabled : 1;
protected:
- struct AccessibleImpl : public Control::Impl::AccessibleImpl,
- public virtual Dali::Accessibility::Text
+ /**
+ * @brief This structure is to connect TextLabel with Accessible functions.
+ */
+ class TextLabelAccessible : public TextControlAccessible
{
- using Control::Impl::AccessibleImpl::AccessibleImpl;
-
- std::string GetText(size_t startOffset, size_t endOffset) override;
- size_t GetCharacterCount() override;
- size_t GetCaretOffset() override;
- bool SetCaretOffset(size_t offset) override;
- Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
- Accessibility::Range GetSelection(size_t selectionNum) override;
- bool RemoveSelection(size_t selectionNum) override;
- bool SetSelection(size_t selectionNum, size_t startOffset, size_t endOffset) override;
- std::string GetNameRaw() override;
- Property::Index GetNamePropertyIndex() override;
+ 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<Toolkit::TextAnchor>& GetTextAnchors() const override;
+
+ /**
+ * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
+ */
+ Toolkit::Text::ControllerPtr GetTextController() const override;
};
};
projects / platform / core / uifw / dali-toolkit.git / blobdiff