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);
89 Text::ControllerPtr getController();
91 private: // From Control
93 * @copydoc Control::OnInitialize()
95 void OnInitialize() override;
98 * @copydoc Control::OnStyleChange()
100 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
103 * @copydoc Control::OnRelayout()
105 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
108 * @copydoc Control::OnTap()
110 void OnTap(const TapGesture& tap) override;
113 * @copydoc Control::GetNaturalSize()
115 Vector3 GetNaturalSize() override;
118 * @copydoc Control::GetHeightForWidth()
120 float GetHeightForWidth(float width) override;
123 * @copydoc Control::OnPropertySet()
125 void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
127 // From ControlInterface
130 * @copydoc Text::ControlInterface::RequestTextRelayout()
132 void RequestTextRelayout() override;
134 private: // from TextScroller
136 * @copydoc Text::ScrollerInterface::ScrollingFinished()
138 void ScrollingFinished() override;
140 public: // From AnchorControlInterface
142 * @copydoc Text::AnchorControlInterface::AnchorClicked()
144 void AnchorClicked(const std::string& href) override;
146 private: // Implementation
148 * Construct a new TextLabel.
153 * A reference counted object may only be deleted by calling Unreference()
155 virtual ~TextLabel();
158 // Undefined copy constructor and assignment operators
159 TextLabel(const TextLabel&);
160 TextLabel& operator=(const TextLabel& rhs);
163 * @brief Set up Autoscrolling
165 void SetUpAutoScrolling();
168 * Creates a text-scroller if one has not been created.
169 * @return The text scroller.
171 Text::TextScrollerPtr GetTextScroller()
175 mTextScroller = Text::TextScroller::New(*this);
177 return mTextScroller;
181 Text::ControllerPtr mController;
182 Text::TextScrollerPtr mTextScroller;
184 Toolkit::Visual::Base mVisual;
187 Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal;
189 int mRenderingBackend;
190 bool mTextUpdateNeeded : 1;
193 struct AccessibleImpl : public DevelControl::AccessibleImpl,
194 public virtual Dali::Accessibility::Text
196 using DevelControl::AccessibleImpl::AccessibleImpl;
198 std::string GetText(size_t startOffset, size_t endOffset) override;
199 size_t GetCharacterCount() override;
200 size_t GetCaretOffset() override;
201 bool SetCaretOffset(size_t offset) override;
202 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
203 Accessibility::Range GetSelection(size_t selectionNum) override;
204 bool RemoveSelection(size_t selectionNum) override;
205 bool SetSelection(size_t selectionNum, size_t startOffset, size_t endOffset) override;
206 std::string GetNameRaw() override;
207 Property::Index GetNamePropertyIndex() override;
211 } // namespace Internal
213 // Helpers for public-api forwarding methods
215 inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel)
217 DALI_ASSERT_ALWAYS(textLabel);
219 Dali::RefObject& handle = textLabel.GetImplementation();
221 return static_cast<Toolkit::Internal::TextLabel&>(handle);
224 inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel)
226 DALI_ASSERT_ALWAYS(textLabel);
228 const Dali::RefObject& handle = textLabel.GetImplementation();
230 return static_cast<const Toolkit::Internal::TextLabel&>(handle);
233 } // namespace Toolkit
237 #endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H