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/public-api/object/property-map.h>
25 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
26 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
27 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
28 #include <dali-toolkit/internal/text/text-control-interface.h>
29 #include <dali-toolkit/internal/text/text-controller.h>
30 #include <dali-toolkit/internal/text/text-scroller-interface.h>
31 #include <dali-toolkit/internal/text/text-scroller.h>
32 #include <dali-toolkit/internal/visuals/text/text-visual.h>
33 #include <dali-toolkit/public-api/controls/control-impl.h>
34 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
43 * @brief A control which renders a short text string.
45 class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface
49 * @copydoc Dali::Toollkit::TextLabel::New()
51 static Toolkit::TextLabel New();
56 * @brief Called when a property of an object of this type is set.
58 * @param[in] object The object whose property is set.
59 * @param[in] index The property index.
60 * @param[in] value The new property value.
62 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
65 * @brief Called to retrieve a property of an object of this type.
67 * @param[in] object The object whose property is to be retrieved.
68 * @param[in] index The property index.
69 * @return The current value of the property.
71 static Property::Value GetProperty(BaseObject* object, Property::Index index);
74 * @copydoc Dali::Toollkit::TextLabel::AnchorClickedSignal()
76 DevelTextLabel::AnchorClickedSignalType& AnchorClickedSignal();
79 * Connects a callback function with the object's signals.
80 * @param[in] object The object providing the signal.
81 * @param[in] tracker Used to disconnect the signal.
82 * @param[in] signalName The signal to connect to.
83 * @param[in] functor A newly allocated FunctorDelegate.
84 * @return True if the signal was connected.
85 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
87 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
90 * @brief Gets text controller
92 * @return The text controller
94 Text::ControllerPtr GetTextController();
96 private: // From Control
98 * @copydoc Control::OnInitialize()
100 void OnInitialize() override;
103 * @copydoc Control::OnStyleChange()
105 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
108 * @copydoc Control::OnRelayout()
110 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
113 * @copydoc Control::OnTap()
115 void OnTap(const TapGesture& tap) override;
118 * @copydoc Control::GetNaturalSize()
120 Vector3 GetNaturalSize() override;
123 * @copydoc Control::GetHeightForWidth()
125 float GetHeightForWidth(float width) override;
128 * @copydoc Control::OnPropertySet()
130 void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
132 // From ControlInterface
135 * @copydoc Text::ControlInterface::RequestTextRelayout()
137 void RequestTextRelayout() override;
139 private: // from TextScroller
141 * @copydoc Text::ScrollerInterface::ScrollingFinished()
143 void ScrollingFinished() override;
145 public: // From AnchorControlInterface
147 * @copydoc Text::AnchorControlInterface::AnchorClicked()
149 void AnchorClicked(const std::string& href) override;
151 private: // Implementation
153 * Construct a new TextLabel.
158 * A reference counted object may only be deleted by calling Unreference()
160 virtual ~TextLabel();
163 // Undefined copy constructor and assignment operators
164 TextLabel(const TextLabel&);
165 TextLabel& operator=(const TextLabel& rhs);
168 * @brief Set up Autoscrolling
170 void SetUpAutoScrolling();
173 * Creates a text-scroller if one has not been created.
174 * @return The text scroller.
176 Text::TextScrollerPtr GetTextScroller()
180 mTextScroller = Text::TextScroller::New(*this);
182 return mTextScroller;
186 * @brief Callback function for when the layout is changed.
187 * @param[in] actor The actor whose layoutDirection is changed.
188 * @param[in] type The layoutDirection.
190 void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
193 Text::ControllerPtr mController;
194 Text::TextScrollerPtr mTextScroller;
196 Toolkit::Visual::Base mVisual;
199 Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal;
201 int mRenderingBackend;
202 bool mTextUpdateNeeded : 1;
206 * @brief This structure is to connect TextLabel with Accessible functions.
208 struct AccessibleImpl : public DevelControl::AccessibleImpl,
209 public virtual Dali::Accessibility::Text
211 using DevelControl::AccessibleImpl::AccessibleImpl;
214 * @copydoc Dali::Accessibility::Text::GetText()
216 std::string GetText(size_t startOffset, size_t endOffset) override;
219 * @copydoc Dali::Accessibility::Text::GetCharacterCount()
221 size_t GetCharacterCount() override;
224 * @copydoc Dali::Accessibility::Text::GetCursorOffset()
226 size_t GetCursorOffset() override;
229 * @copydoc Dali::Accessibility::Text::SetCursorOffset()
231 bool SetCursorOffset(size_t offset) override;
234 * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
236 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
239 * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
241 Accessibility::Range GetRangeOfSelection(size_t selectionIndex) override;
244 * @copydoc Dali::Accessibility::Text::RemoveSelection()
246 bool RemoveSelection(size_t selectionIndex) override;
249 * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
251 bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override;
254 * @copydoc Dali::Accessibility::Text::GetNameRaw()
256 std::string GetNameRaw() override;
259 * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex()
261 Property::Index GetNamePropertyIndex() override;
265 } // namespace Internal
267 // Helpers for public-api forwarding methods
269 inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel)
271 DALI_ASSERT_ALWAYS(textLabel);
273 Dali::RefObject& handle = textLabel.GetImplementation();
275 return static_cast<Toolkit::Internal::TextLabel&>(handle);
278 inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel)
280 DALI_ASSERT_ALWAYS(textLabel);
282 const Dali::RefObject& handle = textLabel.GetImplementation();
284 return static_cast<const Toolkit::Internal::TextLabel&>(handle);
287 } // namespace Toolkit
291 #endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H