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) 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/adaptor-framework/clipboard-event-notifier.h>
  23 #include <dali/devel-api/adaptor-framework/input-method-context.h>
  24 #include <dali/devel-api/atspi-interfaces/editable-text.h>
  25 #include <dali/devel-api/atspi-interfaces/hypertext.h>
  26 #include <dali/devel-api/atspi-interfaces/text.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/devel-api/controls/control-devel.h>
  30 #include <dali-toolkit/devel-api/controls/text-controls/text-field-devel.h>
  31 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  32 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.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-controller.h>
  38 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
  39 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
  40 #include <dali-toolkit/public-api/controls/control-impl.h>
  41 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
  42
  43 namespace Dali
  44 {
  45 namespace Toolkit
  46 {
  47 namespace Internal
  48 {
  49 /**
  50  * @brief A control which renders a short text string.
  51  */
  52 class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface
  53 {
  54 public:
  55   /**
  56    * @copydoc Dali::Toollkit::TextField::New()
  57    */
  58   static Toolkit::TextField New();
  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 Control::OnStyleChange()
 156    */
 157   void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
 158
 159   /**
 160    * @copydoc Control::GetNaturalSize()
 161    */
 162   Vector3 GetNaturalSize() override;
 163
 164   /**
 165    * @copydoc Control::GetHeightForWidth()
 166    */
 167   float GetHeightForWidth(float width) override;
 168
 169   /**
 170    * @copydoc Control::OnInitialize()
 171    */
 172   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
 173
 174   /**
 175    * @copydoc Control::OnKeyInputFocusGained()
 176    */
 177   void OnKeyInputFocusGained() override;
 178
 179   /**
 180    * @copydoc Control::OnKeyInputFocusLost()
 181    */
 182   void OnKeyInputFocusLost() override;
 183
 184   /**
 185    * @copydoc Control::OnAccessibilityActivated()
 186    */
 187   bool OnAccessibilityActivated() override;
 188
 189   /**
 190    * @copydoc Control::OnTap()
 191    */
 192   void OnTap(const TapGesture& tap) override;
 193
 194   /**
 195    * @copydoc Control::OnPan()
 196    */
 197   void OnPan(const PanGesture& gesture) override;
 198
 199   /**
 200    * @copydoc Control::OnLongPress()
 201    */
 202   void OnLongPress(const LongPressGesture& gesture) override;
 203
 204   /**
 205    * @copydoc Control::OnSceneConnection()
 206    */
 207   void OnSceneConnection(int depth) override;
 208
 209   /**
 210    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 211    */
 212   bool OnKeyEvent(const KeyEvent& event) override;
 213
 214   // From ControlInterface
 215
 216   /**
 217    * @copydoc Text::ControlInterface::RequestTextRelayout()
 218    */
 219   void RequestTextRelayout() override;
 220
 221   // From EditableControlInterface
 222
 223   /**
 224    * @copydoc Text::EditableControlInterface::TextChanged()
 225    */
 226   void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
 227
 228   /**
 229    * @copydoc Text::EditableControlInterface::TextDeleted()
 230    */
 231   void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
 232
 233   /**
 234    * @copydoc Text::EditableControlInterface::CursorPositionChanged()
 235    */
 236   void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
 237
 238   /**
 239    * @copydoc Text::EditableControlInterface::TextChanged()
 240    */
 241   void TextChanged(bool immediate) override;
 242
 243   /**
 244    * @copydoc Text::EditableControlInterface::MaxLengthReached()
 245    */
 246   void MaxLengthReached() override;
 247
 248   /**
 249    * @copydoc Text::EditableControlInterface::InputStyleChanged()
 250    */
 251   void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
 252
 253   /**
 254    * @copydoc Text::SelectableControlInterface::SelectionChanged()
 255    */
 256   void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
 257
 258   /**
 259    * @copydoc Text::EditableControlInterface::AddDecoration()
 260    */
 261   void AddDecoration(Actor& actor, Toolkit::Text::DecorationType type, bool needsClipping) override;
 262
 263   /**
 264    * @copydoc Text::EditableControlInterface::InputFiltered()
 265    */
 266   void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
 267
 268   /**
 269    * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
 270    */
 271   void GetControlBackgroundColor(Vector4& color) const override;
 272
 273   // From SelectableControlInterface
 274 public:
 275
 276   /**
 277    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 278    */
 279   void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
 280
 281   /**
 282    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 283    */
 284   Uint32Pair GetTextSelectionRange() const override;
 285
 286   /**
 287    * @copydoc Text::SelectableControlInterface::SelectWholeText()
 288    */
 289   void SelectWholeText() override;
 290
 291   /**
 292    * @copydoc Text::SelectableControlInterface::SelectNone()
 293    */
 294   void SelectNone() override;
 295
 296   /**
 297    * @copydoc Text::SelectableControlInterface::SelectText()
 298    */
 299   void SelectText(const uint32_t start, const uint32_t end) override;
 300
 301   /**
 302    * @copydoc Text::SelectableControlInterface::GetSelectedText()
 303    */
 304   string GetSelectedText() const override;
 305
 306   /**
 307    * @copydoc Text::EditableControlInterface::IsEditable()
 308    */
 309   bool IsEditable() const override;
 310
 311   /**
 312    * @copydoc Text::EditableControlInterface::SetEditable()
 313    */
 314   void SetEditable(bool editable) override;
 315
 316   /**
 317    * @copydoc Dali::EditableControlInterface::CopyText()
 318    */
 319   string CopyText() override;
 320
 321   /**
 322    * @copydoc Dali::EditableControlInterface::CutText()
 323    */
 324   string CutText() override;
 325
 326   /**
 327    * @copydoc Text::EditableControlInterface::PasteText()
 328    */
 329   void PasteText() override;
 330
 331   // From AnchorControlInterface
 332
 333   /**
 334    * @copydoc Text::AnchorControlInterface::AnchorClicked()
 335    */
 336   void AnchorClicked(const std::string& href) override;
 337
 338   /**
 339    * @brief Get the rendered size of a specific text range.
 340    * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
 341    * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
 342    *
 343    * @param[in] startIndex start index of the text requested to calculate size for.
 344    * @param[in] endIndex end index(included) of the text requested to calculate size for.
 345    * @return list of sizes of the reuested text.
 346    */
 347   Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
 348
 349   /**
 350    * @brief Get the top/left rendered position of a specific text range.
 351    * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
 352    * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
 353    *
 354    * @param[in] startIndex start index of the text requested to get position to.
 355    * @param[in] endIndex end index(included) of the text requested to get position to.
 356    * @return list of positions of the requested text.
 357    */
 358   Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
 359
 360 private: // Implementation
 361   /**
 362    * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
 363    */
 364   InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
 365
 366   /**
 367    * @brief Callback when Clipboard signals an item should be pasted
 368    * @param[in] clipboard handle to Clipboard Event Notifier
 369    */
 370   void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
 371
 372   /**
 373    * @brief Get a Property Map for the image used for the required Handle Image
 374    * @param[out] value the returned image property
 375    * @param[in] handleType the type of handle
 376    * @param[in] handleImageType the type of image for the given handleType
 377    */
 378   void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
 379
 380   /**
 381    * @brief Enable or disable clipping.
 382    */
 383   void EnableClipping();
 384
 385   /**
 386    * @brief Callback when keyboard is shown/hidden.
 387    *
 388    * @param[in] keyboardShown True if keyboard is shown.
 389    */
 390   void KeyboardStatusChanged(bool keyboardShown);
 391
 392   /**
 393    * @brief Callback when TextField is touched
 394    *
 395    * @param[in] actor TextField touched
 396    * @param[in] touch Touch information
 397    */
 398   bool OnTouched(Actor actor, const TouchEvent& touch);
 399
 400   /**
 401    * @brief Callbacks called on idle.
 402    *
 403    * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
 404    */
 405   void OnIdleSignal();
 406
 407   /**
 408    * @brief Emits TextChanged signal.
 409    */
 410   void EmitTextChangedSignal();
 411
 412   /**
 413    * @brief Emits CursorPositionChanged signal.
 414    */
 415   void EmitCursorPositionChangedSignal();
 416
 417   /**
 418    * @brief Emits SelectionChanged signal.
 419    */
 420   void EmitSelectionChangedSignal();
 421
 422   /**
 423    * @brief Emits SelectionCleared signal.
 424    */
 425   void EmitSelectionClearedSignal();
 426
 427   /**
 428    * @brief Emits SelectionStarted signal.
 429    */
 430   void EmitSelectionStartedSignal();
 431
 432   /**
 433    * @brief Callback function for when the layout is changed.
 434    * @param[in] actor The actor whose layoutDirection is changed.
 435    * @param[in] type  The layoutDirection.
 436    */
 437   void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
 438
 439   /**
 440   * @brief Add a layer for active or cursor.
 441   * @param[in] layer The actor in which to store the layer.
 442   * @param[in] actor The new layer to add.
 443   */
 444   void AddLayer(Actor& layer, Actor& actor);
 445
 446   /**
 447    * Construct a new TextField.
 448    */
 449   TextField();
 450
 451   /**
 452    * A reference counted object may only be deleted by calling Unreference()
 453    */
 454   virtual ~TextField();
 455
 456   // Undefined copy constructor and assignment operators
 457   TextField(const TextField&);
 458   TextField& operator=(const TextField& rhs);
 459
 460   /**
 461    * @brief Resize actor to the given size.
 462    *
 463    * @param[in] actor The actor to be resized.
 464    * @param[in] size Size to change.
 465    */
 466   void ResizeActor(Actor& actor, const Vector2& size);
 467
 468   /**
 469    * @brief Render view, create and attach actor(s) to this Text Field.
 470    */
 471   void RenderText(Text::Controller::UpdateTextType updateTextType);
 472
 473   // Connection needed to re-render text, when a Text Field returns to the scene.
 474   void OnSceneConnect(Dali::Actor actor);
 475
 476   // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model
 477   void OnAccessibilityStatusChanged();
 478
 479 private: // Data
 480   // Signals
 481   Toolkit::TextField::TextChangedSignalType                mTextChangedSignal;
 482   Toolkit::TextField::MaxLengthReachedSignalType           mMaxLengthReachedSignal;
 483   Toolkit::TextField::InputStyleChangedSignalType          mInputStyleChangedSignal;
 484   Toolkit::DevelTextField::AnchorClickedSignalType         mAnchorClickedSignal;
 485   Toolkit::DevelTextField::InputFilteredSignalType         mInputFilteredSignal;
 486   Toolkit::DevelTextField::CursorPositionChangedSignalType mCursorPositionChangedSignal;
 487   Toolkit::DevelTextField::SelectionChangedSignalType      mSelectionChangedSignal;
 488   Toolkit::DevelTextField::SelectionClearedSignalType      mSelectionClearedSignal;
 489   Toolkit::DevelTextField::SelectionStartedSignalType      mSelectionStartedSignal;
 490
 491   InputMethodContext               mInputMethodContext;
 492   Text::ControllerPtr              mController;
 493   Text::RendererPtr                mRenderer;
 494   Text::DecoratorPtr               mDecorator;
 495   Toolkit::Control                 mStencil;                  ///< For EXCEED_POLICY_CLIP
 496   std::vector<Actor>               mClippingDecorationActors; ///< Decoration actors which need clipping.
 497   std::vector<Toolkit::TextAnchor> mAnchorActors;
 498   Dali::InputMethodOptions         mInputMethodOptions;
 499
 500   Actor         mRenderableActor;
 501   Actor         mActiveLayer;
 502   Actor         mCursorLayer;
 503   Actor         mBackgroundActor;
 504   CallbackBase* mIdleCallback;
 505
 506   float mAlignmentOffset;
 507   int   mRenderingBackend;
 508   int   mExceedPolicy;
 509   bool  mHasBeenStaged : 1;
 510   bool  mTextChanged : 1;           ///< If true, emits TextChangedSignal in next OnRelayout().
 511   bool  mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
 512   bool  mSelectionChanged : 1;      ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
 513   bool  mSelectionCleared : 1;      ///< If true, emits SelectionClearedSignal at the end of OnRelayout().
 514
 515   //args for cursor position changed event
 516   unsigned int mOldPosition;
 517
 518   //args for selection changed event
 519   uint32_t mOldSelectionStart;
 520   uint32_t mOldSelectionEnd;
 521
 522   bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout().
 523
 524 protected:
 525   struct PropertyHandler;
 526
 527   /**
 528    * @brief This structure is to connect TextField with Accessible functions.
 529    */
 530   class TextFieldAccessible : public EditableTextControlAccessible
 531   {
 532   public:
 533     using EditableTextControlAccessible::EditableTextControlAccessible;
 534
 535     /**
 536      * @copydoc Dali::Accessibility::Accessible::GetName()
 537      */
 538     std::string GetName() const override;
 539
 540   protected:
 541     /**
 542      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
 543      */
 544     const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
 545
 546     /**
 547      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
 548      */
 549     Toolkit::Text::ControllerPtr GetTextController() const override;
 550
 551     /**
 552      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetSubstituteCharacter()
 553      */
 554     std::uint32_t GetSubstituteCharacter() const override;
 555
 556     /**
 557      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::IsHiddenInput()
 558      */
 559     bool IsHiddenInput() const override;
 560
 561     /**
 562      * @copydoc Dali::Toolkit::Internal::EditableTextControlAccessible::RequestTextRelayout()
 563      */
 564     void RequestTextRelayout() override;
 565   };
 566 };
 567
 568 } // namespace Internal
 569
 570 // Helpers for public-api forwarding methods
 571
 572 inline Toolkit::Internal::TextField& GetImpl(Toolkit::TextField& textField)
 573 {
 574   DALI_ASSERT_ALWAYS(textField);
 575
 576   Dali::RefObject& handle = textField.GetImplementation();
 577
 578   return static_cast<Toolkit::Internal::TextField&>(handle);
 579 }
 580
 581 inline const Toolkit::Internal::TextField& GetImpl(const Toolkit::TextField& textField)
 582 {
 583   DALI_ASSERT_ALWAYS(textField);
 584
 585   const Dali::RefObject& handle = textField.GetImplementation();
 586
 587   return static_cast<const Toolkit::Internal::TextField&>(handle);
 588 }
 589
 590 } // namespace Toolkit
 591
 592 } // namespace Dali
 593
 594 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H