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