1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/devel-api/actors/actor-devel.h>
23 #include <dali/devel-api/atspi-interfaces/hypertext.h>
24 #include <dali/devel-api/atspi-interfaces/text.h>
25 #include <dali/public-api/object/property-map.h>
28 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
29 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
30 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
31 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
32 #include <dali-toolkit/internal/text/text-control-interface.h>
33 #include <dali-toolkit/internal/text/controller/text-controller.h>
34 #include <dali-toolkit/internal/text/text-scroller-interface.h>
35 #include <dali-toolkit/internal/text/text-scroller.h>
36 #include <dali-toolkit/internal/visuals/text/text-visual.h>
37 #include <dali-toolkit/public-api/controls/control-impl.h>
38 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
47 * @brief A control which renders a short text string.
49 class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface
53 * @copydoc Dali::Toollkit::TextLabel::New()
54 * @param[in] additionalBehaviour custom behavior flags for this TextLabel. Default is CONTROL_BEHAVIOUR_DEFAULT
56 static Toolkit::TextLabel New(ControlBehaviour additionalBehaviour = ControlBehaviour::CONTROL_BEHAVIOUR_DEFAULT);
61 * @brief Called when a property of an object of this type is set.
63 * @param[in] object The object whose property is set.
64 * @param[in] index The property index.
65 * @param[in] value The new property value.
67 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
70 * @brief Called to retrieve a property of an object of this type.
72 * @param[in] object The object whose property is to be retrieved.
73 * @param[in] index The property index.
74 * @return The current value of the property.
76 static Property::Value GetProperty(BaseObject* object, Property::Index index);
79 * @copydoc Dali::Toollkit::TextLabel::AnchorClickedSignal()
81 DevelTextLabel::AnchorClickedSignalType& AnchorClickedSignal();
84 * @copydoc Dali::Toollkit::TextLabel::TextFitChangedSignal()
86 DevelTextLabel::TextFitChangedSignalType& TextFitChangedSignal();
89 * Connects a callback function with the object's signals.
90 * @param[in] object The object providing the signal.
91 * @param[in] tracker Used to disconnect the signal.
92 * @param[in] signalName The signal to connect to.
93 * @param[in] functor A newly allocated FunctorDelegate.
94 * @return True if the signal was connected.
95 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
97 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
100 * @brief Gets text controller
102 * @return The text controller
104 Text::ControllerPtr GetTextController();
107 * @brief Get the rendered size of a specific text range.
108 * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
109 * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
111 * @param[in] startIndex start index of the text requested to calculate size for.
112 * @param[in] endIndex end index(included) of the text requested to calculate size for.
113 * @return list of sizes of the reuested text.
115 Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
118 * @brief Get the top/left rendered position of a specific text range.
119 * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
120 * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
122 * @param[in] startIndex start index of the text requested to get position to.
123 * @param[in] endIndex end index(included) of the text requested to get position to.
124 * @return list of positions of the requested text.
126 Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
129 * @brief Get the line bounding rectangle.
130 * if the requested index is out of range or the line is not yet rendered, a rect of {0, 0, 0, 0} is returned.
132 * @param[in] lineIndex line index to which we want to calculate the geometry for.
133 * @return bounding rectangle.
135 Rect<float> GetLineBoundingRectangle(const uint32_t lineIndex) const;
138 * @brief Get the character bounding rectangle.
139 * If the text is not yet rendered or the index > text.Count(); a rect of {0, 0, 0, 0} is returned.
141 * @param[in] charIndex character index to which we want to calculate the geometry for.
142 * @return bounding rectangle.
144 Rect<float> GetCharacterBoundingRectangle(const uint32_t charIndex) const;
146 private: // From Control
148 * @copydoc Control::OnInitialize()
150 void OnInitialize() override;
153 * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
155 DevelControl::ControlAccessible* CreateAccessibleObject() override;
158 * @copydoc Control::OnStyleChange()
160 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
163 * @copydoc Control::OnRelayout()
165 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
168 * @copydoc Control::OnTap()
170 void OnTap(const TapGesture& tap) override;
173 * @copydoc Control::GetNaturalSize()
175 Vector3 GetNaturalSize() override;
178 * @copydoc Control::GetHeightForWidth()
180 float GetHeightForWidth(float width) override;
183 * @copydoc Control::OnPropertySet()
185 void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
188 * @copydoc Control::OnSceneConnection()
190 void OnSceneConnection(int depth) override;
193 * @copydoc Control::OnSceneDisconnection()
195 void OnSceneDisconnection() override;
197 // From ControlInterface
200 * @copydoc Text::ControlInterface::RequestTextRelayout()
202 void RequestTextRelayout() override;
204 private: // from TextScroller
206 * @copydoc Text::ScrollerInterface::ScrollingFinished()
208 void ScrollingFinished() override;
210 public: // From AnchorControlInterface
212 * @copydoc Text::AnchorControlInterface::AnchorClicked()
214 void AnchorClicked(const std::string& href) override;
216 private: // Implementation
218 * Construct a new TextLabel.
220 * @param[in] additionalBehaviour additional behaviour flags for this TextLabel
222 TextLabel(ControlBehaviour additionalBehaviour);
225 * A reference counted object may only be deleted by calling Unreference()
227 virtual ~TextLabel();
230 // Undefined copy constructor and assignment operators
231 TextLabel(const TextLabel&);
232 TextLabel& operator=(const TextLabel& rhs);
235 * @brief Set up Autoscrolling
237 void SetUpAutoScrolling();
240 * Creates a text-scroller if one has not been created.
241 * @return The text scroller.
243 Text::TextScrollerPtr GetTextScroller()
247 mTextScroller = Text::TextScroller::New(*this);
249 return mTextScroller;
253 * @brief Callback function for when the layout is changed.
254 * @param[in] actor The actor whose layoutDirection is changed.
255 * @param[in] type The layoutDirection.
257 void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
260 * @brief Emits TextFitChanged signal.
262 void EmitTextFitChangedSignal();
263 void OnAccessibilityStatusChanged();
266 Text::ControllerPtr mController;
267 Text::TextScrollerPtr mTextScroller;
269 Toolkit::Visual::Base mVisual;
271 std::vector<Toolkit::TextAnchor> mAnchorActors;
274 Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal;
275 Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal;
277 int mRenderingBackend;
278 bool mTextUpdateNeeded : 1;
279 bool mLastAutoScrollEnabled : 1;
283 * @brief This structure is to connect TextLabel with Accessible functions.
285 class TextLabelAccessible : public TextControlAccessible
288 using TextControlAccessible::TextControlAccessible;
291 * @copydoc Dali::Accessibility::Text::GetNameRaw()
293 std::string GetNameRaw() const override;
296 * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex()
298 Property::Index GetNamePropertyIndex() override;
302 * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
304 const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
307 * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
309 Toolkit::Text::ControllerPtr GetTextController() const override;
313 } // namespace Internal
315 // Helpers for public-api forwarding methods
317 inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel)
319 DALI_ASSERT_ALWAYS(textLabel);
321 Dali::RefObject& handle = textLabel.GetImplementation();
323 return static_cast<Toolkit::Internal::TextLabel&>(handle);
326 inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel)
328 DALI_ASSERT_ALWAYS(textLabel);
330 const Dali::RefObject& handle = textLabel.GetImplementation();
332 return static_cast<const Toolkit::Internal::TextLabel&>(handle);
335 } // namespace Toolkit
339 #endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H