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

   1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
   2 #define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
   3
   4 /*
   5  * Copyright (c) 2020 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/public-api/animation/animation.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/controls/control-impl.h>
  28 #include <dali-toolkit/devel-api/controls/scroll-bar/scroll-bar.h>
  29 #include <dali-toolkit/public-api/controls/text-controls/text-editor.h>
  30 #include <dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h>
  31 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  32 #include <dali-toolkit/internal/text/text-control-interface.h>
  33 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
  34 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
  35 #include <dali-toolkit/internal/text/text-controller.h>
  36 #include <dali-toolkit/internal/text/text-vertical-scroller.h>
  37 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
  38
  39 namespace Dali
  40 {
  41
  42 namespace Toolkit
  43 {
  44
  45 namespace Internal
  46 {
  47 /**
  48  * @brief A control which renders a long text string with styles.
  49  */
  50 class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface
  51 {
  52 public:
  53
  54   /**
  55    * @copydoc Dali::Toollkit::TextEditor::New()
  56    */
  57   static Toolkit::TextEditor New();
  58
  59   // Properties
  60
  61   /**
  62    * @brief Called when a property of an object of this type is set.
  63    *
  64    * @param[in] object The object whose property is set.
  65    * @param[in] index The property index.
  66    * @param[in] value The new property value.
  67    */
  68   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
  69
  70   /**
  71    * @brief Called to retrieve a property of an object of this type.
  72    *
  73    * @param[in] object The object whose property is to be retrieved.
  74    * @param[in] index The property index.
  75    * @return The current value of the property.
  76    */
  77   static Property::Value GetProperty( BaseObject* object, Property::Index index );
  78
  79   /**
  80    * @copydoc Dali::Toollkit::TextEditor::GetInputMethodContext()
  81    */
  82   InputMethodContext GetInputMethodContext();
  83
  84   /**
  85    * @copydoc Dali::Toollkit::TextEditor::MaxLengthReachedSignal()
  86    */
  87   DevelTextEditor::MaxLengthReachedSignalType&  MaxLengthReachedSignal();
  88
  89   /**
  90    * Connects a callback function with the object's signals.
  91    * @param[in] object The object providing the signal.
  92    * @param[in] tracker Used to disconnect the signal.
  93    * @param[in] signalName The signal to connect to.
  94    * @param[in] functor A newly allocated FunctorDelegate.
  95    * @return True if the signal was connected.
  96    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
  97    */
  98   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
  99
 100   /**
 101    * @copydoc TextEditor::TextChangedSignal()
 102    */
 103   Toolkit::TextEditor::TextChangedSignalType&  TextChangedSignal();
 104
 105   /**
 106    * @copydoc TextEditor::TextChangedSignal()
 107    */
 108   Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
 109
 110   /**
 111    * @copydoc TextEditor::ScrollStateChangedSignal()
 112    */
 113   Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal();
 114
 115 private: // From Control
 116
 117   /**
 118    * @copydoc Control::OnInitialize()
 119    */
 120   void OnInitialize() override;
 121
 122   /**
 123    * @copydoc Control::OnStyleChange()
 124    */
 125   void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ) override;
 126
 127   /**
 128    * @copydoc Control::GetNaturalSize()
 129    */
 130   Vector3 GetNaturalSize() override;
 131
 132   /**
 133    * @copydoc Control::GetHeightForWidth()
 134    */
 135   float GetHeightForWidth( float width ) override;
 136
 137   /**
 138    * @copydoc Control::OnInitialize()
 139    */
 140   void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
 141
 142   /**
 143    * @copydoc Control::OnKeyInputFocusGained()
 144    */
 145   void OnKeyInputFocusGained() override;
 146
 147   /**
 148    * @copydoc Control::OnKeyInputFocusLost()
 149    */
 150   void OnKeyInputFocusLost() override;
 151
 152   /**
 153    * @copydoc Control::OnTap()
 154    */
 155   void OnTap( const TapGesture& tap ) override;
 156
 157   /**
 158    * @copydoc Control::OnPan()
 159    */
 160   void OnPan( const PanGesture& gesture ) override;
 161
 162   /**
 163    * @copydoc Control::OnLongPress()
 164    */
 165   void OnLongPress( const LongPressGesture& gesture ) override;
 166
 167   /**
 168    * @copydoc Control::OnSceneConnection()
 169    */
 170   void OnSceneConnection( int depth ) override;
 171
 172   /**
 173    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 174    */
 175   bool OnKeyEvent(const KeyEvent& event) override;
 176
 177 // From ControlInterface
 178
 179   /**
 180    * @copydoc Text::ControlInterface::RequestTextRelayout()
 181    */
 182   void RequestTextRelayout() override;
 183
 184 // From EditableControlInterface
 185
 186   /**
 187    * @copydoc Text::EditableControlInterface::TextChanged()
 188    */
 189   void TextChanged() override;
 190
 191   /**
 192    * @copydoc Text::EditableControlInterface::MaxLengthReached()
 193    */
 194   void MaxLengthReached() override;
 195
 196   /**
 197    * @copydoc Text::EditableControlInterface::InputStyleChanged()
 198    */
 199   void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ) override;
 200
 201   /**
 202    * @copydoc Text::EditableControlInterface::AddDecoration()
 203    */
 204   void AddDecoration( Actor& actor, bool needsClipping ) override;
 205
 206 // From SelectableControlInterface
 207 public:
 208   /**
 209    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 210    */
 211   void SetTextSelectionRange(const uint32_t *start, const uint32_t *end) override;
 212
 213   /**
 214    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 215    */
 216   Uint32Pair GetTextSelectionRange() const override;
 217
 218   /**
 219    * @copydoc Text::SelectableControlInterface::SelectWholeText()
 220    */
 221   void SelectWholeText() override;
 222
 223   /**
 224    * @copydoc Text::SelectableControlInterface::SelectNone()
 225    */
 226   void SelectNone() override;
 227
 228   /**
 229    * @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
 230    */
 231   void ScrollBy(Vector2 Scroll);
 232
 233   /**
 234    * @brief Get Horizontal scroll position of TextEditor.
 235    *
 236    * @return Horizontal scroll position (in pixels) of TextEditor.
 237    */
 238   float GetHorizontalScrollPosition();
 239
 240   /**
 241    * @brief Get Vertical scroll position of TextEditor.
 242    *
 243    * @return Vertical scroll position (in pixels) of TextEditor.
 244    */
 245   float GetVerticalScrollPosition();
 246
 247   /**
 248    * @copydoc Text::SelectableControlInterface::GetSelectedText()
 249    */
 250   string GetSelectedText() const override;
 251
 252   /**
 253    * @copydoc Text::EditableControlInterface::IsEditable()
 254    */
 255   bool IsEditable() const override;
 256
 257   /**
 258    * @copydoc Text::EditableControlInterface::SetEditable()
 259    */
 260   void SetEditable( bool editable ) override;
 261
 262 private: // Implementation
 263
 264   /**
 265    * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
 266    */
 267   InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent );
 268
 269   /**
 270    * @brief Callback when Clipboard signals an item should be pasted
 271    * @param[in] clipboard handle to Clipboard Event Notifier
 272    */
 273   void OnClipboardTextSelected( ClipboardEventNotifier& clipboard );
 274
 275   /**
 276    * @brief Get a Property Map for the image used for the required Handle Image
 277    * @param[out] value the returned image property
 278    * @param[in] handleType the type of handle
 279    * @param[in] handleImageType the type of image for the given handleType
 280    */
 281   void GetHandleImagePropertyValue(  Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType );
 282
 283   /**
 284    * @brief Callback when keyboard is shown/hidden.
 285    *
 286    * @param[in] keyboardShown True if keyboard is shown.
 287    */
 288   void KeyboardStatusChanged( bool keyboardShown );
 289
 290   /**
 291    * @brief update scroll bar position
 292    *
 293    * If text scroll is occurred, create or update scroll bar position
 294    */
 295   void UpdateScrollBar();
 296
 297   /**
 298    * @brief Callback when TextEditor is touched
 299    *
 300    * @param[in] actor TextEditor touched
 301    * @param[in] touch Touch information
 302    */
 303   bool OnTouched( Actor actor, const TouchEvent& touch );
 304
 305   /**
 306    * @brief Callbacks called on idle.
 307    *
 308    * If there are notifications of change of input style on the queue, Toolkit::TextEditor::InputStyleChangedSignal() are emitted.
 309    */
 310   void OnIdleSignal();
 311
 312   /**
 313    * @brief set RenderActor's position with new scrollPosition
 314    *
 315    * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
 316    */
 317   void ApplyScrollPosition();
 318
 319   /**
 320    * @brief Callback function for ScrollBar indicator animation finished signal
 321    *
 322    * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
 323    */
 324   void OnScrollIndicatorAnimationFinished( Animation& animation );
 325
 326   /**
 327    * Construct a new TextEditor.
 328    */
 329   TextEditor();
 330
 331   /**
 332    * A reference counted object may only be deleted by calling Unreference()
 333    */
 334   virtual ~TextEditor();
 335
 336   // Undefined copy constructor and assignment operators
 337   TextEditor(const TextEditor&);
 338   TextEditor& operator=(const TextEditor& rhs);
 339
 340   /**
 341    * @brief Render view, create and attach actor(s) to this text editor.
 342    */
 343   void RenderText( Text::Controller::UpdateTextType updateTextType );
 344
 345   // Connection needed to re-render text, when a text editor returns to the scene.
 346   void OnSceneConnect( Dali::Actor actor );
 347
 348 private: // Data
 349   // Signals
 350   Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
 351   Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
 352   Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal;
 353   Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal;
 354
 355   InputMethodContext mInputMethodContext;
 356   Text::ControllerPtr mController;
 357   Text::RendererPtr mRenderer;
 358   Text::DecoratorPtr mDecorator;
 359   Text::TextVerticalScrollerPtr mTextVerticalScroller;
 360   Toolkit::Control mStencil;
 361   Toolkit::ScrollBar mScrollBar;
 362   Dali::Animation mAnimation;                                              ///< Scroll indicator Show/Hide Animation.
 363   Dali::TimePeriod mAnimationPeriod;
 364   std::vector<Actor> mClippingDecorationActors;   ///< Decoration actors which need clipping.
 365
 366   Actor mRenderableActor;
 367   Actor mActiveLayer;
 368   CallbackBase* mIdleCallback;
 369
 370   float mAlignmentOffset;
 371   float mScrollAnimationDuration;
 372   float mLineSpacing;
 373   int mRenderingBackend;
 374   bool mHasBeenStaged:1;
 375   bool mScrollAnimationEnabled:1;
 376   bool mScrollBarEnabled:1;
 377   bool mScrollStarted:1;
 378 };
 379
 380 } // namespace Internal
 381
 382 // Helpers for public-api forwarding methods
 383
 384 inline Toolkit::Internal::TextEditor& GetImpl( Toolkit::TextEditor& textEditor )
 385 {
 386   DALI_ASSERT_ALWAYS(textEditor);
 387
 388   Dali::RefObject& handle = textEditor.GetImplementation();
 389
 390   return static_cast<Toolkit::Internal::TextEditor&>(handle);
 391 }
 392
 393 inline const Toolkit::Internal::TextEditor& GetImpl( const Toolkit::TextEditor& textEditor )
 394 {
 395   DALI_ASSERT_ALWAYS(textEditor);
 396
 397   const Dali::RefObject& handle = textEditor.GetImplementation();
 398
 399   return static_cast<const Toolkit::Internal::TextEditor&>(handle);
 400 }
 401
 402 } // namespace Toolkit
 403
 404 } // namespace Dali
 405
 406 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H