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) 2021 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/public-api/object/property-map.h>
  23
  24 // INTERNAL INCLUDES
  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>
  35
  36 namespace Dali
  37 {
  38 namespace Toolkit
  39 {
  40 namespace Internal
  41 {
  42 /**
  43  * @brief A control which renders a short text string.
  44  */
  45 class TextLabel : public Control, public Text::ControlInterface, public Text::ScrollerInterface, public Text::AnchorControlInterface
  46 {
  47 public:
  48   /**
  49    * @copydoc Dali::Toollkit::TextLabel::New()
  50    */
  51   static Toolkit::TextLabel New();
  52
  53   // Properties
  54
  55   /**
  56    * @brief Called when a property of an object of this type is set.
  57    *
  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.
  61    */
  62   static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
  63
  64   /**
  65    * @brief Called to retrieve a property of an object of this type.
  66    *
  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.
  70    */
  71   static Property::Value GetProperty(BaseObject* object, Property::Index index);
  72
  73   /**
  74    * @copydoc Dali::Toollkit::TextLabel::AnchorClickedSignal()
  75    */
  76   DevelTextLabel::AnchorClickedSignalType& AnchorClickedSignal();
  77
  78   /**
  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.
  86    */
  87   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
  88
  89   Text::ControllerPtr getController();
  90
  91 private: // From Control
  92   /**
  93    * @copydoc Control::OnInitialize()
  94    */
  95   void OnInitialize() override;
  96
  97   /**
  98    * @copydoc Control::OnStyleChange()
  99    */
 100   void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
 101
 102   /**
 103    * @copydoc Control::OnRelayout()
 104    */
 105   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
 106
 107   /**
 108    * @copydoc Control::OnTap()
 109    */
 110   void OnTap(const TapGesture& tap) override;
 111
 112   /**
 113    * @copydoc Control::GetNaturalSize()
 114    */
 115   Vector3 GetNaturalSize() override;
 116
 117   /**
 118    * @copydoc Control::GetHeightForWidth()
 119    */
 120   float GetHeightForWidth(float width) override;
 121
 122   /**
 123    * @copydoc Control::OnPropertySet()
 124    */
 125   void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
 126
 127   // From ControlInterface
 128
 129   /**
 130    * @copydoc Text::ControlInterface::RequestTextRelayout()
 131    */
 132   void RequestTextRelayout() override;
 133
 134 private: // from TextScroller
 135   /**
 136    * @copydoc Text::ScrollerInterface::ScrollingFinished()
 137    */
 138   void ScrollingFinished() override;
 139
 140 public: // From AnchorControlInterface
 141   /**
 142    * @copydoc Text::AnchorControlInterface::AnchorClicked()
 143    */
 144   void AnchorClicked(const std::string& href) override;
 145
 146 private: // Implementation
 147   /**
 148    * Construct a new TextLabel.
 149    */
 150   TextLabel();
 151
 152   /**
 153    * A reference counted object may only be deleted by calling Unreference()
 154    */
 155   virtual ~TextLabel();
 156
 157 private:
 158   // Undefined copy constructor and assignment operators
 159   TextLabel(const TextLabel&);
 160   TextLabel& operator=(const TextLabel& rhs);
 161
 162   /**
 163    * @brief Set up Autoscrolling
 164    */
 165   void SetUpAutoScrolling();
 166
 167   /**
 168    * Creates a text-scroller if one has not been created.
 169    * @return The text scroller.
 170    */
 171   Text::TextScrollerPtr GetTextScroller()
 172   {
 173     if(!mTextScroller)
 174     {
 175       mTextScroller = Text::TextScroller::New(*this);
 176     }
 177     return mTextScroller;
 178   }
 179
 180   /**
 181    * @brief Callback function for when the layout is changed.
 182    * @param[in] actor The actor whose layoutDirection is changed.
 183    * @param[in] type  The layoutDirection.
 184    */
 185   void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
 186
 187 private: // Data
 188   Text::ControllerPtr   mController;
 189   Text::TextScrollerPtr mTextScroller;
 190
 191   Toolkit::Visual::Base mVisual;
 192
 193   // Signals
 194   Toolkit::DevelTextLabel::AnchorClickedSignalType mAnchorClickedSignal;
 195
 196   int  mRenderingBackend;
 197   bool mTextUpdateNeeded : 1;
 198
 199 protected:
 200   struct AccessibleImpl : public DevelControl::AccessibleImpl,
 201                           public virtual Dali::Accessibility::Text
 202   {
 203     using DevelControl::AccessibleImpl::AccessibleImpl;
 204
 205     std::string          GetText(size_t startOffset, size_t endOffset) override;
 206     size_t               GetCharacterCount() override;
 207     size_t               GetCaretOffset() override;
 208     bool                 SetCaretOffset(size_t offset) override;
 209     Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
 210     Accessibility::Range GetSelection(size_t selectionNum) override;
 211     bool                 RemoveSelection(size_t selectionNum) override;
 212     bool                 SetSelection(size_t selectionNum, size_t startOffset, size_t endOffset) override;
 213     std::string          GetNameRaw() override;
 214     Property::Index      GetNamePropertyIndex() override;
 215   };
 216 };
 217
 218 } // namespace Internal
 219
 220 // Helpers for public-api forwarding methods
 221
 222 inline Toolkit::Internal::TextLabel& GetImpl(Toolkit::TextLabel& textLabel)
 223 {
 224   DALI_ASSERT_ALWAYS(textLabel);
 225
 226   Dali::RefObject& handle = textLabel.GetImplementation();
 227
 228   return static_cast<Toolkit::Internal::TextLabel&>(handle);
 229 }
 230
 231 inline const Toolkit::Internal::TextLabel& GetImpl(const Toolkit::TextLabel& textLabel)
 232 {
 233   DALI_ASSERT_ALWAYS(textLabel);
 234
 235   const Dali::RefObject& handle = textLabel.GetImplementation();
 236
 237   return static_cast<const Toolkit::Internal::TextLabel&>(handle);
 238 }
 239
 240 } // namespace Toolkit
 241
 242 } // namespace Dali
 243
 244 #endif // DALI_TOOLKIT_INTERNAL_TEXT_LABEL_H