dali-toolkit/internal/controls/text-controls/text-label-impl.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H
   2 #define DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  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>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/text/spanned.h>
  29 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  30 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
  31 #include <dali-toolkit/internal/text/controller/text-controller.h>
  32 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
  33 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
  34 #include <dali-toolkit/internal/text/text-control-interface.h>
  35 #include <dali-toolkit/internal/text/text-scroller-interface.h>
  36 #include <dali-toolkit/internal/text/text-scroller.h>
  37 #include <dali-toolkit/internal/visuals/text/text-visual.h>
  38 #include <dali-toolkit/public-api/controls/control-impl.h>
  39 #include <dali-toolkit/public-api/controls/text-controls/text-label.h>
  40 namespace Dali
  41 {
  42 namespace Toolkit
  43 {
  44 namespace Internal
  45 {
  46 /**
  47  * @brief A control which renders a short text string.
  48  */
  49 class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface
  50 {
  51 public:
  52   /**
  53    * @copydoc Dali::Toollkit::TextLabel::New()
  54    * @param[in] additionalBehaviour custom behavior flags for this TextLabel. Default is CONTROL_BEHAVIOUR_DEFAULT
  55    */
  56   static Toolkit::TextLabel New(ControlBehaviour additionalBehaviour = ControlBehaviour::CONTROL_BEHAVIOUR_DEFAULT);
  57
  58   // Properties
  59
  60   /**
  61    * @brief Called when a property of an object of this type is set.
  62    *
  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.
  66    */
  67   static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
  68
  69   /**
  70    * @brief Called to retrieve a property of an object of this type.
  71    *
  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.
  75    */
  76   static Property::Value GetProperty(BaseObject* object, Property::Index index);
  77
  78   /**
  79    * @copydoc Dali::Toollkit::TextLabel::AnchorClickedSignal()
  80    */
  81   DevelTextLabel::AnchorClickedSignalType& AnchorClickedSignal();
  82
  83   /**
  84    * @copydoc Dali::Toollkit::TextLabel::TextFitChangedSignal()
  85    */
  86   DevelTextLabel::TextFitChangedSignalType& TextFitChangedSignal();
  87
  88   /**
  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.
  96    */
  97   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
  98
  99   /**
 100    * @brief Gets text controller
 101    *
 102    * @return The text controller
 103    */
 104   Text::ControllerPtr GetTextController();
 105
 106   /**
 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.
 110    *
 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.
 114    */
 115   Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
 116
 117   /**
 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.
 121    *
 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.
 125    */
 126   Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
 127
 128   /**
 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.
 131    *
 132    * @param[in] lineIndex line index to which we want to calculate the geometry for.
 133    * @return bounding rectangle.
 134    */
 135   Rect<float> GetLineBoundingRectangle(const uint32_t lineIndex) const;
 136
 137   /**
 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.
 140    *
 141    * @param[in] charIndex character index to which we want to calculate the geometry for.
 142    * @return bounding rectangle.
 143    */
 144   Rect<float> GetCharacterBoundingRectangle(const uint32_t charIndex) const;
 145
 146   /**
 147    * @brief Get the character index.
 148    * If the text is not yet rendered or the textis empty, -1 is returned.
 149    *
 150    * @param[in] visualX visual x position.
 151    * @param[in] visualY visual y position.
 152    * @return character index.
 153    */
 154   int GetCharacterIndexAtPosition(float visualX, float visualY) const;
 155
 156   /**
 157    * @brief Gets the bounding box of a specific text range.
 158    *
 159    * @param[in] startIndex start index of the text requested to get bounding box to.
 160    * @param[in] endIndex end index(included) of the text requested to get bounding box to.
 161    * @return bounding box of the requested text.
 162    */
 163   Rect<> GetTextBoundingRectangle(uint32_t startIndex, uint32_t endIndex) const;
 164
 165   /**
 166    * @brief Set the @p spannedText into current textLabel
 167    * the spanned text contains content (text) and  format (spans with ranges)
 168    * the text is copied into text-controller and the spans are applied on ranges
 169    *
 170    * @param[in] spannedText the text with spans.
 171    */
 172   void SetSpannedText(const Text::Spanned& spannedText);
 173
 174 private: // From Control
 175   /**
 176    * @copydoc Control::OnInitialize()
 177    */
 178   void OnInitialize() override;
 179
 180   /**
 181    * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
 182    */
 183   DevelControl::ControlAccessible* CreateAccessibleObject() override;
 184
 185   /**
 186    * @copydoc Control::OnStyleChange()
 187    */
 188   void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
 189
 190   /**
 191    * @copydoc Control::OnRelayout()
 192    */
 193   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
 194
 195   /**
 196    * @copydoc Control::OnTap()
 197    */
 198   void OnTap(const TapGesture& tap) override;
 199
 200   /**
 201    * @copydoc Control::GetNaturalSize()
 202    */
 203   Vector3 GetNaturalSize() override;
 204
 205   /**
 206    * @copydoc Control::GetHeightForWidth()
 207    */
 208   float GetHeightForWidth(float width) override;
 209
 210   /**
 211    * @copydoc Control::OnPropertySet()
 212    */
 213   void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
 214
 215   /**
 216    * @copydoc Control::OnSceneConnection()
 217    */
 218   void OnSceneConnection(int depth) override;
 219
 220   /**
 221    * @copydoc Control::OnSceneDisconnection()
 222    */
 223   void OnSceneDisconnection() override;
 224
 225   // From ControlInterface
 226
 227   /**
 228    * @copydoc Text::ControlInterface::RequestTextRelayout()
 229    */
 230   void RequestTextRelayout() override;
 231
 232 private: // from TextScroller
 233   /**
 234    * @copydoc Text::ScrollerInterface::ScrollingFinished()
 235    */
 236   void ScrollingFinished() override;
 237
 238 public: // From AnchorControlInterface
 239   /**
 240    * @copydoc Text::AnchorControlInterface::AnchorClicked()
 241    */
 242   void AnchorClicked(const std::string& href) override;
 243
 244 private: // Implementation
 245   /**
 246    * Construct a new TextLabel.
 247    *
 248    * @param[in] additionalBehaviour additional behaviour flags for this TextLabel
 249    */
 250   TextLabel(ControlBehaviour additionalBehaviour);
 251
 252   /**
 253    * A reference counted object may only be deleted by calling Unreference()
 254    */
 255   virtual ~TextLabel();
 256
 257 private:
 258   // Undefined copy constructor and assignment operators
 259   TextLabel(const TextLabel&);
 260   TextLabel& operator=(const TextLabel& rhs);
 261
 262   /**
 263    * @brief Set up Autoscrolling
 264    */
 265   void SetUpAutoScrolling();
 266
 267   /**
 268    * Creates a text-scroller if one has not been created.
 269    * @return The text scroller.
 270    */
 271   Text::TextScrollerPtr GetTextScroller()
 272   {
 273     if(!mTextScroller)
 274     {
 275       mTextScroller = Text::TextScroller::New(*this);
 276     }
 277     return mTextScroller;
 278   }
 279
 280   /**
 281    * @brief Callback function for when the layout is changed.
 282    * @param[in] actor The actor whose layoutDirection is changed.
 283    * @param[in] type  The layoutDirection.
 284    */
 285   void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
 286
 287   /**
 288    * @brief Emits TextFitChanged signal.
 289    */
 290   void EmitTextFitChangedSignal();
 291   void OnAccessibilityStatusChanged();
 292
 293 private: // Data
 294   Text::ControllerPtr   mController;
 295   Text::TextScrollerPtr mTextScroller;
 296
 297   Toolkit::Visual::Base mVisual;
 298
 299   std::vector<Toolkit::TextAnchor> mAnchorActors;
 300
 301   // Signals
 302   Toolkit::DevelTextLabel::AnchorClickedSignalType  mAnchorClickedSignal;
 303   Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal;
 304
 305   int  mRenderingBackend;
 306   bool mTextUpdateNeeded : 1;
 307   bool mLastAutoScrollEnabled : 1;
 308
 309 protected:
 310   /**
 311    * @brief This structure is to connect TextLabel with Accessible functions.
 312    */
 313   class TextLabelAccessible : public TextControlAccessible
 314   {
 315   public:
 316     using TextControlAccessible::TextControlAccessible;
 317
 318     /**
 319      * @copydoc Dali::Accessibility::Text::GetNameRaw()
 320      */
 321     std::string GetNameRaw() const override;
 322
 323     /**
 324      * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex()
 325      */
 326     Property::Index GetNamePropertyIndex() override;
 327
 328   protected:
 329     /**
 330      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
 331      */
 332     const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
 333
 334     /**
 335      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
 336      */
 337     Toolkit::Text::ControllerPtr GetTextController() const override;
 338   };
 339 };
 340
 341 } // namespace Internal
 342
 343 // Helpers for public-api forwarding methods
 344
 345 inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel)
 346 {
 347   DALI_ASSERT_ALWAYS(textLabel);
 348
 349   Dali::RefObject& handle = textLabel.GetImplementation();
 350
 351   return static_cast<Toolkit::Internal::TextLabel&>(handle);
 352 }
 353
 354 inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel)
 355 {
 356   DALI_ASSERT_ALWAYS(textLabel);
 357
 358   const Dali::RefObject& handle = textLabel.GetImplementation();
 359
 360   return static_cast<const Toolkit::Internal::TextLabel&>(handle);
 361 }
 362
 363 } // namespace Toolkit
 364
 365 } // namespace Dali
 366
 367 #endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H