1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H
5 * Copyright (c) 2021 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/atspi-interfaces/hypertext.h>
23 #include <dali/devel-api/atspi-interfaces/text.h>
24 #include <dali/public-api/object/property-map.h>
27 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
28 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
29 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
30 #include <dali-toolkit/internal/text/text-control-interface.h>
31 #include <dali-toolkit/internal/text/text-controller.h>
32 #include <dali-toolkit/internal/text/text-scroller-interface.h>
33 #include <dali-toolkit/internal/text/text-scroller.h>
34 #include <dali-toolkit/internal/visuals/text/text-visual.h>
35 #include <dali-toolkit/public-api/controls/control-impl.h>
36 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
45 * @brief A control which renders a short text string.
47 class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface
51 * @copydoc Dali::Toollkit::TextLabel::New()
53 static Toolkit::TextLabel New();
58 * @brief Called when a property of an object of this type is set.
60 * @param[in] object The object whose property is set.
61 * @param[in] index The property index.
62 * @param[in] value The new property value.
64 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
67 * @brief Called to retrieve a property of an object of this type.
69 * @param[in] object The object whose property is to be retrieved.
70 * @param[in] index The property index.
71 * @return The current value of the property.
73 static Property::Value GetProperty(BaseObject* object, Property::Index index);
76 * @copydoc Dali::Toollkit::TextLabel::AnchorClickedSignal()
78 DevelTextLabel::AnchorClickedSignalType& AnchorClickedSignal();
81 * @copydoc Dali::Toollkit::TextLabel::TextFitChangedSignal()
83 DevelTextLabel::TextFitChangedSignalType& TextFitChangedSignal();
86 * Connects a callback function with the object's signals.
87 * @param[in] object The object providing the signal.
88 * @param[in] tracker Used to disconnect the signal.
89 * @param[in] signalName The signal to connect to.
90 * @param[in] functor A newly allocated FunctorDelegate.
91 * @return True if the signal was connected.
92 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
94 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
97 * @brief Gets text controller
99 * @return The text controller
101 Text::ControllerPtr GetTextController();
104 * @brief Get the rendered size of a specific text range.
105 * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
106 * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
108 * @param[in] startIndex start index of the text requested to calculate size for.
109 * @param[in] endIndex end index(included) of the text requested to calculate size for.
110 * @return list of sizes of the reuested text.
112 Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
115 * @brief Get the top/left rendered position of a specific text range.
116 * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
117 * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
119 * @param[in] startIndex start index of the text requested to get position to.
120 * @param[in] endIndex end index(included) of the text requested to get position to.
121 * @return list of positions of the requested text.
123 Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
125 private: // From Control
127 * @copydoc Control::OnInitialize()
129 void OnInitialize() override;
132 * @copydoc Control::OnStyleChange()
134 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
137 * @copydoc Control::OnRelayout()
139 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
142 * @copydoc Control::OnTap()
144 void OnTap(const TapGesture& tap) override;
147 * @copydoc Control::GetNaturalSize()
149 Vector3 GetNaturalSize() override;
152 * @copydoc Control::GetHeightForWidth()
154 float GetHeightForWidth(float width) override;
157 * @copydoc Control::OnPropertySet()
159 void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
161 // From ControlInterface
164 * @copydoc Text::ControlInterface::RequestTextRelayout()
166 void RequestTextRelayout() override;
168 private: // from TextScroller
170 * @copydoc Text::ScrollerInterface::ScrollingFinished()
172 void ScrollingFinished() override;
174 public: // From AnchorControlInterface
176 * @copydoc Text::AnchorControlInterface::AnchorClicked()
178 void AnchorClicked(const std::string& href) override;
180 private: // Implementation
182 * Construct a new TextLabel.
187 * A reference counted object may only be deleted by calling Unreference()
189 virtual ~TextLabel();
192 // Undefined copy constructor and assignment operators
193 TextLabel(const TextLabel&);
194 TextLabel& operator=(const TextLabel& rhs);
197 * @brief Set up Autoscrolling
199 void SetUpAutoScrolling();
202 * Creates a text-scroller if one has not been created.
203 * @return The text scroller.
205 Text::TextScrollerPtr GetTextScroller()
209 mTextScroller = Text::TextScroller::New(*this);
211 return mTextScroller;
215 * @brief Callback function for when the layout is changed.
216 * @param[in] actor The actor whose layoutDirection is changed.
217 * @param[in] type The layoutDirection.
219 void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
222 * @brief Emits TextFitChanged signal.
224 void EmitTextFitChangedSignal();
225 void OnAccessibilityStatusChanged();
228 Text::ControllerPtr mController;
229 Text::TextScrollerPtr mTextScroller;
231 Toolkit::Visual::Base mVisual;
233 std::vector<Toolkit::TextAnchor> mAnchorActors;
236 Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal;
237 Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal;
239 int mRenderingBackend;
240 bool mTextUpdateNeeded : 1;
244 * @brief This structure is to connect TextLabel with Accessible functions.
246 struct AccessibleImpl : public DevelControl::ControlAccessible,
247 public virtual Dali::Accessibility::Text,
248 public virtual Dali::Accessibility::Hypertext
250 using DevelControl::ControlAccessible::ControlAccessible;
253 * @copydoc Dali::Accessibility::Text::GetText()
255 std::string GetText(size_t startOffset, size_t endOffset) const override;
258 * @copydoc Dali::Accessibility::Text::GetCharacterCount()
260 size_t GetCharacterCount() const override;
263 * @copydoc Dali::Accessibility::Text::GetCursorOffset()
265 size_t GetCursorOffset() const override;
268 * @copydoc Dali::Accessibility::Text::SetCursorOffset()
270 bool SetCursorOffset(size_t offset) override;
273 * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
275 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) const override;
278 * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
280 Accessibility::Range GetRangeOfSelection(size_t selectionIndex) const override;
283 * @copydoc Dali::Accessibility::Text::RemoveSelection()
285 bool RemoveSelection(size_t selectionIndex) override;
288 * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
290 bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override;
293 * @copydoc Dali::Accessibility::Text::GetNameRaw()
295 std::string GetNameRaw() const override;
298 * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex()
300 Property::Index GetNamePropertyIndex() override;
303 * @copydoc Dali::Accessibility::Hypertext::GetLink()
305 Accessibility::Hyperlink* GetLink(int32_t linkIndex) const override;
308 * @copydoc Dali::Accessibility::Hypertext::GetLinkIndex()
310 int32_t GetLinkIndex(int32_t characterOffset) const override;
313 * @copydoc Dali::Accessibility::Hypertext::GetLinkCount()
315 int32_t GetLinkCount() const override;
319 } // namespace Internal
321 // Helpers for public-api forwarding methods
323 inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel)
325 DALI_ASSERT_ALWAYS(textLabel);
327 Dali::RefObject& handle = textLabel.GetImplementation();
329 return static_cast<Toolkit::Internal::TextLabel&>(handle);
332 inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel)
334 DALI_ASSERT_ALWAYS(textLabel);
336 const Dali::RefObject& handle = textLabel.GetImplementation();
338 return static_cast<const Toolkit::Internal::TextLabel&>(handle);
341 } // namespace Toolkit
345 #endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H