Refactored text field/editor property getters/setters
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / text-controls / text-editor-impl.h
index eb3bae4..8c5d7be 100644 (file)
@@ -93,6 +93,26 @@ public:
   DevelTextEditor::AnchorClickedSignalType& AnchorClickedSignal();
 
   /**
+   * @copydoc Dali::Toollkit::TextEditor::CursorPositionChangedSignal()
+   */
+  DevelTextEditor::CursorPositionChangedSignalType& CursorPositionChangedSignal();
+
+  /**
+   * @copydoc Dali::Toollkit::TextEditor::InputFilteredSignal()
+   */
+  DevelTextEditor::InputFilteredSignalType& InputFilteredSignal();
+
+  /**
+   * @copydoc Dali::Toollkit::TextEditor::SelectionChangedSignal()
+   */
+  DevelTextEditor::SelectionChangedSignalType& SelectionChangedSignal();
+
+  /**
+   * @copydoc Dali::Toollkit::TextEditor::SelectionClearedSignal()
+   */
+  DevelTextEditor::SelectionClearedSignalType& SelectionClearedSignal();
+
+  /**
    * 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.
@@ -104,6 +124,13 @@ public:
   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
 
   /**
+   * @brief Gets text controller
+   *
+   * @return The text controller
+   */
+  Text::ControllerPtr GetTextController();
+
+  /**
    * @copydoc TextEditor::TextChangedSignal()
    */
   Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal();
@@ -204,9 +231,9 @@ private: // From Control
   void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
 
   /**
-   * @copydoc Text::EditableControlInterface::CaretMoved()
+   * @copydoc Text::EditableControlInterface::CursorPositionChanged()
    */
-  void CaretMoved(unsigned int position) override;
+  void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
 
   /**
    * @copydoc Text::EditableControlInterface::TextChanged()
@@ -224,10 +251,25 @@ private: // From Control
   void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
 
   /**
+   * @copydoc Text::SelectableControlInterface::SelectionChanged()
+   */
+  void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
+
+  /**
    * @copydoc Text::EditableControlInterface::AddDecoration()
    */
   void AddDecoration(Actor& actor, bool needsClipping) override;
 
+  /**
+   * @copydoc Text::EditableControlInterface::InputFiltered()
+   */
+  void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
+
+  /**
+   * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
+   */
+  void GetControlBackgroundColor(Vector4& color) const override;
+
   // From SelectableControlInterface
 public:
   /**
@@ -251,6 +293,11 @@ public:
   void SelectNone() override;
 
   /**
+   * @copydoc Text::SelectableControlInterface::SelectText()
+   */
+  void SelectText(const uint32_t start, const uint32_t end) override;
+
+  /**
    * @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
    */
   void ScrollBy(Vector2 Scroll);
@@ -284,6 +331,21 @@ public:
    */
   void SetEditable(bool editable) override;
 
+  /**
+   * @copydoc Text::EditableControlInterface::CopyText()
+   */
+  string CopyText() override;
+
+  /**
+   * @copydoc Text::EditableControlInterface::CutText()
+   */
+  string CutText() override;
+
+  /**
+   * @copydoc Text::EditableControlInterface::PasteText()
+   */
+  void PasteText() override;
+
   // From AnchorControlInterface
 
   /**
@@ -291,8 +353,6 @@ public:
    */
   void AnchorClicked(const std::string& href) override;
 
-  Text::ControllerPtr getController();
-
 private: // Implementation
   /**
    * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
@@ -343,11 +403,26 @@ private: // Implementation
   void OnIdleSignal();
 
   /**
+   * @brief Emits CursorPositionChanged signal.
+   */
+  void EmitCursorPositionChangedSignal();
+
+  /**
    * @brief Emits TextChanged signal.
    */
   void EmitTextChangedSignal();
 
   /**
+   * @brief Emits SelectionChanged signal.
+   */
+  void EmitSelectionChangedSignal();
+
+  /**
+   * @brief Emits SelectionCleared signal.
+   */
+  void EmitSelectionClearedSignal();
+
+  /**
    * @brief set RenderActor's position with new scrollPosition
    *
    * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
@@ -362,6 +437,13 @@ private: // Implementation
   void OnScrollIndicatorAnimationFinished(Animation& animation);
 
   /**
+  * @brief Callback function for when the layout is changed.
+  * @param[in] actor The actor whose layoutDirection is changed.
+  * @param[in] type  The layoutDirection.
+  */
+  void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
+
+  /**
    * Construct a new TextEditor.
    */
   TextEditor();
@@ -393,11 +475,15 @@ private: // Implementation
 
 private: // Data
   // Signals
