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