X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Ftext-controls%2Ftext-editor-impl.h;h=866c444adec9c6e76727bfa5cf1a4898d85021e2;hb=e54ea0676d3bbe53d40309a41b1b415f8f6a64d4;hp=c8bae9c6dce6157bc05c1dd33652284af21fc315;hpb=c940eb40f599361d84edfc3883d5f329f58bc0b4;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/controls/text-controls/text-editor-impl.h b/dali-toolkit/internal/controls/text-controls/text-editor-impl.h old mode 100755 new mode 100644 index c8bae9c..8a96a13 --- a/dali-toolkit/internal/controls/text-controls/text-editor-impl.h +++ b/dali-toolkit/internal/controls/text-controls/text-editor-impl.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 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. @@ -19,37 +19,42 @@ */ // EXTERNAL INCLUDES +#include #include #include +#include +#include +#include #include // INTERNAL INCLUDES -#include +#include #include -#include #include +#include #include +#include +#include #include -#include #include +#include +#include #include -#include +#include +#include namespace Dali { - namespace Toolkit { - namespace Internal { /** * @brief A control which renders a long text string with styles. */ -class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface +class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface { public: - /** * @copydoc Dali::Toollkit::TextEditor::New() */ @@ -64,7 +69,7 @@ public: * @param[in] index The property index. * @param[in] value The new property value. */ - static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value ); + static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value); /** * @brief Called to retrieve a property of an object of this type. @@ -73,7 +78,7 @@ public: * @param[in] index The property index. * @return The current value of the property. */ - static Property::Value GetProperty( BaseObject* object, Property::Index index ); + static Property::Value GetProperty(BaseObject* object, Property::Index index); /** * @copydoc Dali::Toollkit::TextEditor::GetInputMethodContext() @@ -83,7 +88,37 @@ public: /** * @copydoc Dali::Toollkit::TextEditor::MaxLengthReachedSignal() */ - DevelTextEditor::MaxLengthReachedSignalType& MaxLengthReachedSignal(); + DevelTextEditor::MaxLengthReachedSignalType& MaxLengthReachedSignal(); + + /** + * @copydoc Dali::Toollkit::TextEditor::AnchorClickedSignal() + */ + 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(); + + /** + * @copydoc Dali::Toollkit::TextEditor::SelectionStartedSignal() + */ + DevelTextEditor::SelectionStartedSignalType& SelectionStartedSignal(); /** * Connects a callback function with the object's signals. @@ -94,12 +129,19 @@ public: * @return True if the signal was connected. * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor. */ - static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ); + 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(); + Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal(); /** * @copydoc TextEditor::TextChangedSignal() @@ -112,108 +154,246 @@ public: Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal(); private: // From Control - /** * @copydoc Control::OnInitialize() */ - virtual void OnInitialize(); + void OnInitialize() override; /** * @copydoc Control::OnStyleChange() */ - virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); + void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override; /** * @copydoc Control::GetNaturalSize() */ - virtual Vector3 GetNaturalSize(); + Vector3 GetNaturalSize() override; /** * @copydoc Control::GetHeightForWidth() */ - virtual float GetHeightForWidth( float width ); + float GetHeightForWidth(float width) override; /** * @copydoc Control::OnInitialize() */ - virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); + void OnRelayout(const Vector2& size, RelayoutContainer& container) override; /** * @copydoc Control::OnKeyInputFocusGained() */ - virtual void OnKeyInputFocusGained(); + void OnKeyInputFocusGained() override; /** * @copydoc Control::OnKeyInputFocusLost() */ - virtual void OnKeyInputFocusLost(); + void OnKeyInputFocusLost() override; + + /** + * @copydoc Control::OnAccessibilityActivated() + */ + bool OnAccessibilityActivated() override; /** * @copydoc Control::OnTap() */ - virtual void OnTap( const TapGesture& tap ); + void OnTap(const TapGesture& tap) override; /** * @copydoc Control::OnPan() */ - virtual void OnPan( const PanGesture& gesture ); + void OnPan(const PanGesture& gesture) override; /** * @copydoc Control::OnLongPress() */ - virtual void OnLongPress( const LongPressGesture& gesture ); + void OnLongPress(const LongPressGesture& gesture) override; /** * @copydoc Control::OnSceneConnection() */ - virtual void OnSceneConnection( int depth ); + void OnSceneConnection(int depth) override; /** * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) */ - virtual bool OnKeyEvent(const KeyEvent& event); + bool OnKeyEvent(const KeyEvent& event) override; -// From ControlInterface + // From ControlInterface /** * @copydoc Text::ControlInterface::RequestTextRelayout() */ - virtual void RequestTextRelayout(); + void RequestTextRelayout() override; -// From EditableControlInterface + // From EditableControlInterface /** - * @copydoc Text::ControlInterface::TextChanged() + * @copydoc Text::EditableControlInterface::TextChanged() */ - virtual void TextChanged(); + void TextInserted(unsigned int position, unsigned int length, const std::string& content) override; /** - * @copydoc Text::ControlInterface::MaxLengthReached() + * @copydoc Text::EditableControlInterface::TextDeleted() */ - virtual void MaxLengthReached(); + void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override; /** - * @copydoc Text::ControlInterface::InputStyleChanged() + * @copydoc Text::EditableControlInterface::CursorPositionChanged() */ - virtual void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ); + void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override; /** - * @copydoc Text::ControlInterface::AddDecoration() + * @copydoc Text::EditableControlInterface::TextChanged() */ - virtual void AddDecoration( Actor& actor, bool needsClipping ); + void TextChanged(bool immediate) override; -private: // Implementation + /** + * @copydoc Text::EditableControlInterface::MaxLengthReached() + */ + void MaxLengthReached() override; + + /** + * @copydoc Text::EditableControlInterface::InputStyleChanged() + */ + 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, Toolkit::Text::DecorationType type, 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: + /** + * @copydoc Text::SelectableControlInterface::SetTextSelectionRange() + */ + void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override; + + /** + * @copydoc Text::SelectableControlInterface::GetTextSelectionRange() + */ + Uint32Pair GetTextSelectionRange() const override; + + /** + * @copydoc Text::SelectableControlInterface::SelectWholeText() + */ + void SelectWholeText() override; + + /** + * @copydoc Text::SelectableControlInterface::SelectNone() + */ + 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); + + /** + * @brief Get Horizontal scroll position of TextEditor. + * + * @return Horizontal scroll position (in pixels) of TextEditor. + */ + float GetHorizontalScrollPosition(); + + /** + * @brief Get Vertical scroll position of TextEditor. + * + * @return Vertical scroll position (in pixels) of TextEditor. + */ + float GetVerticalScrollPosition(); + + /** + * @brief Get the rendered size of a specific text range. + * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line. + * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction. + * + * @param[in] startIndex start index of the text requested to calculate size for. + * @param[in] endIndex end index(included) of the text requested to calculate size for. + * @return list of sizes of the reuested text. + */ + Vector GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const; + + /** + * @brief Get the top/left rendered position of a specific text range. + * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line. + * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction. + * + * @param[in] startIndex start index of the text requested to get position to. + * @param[in] endIndex end index(included) of the text requested to get position to. + * @return list of positions of the requested text. + */ + Vector GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const; + + /** + * @copydoc Text::SelectableControlInterface::GetSelectedText() + */ + string GetSelectedText() const override; + + /** + * @copydoc Text::EditableControlInterface::IsEditable() + */ + bool IsEditable() const override; + + /** + * @copydoc Text::EditableControlInterface::SetEditable() + */ + 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 + + /** + * @copydoc Text::AnchorControlInterface::AnchorClicked() + */ + void AnchorClicked(const std::string& href) override; + +private: // Implementation + /** * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent) */ - InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent ); + InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent); /** * @brief Callback when Clipboard signals an item should be pasted * @param[in] clipboard handle to Clipboard Event Notifier */ - void OnClipboardTextSelected( ClipboardEventNotifier& clipboard ); + void OnClipboardTextSelected(ClipboardEventNotifier& clipboard); /** * @brief Get a Property Map for the image used for the required Handle Image @@ -221,14 +401,14 @@ private: // Implementation * @param[in] handleType the type of handle * @param[in] handleImageType the type of image for the given handleType */ - void GetHandleImagePropertyValue( Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType ); + void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType); /** * @brief Callback when keyboard is shown/hidden. * * @param[in] keyboardShown True if keyboard is shown. */ - void KeyboardStatusChanged( bool keyboardShown ); + void KeyboardStatusChanged(bool keyboardShown); /** * @brief update scroll bar position @@ -243,7 +423,7 @@ private: // Implementation * @param[in] actor TextEditor touched * @param[in] touch Touch information */ - bool OnTouched( Actor actor, const TouchData& touch ); + bool OnTouched(Actor actor, const TouchEvent& touch); /** * @brief Callbacks called on idle. @@ -253,6 +433,31 @@ 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 Emits SelectionStarted signal. + */ + void EmitSelectionStartedSignal(); + + /** * @brief set RenderActor's position with new scrollPosition * * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled @@ -264,7 +469,21 @@ private: // Implementation * * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false */ - void OnScrollIndicatorAnimationFinished( Animation& animation ); + 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); + + /** + * @brief Add a layer for active or cursor. + * @param[in] layer The actor in which to store the layer. + * @param[in] actor The new layer to add. + */ + void AddLayer(Actor& layer, Actor& actor); /** * Construct a new TextEditor. @@ -281,50 +500,191 @@ private: // Implementation TextEditor& operator=(const TextEditor& rhs); /** + * @brief Resize actor to the given size. + * + * @param[in] actor The actor to be resized. + * @param[in] size Size to change. + */ + void ResizeActor(Actor& actor, const Vector2& size); + + /** * @brief Render view, create and attach actor(s) to this text editor. */ - void RenderText( Text::Controller::UpdateTextType updateTextType ); + void RenderText(Text::Controller::UpdateTextType updateTextType); // Connection needed to re-render text, when a text editor returns to the scene. - void OnSceneConnect( Dali::Actor actor ); + void OnSceneConnect(Dali::Actor actor); + + // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model + void OnAccessibilityStatusChanged(); private: // Data // Signals - Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal; - Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal; - Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal; - Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal; - - InputMethodContext mInputMethodContext; - Text::ControllerPtr mController; - Text::RendererPtr mRenderer; - Text::DecoratorPtr mDecorator; - Text::TextVerticalScrollerPtr mTextVerticalScroller; - Toolkit::Control mStencil; - Toolkit::ScrollBar mScrollBar; - Dali::Animation mAnimation; ///< Scroll indicator Show/Hide Animation. - Dali::TimePeriod mAnimationPeriod; - std::vector mClippingDecorationActors; ///< Decoration actors which need clipping. - - Actor mRenderableActor; - Actor mActiveLayer; + 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; + Toolkit::DevelTextEditor::SelectionStartedSignalType mSelectionStartedSignal; + + InputMethodContext mInputMethodContext; + Text::ControllerPtr mController; + Text::RendererPtr mRenderer; + Text::DecoratorPtr mDecorator; + Text::TextVerticalScrollerPtr mTextVerticalScroller; + Toolkit::Control mStencil; + Toolkit::ScrollBar mScrollBar; + Dali::Animation mAnimation; ///< Scroll indicator Show/Hide Animation. + Dali::TimePeriod mAnimationPeriod; + std::vector mClippingDecorationActors; ///< Decoration actors which need clipping. + std::vector mAnchorActors; + Dali::InputMethodOptions mInputMethodOptions; + + Actor mRenderableActor; + Actor mActiveLayer; + Actor mCursorLayer; + Actor mBackgroundActor; CallbackBase* mIdleCallback; float mAlignmentOffset; float mScrollAnimationDuration; float mLineSpacing; - int mRenderingBackend; - bool mHasBeenStaged:1; - bool mScrollAnimationEnabled:1; - bool mScrollBarEnabled:1; - bool mScrollStarted:1; + int mRenderingBackend; + bool mHasBeenStaged : 1; + bool mScrollAnimationEnabled : 1; + bool mScrollBarEnabled : 1; + bool mScrollStarted : 1; + 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; + + bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout(). + + struct PropertyHandler; + + /** + * @brief This structure is to connect TextEditor with Accessible functions. + */ + struct AccessibleImpl : public DevelControl::ControlAccessible, + public virtual Dali::Accessibility::EditableText, + public virtual Dali::Accessibility::Hypertext + { + using DevelControl::ControlAccessible::ControlAccessible; + + /** + * @copydoc Dali::Accessibility::Accessible::GetName() + */ + std::string GetName() const override; + + /** + * @copydoc Dali::Accessibility::Text::GetText() + */ + std::string GetText(size_t startOffset, size_t endOffset) const override; + + /** + * @copydoc Dali::Accessibility::Text::GetCharacterCount() + */ + size_t GetCharacterCount() const override; + + /** + * @copydoc Dali::Accessibility::Text::GetCursorOffset() + */ + size_t GetCursorOffset() const 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) const override; + + /** + * @copydoc Dali::Accessibility::Text::GetRangeOfSelection() + */ + Accessibility::Range GetRangeOfSelection(size_t selectionIndex) const 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::Text::GetRangeExtents() + */ + Rect<> GetRangeExtents(size_t startOffset, size_t endOffset, Accessibility::CoordinateType type) 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; + + /** + * @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; + + /** + * @copydoc Dali::Accessibility::Hypertext::GetLink() + */ + Accessibility::Hyperlink* GetLink(int32_t linkIndex) const override; + + /** + * @copydoc Dali::Accessibility::Hypertext::GetLinkIndex() + */ + int32_t GetLinkIndex(int32_t characterOffset) const override; + + /** + * @copydoc Dali::Accessibility::Hypertext::GetLinkCount() + */ + int32_t GetLinkCount() const override; + }; }; } // namespace Internal // Helpers for public-api forwarding methods -inline Toolkit::Internal::TextEditor& GetImpl( Toolkit::TextEditor& textEditor ) +inline Toolkit::Internal::TextEditor& GetImpl(Toolkit::TextEditor& textEditor) { DALI_ASSERT_ALWAYS(textEditor); @@ -333,7 +693,7 @@ inline Toolkit::Internal::TextEditor& GetImpl( Toolkit::TextEditor& textEditor ) return static_cast(handle); } -inline const Toolkit::Internal::TextEditor& GetImpl( const Toolkit::TextEditor& textEditor ) +inline const Toolkit::Internal::TextEditor& GetImpl(const Toolkit::TextEditor& textEditor) { DALI_ASSERT_ALWAYS(textEditor);