-  Toolkit::TextEditor::TextChangedSignalType           mTextChangedSignal;
-  Toolkit::TextEditor::InputStyleChangedSignalType     mInputStyleChangedSignal;
-  Toolkit::TextEditor::ScrollStateChangedSignalType    mScrollStateChangedSignal;
-  Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal;
-  Toolkit::DevelTextEditor::AnchorClickedSignalType    mAnchorClickedSignal;
+  Toolkit::TextEditor::TextChangedSignalType                mTextChangedSignal;
+  Toolkit::TextEditor::InputStyleChangedSignalType          mInputStyleChangedSignal;
+  Toolkit::TextEditor::ScrollStateChangedSignalType         mScrollStateChangedSignal;
+  Toolkit::DevelTextEditor::MaxLengthReachedSignalType      mMaxLengthReachedSignal;
+  Toolkit::DevelTextEditor::AnchorClickedSignalType         mAnchorClickedSignal;
+  Toolkit::DevelTextEditor::InputFilteredSignalType         mInputFilteredSignal;
+  Toolkit::DevelTextEditor::CursorPositionChangedSignalType mCursorPositionChangedSignal;
+  Toolkit::DevelTextEditor::SelectionChangedSignalType      mSelectionChangedSignal;
+  Toolkit::DevelTextEditor::SelectionClearedSignalType      mSelectionClearedSignal;
 
   InputMethodContext            mInputMethodContext;
   Text::ControllerPtr           mController;
@@ -409,9 +495,11 @@ private: // Data
   Dali::Animation               mAnimation; ///< Scroll indicator Show/Hide Animation.
   Dali::TimePeriod              mAnimationPeriod;
   std::vector<Actor>            mClippingDecorationActors; ///< Decoration actors which need clipping.
+  Dali::InputMethodOptions      mInputMethodOptions;
 
   Actor         mRenderableActor;
   Actor         mActiveLayer;
+  Actor         mBackgroundActor;
   CallbackBase* mIdleCallback;
 
   float mAlignmentOffset;
@@ -422,29 +510,103 @@ private: // Data
   bool  mScrollAnimationEnabled : 1;
   bool  mScrollBarEnabled : 1;
   bool  mScrollStarted : 1;
-  bool  mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout().
+  bool  mTextChanged : 1;           ///< If true, emits TextChangedSignal in next OnRelayout().
+  bool  mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
+  bool  mSelectionChanged : 1;      ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
+  bool  mSelectionCleared : 1;      ///< If true, emits SelectionClearedSignal at the end of OnRelayout().
+
+  //args for cursor PositionChanged event
+  unsigned int mOldPosition;
 
+  //args for selection changed event
+  uint32_t mOldSelectionStart;
+  uint32_t mOldSelectionEnd;
+
+  struct PropertyHandler;
+
+  /**
+   * @brief This structure is to connect TextEditor with Accessible functions.
+   */
   struct AccessibleImpl : public DevelControl::AccessibleImpl,
                           public virtual Dali::Accessibility::Text,
                           public virtual Dali::Accessibility::EditableText
   {
     using DevelControl::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;
-    Accessibility::Range  GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
-    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;
+    /**
+     * @copydoc Dali::Accessibility::Accessible::GetName()
+     */
+    std::string GetName() override;
+
+    /**
+     * @copydoc Dali::Accessibility::Text::GetText()
+     */
+    std::string GetText(size_t startOffset, size_t endOffset) override;
+
+    /**
+     * @copydoc Dali::Accessibility::Text::GetCharacterCount()
+     */
+    size_t GetCharacterCount() override;
+
+    /**
+     * @copydoc Dali::Accessibility::Text::GetCursorOffset()
+     */
+    size_t GetCursorOffset() override;
+
+    /**
+     * @copydoc Dali::Accessibility::Text::SetCursorOffset()
+     */
+    bool SetCursorOffset(size_t offset) override;
+
+    /**
+     * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
+     */
+    Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
+
+    /**
+     * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
+     */
+    Accessibility::Range GetRangeOfSelection(size_t selectionIndex) override;
+
+    /**
+     * @copydoc Dali::Accessibility::Text::RemoveSelection()
+     */
+    bool RemoveSelection(size_t selectionIndex) override;
+
+    /**
+     * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
+     */
+    bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override;
+
+    /**
+     * @copydoc Dali::Accessibility::EditableText::CopyText()
+     */
+    bool CopyText(size_t startPosition, size_t endPosition) override;
+
+    /**
+     * @copydoc Dali::Accessibility::EditableText::CutText()
+     */
+    bool CutText(size_t startPosition, size_t endPosition) override;
+
+    /**
+     * @copydoc Dali::Accessibility::Accessible::GetStates()
+     */
     Accessibility::States CalculateStates() override;
-    bool                  InsertText(size_t startPosition, std::string text) override;
-    bool                  SetTextContents(std::string newContents) override;
-    bool                  DeleteText(size_t startPosition, size_t endPosition) override;
+
+    /**
+     * @copydoc Dali::Accessibility::EditableText::InsertText()
+     */
+    bool InsertText(size_t startPosition, std::string text) override;
+
+    /**
+     * @copydoc Dali::Accessibility::EditableText::SetTextContents()
+     */
+    bool SetTextContents(std::string newContents) override;
+
+    /**
+     * @copydoc Dali::Accessibility::EditableText::DeleteText()
+     */
+    bool DeleteText(size_t startPosition, size_t endPosition) override;
   };
 };