[Tizen](ATSPI) squashed implementation
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / text-controls / text-editor-impl.h
old mode 100644 (file)
new mode 100755 (executable)
index cb40406..d4a38be
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H__
-#define __DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H__
+#ifndef DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
+#define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  *
  */
 
+// EXTERNAL INCLUDES
+#include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
+#include <dali/devel-api/adaptor-framework/input-method-context.h>
+#include <dali/public-api/adaptor-framework/accessibility.h>
+#include <dali/public-api/animation/animation.h>
+
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/control-impl.h>
+#include <dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h>
 #include <dali-toolkit/public-api/controls/text-controls/text-editor.h>
-#include <dali-toolkit/internal/text/clipping/text-clipper.h>
 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
 #include <dali-toolkit/internal/text/text-control-interface.h>
+#include <dali-toolkit/internal/text/text-editable-control-interface.h>
 #include <dali-toolkit/internal/text/text-controller.h>
+#include <dali-toolkit/internal/text/text-vertical-scroller.h>
 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
-
-// EXTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
+#include <dali-toolkit/internal/controls/control/control-data-impl.h>
 
 namespace Dali
 {
@@ -38,11 +44,10 @@ namespace Toolkit
 
 namespace Internal
 {
-
 /**
  * @brief A control which renders a long text string with styles.
  */
-class TextEditor : public Control, public Text::ControlInterface
+class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface
 {
 public:
 
@@ -72,6 +77,11 @@ public:
   static Property::Value GetProperty( BaseObject* object, Property::Index index );
 
   /**
+   * @copydoc Dali::Toollkit::TextEditor::GetInputMethodContext()
+   */
+  InputMethodContext GetInputMethodContext();
+
+  /**
    * Connects a callback function with the object's signals.
    * @param[in] object The object providing the signal.
    * @param[in] tracker Used to disconnect the signal.
@@ -92,6 +102,11 @@ public:
    */
   Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
 
+  /**
+   * @copydoc TextEditor::ScrollStateChangedSignal()
+   */
+  Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal();
+
 private: // From Control
 
   /**
@@ -157,14 +172,26 @@ private: // From Control
 // From ControlInterface
 
   /**
-   * @copydoc Text::ControlInterface::AddDecoration()
+   * @copydoc Text::ControlInterface::RequestTextRelayout()
    */
-  virtual void AddDecoration( Actor& actor, bool needsClipping );
+  virtual void RequestTextRelayout();
+
+// From EditableControlInterface
 
   /**
-   * @copydoc Text::ControlInterface::RequestTextRelayout()
+   * @copydoc Text::ControlInterface::TextInserted()
    */
-  virtual void RequestTextRelayout();
+  virtual void TextInserted( unsigned int position, unsigned int length, const std::string &content );
+
+  /**
+   * @copydoc Text::ControlInterface::TextDeleted()
+   */
+  virtual void TextDeleted( unsigned int position, unsigned int length, const std::string &content );
+
+  /**
+   * @copydoc Text::ControlInterface::CaretMoved()
+   */
+  virtual void CaretMoved( unsigned int position );
 
   /**
    * @copydoc Text::ControlInterface::TextChanged()
@@ -181,12 +208,19 @@ private: // From Control
    */
   virtual void InputStyleChanged( Text::InputStyle::Mask inputStyleMask );
 
+  /**
+   * @copydoc Text::ControlInterface::AddDecoration()
+   */
+  virtual void AddDecoration( Actor& actor, bool needsClipping );
+
+  Text::ControllerPtr getController();
+
 private: // Implementation
 
   /**
-   * @copydoc Dali::Toolkit::Text::Controller::(ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent)
+   * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
    */
-  ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
+  InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent );
 
   /**
    * @brief Callback when Clipboard signals an item should be pasted
@@ -203,19 +237,18 @@ private: // Implementation
   void GetHandleImagePropertyValue(  Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType );
 
   /**
-   * @brief Enable or disable clipping.
+   * @brief Callback when keyboard is shown/hidden.
    *
-   * @param[in] clipping True if clipping should be enabled.
-   * @param[in] size The area to clip within.
+   * @param[in] keyboardShown True if keyboard is shown.
    */
-  void EnableClipping( bool clipping, const Vector2& size );
+  void KeyboardStatusChanged( bool keyboardShown );
 
   /**
-   * @brief Callback when keyboard is shown/hidden.
+   * @brief update scroll bar position
    *
-   * @param[in] keyboardShown True if keyboard is shown.
+   * If text scroll is occurred, create or update scroll bar position
    */
-  void KeyboardStatusChanged( bool keyboardShown );
+  void UpdateScrollBar();
 
   /**
    * @brief Callback when TextEditor is touched
@@ -233,6 +266,20 @@ private: // Implementation
   void OnIdleSignal();
 
   /**
+   * @brief set RenderActor's position with new scrollPosition
+   *
+   * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
+   */
+  void ApplyScrollPosition();
+
+  /**
+   * @brief Callback function for ScrollBar indicator animation finished signal
+   *
+   * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
+   */
+  void OnScrollIndicatorAnimationFinished( Animation& animation );
+
+  /**
    * Construct a new TextEditor.
    */
   TextEditor();
@@ -255,22 +302,57 @@ private: // Implementation
   void OnStageConnect( Dali::Actor actor );
 
 private: // Data
-
   // Signals
   Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
   Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
+  Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal;
 
+  InputMethodContext mInputMethodContext;
   Text::ControllerPtr mController;
   Text::RendererPtr mRenderer;
   Text::DecoratorPtr mDecorator;
-  Text::ClipperPtr mClipper;
+  Text::TextVerticalScrollerPtr mTextVerticalScroller;
+  Toolkit::Control mStencil;
+  Toolkit::ScrollBar mScrollBar;
+  Dali::Animation mAnimation;                                              ///< Scroll indicator Show/Hide Animation.
+  Dali::TimePeriod mAnimationPeriod;
   std::vector<Actor> mClippingDecorationActors;   ///< Decoration actors which need clipping.
 
   Actor mRenderableActor;
+  Actor mActiveLayer;
   CallbackBase* mIdleCallback;
 
+  float mAlignmentOffset;
+  float mScrollAnimationDuration;
+  float mLineSpacing;
   int mRenderingBackend;
   bool mHasBeenStaged:1;
+  bool mScrollAnimationEnabled:1;
+  bool mScrollBarEnabled:1;
+  bool mScrollStarted:1;
+
+  struct AccessibleImpl : public Control::Impl::AccessibleImpl,
+                          public virtual Dali::Accessibility::Text,
+                          public virtual Dali::Accessibility::EditableText
+  {
+    using Control::Impl::AccessibleImpl::AccessibleImpl;
+
+    std::string GetName() override;
+    std::string GetText( size_t startOffset, size_t endOffset ) override;
+    size_t GetCharacterCount() override;
+    size_t GetCaretOffset() override;
+    bool SetCaretOffset(size_t offset) override;
+    Dali::Accessibility::Range
+    GetTextAtOffset( size_t offset,
+                     Dali::Accessibility::TextBoundary boundary ) override;
+    Dali::Accessibility::Range GetSelection( size_t selectionNum ) override;
+    bool RemoveSelection( size_t selectionNum ) override;
+    bool SetSelection( size_t selectionNum, size_t startOffset,
+                       size_t endOffset ) override;
+    bool CopyText( size_t startPosition, size_t endPosition ) override;
+    bool CutText( size_t startPosition, size_t endPosition ) override;
+    Dali::Accessibility::States CalculateStates() override;
+  };
 };
 
 } // namespace Internal
@@ -299,4 +381,4 @@ inline const Toolkit::Internal::TextEditor& GetImpl( const Toolkit::TextEditor&
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H__
+#endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H