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   /**
 175    * @brief Set text fit array to text label.
 176    *
 177    * @param[in] enable Whether the text fit array is enabled or not.
 178    * @param[in] fitOptions list of the fit options.
 179    */
 180   void SetTextFitArray(const bool enable, std::vector<Toolkit::DevelTextLabel::FitOption>& fitOptions);
 181
 182   /**
 183    * @brief Get the text fit array of text label.
 184    *
 185    * @return list of the fit options.
 186    */
 187   std::vector<Toolkit::DevelTextLabel::FitOption>& GetTextFitArray();
 188
 189   /**
 190    * @brief Whether the text fit array is enabled or not.
 191    *
 192    * @return True if the text fit array is enabled.
 193    */
 194   bool IsTextFitArrayEnabled() const;
 195
 196 private: // From Control
 197   /**
 198    * @copydoc Control::OnInitialize()
 199    */
 200   void OnInitialize() override;
 201
 202   /**
 203    * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
 204    */
 205   DevelControl::ControlAccessible* CreateAccessibleObject() override;
 206
 207   /**
 208    * @copydoc Control::OnStyleChange()
 209    */
 210   void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
 211
 212   /**
 213    * @copydoc Control::OnRelayout()
 214    */
 215   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
 216
 217   /**
 218    * @copydoc Control::OnTap()
 219    */
 220   void OnTap(const TapGesture& tap) override;
 221
 222   /**
 223    * @copydoc Control::GetNaturalSize()
 224    */
 225   Vector3 GetNaturalSize() override;
 226
 227   /**
 228    * @copydoc Control::GetHeightForWidth()
 229    */
 230   float GetHeightForWidth(float width) override;
 231
 232   /**
 233    * @copydoc Control::OnPropertySet()
 234    */
 235   void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
 236
 237   /**
 238    * @copydoc Control::OnSceneConnection()
 239    */
 240   void OnSceneConnection(int depth) override;
 241
 242   /**
 243    * @copydoc Control::OnSceneDisconnection()
 244    */
 245   void OnSceneDisconnection() override;
 246
 247   // From ControlInterface
 248
 249   /**
 250    * @copydoc Text::ControlInterface::RequestTextRelayout()
 251    */
 252   void RequestTextRelayout() override;
 253
 254 private: // from TextScroller
 255   /**
 256    * @copydoc Text::ScrollerInterface::ScrollingFinished()
 257    */
 258   void ScrollingFinished() override;
 259
 260 public: // From AnchorControlInterface
 261   /**
 262    * @copydoc Text::AnchorControlInterface::AnchorClicked()
 263    */
 264   void AnchorClicked(const std::string& href) override;
 265
 266 private: // Implementation
 267   /**
 268    * Construct a new TextLabel.
 269    *
 270    * @param[in] additionalBehaviour additional behaviour flags for this TextLabel
 271    */
 272   TextLabel(ControlBehaviour additionalBehaviour);
 273
 274   /**
 275    * A reference counted object may only be deleted by calling Unreference()
 276    */
 277   virtual ~TextLabel();
 278
 279 private:
 280   // Undefined copy constructor and assignment operators
 281   TextLabel(const TextLabel&);
 282   TextLabel& operator=(const TextLabel& rhs);
 283
 284   /**
 285    * @brief Set up Autoscrolling
 286    */
 287   void SetUpAutoScrolling();
 288
 289   /**
 290    * Creates a text-scroller if one has not been created.
 291    * @return The text scroller.
 292    */
 293   Text::TextScrollerPtr GetTextScroller()
 294   {
 295     if(!mTextScroller)
 296     {
 297       mTextScroller = Text::TextScroller::New(*this);
 298     }
 299     return mTextScroller;
 300   }
 301
 302   /**
 303    * @brief Callback function for when the layout is changed.
 304    * @param[in] actor The actor whose layoutDirection is changed.
 305    * @param[in] type  The layoutDirection.
 306    */
 307   void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
 308
 309   /**
 310    * @brief Emits TextFitChanged signal.
 311    */
 312   void EmitTextFitChangedSignal();
 313   void OnAccessibilityStatusChanged();
 314
 315 private: // Data
 316   Text::ControllerPtr   mController;
 317   Text::TextScrollerPtr mTextScroller;
 318
 319   Toolkit::Visual::Base mVisual;
 320
 321   std::vector<Toolkit::TextAnchor> mAnchorActors;
 322
 323   // Signals
 324   Toolkit::DevelTextLabel::AnchorClickedSignalType  mAnchorClickedSignal;
 325   Toolkit::DevelTextLabel::TextFitChangedSignalType mTextFitChangedSignal;
 326
 327   int  mRenderingBackend;
 328   bool mTextUpdateNeeded : 1;
 329   bool mLastAutoScrollEnabled : 1;
 330
 331 protected:
 332   /**
 333    * @brief This structure is to connect TextLabel with Accessible functions.
 334    */
 335   class TextLabelAccessible : public TextControlAccessible
 336   {
 337   public:
 338     using TextControlAccessible::TextControlAccessible;
 339
 340     /**
 341      * @copydoc Dali::Accessibility::Text::GetNameRaw()
 342      */
 343     std::string GetNameRaw() const override;
 344
 345     /**
 346      * @copydoc Dali::Accessibility::Text::GetNamePropertyIndex()
 347      */
 348     Property::Index GetNamePropertyIndex() override;
 349
 350   protected:
 351     /**
 352      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
 353      */
 354     const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
 355
 356     /**
 357      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
 358      */
 359     Toolkit::Text::ControllerPtr GetTextController() const override;
 360   };
 361 };
 362
 363 } // namespace Internal
 364
 365 // Helpers for public-api forwarding methods
 366
 367 inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel)
 368 {
 369   DALI_ASSERT_ALWAYS(textLabel);
 370
 371   Dali::RefObject& handle = textLabel.GetImplementation();
 372
 373   return static_cast<Toolkit::Internal::TextLabel&>(handle);
 374 }
 375
 376 inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel)
 377 {
 378   DALI_ASSERT_ALWAYS(textLabel);
 379
 380   const Dali::RefObject& handle = textLabel.GetImplementation();
 381
 382   return static_cast<const Toolkit::Internal::TextLabel&>(handle);
 383 }
 384
 385 } // namespace Toolkit
 386
 387 } // namespace Dali
 388
 389 #endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H