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

   1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
   2 #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
   3
   4 /*
   5  * Copyright (c) 2024 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/adaptor-framework/input-method-context.h>
  23 #include <dali/devel-api/atspi-interfaces/editable-text.h>
  24 #include <dali/devel-api/atspi-interfaces/hypertext.h>
  25 #include <dali/devel-api/atspi-interfaces/text.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/controls/control-devel.h>
  29 #include <dali-toolkit/devel-api/controls/text-controls/text-field-devel.h>
  30 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  31 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
  32 #include <dali-toolkit/internal/text/controller/text-controller.h>
  33 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  34 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
  35 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
  36 #include <dali-toolkit/internal/text/text-control-interface.h>
  37 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
  38 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
  39 #include <dali-toolkit/public-api/controls/control-impl.h>
  40 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
  41
  42 namespace Dali
  43 {
  44 namespace Toolkit
  45 {
  46 namespace Internal
  47 {
  48 /**
  49  * @brief A control which renders a short text string.
  50  */
  51 class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface
  52 {
  53 public:
  54   /**
  55    * @copydoc Dali::Toollkit::TextField::New()
  56    * @param[in] additionalBehaviour custom behavior flags for this TextField. Default is CONTROL_BEHAVIOUR_DEFAULT
  57    */
  58   static Toolkit::TextField New(ControlBehaviour additionalBehaviour = ControlBehaviour::CONTROL_BEHAVIOUR_DEFAULT);
  59
  60   // Properties
  61
  62   /**
  63    * @brief Called when a property of an object of this type is set.
  64    *
  65    * @param[in] object The object whose property is set.
  66    * @param[in] index The property index.
  67    * @param[in] value The new property value.
  68    */
  69   static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
  70
  71   /**
  72    * @brief Called to retrieve a property of an object of this type.
  73    *
  74    * @param[in] object The object whose property is to be retrieved.
  75    * @param[in] index The property index.
  76    * @return The current value of the property.
  77    */
  78   static Property::Value GetProperty(BaseObject* object, Property::Index index);
  79
  80   /**
  81    * @copydoc Dali::Toollkit::TextField::GetInputMethodContext()
  82    */
  83   InputMethodContext GetInputMethodContext();
  84
  85   /**
  86    * Connects a callback function with the object's signals.
  87    * @param[in] object The object providing the signal.
  88    * @param[in] tracker Used to disconnect the signal.
  89    * @param[in] signalName The signal to connect to.
  90    * @param[in] functor A newly allocated FunctorDelegate.
  91    * @return True if the signal was connected.
  92    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
  93    */
  94   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
  95
  96   /**
  97    * @brief Gets text controller
  98    *
  99    * @return The text controller
 100    */
 101   Text::ControllerPtr GetTextController();
 102
 103   /**
 104    * @copydoc TextField::TextChangedSignal()
 105    */
 106   Toolkit::TextField::TextChangedSignalType& TextChangedSignal();
 107
 108   /**
 109    * @copydoc TextField::MaxLengthReachedSignal()
 110    */
 111   Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal();
 112
 113   /**
 114    * @copydoc TextField::TextChangedSignal()
 115    */
 116   Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal();
 117
 118   /**
 119    * @copydoc TextField::AnchorClickedSignal()
 120    */
 121   DevelTextField::AnchorClickedSignalType& AnchorClickedSignal();
 122
 123   /**
 124    * @copydoc TextField::CursorPositionChangedSignal()
 125    */
 126   DevelTextField::CursorPositionChangedSignalType& CursorPositionChangedSignal();
 127
 128   /**
 129    * @copydoc TextField::InputFilteredSignal()
 130    */
 131   DevelTextField::InputFilteredSignalType& InputFilteredSignal();
 132
 133   /**
 134    * @copydoc TextField::SelectionChangedSignal()
 135    */
 136   DevelTextField::SelectionChangedSignalType& SelectionChangedSignal();
 137
 138   /**
 139    * @copydoc TextField::SelectionClearedSignal()
 140    */
 141   DevelTextField::SelectionClearedSignalType& SelectionClearedSignal();
 142
 143   /**
 144    * @copydoc TextField::SelectionStartedSignal()
 145    */
 146   DevelTextField::SelectionStartedSignalType& SelectionStartedSignal();
 147
 148 private: // From Control
 149   /**
 150    * @copydoc Control::OnInitialize()
 151    */
 152   void OnInitialize() override;
 153
 154   /**
 155    * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
 156    */
 157   DevelControl::ControlAccessible* CreateAccessibleObject() override;
 158
 159   /**
 160    * @copydoc Control::OnStyleChange()
 161    */
 162   void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
 163
 164   /**
 165    * @copydoc Control::GetNaturalSize()
 166    */
 167   Vector3 GetNaturalSize() override;
 168
 169   /**
 170    * @copydoc Control::GetHeightForWidth()
 171    */
 172   float GetHeightForWidth(float width) override;
 173
 174   /**
 175    * @copydoc Control::OnInitialize()
 176    */
 177   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
 178
 179   /**
 180    * @copydoc Control::OnKeyInputFocusGained()
 181    */
 182   void OnKeyInputFocusGained() override;
 183
 184   /**
 185    * @copydoc Control::OnKeyInputFocusLost()
 186    */
 187   void OnKeyInputFocusLost() override;
 188
 189   /**
 190    * @copydoc Control::OnAccessibilityActivated()
 191    */
 192   bool OnAccessibilityActivated() override;
 193
 194   /**
 195    * @copydoc Control::OnTap()
 196    */
 197   void OnTap(const TapGesture& tap) override;
 198
 199   /**
 200    * @copydoc Control::OnPan()
 201    */
 202   void OnPan(const PanGesture& gesture) override;
 203
 204   /**
 205    * @copydoc Control::OnLongPress()
 206    */
 207   void OnLongPress(const LongPressGesture& gesture) override;
 208
 209   /**
 210    * @copydoc Control::OnSceneConnection()
 211    */
 212   void OnSceneConnection(int depth) override;
 213
 214   /**
 215    * @copydoc Control::OnPropertySet()
 216    */
 217   void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
 218
 219   /**
 220    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 221    */
 222   bool OnKeyEvent(const KeyEvent& event) override;
 223
 224   // From ControlInterface
 225
 226   /**
 227    * @copydoc Text::ControlInterface::RequestTextRelayout()
 228    */
 229   void RequestTextRelayout() override;
 230
 231   // From EditableControlInterface
 232
 233   /**
 234    * @copydoc Text::EditableControlInterface::TextChanged()
 235    */
 236   void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
 237
 238   /**
 239    * @copydoc Text::EditableControlInterface::TextDeleted()
 240    */
 241   void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
 242
 243   /**
 244    * @copydoc Text::EditableControlInterface::CursorPositionChanged()
 245    */
 246   void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
 247
 248   /**
 249    * @copydoc Text::EditableControlInterface::TextChanged()
 250    */
 251   void TextChanged(bool immediate) override;
 252
 253   /**
 254    * @copydoc Text::EditableControlInterface::MaxLengthReached()
 255    */
 256   void MaxLengthReached() override;
 257
 258   /**
 259    * @copydoc Text::EditableControlInterface::InputStyleChanged()
 260    */
 261   void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
 262
 263   /**
 264    * @copydoc Text::SelectableControlInterface::SelectionChanged()
 265    */
 266   void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
 267
 268   /**
 269    * @copydoc Text::EditableControlInterface::AddDecoration()
 270    */
 271   void AddDecoration(Actor& actor, Toolkit::Text::DecorationType type, bool needsClipping) override;
 272
 273   /**
 274    * @copydoc Text::EditableControlInterface::InputFiltered()
 275    */
 276   void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
 277
 278   /**
 279    * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
 280    */
 281   void GetControlBackgroundColor(Vector4& color) const override;
 282
 283   // From SelectableControlInterface
 284 public:
 285   /**
 286    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 287    */
 288   void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
 289
 290   /**
 291    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 292    */
 293   Uint32Pair GetTextSelectionRange() const override;
 294
 295   /**
 296    * @copydoc Text::SelectableControlInterface::SelectWholeText()
 297    */
 298   void SelectWholeText() override;
 299
 300   /**
 301    * @copydoc Text::SelectableControlInterface::SelectNone()
 302    */
 303   void SelectNone() override;
 304
 305   /**
 306    * @copydoc Text::SelectableControlInterface::SelectText()
 307    */
 308   void SelectText(const uint32_t start, const uint32_t end) override;
 309
 310   /**
 311    * @copydoc Text::SelectableControlInterface::GetSelectedText()
 312    */
 313   string GetSelectedText() const override;
 314
 315   /**
 316    * @copydoc Text::EditableControlInterface::IsEditable()
 317    */
 318   bool IsEditable() const override;
 319
 320   /**
 321    * @copydoc Text::EditableControlInterface::SetEditable()
 322    */
 323   void SetEditable(bool editable) override;
 324
 325   /**
 326    * @copydoc Dali::EditableControlInterface::CopyText()
 327    */
 328   string CopyText() override;
 329
 330   /**
 331    * @copydoc Dali::EditableControlInterface::CutText()
 332    */
 333   string CutText() override;
 334
 335   /**
 336    * @copydoc Text::EditableControlInterface::PasteText()
 337    */
 338   void PasteText() override;
 339
 340   // From AnchorControlInterface
 341
 342   /**
 343    * @copydoc Text::AnchorControlInterface::AnchorClicked()
 344    */
 345   void AnchorClicked(const std::string& href) override;
 346
 347   /**
 348    * @brief Get the rendered size of a specific text range.
 349    * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
 350    * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
 351    *
 352    * @param[in] startIndex start index of the text requested to calculate size for.
 353    * @param[in] endIndex end index(included) of the text requested to calculate size for.
 354    * @return list of sizes of the reuested text.
 355    */
 356   Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
 357
 358   /**
 359    * @brief Get the top/left rendered position of a specific text range.
 360    * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
 361    * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
 362    *
 363    * @param[in] startIndex start index of the text requested to get position to.
 364    * @param[in] endIndex end index(included) of the text requested to get position to.
 365    * @return list of positions of the requested text.
 366    */
 367   Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
 368
 369   /**
 370    * @brief Get the line bounding rectangle.
 371    * if the requested index is out of range or the line is not yet rendered, a rect of {0, 0, 0, 0} is returned.
 372    *
 373    * @param[in] lineIndex line index to which we want to calculate the geometry for.
 374    * @return bounding rectangle.
 375    */
 376   Rect<float> GetLineBoundingRectangle(const uint32_t lineIndex) const;
 377
 378   /**
 379    * @brief Get the character bounding rectangle.
 380    * If the text is not yet rendered or the index > text.Count(); a rect of {0, 0, 0, 0} is returned.
 381    *
 382    * @param[in] charIndex character index to which we want to calculate the geometry for.
 383    * @return bounding rectangle.
 384    */
 385   Rect<float> GetCharacterBoundingRectangle(const uint32_t charIndex) const;
 386
 387   /**
 388    * @brief Get the character index.
 389    * If the text is not yet rendered or the text is empty, -1 is returned.
 390    *
 391    * @param[in] visualX visual x position.
 392    * @param[in] visualY visual y position.
 393    * @return character index.
 394    */
 395   int GetCharacterIndexAtPosition(float visualX, float visualY) const;
 396
 397   /**
 398    * @brief Gets the bounding box of a specific text range.
 399    *
 400    * @param[in] startIndex start index of the text requested to get bounding box to.
 401    * @param[in] endIndex end index(included) of the text requested to get bounding box to.
 402    * @return bounding box of the requested text.
 403    */
 404   Rect<> GetTextBoundingRectangle(uint32_t startIndex, uint32_t endIndex) const;
 405
 406   /**
 407    * @brief Set the @p spannedText into current textField
 408    * the spanned text contains content (text) and  format (spans with ranges)
 409    * the text is copied into text-controller and the spans are applied on ranges
 410    *
 411    * @param[in] spannedText the text with spans.
 412    */
 413   void SetSpannedText(const Text::Spanned& spannedText);
 414
 415 private: // Implementation
 416   /**
 417    * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
 418    */
 419   InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
 420
 421   /**
 422    * @brief Get a Property Map for the image used for the required Handle Image
 423    * @param[out] value the returned image property
 424    * @param[in] handleType the type of handle
 425    * @param[in] handleImageType the type of image for the given handleType
 426    */
 427   void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
 428
 429   /**
 430    * @brief Enable or disable clipping.
 431    */
 432   void EnableClipping();
 433
 434   /**
 435    * @brief Callback when keyboard is shown/hidden.
 436    *
 437    * @param[in] keyboardShown True if keyboard is shown.
 438    */
 439   void KeyboardStatusChanged(bool keyboardShown);
 440
 441   /**
 442    * @brief Callback when TextField is touched
 443    *
 444    * @param[in] actor TextField touched
 445    * @param[in] touch Touch information
 446    */
 447   bool OnTouched(Actor actor, const TouchEvent& touch);
 448
 449   /**
 450    * @brief Emits TextChanged signal.
 451    */
 452   void EmitTextChangedSignal();
 453
 454   /**
 455    * @brief Emits CursorPositionChanged signal.
 456    */
 457   void EmitCursorPositionChangedSignal();
 458
 459   /**
 460    * @brief Emits SelectionChanged signal.
 461    */
 462   void EmitSelectionChangedSignal();
 463
 464   /**
 465    * @brief Emits SelectionCleared signal.
 466    */
 467   void EmitSelectionClearedSignal();
 468
 469   /**
 470    * @brief Emits SelectionStarted signal.
 471    */
 472   void EmitSelectionStartedSignal();
 473
 474   /**
 475    * @brief Callback function for when the layout is changed.
 476    * @param[in] actor The actor whose layoutDirection is changed.
 477    * @param[in] type  The layoutDirection.
 478    */
 479   void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
 480
 481   /**
 482   * @brief Add a layer for active or cursor.
 483   * @param[in] layer The actor in which to store the layer.
 484   * @param[in] actor The new layer to add.
 485   */
 486   void AddLayer(Actor& layer, Actor& actor);
 487
 488   /**
 489    * Construct a new TextField.
 490    *
 491    * @param[in] additionalBehaviour additional behaviour flags for this TextField
 492    */
 493   TextField(ControlBehaviour additionalBehaviour);
 494
 495   /**
 496    * A reference counted object may only be deleted by calling Unreference()
 497    */
 498   virtual ~TextField();
 499
 500   // Undefined copy constructor and assignment operators
 501   TextField(const TextField&);
 502   TextField& operator=(const TextField& rhs);
 503
 504   /**
 505    * @brief Resize actor to the given size.
 506    *
 507    * @param[in] actor The actor to be resized.
 508    * @param[in] size Size to change.
 509    */
 510   void ResizeActor(Actor& actor, const Vector2& size);
 511
 512   /**
 513    * @brief Render view, create and attach actor(s) to this Text Field.
 514    */
 515   void RenderText(Text::Controller::UpdateTextType updateTextType);
 516
 517   // Connection needed to re-render text, when a Text Field returns to the scene.
 518   void OnSceneConnect(Dali::Actor actor);
 519
 520   // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model
 521   void OnAccessibilityStatusChanged();
 522
 523 private: // Data
 524   // Signals
 525   Toolkit::TextField::TextChangedSignalType                mTextChangedSignal;
 526   Toolkit::TextField::MaxLengthReachedSignalType           mMaxLengthReachedSignal;
 527   Toolkit::TextField::InputStyleChangedSignalType          mInputStyleChangedSignal;
 528   Toolkit::DevelTextField::AnchorClickedSignalType         mAnchorClickedSignal;
 529   Toolkit::DevelTextField::InputFilteredSignalType         mInputFilteredSignal;
 530   Toolkit::DevelTextField::CursorPositionChangedSignalType mCursorPositionChangedSignal;
 531   Toolkit::DevelTextField::SelectionChangedSignalType      mSelectionChangedSignal;
 532   Toolkit::DevelTextField::SelectionClearedSignalType      mSelectionClearedSignal;
 533   Toolkit::DevelTextField::SelectionStartedSignalType      mSelectionStartedSignal;
 534
 535   InputMethodContext               mInputMethodContext;
 536   Text::ControllerPtr              mController;
 537   Text::RendererPtr                mRenderer;
 538   Text::DecoratorPtr               mDecorator;
 539   Toolkit::Control                 mStencil;                  ///< For EXCEED_POLICY_CLIP
 540   std::vector<Actor>               mClippingDecorationActors; ///< Decoration actors which need clipping.
 541   std::vector<Toolkit::TextAnchor> mAnchorActors;
 542   Dali::InputMethodOptions         mInputMethodOptions;
 543
 544   Actor mRenderableActor;
 545   Actor mActiveLayer;
 546   Actor mCursorLayer;
 547   Actor mBackgroundActor;
 548
 549   float mAlignmentOffset;
 550   int   mRenderingBackend;
 551   int   mExceedPolicy;
 552   bool  mHasBeenStaged : 1;
 553   bool  mTextChanged : 1;           ///< If true, emits TextChangedSignal in next OnRelayout().
 554   bool  mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
 555   bool  mSelectionChanged : 1;      ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
 556   bool  mSelectionCleared : 1;      ///< If true, emits SelectionClearedSignal at the end of OnRelayout().
 557
 558   //args for cursor position changed event
 559   unsigned int mOldPosition;
 560
 561   //args for selection changed event
 562   uint32_t mOldSelectionStart;
 563   uint32_t mOldSelectionEnd;
 564
 565   bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout().
 566
 567 protected:
 568   struct PropertyHandler;
 569
 570   /**
 571    * @brief This structure is to connect TextField with Accessible functions.
 572    */
 573   class TextFieldAccessible : public EditableTextControlAccessible
 574   {
 575   public:
 576     using EditableTextControlAccessible::EditableTextControlAccessible;
 577
 578     /**
 579      * @copydoc Dali::Accessibility::Accessible::GetName()
 580      */
 581     std::string GetName() const override;
 582
 583   protected:
 584     /**
 585      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
 586      */
 587     const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
 588
 589     /**
 590      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
 591      */
 592     Toolkit::Text::ControllerPtr GetTextController() const override;
 593
 594     /**
 595      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetSubstituteCharacter()
 596      */
 597     std::uint32_t GetSubstituteCharacter() const override;
 598
 599     /**
 600      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::IsHiddenInput()
 601      */
 602     bool IsHiddenInput() const override;
 603
 604     /**
 605      * @copydoc Dali::Toolkit::Internal::EditableTextControlAccessible::RequestTextRelayout()
 606      */
 607     void RequestTextRelayout() override;
 608   };
 609 };
 610
 611 } // namespace Internal
 612
 613 // Helpers for public-api forwarding methods
 614
 615 inline Toolkit::Internal::TextField& GetImpl(Toolkit::TextField& textField)
 616 {
 617   DALI_ASSERT_ALWAYS(textField);
 618
 619   Dali::RefObject& handle = textField.GetImplementation();
 620
 621   return static_cast<Toolkit::Internal::TextField&>(handle);
 622 }
 623
 624 inline const Toolkit::Internal::TextField& GetImpl(const Toolkit::TextField& textField)
 625 {
 626   DALI_ASSERT_ALWAYS(textField);
 627
 628   const Dali::RefObject& handle = textField.GetImplementation();
 629
 630   return static_cast<const Toolkit::Internal::TextField&>(handle);
 631 }
 632
 633 } // namespace Toolkit
 634
 635 } // namespace Dali
 636
 637 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H